Back to Collection Items
use 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->UpdateString("current_only","<boolean>");
$queryParams->UpdateString("include","<string>");
$queryParams->UpdateInt("page[offset]",0);
$queryParams->UpdateInt("page[limit]",30);
$http->SetRequestHeader("Accept","application/json");
# resp is a HttpResponse
$resp = $http->QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/downtime",$queryParams);
if ($http->get_LastMethodSuccess() == 0) {
print $http->lastErrorText() . "\r\n";
exit;
}
$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);
$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);
print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";
$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
print "Response Header:" . "\r\n";
print $resp->header() . "\r\n";
print "Failed." . "\r\n";
exit;
}
# 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
$Total_filtered_count = $jResp->stringOf("meta.page.total_filtered_count");
$i = 0;
$count_i = $jResp->SizeOfArray("data");
while ($i < $count_i) {
$jResp->put_I($i);
$Canceled = $jResp->stringOf("data[i].attributes.canceled");
$Created = $jResp->stringOf("data[i].attributes.created");
$Display_timezone = $jResp->stringOf("data[i].attributes.display_timezone");
$Message = $jResp->stringOf("data[i].attributes.message");
$Modified = $jResp->stringOf("data[i].attributes.modified");
$Monitor_id = $jResp->stringOf("data[i].attributes.monitor_identifier.monitor_id");
$Mute_first_recovery_notification = $jResp->stringOf("data[i].attributes.mute_first_recovery_notification");
$v_End = $jResp->stringOf("data[i].attributes.schedule.current_downtime.end");
$Start = $jResp->stringOf("data[i].attributes.schedule.current_downtime.start");
$Timezone = $jResp->stringOf("data[i].attributes.schedule.timezone");
$Scope = $jResp->stringOf("data[i].attributes.scope");
$Status = $jResp->stringOf("data[i].attributes.status");
$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.monitor.data.id");
$DataType = $jResp->stringOf("data[i].relationships.monitor.data.type");
$v_type = $jResp->stringOf("data[i].type");
$j = 0;
$count_j = $jResp->SizeOfArray("data[i].attributes.notify_end_states");
while ($j < $count_j) {
$jResp->put_J($j);
$strVal = $jResp->stringOf("data[i].attributes.notify_end_states[j]");
$j = $j + 1;
}
$j = 0;
$count_j = $jResp->SizeOfArray("data[i].attributes.notify_end_types");
while ($j < $count_j) {
$jResp->put_J($j);
$strVal = $jResp->stringOf("data[i].attributes.notify_end_types[j]");
$j = $j + 1;
}
$j = 0;
$count_j = $jResp->SizeOfArray("data[i].attributes.schedule.recurrences");
while ($j < $count_j) {
$jResp->put_J($j);
$duration = $jResp->stringOf("data[i].attributes.schedule.recurrences[j].duration");
$rrule = $jResp->stringOf("data[i].attributes.schedule.recurrences[j].rrule");
$start = $jResp->stringOf("data[i].attributes.schedule.recurrences[j].start");
$j = $j + 1;
}
$i = $i + 1;
}
$i = 0;
$count_i = $jResp->SizeOfArray("included");
while ($i < $count_i) {
$jResp->put_I($i);
$Created_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");
$Name = $jResp->stringOf("included[i].attributes.name");
$Service_account = $jResp->stringOf("included[i].attributes.service_account");
$attributesStatus = $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;
}
$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;
}
$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;
}
$i = $i + 1;
}
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}"
}
]
}
