Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()
var success: Bool
let queryParams = CkoJsonObject()
queryParams.UpdateInt("page[size]", value: 10)
queryParams.UpdateInt("page[number]", value: 0)
queryParams.UpdateString("sort", value: "name")
queryParams.UpdateString("filter", value: "<string>")
queryParams.UpdateString("filter[created_at][start]", value: "<string>")
queryParams.UpdateString("filter[created_at][end]", value: "<string>")
queryParams.UpdateString("filter[modified_at][start]", value: "<string>")
queryParams.UpdateString("filter[modified_at][end]", value: "<string>")
queryParams.UpdateString("include", value: "<string>")
http.SetRequestHeader("Accept", value: "application/json")
var resp: CkoHttpResponse? = http.QuickRequestParams("GET", url: "https://api.app.ddog-gov.com/api/v2/api_keys", json: queryParams)
if http.LastMethodSuccess == false {
print("\(http.LastErrorText)")
return
}
let sbResponseBody = CkoStringBuilder()
resp!.GetBodySb(sbResponseBody)
let jResp = CkoJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = false
print("Response Body:")
print("\(jResp.Emit())")
var respStatusCode: Int = resp!.StatusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.Header)")
print("Failed.")
resp = nil
return
}
resp = nil
// 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
var Created_at: String?
var Last4: String?
var Modified_at: String?
var Name: String?
var id: String?
var Id: String?
var v_Type: String?
var DataId: String?
var DataType: String?
var v_type: String?
var attributesCreated_at: String?
var Disabled: String?
var v_Email: String?
var Handle: String?
var Icon: String?
var attributesModified_at: String?
var attributesName: String?
var Service_account: String?
var Status: String?
var Title: String?
var Verified: String?
var j: Int
var count_j: Int
var i: Int = 0
var count_i: Int = jResp.SizeOfArray("data").intValue
while i < count_i {
jResp.I = i
Created_at = jResp.StringOf("data[i].attributes.created_at")
Last4 = jResp.StringOf("data[i].attributes.last4")
Modified_at = jResp.StringOf("data[i].attributes.modified_at")
Name = jResp.StringOf("data[i].attributes.name")
id = jResp.StringOf("data[i].id")
Id = jResp.StringOf("data[i].relationships.created_by.data.id")
v_Type = jResp.StringOf("data[i].relationships.created_by.data.type")
DataId = jResp.StringOf("data[i].relationships.modified_by.data.id")
DataType = jResp.StringOf("data[i].relationships.modified_by.data.type")
v_type = jResp.StringOf("data[i].type")
i = i + 1
}
i = 0
count_i = jResp.SizeOfArray("included").intValue
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").intValue
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").intValue
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").intValue
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
}
}
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}"
}
]
}
