Ruby / Datadog API Collection / Get all application keys owned by current user
Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateInt("page[size]",10)
queryParams.UpdateInt("page[number]",0)
queryParams.UpdateString("sort","name")
queryParams.UpdateString("filter","<string>")
queryParams.UpdateString("filter[created_at][start]","<string>")
queryParams.UpdateString("filter[created_at][end]","<string>")
http.SetRequestHeader("Accept","application/json")
# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/current_user/application_keys",queryParams)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# 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
count_i = jResp.SizeOfArray("data")
while i < count_i
jResp.put_I(i)
Created_at = jResp.stringOf("data[i].attributes.created_at")
Last4 = jResp.stringOf("data[i].attributes.last4")
Name = jResp.stringOf("data[i].attributes.name")
id = jResp.stringOf("data[i].id")
Id = jResp.stringOf("data[i].relationships.owned_by.data.id")
v_Type = jResp.stringOf("data[i].relationships.owned_by.data.type")
v_type = jResp.stringOf("data[i].type")
j = 0
count_j = jResp.SizeOfArray("data[i].attributes.scopes")
while j < count_j
jResp.put_J(j)
strVal = jResp.stringOf("data[i].attributes.scopes[j]")
j = j + 1
end
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("included")
while i < count_i
jResp.put_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")
Modified_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.put_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
end
j = 0
count_j = jResp.SizeOfArray("included[i].relationships.other_users.data")
while j < count_j
jResp.put_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
end
j = 0
count_j = jResp.SizeOfArray("included[i].relationships.roles.data")
while j < count_j
jResp.put_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
end
i = i + 1
end
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/current_user/application_keys
Postman Collection Item JSON
{
"name": "Get all application keys owned by current user",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/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",
"current_user",
"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."
}
]
},
"description": "List all application keys available for current user"
},
"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/current_user/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",
"current_user",
"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."
}
]
}
},
"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/current_user/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",
"current_user",
"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."
}
]
}
},
"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/current_user/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",
"current_user",
"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."
}
]
}
},
"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/current_user/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",
"current_user",
"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."
}
]
}
},
"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/current_user/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",
"current_user",
"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."
}
]
}
},
"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}"
}
]
}
