Chilkat Online Tools

delphiDll / Datadog API Collection / Get API key

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
queryParams: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
attributesCreated_at: PWideChar;
Disabled: PWideChar;
v_Email: PWideChar;
Handle: PWideChar;
Icon: PWideChar;
attributesModified_at: PWideChar;
attributesName: PWideChar;
Service_account: PWideChar;
Status: PWideChar;
Title: PWideChar;
Verified: PWideChar;
id: PWideChar;
v_type: PWideChar;
j: Integer;
count_j: Integer;
Created_at: PWideChar;
Key: PWideChar;
Last4: PWideChar;
Modified_at: PWideChar;
Name: PWideChar;
Id: PWideChar;
DataId: PWideChar;
v_Type: PWideChar;
DataType: PWideChar;
dataType: PWideChar;
i: Integer;
count_i: Integer;

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

http := CkHttp_Create();

queryParams := CkJsonObject_Create();
CkJsonObject_UpdateString(queryParams,'include','<string>');

CkHttp_SetRequestHeader(http,'Accept','application/json');

resp := CkHttp_QuickRequestParams(http,'GET','https://api.app.ddog-gov.com/api/v2/api_keys/:api_key_id',queryParams);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttpResponse__header(resp));
    Memo1.Lines.Add('Failed.');
    CkHttpResponse_Dispose(resp);
    Exit;
  end;
CkHttpResponse_Dispose(resp);

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

// {
//   "data": {
//     "attributes": {
//       "created_at": "<string>",
//       "key": "<string>",
//       "last4": "<string>",
//       "modified_at": "<string>",
//       "name": "<string>"
//     },
//     "id": "<string>",
//     "relationships": {
//       "created_by": {
//         "data": {
//           "id": "<string>",
//           "type": "users"
//         }
//       },
//       "modified_by": {
//         "data": {
//           "id": "<string>",
//           "type": "users"
//         }
//       }
//     },
//     "type": "api_keys"
//   },
//   "included": [
//     {
//       "attributes": {
//         "created_at": "<dateTime>",
//         "disabled": "<boolean>",
//         "email": "<string>",
//         "handle": "<string>",
//         "icon": "<string>",
//         "modified_at": "<dateTime>",
//         "name": "<string>",
//         "service_account": "<boolean>",
//         "status": "<string>",
//         "title": "<string>",
//         "verified": "<boolean>"
//       },
//       "id": "<string>",
//       "relationships": {
//         "org": {
//           "data": {
//             "id": "<string>",
//             "type": "orgs"
//           }
//         },
//         "other_orgs": {
//           "data": [
//             {
//               "id": "<string>",
//               "type": "orgs"
//             },
//             {
//               "id": "<string>",
//               "type": "orgs"
//             }
//           ]
//         },
//         "other_users": {
//           "data": [
//             {
//               "id": "<string>",
//               "type": "users"
//             },
//             {
//               "id": "<string>",
//               "type": "users"
//             }
//           ]
//         },
//         "roles": {
//           "data": [
//             {
//               "id": "<string>",
//               "type": "roles"
//             },
//             {
//               "id": "<string>",
//               "type": "roles"
//             }
//           ]
//         }
//       },
//       "type": "users"
//     },
//     {
//       "attributes": {
//         "created_at": "<dateTime>",
//         "disabled": "<boolean>",
//         "email": "<string>",
//         "handle": "<string>",
//         "icon": "<string>",
//         "modified_at": "<dateTime>",
//         "name": "<string>",
//         "service_account": "<boolean>",
//         "status": "<string>",
//         "title": "<string>",
//         "verified": "<boolean>"
//       },
//       "id": "<string>",
//       "relationships": {
//         "org": {
//           "data": {
//             "id": "<string>",
//             "type": "orgs"
//           }
//         },
//         "other_orgs": {
//           "data": [
//             {
//               "id": "<string>",
//               "type": "orgs"
//             },
//             {
//               "id": "<string>",
//               "type": "orgs"
//             }
//           ]
//         },
//         "other_users": {
//           "data": [
//             {
//               "id": "<string>",
//               "type": "users"
//             },
//             {
//               "id": "<string>",
//               "type": "users"
//             }
//           ]
//         },
//         "roles": {
//           "data": [
//             {
//               "id": "<string>",
//               "type": "roles"
//             },
//             {
//               "id": "<string>",
//               "type": "roles"
//             }
//           ]
//         }
//       },
//       "type": "users"
//     }
//   ]
// }

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

Created_at := CkJsonObject__stringOf(jResp,'data.attributes.created_at');
Key := CkJsonObject__stringOf(jResp,'data.attributes.key');
Last4 := CkJsonObject__stringOf(jResp,'data.attributes.last4');
Modified_at := CkJsonObject__stringOf(jResp,'data.attributes.modified_at');
Name := CkJsonObject__stringOf(jResp,'data.attributes.name');
Id := CkJsonObject__stringOf(jResp,'data.id');
DataId := CkJsonObject__stringOf(jResp,'data.relationships.created_by.data.id');
v_Type := CkJsonObject__stringOf(jResp,'data.relationships.created_by.data.type');
DataId := CkJsonObject__stringOf(jResp,'data.relationships.modified_by.data.id');
DataType := CkJsonObject__stringOf(jResp,'data.relationships.modified_by.data.type');
dataType := CkJsonObject__stringOf(jResp,'data.type');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'included');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    attributesCreated_at := CkJsonObject__stringOf(jResp,'included[i].attributes.created_at');
    Disabled := CkJsonObject__stringOf(jResp,'included[i].attributes.disabled');
    v_Email := CkJsonObject__stringOf(jResp,'included[i].attributes.email');
    Handle := CkJsonObject__stringOf(jResp,'included[i].attributes.handle');
    Icon := CkJsonObject__stringOf(jResp,'included[i].attributes.icon');
    attributesModified_at := CkJsonObject__stringOf(jResp,'included[i].attributes.modified_at');
    attributesName := CkJsonObject__stringOf(jResp,'included[i].attributes.name');
    Service_account := CkJsonObject__stringOf(jResp,'included[i].attributes.service_account');
    Status := CkJsonObject__stringOf(jResp,'included[i].attributes.status');
    Title := CkJsonObject__stringOf(jResp,'included[i].attributes.title');
    Verified := CkJsonObject__stringOf(jResp,'included[i].attributes.verified');
    id := CkJsonObject__stringOf(jResp,'included[i].id');
    DataId := CkJsonObject__stringOf(jResp,'included[i].relationships.org.data.id');
    DataType := CkJsonObject__stringOf(jResp,'included[i].relationships.org.data.type');
    v_type := CkJsonObject__stringOf(jResp,'included[i].type');
    j := 0;
    count_j := CkJsonObject_SizeOfArray(jResp,'included[i].relationships.other_orgs.data');
    while j < count_j do
      begin
        CkJsonObject_putJ(jResp,j);
        id := CkJsonObject__stringOf(jResp,'included[i].relationships.other_orgs.data[j].id');
        v_type := CkJsonObject__stringOf(jResp,'included[i].relationships.other_orgs.data[j].type');
        j := j + 1;
      end;

    j := 0;
    count_j := CkJsonObject_SizeOfArray(jResp,'included[i].relationships.other_users.data');
    while j < count_j do
      begin
        CkJsonObject_putJ(jResp,j);
        id := CkJsonObject__stringOf(jResp,'included[i].relationships.other_users.data[j].id');
        v_type := CkJsonObject__stringOf(jResp,'included[i].relationships.other_users.data[j].type');
        j := j + 1;
      end;

    j := 0;
    count_j := CkJsonObject_SizeOfArray(jResp,'included[i].relationships.roles.data');
    while j < count_j do
      begin
        CkJsonObject_putJ(jResp,j);
        id := CkJsonObject__stringOf(jResp,'included[i].relationships.roles.data[j].id');
        v_type := CkJsonObject__stringOf(jResp,'included[i].relationships.roles.data[j].type');
        j := j + 1;
      end;

    i := i + 1;
  end;

CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

Curl Command

curl -G -d "include=%3Cstring%3E"
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/api_keys/:api_key_id

Postman Collection Item JSON

{
  "name": "Get API key",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id?include=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "api_keys",
        ":api_key_id"
      ],
      "query": [
        {
          "key": "include",
          "value": "<string>",
          "description": "Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`."
        }
      ],
      "variable": [
        {
          "key": "api_key_id",
          "value": "<string>"
        }
      ]
    },
    "description": "Get an API key."
  },
  "response": [
    {
      "name": "OK",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id?include=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "api_keys",
            ":api_key_id"
          ],
          "query": [
            {
              "key": "include",
              "value": "<string>",
              "description": "Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`."
            }
          ],
          "variable": [
            {
              "key": "api_key_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\n    \"attributes\": {\n      \"created_at\": \"<string>\",\n      \"key\": \"<string>\",\n      \"last4\": \"<string>\",\n      \"modified_at\": \"<string>\",\n      \"name\": \"<string>\"\n    },\n    \"id\": \"<string>\",\n    \"relationships\": {\n      \"created_by\": {\n        \"data\": {\n          \"id\": \"<string>\",\n          \"type\": \"users\"\n        }\n      },\n      \"modified_by\": {\n        \"data\": {\n          \"id\": \"<string>\",\n          \"type\": \"users\"\n        }\n      }\n    },\n    \"type\": \"api_keys\"\n  },\n  \"included\": [\n    {\n      \"attributes\": {\n        \"created_at\": \"<dateTime>\",\n        \"disabled\": \"<boolean>\",\n        \"email\": \"<string>\",\n        \"handle\": \"<string>\",\n        \"icon\": \"<string>\",\n        \"modified_at\": \"<dateTime>\",\n        \"name\": \"<string>\",\n        \"service_account\": \"<boolean>\",\n        \"status\": \"<string>\",\n        \"title\": \"<string>\",\n        \"verified\": \"<boolean>\"\n      },\n      \"id\": \"<string>\",\n      \"relationships\": {\n        \"org\": {\n          \"data\": {\n            \"id\": \"<string>\",\n            \"type\": \"orgs\"\n          }\n        },\n        \"other_orgs\": {\n          \"data\": [\n            {\n              \"id\": \"<string>\",\n              \"type\": \"orgs\"\n            },\n            {\n              \"id\": \"<string>\",\n              \"type\": \"orgs\"\n            }\n          ]\n        },\n        \"other_users\": {\n          \"data\": [\n            {\n              \"id\": \"<string>\",\n              \"type\": \"users\"\n            },\n            {\n              \"id\": \"<string>\",\n              \"type\": \"users\"\n            }\n          ]\n        },\n        \"roles\": {\n          \"data\": [\n            {\n              \"id\": \"<string>\",\n              \"type\": \"roles\"\n            },\n            {\n              \"id\": \"<string>\",\n              \"type\": \"roles\"\n            }\n          ]\n        }\n      },\n      \"type\": \"users\"\n    },\n    {\n      \"attributes\": {\n        \"created_at\": \"<dateTime>\",\n        \"disabled\": \"<boolean>\",\n        \"email\": \"<string>\",\n        \"handle\": \"<string>\",\n        \"icon\": \"<string>\",\n        \"modified_at\": \"<dateTime>\",\n        \"name\": \"<string>\",\n        \"service_account\": \"<boolean>\",\n        \"status\": \"<string>\",\n        \"title\": \"<string>\",\n        \"verified\": \"<boolean>\"\n      },\n      \"id\": \"<string>\",\n      \"relationships\": {\n        \"org\": {\n          \"data\": {\n            \"id\": \"<string>\",\n            \"type\": \"orgs\"\n          }\n        },\n        \"other_orgs\": {\n          \"data\": [\n            {\n              \"id\": \"<string>\",\n              \"type\": \"orgs\"\n            },\n            {\n              \"id\": \"<string>\",\n              \"type\": \"orgs\"\n            }\n          ]\n        },\n        \"other_users\": {\n          \"data\": [\n            {\n              \"id\": \"<string>\",\n              \"type\": \"users\"\n            },\n            {\n              \"id\": \"<string>\",\n              \"type\": \"users\"\n            }\n          ]\n        },\n        \"roles\": {\n          \"data\": [\n            {\n              \"id\": \"<string>\",\n              \"type\": \"roles\"\n            },\n            {\n              \"id\": \"<string>\",\n              \"type\": \"roles\"\n            }\n          ]\n        }\n      },\n      \"type\": \"users\"\n    }\n  ]\n}"
    },
    {
      "name": "Forbidden",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id?include=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "api_keys",
            ":api_key_id"
          ],
          "query": [
            {
              "key": "include",
              "value": "<string>",
              "description": "Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`."
            }
          ],
          "variable": [
            {
              "key": "api_key_id"
            }
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    },
    {
      "name": "Not Found",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id?include=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "api_keys",
            ":api_key_id"
          ],
          "query": [
            {
              "key": "include",
              "value": "<string>",
              "description": "Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`."
            }
          ],
          "variable": [
            {
              "key": "api_key_id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    },
    {
      "name": "Too many requests",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id?include=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "api_keys",
            ":api_key_id"
          ],
          "query": [
            {
              "key": "include",
              "value": "<string>",
              "description": "Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`."
            }
          ],
          "variable": [
            {
              "key": "api_key_id"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    }
  ]
}