Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# 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 = Chilkat::CkJsonObject.new()
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 is a CkHttpResponse
resp = http.PostJson3("https://api.app.ddog-gov.com/api/v2/downtime","application/json",json)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# 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 < count_i
jResp.put_I(i)
strVal = jResp.stringOf("data.attributes.notify_end_states[i]")
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("data.attributes.notify_end_types")
while i < count_i
jResp.put_I(i)
strVal = jResp.stringOf("data.attributes.notify_end_types[i]")
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("data.attributes.schedule.recurrences")
while i < count_i
jResp.put_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
end
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
end
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
end
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
end
i = i + 1
end
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}"
}
]
}
