Chilkat Online Tools

phpAx / Datadog API Collection / Generate a new external ID

Back to Collection Items

<?php

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

$http = new COM("Chilkat_9_5_0.Http");

// 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 = new COM("Chilkat_9_5_0.JsonObject");
$json->UpdateString('access_key_id','eiusmod');
$json->UpdateString('account_id','123456789012');
$json->UpdateBool('account_specific_namespace_rules.auto_scaling',0);
$json->UpdateBool('account_specific_namespace_rules.opswork',0);
$json->UpdateBool('cspm_resource_collection_enabled',1);
$json->UpdateString('excluded_regions[0]','us-east-1');
$json->UpdateString('excluded_regions[1]','us-west-2');
$json->UpdateString('filter_tags[0]','$KEY:$VALUE');
$json->UpdateString('host_tags[0]','$KEY:$VALUE');
$json->UpdateBool('metrics_collection_enabled',0);
$json->UpdateBool('resource_collection_enabled',1);
$json->UpdateString('role_name','DatadogAWSIntegrationRole');
$json->UpdateString('secret_access_key','amet et dolore deserunt pariatur');

$http->SetRequestHeader('Content-Type','application/json');
$http->SetRequestHeader('Accept','application/json');

$sbRequestBody = new COM("Chilkat_9_5_0.StringBuilder");
$json->EmitSb($sbRequestBody);

// resp is a Chilkat_9_5_0.HttpResponse
$resp = $http->PTextSb('PUT','https://api.app.ddog-gov.com/api/v1/integration/aws/generate_new_external_id',$sbRequestBody,'utf-8','application/json',0,0);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

$sbResponseBody = new COM("Chilkat_9_5_0.StringBuilder");
$resp->GetBodySb($sbResponseBody);

$jResp = new COM("Chilkat_9_5_0.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->Header . "\n";
    print 'Failed.' . "\n";

    exit;
}

// 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 = $jResp->stringOf('external_id');

?>

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}"
    }
  ]
}