Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
set queryParams [new_CkJsonObject]
CkJsonObject_UpdateInt $queryParams "page[size]" 10
CkJsonObject_UpdateInt $queryParams "page[number]" 0
CkJsonObject_UpdateString $queryParams "sort" "name"
CkJsonObject_UpdateString $queryParams "filter" "<string>"
CkJsonObject_UpdateString $queryParams "filter[created_at][start]" "<string>"
CkJsonObject_UpdateString $queryParams "filter[created_at][end]" "<string>"
CkJsonObject_UpdateString $queryParams "filter[modified_at][start]" "<string>"
CkJsonObject_UpdateString $queryParams "filter[modified_at][end]" "<string>"
CkJsonObject_UpdateString $queryParams "include" "<string>"
CkHttp_SetRequestHeader $http "Accept" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://api.app.ddog-gov.com/api/v2/api_keys" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $queryParams
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "data": [
# {
# "attributes": {
# "created_at": "<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"
# },
# {
# "attributes": {
# "created_at": "<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
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "data"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set Created_at [CkJsonObject_stringOf $jResp "data[i].attributes.created_at"]
set Last4 [CkJsonObject_stringOf $jResp "data[i].attributes.last4"]
set Modified_at [CkJsonObject_stringOf $jResp "data[i].attributes.modified_at"]
set Name [CkJsonObject_stringOf $jResp "data[i].attributes.name"]
set id [CkJsonObject_stringOf $jResp "data[i].id"]
set Id [CkJsonObject_stringOf $jResp "data[i].relationships.created_by.data.id"]
set v_Type [CkJsonObject_stringOf $jResp "data[i].relationships.created_by.data.type"]
set DataId [CkJsonObject_stringOf $jResp "data[i].relationships.modified_by.data.id"]
set DataType [CkJsonObject_stringOf $jResp "data[i].relationships.modified_by.data.type"]
set v_type [CkJsonObject_stringOf $jResp "data[i].type"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "included"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set attributesCreated_at [CkJsonObject_stringOf $jResp "included[i].attributes.created_at"]
set Disabled [CkJsonObject_stringOf $jResp "included[i].attributes.disabled"]
set v_Email [CkJsonObject_stringOf $jResp "included[i].attributes.email"]
set Handle [CkJsonObject_stringOf $jResp "included[i].attributes.handle"]
set Icon [CkJsonObject_stringOf $jResp "included[i].attributes.icon"]
set attributesModified_at [CkJsonObject_stringOf $jResp "included[i].attributes.modified_at"]
set attributesName [CkJsonObject_stringOf $jResp "included[i].attributes.name"]
set Service_account [CkJsonObject_stringOf $jResp "included[i].attributes.service_account"]
set Status [CkJsonObject_stringOf $jResp "included[i].attributes.status"]
set Title [CkJsonObject_stringOf $jResp "included[i].attributes.title"]
set Verified [CkJsonObject_stringOf $jResp "included[i].attributes.verified"]
set id [CkJsonObject_stringOf $jResp "included[i].id"]
set DataId [CkJsonObject_stringOf $jResp "included[i].relationships.org.data.id"]
set DataType [CkJsonObject_stringOf $jResp "included[i].relationships.org.data.type"]
set v_type [CkJsonObject_stringOf $jResp "included[i].type"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "included[i].relationships.other_orgs.data"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set id [CkJsonObject_stringOf $jResp "included[i].relationships.other_orgs.data[j].id"]
set v_type [CkJsonObject_stringOf $jResp "included[i].relationships.other_orgs.data[j].type"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "included[i].relationships.other_users.data"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set id [CkJsonObject_stringOf $jResp "included[i].relationships.other_users.data[j].id"]
set v_type [CkJsonObject_stringOf $jResp "included[i].relationships.other_users.data[j].type"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "included[i].relationships.roles.data"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set id [CkJsonObject_stringOf $jResp "included[i].relationships.roles.data[j].id"]
set v_type [CkJsonObject_stringOf $jResp "included[i].relationships.roles.data[j].type"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -G -d "page[size]=10"
-d "page[number]=0"
-d "sort=name"
-d "filter=%3Cstring%3E"
-d "filter[created_at][start]=%3Cstring%3E"
-d "filter[created_at][end]=%3Cstring%3E"
-d "filter[modified_at][start]=%3Cstring%3E"
-d "filter[modified_at][end]=%3Cstring%3E"
-d "include=%3Cstring%3E"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/api_keys
Postman Collection Item JSON
{
"name": "Get all API keys",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/api_keys?page[size]=10&page[number]=0&sort=name&filter=<string>&filter[created_at][start]=<string>&filter[created_at][end]=<string>&filter[modified_at][start]=<string>&filter[modified_at][end]=<string>&include=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort",
"value": "name",
"description": "API key attribute used to sort results. Sort order is ascending\nby default. In order to specify a descending sort, prefix the\nattribute with a minus sign."
},
{
"key": "filter",
"value": "<string>",
"description": "Filter API keys by the specified string."
},
{
"key": "filter[created_at][start]",
"value": "<string>",
"description": "Only include API keys created on or after the specified date."
},
{
"key": "filter[created_at][end]",
"value": "<string>",
"description": "Only include API keys created on or before the specified date."
},
{
"key": "filter[modified_at][start]",
"value": "<string>",
"description": "Only include API keys modified on or after the specified date."
},
{
"key": "filter[modified_at][end]",
"value": "<string>",
"description": "Only include API keys modified on or before the specified date."
},
{
"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`."
}
]
},
"description": "List all API keys available for your account."
},
"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?page[size]=10&page[number]=0&sort=name&filter=<string>&filter[created_at][start]=<string>&filter[created_at][end]=<string>&filter[modified_at][start]=<string>&filter[modified_at][end]=<string>&include=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort",
"value": "name",
"description": "API key attribute used to sort results. Sort order is ascending\nby default. In order to specify a descending sort, prefix the\nattribute with a minus sign."
},
{
"key": "filter",
"value": "<string>",
"description": "Filter API keys by the specified string."
},
{
"key": "filter[created_at][start]",
"value": "<string>",
"description": "Only include API keys created on or after the specified date."
},
{
"key": "filter[created_at][end]",
"value": "<string>",
"description": "Only include API keys created on or before the specified date."
},
{
"key": "filter[modified_at][start]",
"value": "<string>",
"description": "Only include API keys modified on or after the specified date."
},
{
"key": "filter[modified_at][end]",
"value": "<string>",
"description": "Only include API keys modified on or before the specified date."
},
{
"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`."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"created_at\": \"<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 {\n \"attributes\": {\n \"created_at\": \"<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 ],\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": "Bad Request",
"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?page[size]=10&page[number]=0&sort=name&filter=<string>&filter[created_at][start]=<string>&filter[created_at][end]=<string>&filter[modified_at][start]=<string>&filter[modified_at][end]=<string>&include=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort",
"value": "name",
"description": "API key attribute used to sort results. Sort order is ascending\nby default. In order to specify a descending sort, prefix the\nattribute with a minus sign."
},
{
"key": "filter",
"value": "<string>",
"description": "Filter API keys by the specified string."
},
{
"key": "filter[created_at][start]",
"value": "<string>",
"description": "Only include API keys created on or after the specified date."
},
{
"key": "filter[created_at][end]",
"value": "<string>",
"description": "Only include API keys created on or before the specified date."
},
{
"key": "filter[modified_at][start]",
"value": "<string>",
"description": "Only include API keys modified on or after the specified date."
},
{
"key": "filter[modified_at][end]",
"value": "<string>",
"description": "Only include API keys modified on or before the specified date."
},
{
"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`."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\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?page[size]=10&page[number]=0&sort=name&filter=<string>&filter[created_at][start]=<string>&filter[created_at][end]=<string>&filter[modified_at][start]=<string>&filter[modified_at][end]=<string>&include=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort",
"value": "name",
"description": "API key attribute used to sort results. Sort order is ascending\nby default. In order to specify a descending sort, prefix the\nattribute with a minus sign."
},
{
"key": "filter",
"value": "<string>",
"description": "Filter API keys by the specified string."
},
{
"key": "filter[created_at][start]",
"value": "<string>",
"description": "Only include API keys created on or after the specified date."
},
{
"key": "filter[created_at][end]",
"value": "<string>",
"description": "Only include API keys created on or before the specified date."
},
{
"key": "filter[modified_at][start]",
"value": "<string>",
"description": "Only include API keys modified on or after the specified date."
},
{
"key": "filter[modified_at][end]",
"value": "<string>",
"description": "Only include API keys modified on or before the specified date."
},
{
"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`."
}
]
}
},
"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": "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?page[size]=10&page[number]=0&sort=name&filter=<string>&filter[created_at][start]=<string>&filter[created_at][end]=<string>&filter[modified_at][start]=<string>&filter[modified_at][end]=<string>&include=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"api_keys"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort",
"value": "name",
"description": "API key attribute used to sort results. Sort order is ascending\nby default. In order to specify a descending sort, prefix the\nattribute with a minus sign."
},
{
"key": "filter",
"value": "<string>",
"description": "Filter API keys by the specified string."
},
{
"key": "filter[created_at][start]",
"value": "<string>",
"description": "Only include API keys created on or after the specified date."
},
{
"key": "filter[created_at][end]",
"value": "<string>",
"description": "Only include API keys created on or before the specified date."
},
{
"key": "filter[modified_at][start]",
"value": "<string>",
"description": "Only include API keys modified on or after the specified date."
},
{
"key": "filter[modified_at][end]",
"value": "<string>",
"description": "Only include API keys modified on or before the specified date."
},
{
"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`."
}
]
}
},
"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}"
}
]
}
