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_UpdateString $queryParams "current_only" "<boolean>"
CkJsonObject_UpdateString $queryParams "include" "<string>"
CkJsonObject_UpdateInt $queryParams "page[offset]" 0
CkJsonObject_UpdateInt $queryParams "page[limit]" 30
CkHttp_SetRequestHeader $http "Accept" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://api.app.ddog-gov.com/api/v2/downtime" $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": {
# "canceled": "<dateTime>",
# "created": "<dateTime>",
# "display_timezone": "UTC",
# "message": "<string>",
# "modified": "<dateTime>",
# "monitor_identifier": {
# "monitor_id": "<long>"
# },
# "mute_first_recovery_notification": "<boolean>",
# "notify_end_states": [
# "no data",
# "no data"
# ],
# "notify_end_types": [
# "canceled",
# "canceled"
# ],
# "schedule": {
# "recurrences": [
# {
# "duration": "<string>",
# "rrule": "<string>",
# "start": "<string>"
# }
# ],
# "current_downtime": {
# "end": "<dateTime>",
# "start": "<dateTime>"
# },
# "timezone": "UTC"
# },
# "scope": "<string>",
# "status": "active"
# },
# "id": "<string>",
# "relationships": {
# "created_by": {
# "data": {
# "id": "<string>",
# "type": "users"
# }
# },
# "monitor": {
# "data": {
# "id": "<string>",
# "type": "monitors"
# }
# }
# },
# "type": "downtime"
# },
# {
# "attributes": {
# "canceled": "<dateTime>",
# "created": "<dateTime>",
# "display_timezone": "UTC",
# "message": "<string>",
# "modified": "<dateTime>",
# "monitor_identifier": {
# "monitor_id": "<long>"
# },
# "mute_first_recovery_notification": "<boolean>",
# "notify_end_states": [
# "warn",
# "alert"
# ],
# "notify_end_types": [
# "canceled",
# "canceled"
# ],
# "schedule": {
# "recurrences": [
# {
# "duration": "<string>",
# "rrule": "<string>",
# "start": "<string>"
# }
# ],
# "current_downtime": {
# "end": "<dateTime>",
# "start": "<dateTime>"
# },
# "timezone": "UTC"
# },
# "scope": "<string>",
# "status": "scheduled"
# },
# "id": "<string>",
# "relationships": {
# "created_by": {
# "data": {
# "id": "<string>",
# "type": "users"
# }
# },
# "monitor": {
# "data": {
# "id": "<string>",
# "type": "monitors"
# }
# }
# },
# "type": "downtime"
# }
# ],
# "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"
# }
# ],
# "meta": {
# "page": {
# "total_filtered_count": "<long>"
# }
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set Total_filtered_count [CkJsonObject_stringOf $jResp "meta.page.total_filtered_count"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "data"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set Canceled [CkJsonObject_stringOf $jResp "data[i].attributes.canceled"]
set Created [CkJsonObject_stringOf $jResp "data[i].attributes.created"]
set Display_timezone [CkJsonObject_stringOf $jResp "data[i].attributes.display_timezone"]
set Message [CkJsonObject_stringOf $jResp "data[i].attributes.message"]
set Modified [CkJsonObject_stringOf $jResp "data[i].attributes.modified"]
set Monitor_id [CkJsonObject_stringOf $jResp "data[i].attributes.monitor_identifier.monitor_id"]
set Mute_first_recovery_notification [CkJsonObject_stringOf $jResp "data[i].attributes.mute_first_recovery_notification"]
set v_End [CkJsonObject_stringOf $jResp "data[i].attributes.schedule.current_downtime.end"]
set Start [CkJsonObject_stringOf $jResp "data[i].attributes.schedule.current_downtime.start"]
set Timezone [CkJsonObject_stringOf $jResp "data[i].attributes.schedule.timezone"]
set Scope [CkJsonObject_stringOf $jResp "data[i].attributes.scope"]
set Status [CkJsonObject_stringOf $jResp "data[i].attributes.status"]
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.monitor.data.id"]
set DataType [CkJsonObject_stringOf $jResp "data[i].relationships.monitor.data.type"]
set v_type [CkJsonObject_stringOf $jResp "data[i].type"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "data[i].attributes.notify_end_states"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set strVal [CkJsonObject_stringOf $jResp "data[i].attributes.notify_end_states[j]"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "data[i].attributes.notify_end_types"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set strVal [CkJsonObject_stringOf $jResp "data[i].attributes.notify_end_types[j]"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "data[i].attributes.schedule.recurrences"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set duration [CkJsonObject_stringOf $jResp "data[i].attributes.schedule.recurrences[j].duration"]
set rrule [CkJsonObject_stringOf $jResp "data[i].attributes.schedule.recurrences[j].rrule"]
set start [CkJsonObject_stringOf $jResp "data[i].attributes.schedule.recurrences[j].start"]
set j [expr $j + 1]
}
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 Created_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 Modified_at [CkJsonObject_stringOf $jResp "included[i].attributes.modified_at"]
set Name [CkJsonObject_stringOf $jResp "included[i].attributes.name"]
set Service_account [CkJsonObject_stringOf $jResp "included[i].attributes.service_account"]
set attributesStatus [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 "current_only=%3Cboolean%3E"
-d "include=%3Cstring%3E"
-d "page[offset]=0"
-d "page[limit]=30"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/downtime
Postman Collection Item JSON
{
"name": "Get all downtimes",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/downtime?current_only=<boolean>&include=<string>&page[offset]=0&page[limit]=30",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime"
],
"query": [
{
"key": "current_only",
"value": "<boolean>",
"description": "Only return downtimes that are active when the request is made."
},
{
"key": "include",
"value": "<string>",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npaths are `created_by` and `monitor`."
},
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page."
},
{
"key": "page[limit]",
"value": "30",
"description": "Maximum number of downtimes in the response."
}
]
},
"description": "Get all scheduled downtimes."
},
"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/downtime?current_only=<boolean>&include=<string>&page[offset]=0&page[limit]=30",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime"
],
"query": [
{
"key": "current_only",
"value": "<boolean>",
"description": "Only return downtimes that are active when the request is made."
},
{
"key": "include",
"value": "<string>",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npaths are `created_by` and `monitor`."
},
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page."
},
{
"key": "page[limit]",
"value": "30",
"description": "Maximum number of downtimes in the response."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"canceled\": \"<dateTime>\",\n \"created\": \"<dateTime>\",\n \"display_timezone\": \"UTC\",\n \"message\": \"<string>\",\n \"modified\": \"<dateTime>\",\n \"monitor_identifier\": {\n \"monitor_id\": \"<long>\"\n },\n \"mute_first_recovery_notification\": \"<boolean>\",\n \"notify_end_states\": [\n \"no data\",\n \"no data\"\n ],\n \"notify_end_types\": [\n \"canceled\",\n \"canceled\"\n ],\n \"schedule\": {\n \"recurrences\": [\n {\n \"duration\": \"<string>\",\n \"rrule\": \"<string>\",\n \"start\": \"<string>\"\n }\n ],\n \"current_downtime\": {\n \"end\": \"<dateTime>\",\n \"start\": \"<dateTime>\"\n },\n \"timezone\": \"UTC\"\n },\n \"scope\": \"<string>\",\n \"status\": \"active\"\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"created_by\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n },\n \"monitor\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"monitors\"\n }\n }\n },\n \"type\": \"downtime\"\n },\n {\n \"attributes\": {\n \"canceled\": \"<dateTime>\",\n \"created\": \"<dateTime>\",\n \"display_timezone\": \"UTC\",\n \"message\": \"<string>\",\n \"modified\": \"<dateTime>\",\n \"monitor_identifier\": {\n \"monitor_id\": \"<long>\"\n },\n \"mute_first_recovery_notification\": \"<boolean>\",\n \"notify_end_states\": [\n \"warn\",\n \"alert\"\n ],\n \"notify_end_types\": [\n \"canceled\",\n \"canceled\"\n ],\n \"schedule\": {\n \"recurrences\": [\n {\n \"duration\": \"<string>\",\n \"rrule\": \"<string>\",\n \"start\": \"<string>\"\n }\n ],\n \"current_downtime\": {\n \"end\": \"<dateTime>\",\n \"start\": \"<dateTime>\"\n },\n \"timezone\": \"UTC\"\n },\n \"scope\": \"<string>\",\n \"status\": \"scheduled\"\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"created_by\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n },\n \"monitor\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"monitors\"\n }\n }\n },\n \"type\": \"downtime\"\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 \"meta\": {\n \"page\": {\n \"total_filtered_count\": \"<long>\"\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/downtime?current_only=<boolean>&include=<string>&page[offset]=0&page[limit]=30",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime"
],
"query": [
{
"key": "current_only",
"value": "<boolean>",
"description": "Only return downtimes that are active when the request is made."
},
{
"key": "include",
"value": "<string>",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npaths are `created_by` and `monitor`."
},
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page."
},
{
"key": "page[limit]",
"value": "30",
"description": "Maximum number of downtimes in the response."
}
]
}
},
"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/downtime?current_only=<boolean>&include=<string>&page[offset]=0&page[limit]=30",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime"
],
"query": [
{
"key": "current_only",
"value": "<boolean>",
"description": "Only return downtimes that are active when the request is made."
},
{
"key": "include",
"value": "<string>",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npaths are `created_by` and `monitor`."
},
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page."
},
{
"key": "page[limit]",
"value": "30",
"description": "Maximum number of downtimes in the response."
}
]
}
},
"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}"
}
]
}
