Back to Collection Items
Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = New-Object Chilkat.Http
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "data": {
# "type": "downtime",
# "attributes": {
# "scope": "<string>",
# "monitor_identifier": {
# "monitor_id": "<long>"
# },
# "display_timezone": "UTC",
# "message": "<string>",
# "mute_first_recovery_notification": "<boolean>",
# "notify_end_states": [
# "warn",
# "warn"
# ],
# "notify_end_types": [
# "expired",
# "expired"
# ],
# "schedule": {
# "recurrences": [
# {
# "duration": "<string>",
# "rrule": "<string>",
# "start": "<string>"
# },
# {
# "duration": "<string>",
# "rrule": "<string>",
# "start": "<string>"
# }
# ],
# "timezone": "UTC"
# }
# }
# }
# }
$json = New-Object Chilkat.JsonObject
$json.UpdateString("data.type","downtime")
$json.UpdateString("data.attributes.scope","<string>")
$json.UpdateString("data.attributes.monitor_identifier.monitor_id","<long>")
$json.UpdateString("data.attributes.display_timezone","UTC")
$json.UpdateString("data.attributes.message","<string>")
$json.UpdateString("data.attributes.mute_first_recovery_notification","<boolean>")
$json.UpdateString("data.attributes.notify_end_states[0]","warn")
$json.UpdateString("data.attributes.notify_end_states[1]","warn")
$json.UpdateString("data.attributes.notify_end_types[0]","expired")
$json.UpdateString("data.attributes.notify_end_types[1]","expired")
$json.UpdateString("data.attributes.schedule.recurrences[0].duration","<string>")
$json.UpdateString("data.attributes.schedule.recurrences[0].rrule","<string>")
$json.UpdateString("data.attributes.schedule.recurrences[0].start","<string>")
$json.UpdateString("data.attributes.schedule.recurrences[1].duration","<string>")
$json.UpdateString("data.attributes.schedule.recurrences[1].rrule","<string>")
$json.UpdateString("data.attributes.schedule.recurrences[1].start","<string>")
$json.UpdateString("data.attributes.schedule.timezone","UTC")
$http.SetRequestHeader("Content-Type","application/json")
$http.SetRequestHeader("Accept","application/json")
$resp = $http.PostJson3("https://api.app.ddog-gov.com/api/v2/downtime","application/json",$json)
if ($http.LastMethodSuccess -eq $false) {
$($http.LastErrorText)
exit
}
$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false
$("Response Body:")
$($jResp.Emit())
$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
$("Response Header:")
$($resp.Header)
$("Failed.")
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": [
# "alert",
# "alert"
# ],
# "notify_end_types": [
# "canceled",
# "expired"
# ],
# "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"
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$Canceled = $jResp.StringOf("data.attributes.canceled")
$Created = $jResp.StringOf("data.attributes.created")
$Display_timezone = $jResp.StringOf("data.attributes.display_timezone")
$Message = $jResp.StringOf("data.attributes.message")
$Modified = $jResp.StringOf("data.attributes.modified")
$Monitor_id = $jResp.StringOf("data.attributes.monitor_identifier.monitor_id")
$Mute_first_recovery_notification = $jResp.StringOf("data.attributes.mute_first_recovery_notification")
$v_End = $jResp.StringOf("data.attributes.schedule.current_downtime.end")
$Start = $jResp.StringOf("data.attributes.schedule.current_downtime.start")
$Timezone = $jResp.StringOf("data.attributes.schedule.timezone")
$Scope = $jResp.StringOf("data.attributes.scope")
$Status = $jResp.StringOf("data.attributes.status")
$Id = $jResp.StringOf("data.id")
$DataId = $jResp.StringOf("data.relationships.created_by.data.id")
$v_Type = $jResp.StringOf("data.relationships.created_by.data.type")
$DataId = $jResp.StringOf("data.relationships.monitor.data.id")
$DataType = $jResp.StringOf("data.relationships.monitor.data.type")
$dataType = $jResp.StringOf("data.type")
$i = 0
$count_i = $jResp.SizeOfArray("data.attributes.notify_end_states")
while ($i -lt $count_i) {
$jResp.I = $i
$strVal = $jResp.StringOf("data.attributes.notify_end_states[i]")
$i = $i + 1
}
$i = 0
$count_i = $jResp.SizeOfArray("data.attributes.notify_end_types")
while ($i -lt $count_i) {
$jResp.I = $i
$strVal = $jResp.StringOf("data.attributes.notify_end_types[i]")
$i = $i + 1
}
$i = 0
$count_i = $jResp.SizeOfArray("data.attributes.schedule.recurrences")
while ($i -lt $count_i) {
$jResp.I = $i
$duration = $jResp.StringOf("data.attributes.schedule.recurrences[i].duration")
$rrule = $jResp.StringOf("data.attributes.schedule.recurrences[i].rrule")
$start = $jResp.StringOf("data.attributes.schedule.recurrences[i].start")
$i = $i + 1
}
$i = 0
$count_i = $jResp.SizeOfArray("included")
while ($i -lt $count_i) {
$jResp.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 -lt $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")
while ($j -lt $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")
while ($j -lt $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 -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"type": "downtime",
"attributes": {
"scope": "<string>",
"monitor_identifier": {
"monitor_id": "<long>"
},
"display_timezone": "UTC",
"message": "<string>",
"mute_first_recovery_notification": "<boolean>",
"notify_end_states": [
"warn",
"warn"
],
"notify_end_types": [
"expired",
"expired"
],
"schedule": {
"recurrences": [
{
"duration": "<string>",
"rrule": "<string>",
"start": "<string>"
},
{
"duration": "<string>",
"rrule": "<string>",
"start": "<string>"
}
],
"timezone": "UTC"
}
}
}
}'
https://api.app.ddog-gov.com/api/v2/downtime
Postman Collection Item JSON
{
"name": "Schedule a downtime",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"downtime\",\n \"attributes\": {\n \"scope\": \"<string>\",\n \"monitor_identifier\": {\n \"monitor_id\": \"<long>\"\n },\n \"display_timezone\": \"UTC\",\n \"message\": \"<string>\",\n \"mute_first_recovery_notification\": \"<boolean>\",\n \"notify_end_states\": [\n \"warn\",\n \"warn\"\n ],\n \"notify_end_types\": [\n \"expired\",\n \"expired\"\n ],\n \"schedule\": {\n \"recurrences\": [\n {\n \"duration\": \"<string>\",\n \"rrule\": \"<string>\",\n \"start\": \"<string>\"\n },\n {\n \"duration\": \"<string>\",\n \"rrule\": \"<string>\",\n \"start\": \"<string>\"\n }\n ],\n \"timezone\": \"UTC\"\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/downtime",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime"
]
},
"description": "Schedule a downtime."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"downtime\",\n \"attributes\": {\n \"scope\": \"<string>\",\n \"monitor_identifier\": {\n \"monitor_id\": \"<long>\"\n },\n \"display_timezone\": \"UTC\",\n \"message\": \"<string>\",\n \"mute_first_recovery_notification\": \"<boolean>\",\n \"notify_end_states\": [\n \"warn\",\n \"warn\"\n ],\n \"notify_end_types\": [\n \"expired\",\n \"expired\"\n ],\n \"schedule\": {\n \"recurrences\": [\n {\n \"duration\": \"<string>\",\n \"rrule\": \"<string>\",\n \"start\": \"<string>\"\n },\n {\n \"duration\": \"<string>\",\n \"rrule\": \"<string>\",\n \"start\": \"<string>\"\n }\n ],\n \"timezone\": \"UTC\"\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/downtime",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\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 \"alert\",\n \"alert\"\n ],\n \"notify_end_types\": [\n \"canceled\",\n \"expired\"\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 \"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": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"downtime\",\n \"attributes\": {\n \"scope\": \"<string>\",\n \"monitor_identifier\": {\n \"monitor_id\": \"<long>\"\n },\n \"display_timezone\": \"UTC\",\n \"message\": \"<string>\",\n \"mute_first_recovery_notification\": \"<boolean>\",\n \"notify_end_states\": [\n \"warn\",\n \"warn\"\n ],\n \"notify_end_types\": [\n \"expired\",\n \"expired\"\n ],\n \"schedule\": {\n \"recurrences\": [\n {\n \"duration\": \"<string>\",\n \"rrule\": \"<string>\",\n \"start\": \"<string>\"\n },\n {\n \"duration\": \"<string>\",\n \"rrule\": \"<string>\",\n \"start\": \"<string>\"\n }\n ],\n \"timezone\": \"UTC\"\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/downtime",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime"
]
}
},
"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": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"downtime\",\n \"attributes\": {\n \"scope\": \"<string>\",\n \"monitor_identifier\": {\n \"monitor_id\": \"<long>\"\n },\n \"display_timezone\": \"UTC\",\n \"message\": \"<string>\",\n \"mute_first_recovery_notification\": \"<boolean>\",\n \"notify_end_states\": [\n \"warn\",\n \"warn\"\n ],\n \"notify_end_types\": [\n \"expired\",\n \"expired\"\n ],\n \"schedule\": {\n \"recurrences\": [\n {\n \"duration\": \"<string>\",\n \"rrule\": \"<string>\",\n \"start\": \"<string>\"\n },\n {\n \"duration\": \"<string>\",\n \"rrule\": \"<string>\",\n \"start\": \"<string>\"\n }\n ],\n \"timezone\": \"UTC\"\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/downtime",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime"
]
}
},
"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": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"downtime\",\n \"attributes\": {\n \"scope\": \"<string>\",\n \"monitor_identifier\": {\n \"monitor_id\": \"<long>\"\n },\n \"display_timezone\": \"UTC\",\n \"message\": \"<string>\",\n \"mute_first_recovery_notification\": \"<boolean>\",\n \"notify_end_states\": [\n \"warn\",\n \"warn\"\n ],\n \"notify_end_types\": [\n \"expired\",\n \"expired\"\n ],\n \"schedule\": {\n \"recurrences\": [\n {\n \"duration\": \"<string>\",\n \"rrule\": \"<string>\",\n \"start\": \"<string>\"\n },\n {\n \"duration\": \"<string>\",\n \"rrule\": \"<string>\",\n \"start\": \"<string>\"\n }\n ],\n \"timezone\": \"UTC\"\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/downtime",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime"
]
}
},
"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}"
}
]
}
