lianja / Datadog API Collection / List application keys for this service account
Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loQueryParams = createobject("CkJsonObject")
loQueryParams.UpdateInt("page[size]",10)
loQueryParams.UpdateInt("page[number]",0)
loQueryParams.UpdateString("sort","name")
loQueryParams.UpdateString("filter","<string>")
loQueryParams.UpdateString("filter[created_at][start]","<string>")
loQueryParams.UpdateString("filter[created_at][end]","<string>")
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/service_accounts/:service_account_id/application_keys",loQueryParams)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loQueryParams
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loQueryParams
release loSbResponseBody
release loJResp
return
endif
release loResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": [
// {
// "attributes": {
// "created_at": "<string>",
// "last4": "<string>",
// "name": "<string>",
// "scopes": [
// "<string>",
// "<string>"
// ]
// },
// "id": "<string>",
// "relationships": {
// "owned_by": {
// "data": {
// "id": "<string>",
// "type": "users"
// }
// }
// },
// "type": "application_keys"
// },
// {
// "attributes": {
// "created_at": "<string>",
// "last4": "<string>",
// "name": "<string>",
// "scopes": [
// "<string>",
// "<string>"
// ]
// },
// "id": "<string>",
// "relationships": {
// "owned_by": {
// "data": {
// "id": "<string>",
// "type": "users"
// }
// }
// },
// "type": "application_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
i = 0
lnCount_i = loJResp.SizeOfArray("data")
do while i < lnCount_i
loJResp.I = i
lcCreated_at = loJResp.StringOf("data[i].attributes.created_at")
lcLast4 = loJResp.StringOf("data[i].attributes.last4")
lcName = loJResp.StringOf("data[i].attributes.name")
lcId = loJResp.StringOf("data[i].id")
lcId = loJResp.StringOf("data[i].relationships.owned_by.data.id")
lcV_Type = loJResp.StringOf("data[i].relationships.owned_by.data.type")
lcV_type = loJResp.StringOf("data[i].type")
j = 0
lnCount_j = loJResp.SizeOfArray("data[i].attributes.scopes")
do while j < lnCount_j
loJResp.J = j
lcStrVal = loJResp.StringOf("data[i].attributes.scopes[j]")
j = j + 1
enddo
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("included")
do while i < lnCount_i
loJResp.I = i
lcAttributesCreated_at = loJResp.StringOf("included[i].attributes.created_at")
lcDisabled = loJResp.StringOf("included[i].attributes.disabled")
lcV_Email = loJResp.StringOf("included[i].attributes.email")
lcHandle = loJResp.StringOf("included[i].attributes.handle")
lcIcon = loJResp.StringOf("included[i].attributes.icon")
lcModified_at = loJResp.StringOf("included[i].attributes.modified_at")
lcAttributesName = loJResp.StringOf("included[i].attributes.name")
lcService_account = loJResp.StringOf("included[i].attributes.service_account")
lcStatus = loJResp.StringOf("included[i].attributes.status")
lcTitle = loJResp.StringOf("included[i].attributes.title")
lcVerified = loJResp.StringOf("included[i].attributes.verified")
lcId = loJResp.StringOf("included[i].id")
lcDataId = loJResp.StringOf("included[i].relationships.org.data.id")
lcDataType = loJResp.StringOf("included[i].relationships.org.data.type")
lcV_type = loJResp.StringOf("included[i].type")
j = 0
lnCount_j = loJResp.SizeOfArray("included[i].relationships.other_orgs.data")
do while j < lnCount_j
loJResp.J = j
lcId = loJResp.StringOf("included[i].relationships.other_orgs.data[j].id")
lcV_type = loJResp.StringOf("included[i].relationships.other_orgs.data[j].type")
j = j + 1
enddo
j = 0
lnCount_j = loJResp.SizeOfArray("included[i].relationships.other_users.data")
do while j < lnCount_j
loJResp.J = j
lcId = loJResp.StringOf("included[i].relationships.other_users.data[j].id")
lcV_type = loJResp.StringOf("included[i].relationships.other_users.data[j].type")
j = j + 1
enddo
j = 0
lnCount_j = loJResp.SizeOfArray("included[i].relationships.roles.data")
do while j < lnCount_j
loJResp.J = j
lcId = loJResp.StringOf("included[i].relationships.roles.data[j].id")
lcV_type = loJResp.StringOf("included[i].relationships.roles.data[j].type")
j = j + 1
enddo
i = i + 1
enddo
release loHttp
release loQueryParams
release loSbResponseBody
release loJResp
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"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/service_accounts/:service_account_id/application_keys
Postman Collection Item JSON
{
"name": "List application keys for this service account",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys?page[size]=10&page[number]=0&sort=name&filter=<string>&filter[created_at][start]=<string>&filter[created_at][end]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_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": "Application 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 application keys by the specified string."
},
{
"key": "filter[created_at][start]",
"value": "<string>",
"description": "Only include application keys created on or after the specified date."
},
{
"key": "filter[created_at][end]",
"value": "<string>",
"description": "Only include application keys created on or before the specified date."
}
],
"variable": [
{
"key": "service_account_id",
"value": "<string>"
}
]
},
"description": "List all application keys available for this service 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/service_accounts/:service_account_id/application_keys?page[size]=10&page[number]=0&sort=name&filter=<string>&filter[created_at][start]=<string>&filter[created_at][end]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_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": "Application 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 application keys by the specified string."
},
{
"key": "filter[created_at][start]",
"value": "<string>",
"description": "Only include application keys created on or after the specified date."
},
{
"key": "filter[created_at][end]",
"value": "<string>",
"description": "Only include application keys created on or before the specified date."
}
],
"variable": [
{
"key": "service_account_id"
}
]
}
},
"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 \"name\": \"<string>\",\n \"scopes\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"owned_by\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"application_keys\"\n },\n {\n \"attributes\": {\n \"created_at\": \"<string>\",\n \"last4\": \"<string>\",\n \"name\": \"<string>\",\n \"scopes\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"owned_by\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"application_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/service_accounts/:service_account_id/application_keys?page[size]=10&page[number]=0&sort=name&filter=<string>&filter[created_at][start]=<string>&filter[created_at][end]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_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": "Application 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 application keys by the specified string."
},
{
"key": "filter[created_at][start]",
"value": "<string>",
"description": "Only include application keys created on or after the specified date."
},
{
"key": "filter[created_at][end]",
"value": "<string>",
"description": "Only include application keys created on or before the specified date."
}
],
"variable": [
{
"key": "service_account_id"
}
]
}
},
"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/service_accounts/:service_account_id/application_keys?page[size]=10&page[number]=0&sort=name&filter=<string>&filter[created_at][start]=<string>&filter[created_at][end]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_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": "Application 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 application keys by the specified string."
},
{
"key": "filter[created_at][start]",
"value": "<string>",
"description": "Only include application keys created on or after the specified date."
},
{
"key": "filter[created_at][end]",
"value": "<string>",
"description": "Only include application keys created on or before the specified date."
}
],
"variable": [
{
"key": "service_account_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/service_accounts/:service_account_id/application_keys?page[size]=10&page[number]=0&sort=name&filter=<string>&filter[created_at][start]=<string>&filter[created_at][end]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_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": "Application 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 application keys by the specified string."
},
{
"key": "filter[created_at][start]",
"value": "<string>",
"description": "Only include application keys created on or after the specified date."
},
{
"key": "filter[created_at][end]",
"value": "<string>",
"description": "Only include application keys created on or before the specified date."
}
],
"variable": [
{
"key": "service_account_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/service_accounts/:service_account_id/application_keys?page[size]=10&page[number]=0&sort=name&filter=<string>&filter[created_at][start]=<string>&filter[created_at][end]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"service_accounts",
":service_account_id",
"application_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": "Application 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 application keys by the specified string."
},
{
"key": "filter[created_at][start]",
"value": "<string>",
"description": "Only include application keys created on or after the specified date."
},
{
"key": "filter[created_at][end]",
"value": "<string>",
"description": "Only include application keys created on or before the specified date."
}
],
"variable": [
{
"key": "service_account_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}"
}
]
}
