Back to Collection Items
var os = require('os');
if (os.platform() == 'win32') {
if (os.arch() == 'ia32') {
var chilkat = require('@chilkat/ck-node21-win-ia32');
} else {
var chilkat = require('@chilkat/ck-node21-win64');
}
} else if (os.platform() == 'linux') {
if (os.arch() == 'arm') {
var chilkat = require('@chilkat/ck-node21-arm');
} else if (os.arch() == 'x86') {
var chilkat = require('@chilkat/ck-node21-linux32');
} else {
var chilkat = require('@chilkat/ck-node21-linux64');
}
} else if (os.platform() == 'darwin') {
if (os.arch() == 'arm64') {
var chilkat = require('@chilkat/ck-node21-mac-m1');
} else {
var chilkat = require('@chilkat/ck-node21-macosx');
}
}
function chilkatExample() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
var http = new chilkat.Http();
var success;
var queryParams = new chilkat.JsonObject();
queryParams.UpdateString("include","<string>");
http.SetRequestHeader("Accept","application/json");
// resp: HttpResponse
var resp = http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/api_keys/:api_key_id",queryParams);
if (http.LastMethodSuccess == false) {
console.log(http.LastErrorText);
return;
}
var sbResponseBody = new chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);
var jResp = new chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;
console.log("Response Body:");
console.log(jResp.Emit());
var respStatusCode = resp.StatusCode;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
console.log("Response Header:");
console.log(resp.Header);
console.log("Failed.");
return;
}
// 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
var attributesCreated_at;
var Disabled;
var v_Email;
var Handle;
var Icon;
var attributesModified_at;
var attributesName;
var Service_account;
var Status;
var Title;
var Verified;
var id;
var v_type;
var j;
var count_j;
var Created_at = jResp.StringOf("data.attributes.created_at");
var Key = jResp.StringOf("data.attributes.key");
var Last4 = jResp.StringOf("data.attributes.last4");
var Modified_at = jResp.StringOf("data.attributes.modified_at");
var Name = jResp.StringOf("data.attributes.name");
var Id = jResp.StringOf("data.id");
var DataId = jResp.StringOf("data.relationships.created_by.data.id");
var v_Type = jResp.StringOf("data.relationships.created_by.data.type");
DataId = jResp.StringOf("data.relationships.modified_by.data.id");
var DataType = jResp.StringOf("data.relationships.modified_by.data.type");
var dataType = jResp.StringOf("data.type");
var i = 0;
var count_i = jResp.SizeOfArray("included");
while (i < count_i) {
jResp.I = i;
attributesCreated_at = jResp.StringOf("included[i].attributes.created_at");
Disabled = jResp.StringOf("included[i].attributes.disabled");
v_Email = jResp.StringOf("included[i].attributes.email");
Handle = jResp.StringOf("included[i].attributes.handle");
Icon = jResp.StringOf("included[i].attributes.icon");
attributesModified_at = jResp.StringOf("included[i].attributes.modified_at");
attributesName = jResp.StringOf("included[i].attributes.name");
Service_account = jResp.StringOf("included[i].attributes.service_account");
Status = jResp.StringOf("included[i].attributes.status");
Title = jResp.StringOf("included[i].attributes.title");
Verified = jResp.StringOf("included[i].attributes.verified");
id = jResp.StringOf("included[i].id");
DataId = jResp.StringOf("included[i].relationships.org.data.id");
DataType = jResp.StringOf("included[i].relationships.org.data.type");
v_type = jResp.StringOf("included[i].type");
j = 0;
count_j = jResp.SizeOfArray("included[i].relationships.other_orgs.data");
while (j < count_j) {
jResp.J = j;
id = jResp.StringOf("included[i].relationships.other_orgs.data[j].id");
v_type = jResp.StringOf("included[i].relationships.other_orgs.data[j].type");
j = j+1;
}
j = 0;
count_j = jResp.SizeOfArray("included[i].relationships.other_users.data");
while (j < count_j) {
jResp.J = j;
id = jResp.StringOf("included[i].relationships.other_users.data[j].id");
v_type = jResp.StringOf("included[i].relationships.other_users.data[j].type");
j = j+1;
}
j = 0;
count_j = jResp.SizeOfArray("included[i].relationships.roles.data");
while (j < count_j) {
jResp.J = j;
id = jResp.StringOf("included[i].relationships.roles.data[j].id");
v_type = jResp.StringOf("included[i].relationships.roles.data[j].type");
j = j+1;
}
i = i+1;
}
}
chilkatExample();
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}"
}
]
}
