Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateString("current_only","<boolean>")
$oQueryParams.UpdateString("include","<string>")
$oQueryParams.UpdateInt("page[offset]",0)
$oQueryParams.UpdateInt("page[limit]",30)
$oHttp.SetRequestHeader "Accept","application/json"
Local $oResp = $oHttp.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/downtime",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sCanceled
Local $sCreated
Local $sDisplay_timezone
Local $sMessage
Local $sModified
Local $sMonitor_id
Local $sMute_first_recovery_notification
Local $sV_End
Local $sStart
Local $sTimezone
Local $sScope
Local $sStatus
Local $sId
Local $sId
Local $sV_Type
Local $sDataId
Local $sDataType
Local $sV_type
Local $iJ
Local $iCount_j
Local $strVal
Local $sDuration
Local $sRrule
Local $start
Local $sCreated_at
Local $sDisabled
Local $sV_Email
Local $sHandle
Local $sIcon
Local $sModified_at
Local $sName
Local $sService_account
Local $sAttributesStatus
Local $sTitle
Local $sVerified
Local $sTotal_filtered_count = $oJResp.StringOf("meta.page.total_filtered_count")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("data")
While $i < $iCount_i
$oJResp.I = $i
$sCanceled = $oJResp.StringOf("data[i].attributes.canceled")
$sCreated = $oJResp.StringOf("data[i].attributes.created")
$sDisplay_timezone = $oJResp.StringOf("data[i].attributes.display_timezone")
$sMessage = $oJResp.StringOf("data[i].attributes.message")
$sModified = $oJResp.StringOf("data[i].attributes.modified")
$sMonitor_id = $oJResp.StringOf("data[i].attributes.monitor_identifier.monitor_id")
$sMute_first_recovery_notification = $oJResp.StringOf("data[i].attributes.mute_first_recovery_notification")
$sV_End = $oJResp.StringOf("data[i].attributes.schedule.current_downtime.end")
$sStart = $oJResp.StringOf("data[i].attributes.schedule.current_downtime.start")
$sTimezone = $oJResp.StringOf("data[i].attributes.schedule.timezone")
$sScope = $oJResp.StringOf("data[i].attributes.scope")
$sStatus = $oJResp.StringOf("data[i].attributes.status")
$sId = $oJResp.StringOf("data[i].id")
$sId = $oJResp.StringOf("data[i].relationships.created_by.data.id")
$sV_Type = $oJResp.StringOf("data[i].relationships.created_by.data.type")
$sDataId = $oJResp.StringOf("data[i].relationships.monitor.data.id")
$sDataType = $oJResp.StringOf("data[i].relationships.monitor.data.type")
$sV_type = $oJResp.StringOf("data[i].type")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("data[i].attributes.notify_end_states")
While $iJ < $iCount_j
$oJResp.J = $iJ
$strVal = $oJResp.StringOf("data[i].attributes.notify_end_states[j]")
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("data[i].attributes.notify_end_types")
While $iJ < $iCount_j
$oJResp.J = $iJ
$strVal = $oJResp.StringOf("data[i].attributes.notify_end_types[j]")
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("data[i].attributes.schedule.recurrences")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sDuration = $oJResp.StringOf("data[i].attributes.schedule.recurrences[j].duration")
$sRrule = $oJResp.StringOf("data[i].attributes.schedule.recurrences[j].rrule")
$start = $oJResp.StringOf("data[i].attributes.schedule.recurrences[j].start")
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("included")
While $i < $iCount_i
$oJResp.I = $i
$sCreated_at = $oJResp.StringOf("included[i].attributes.created_at")
$sDisabled = $oJResp.StringOf("included[i].attributes.disabled")
$sV_Email = $oJResp.StringOf("included[i].attributes.email")
$sHandle = $oJResp.StringOf("included[i].attributes.handle")
$sIcon = $oJResp.StringOf("included[i].attributes.icon")
$sModified_at = $oJResp.StringOf("included[i].attributes.modified_at")
$sName = $oJResp.StringOf("included[i].attributes.name")
$sService_account = $oJResp.StringOf("included[i].attributes.service_account")
$sAttributesStatus = $oJResp.StringOf("included[i].attributes.status")
$sTitle = $oJResp.StringOf("included[i].attributes.title")
$sVerified = $oJResp.StringOf("included[i].attributes.verified")
$sId = $oJResp.StringOf("included[i].id")
$sDataId = $oJResp.StringOf("included[i].relationships.org.data.id")
$sDataType = $oJResp.StringOf("included[i].relationships.org.data.type")
$sV_type = $oJResp.StringOf("included[i].type")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("included[i].relationships.other_orgs.data")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sId = $oJResp.StringOf("included[i].relationships.other_orgs.data[j].id")
$sV_type = $oJResp.StringOf("included[i].relationships.other_orgs.data[j].type")
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("included[i].relationships.other_users.data")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sId = $oJResp.StringOf("included[i].relationships.other_users.data[j].id")
$sV_type = $oJResp.StringOf("included[i].relationships.other_users.data[j].type")
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("included[i].relationships.roles.data")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sId = $oJResp.StringOf("included[i].relationships.roles.data[j].id")
$sV_type = $oJResp.StringOf("included[i].relationships.roles.data[j].type")
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
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}"
}
]
}
