Chilkat Online Tools

PureBasic / Datadog API Collection / Generate a new external ID

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

    ; This example assumes the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    ; The following JSON is sent in the request body.

    ; {
    ;   "access_key_id": "eiusmod",
    ;   "account_id": "123456789012",
    ;   "account_specific_namespace_rules": {
    ;     "auto_scaling": false,
    ;     "opswork": false
    ;   },
    ;   "cspm_resource_collection_enabled": true,
    ;   "excluded_regions": [
    ;     "us-east-1",
    ;     "us-west-2"
    ;   ],
    ;   "filter_tags": [
    ;     "$KEY:$VALUE"
    ;   ],
    ;   "host_tags": [
    ;     "$KEY:$VALUE"
    ;   ],
    ;   "metrics_collection_enabled": false,
    ;   "resource_collection_enabled": true,
    ;   "role_name": "DatadogAWSIntegrationRole",
    ;   "secret_access_key": "amet et dolore deserunt pariatur"
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"access_key_id","eiusmod")
    CkJsonObject::ckUpdateString(json,"account_id","123456789012")
    CkJsonObject::ckUpdateBool(json,"account_specific_namespace_rules.auto_scaling",0)
    CkJsonObject::ckUpdateBool(json,"account_specific_namespace_rules.opswork",0)
    CkJsonObject::ckUpdateBool(json,"cspm_resource_collection_enabled",1)
    CkJsonObject::ckUpdateString(json,"excluded_regions[0]","us-east-1")
    CkJsonObject::ckUpdateString(json,"excluded_regions[1]","us-west-2")
    CkJsonObject::ckUpdateString(json,"filter_tags[0]","$KEY:$VALUE")
    CkJsonObject::ckUpdateString(json,"host_tags[0]","$KEY:$VALUE")
    CkJsonObject::ckUpdateBool(json,"metrics_collection_enabled",0)
    CkJsonObject::ckUpdateBool(json,"resource_collection_enabled",1)
    CkJsonObject::ckUpdateString(json,"role_name","DatadogAWSIntegrationRole")
    CkJsonObject::ckUpdateString(json,"secret_access_key","amet et dolore deserunt pariatur")

    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
    CkHttp::ckSetRequestHeader(http,"Accept","application/json")

    sbRequestBody.i = CkStringBuilder::ckCreate()
    If sbRequestBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckEmitSb(json,sbRequestBody)

    resp.i = CkHttp::ckPTextSb(http,"PUT","https://api.app.ddog-gov.com/api/v1/integration/aws/generate_new_external_id",sbRequestBody,"utf-8","application/json",0,0)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        ProcedureReturn
    EndIf

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Failed."
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

    ; Sample JSON response:
    ; (Sample code for parsing the JSON response is shown below)

    ; {
    ;   "external_id": "ex sit ea commodo tempor"
    ; }

    ; Sample code for parsing the JSON response...
    ; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    external_id.s = CkJsonObject::ckStringOf(jResp,"external_id")


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

Curl Command

curl -X PUT
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "access_key_id": "eiusmod",
  "account_id": "123456789012",
  "account_specific_namespace_rules": {
    "auto_scaling": false,
    "opswork": false
  },
  "cspm_resource_collection_enabled": true,
  "excluded_regions": [
    "us-east-1",
    "us-west-2"
  ],
  "filter_tags": [
    "$KEY:$VALUE"
  ],
  "host_tags": [
    "$KEY:$VALUE"
  ],
  "metrics_collection_enabled": false,
  "resource_collection_enabled": true,
  "role_name": "DatadogAWSIntegrationRole",
  "secret_access_key": "amet et dolore deserunt pariatur"
}'
https://api.app.ddog-gov.com/api/v1/integration/aws/generate_new_external_id

Postman Collection Item JSON

{
  "name": "Generate a new external ID",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"access_key_id\": \"eiusmod\",\n  \"account_id\": \"123456789012\",\n  \"account_specific_namespace_rules\": {\n    \"auto_scaling\": false,\n    \"opswork\": false\n  },\n  \"cspm_resource_collection_enabled\": true,\n  \"excluded_regions\": [\n    \"us-east-1\",\n    \"us-west-2\"\n  ],\n  \"filter_tags\": [\n    \"$KEY:$VALUE\"\n  ],\n  \"host_tags\": [\n    \"$KEY:$VALUE\"\n  ],\n  \"metrics_collection_enabled\": false,\n  \"resource_collection_enabled\": true,\n  \"role_name\": \"DatadogAWSIntegrationRole\",\n  \"secret_access_key\": \"amet et dolore deserunt pariatur\"\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v1/integration/aws/generate_new_external_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "integration",
        "aws",
        "generate_new_external_id"
      ]
    },
    "description": "Generate a new AWS external ID for a given AWS account ID and role name pair."
  },
  "response": [
    {
      "name": "OK",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"access_key_id\": \"eiusmod\",\n  \"account_id\": \"123456789012\",\n  \"account_specific_namespace_rules\": {\n    \"auto_scaling\": false,\n    \"opswork\": false\n  },\n  \"cspm_resource_collection_enabled\": true,\n  \"excluded_regions\": [\n    \"us-east-1\",\n    \"us-west-2\"\n  ],\n  \"filter_tags\": [\n    \"$KEY:$VALUE\"\n  ],\n  \"host_tags\": [\n    \"$KEY:$VALUE\"\n  ],\n  \"metrics_collection_enabled\": false,\n  \"resource_collection_enabled\": true,\n  \"role_name\": \"DatadogAWSIntegrationRole\",\n  \"secret_access_key\": \"amet et dolore deserunt pariatur\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/integration/aws/generate_new_external_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "integration",
            "aws",
            "generate_new_external_id"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"external_id\": \"ex sit ea commodo tempor\"\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"access_key_id\": \"eiusmod\",\n  \"account_id\": \"123456789012\",\n  \"account_specific_namespace_rules\": {\n    \"auto_scaling\": false,\n    \"opswork\": false\n  },\n  \"cspm_resource_collection_enabled\": true,\n  \"excluded_regions\": [\n    \"us-east-1\",\n    \"us-west-2\"\n  ],\n  \"filter_tags\": [\n    \"$KEY:$VALUE\"\n  ],\n  \"host_tags\": [\n    \"$KEY:$VALUE\"\n  ],\n  \"metrics_collection_enabled\": false,\n  \"resource_collection_enabled\": true,\n  \"role_name\": \"DatadogAWSIntegrationRole\",\n  \"secret_access_key\": \"amet et dolore deserunt pariatur\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/integration/aws/generate_new_external_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "integration",
            "aws",
            "generate_new_external_id"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    },
    {
      "name": "Authentication Error",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"access_key_id\": \"eiusmod\",\n  \"account_id\": \"123456789012\",\n  \"account_specific_namespace_rules\": {\n    \"auto_scaling\": false,\n    \"opswork\": false\n  },\n  \"cspm_resource_collection_enabled\": true,\n  \"excluded_regions\": [\n    \"us-east-1\",\n    \"us-west-2\"\n  ],\n  \"filter_tags\": [\n    \"$KEY:$VALUE\"\n  ],\n  \"host_tags\": [\n    \"$KEY:$VALUE\"\n  ],\n  \"metrics_collection_enabled\": false,\n  \"resource_collection_enabled\": true,\n  \"role_name\": \"DatadogAWSIntegrationRole\",\n  \"secret_access_key\": \"amet et dolore deserunt pariatur\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/integration/aws/generate_new_external_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "integration",
            "aws",
            "generate_new_external_id"
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    },
    {
      "name": "Too many requests",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"access_key_id\": \"eiusmod\",\n  \"account_id\": \"123456789012\",\n  \"account_specific_namespace_rules\": {\n    \"auto_scaling\": false,\n    \"opswork\": false\n  },\n  \"cspm_resource_collection_enabled\": true,\n  \"excluded_regions\": [\n    \"us-east-1\",\n    \"us-west-2\"\n  ],\n  \"filter_tags\": [\n    \"$KEY:$VALUE\"\n  ],\n  \"host_tags\": [\n    \"$KEY:$VALUE\"\n  ],\n  \"metrics_collection_enabled\": false,\n  \"resource_collection_enabled\": true,\n  \"role_name\": \"DatadogAWSIntegrationRole\",\n  \"secret_access_key\": \"amet et dolore deserunt pariatur\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/integration/aws/generate_new_external_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "integration",
            "aws",
            "generate_new_external_id"
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    }
  ]
}