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]
CkHttp_SetRequestHeader $http "Accept" "application/json"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://api.app.ddog-gov.com/api/v1/synthetics/tests/api/:public_id" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "name": "Example test name",
# "config": {
# "assertions": [
# {
# "operator": "lessThan",
# "target": 1000,
# "type": "responseTime"
# }
# ],
# "request": {
# "method": "GET",
# "url": "https://example.com"
# }
# },
# "locations": [
# "aws:eu-west-3"
# ],
# "options": {
# "accept_self_signed": true,
# "allow_insecure": true,
# "checkCertificateRevocation": true,
# "ci": {
# "executionRule": "non_blocking"
# },
# "device_ids": [
# "laptop_large",
# "laptop_large"
# ],
# "disableCors": false,
# "disableCsp": false,
# "follow_redirects": true,
# "httpVersion": "http1",
# "ignoreServerCertificateError": false,
# "initialNavigationTimeout": 87780679,
# "min_failure_duration": -32472759,
# "min_location_failed": -5806955,
# "monitor_name": "et deserunt ",
# "monitor_options": {
# "renotify_interval": 834
# },
# "monitor_priority": 3,
# "noScreenshot": false,
# "restricted_roles": [
# "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
# ],
# "retry": {
# "count": -50657150,
# "interval": -91565669.0691471
# },
# "rumSettings": {
# "applicationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
# "clientTokenId": 12345,
# "isEnabled": true
# },
# "scheduling": {
# "timeframes": [
# {
# "day": 1,
# "from": "07:00",
# "to": "16:00"
# },
# {
# "day": 3,
# "from": "07:00",
# "to": "16:00"
# }
# ],
# "timezone": "America/New_York"
# },
# "tick_every": 384020
# },
# "type": "api",
# "message": "Notification message",
# "monitor_id": 12345678,
# "public_id": "123-abc-456",
# "status": "live",
# "subtype": "http",
# "tags": [
# "env:production"
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set name [CkJsonObject_stringOf $jResp "name"]
set Method [CkJsonObject_stringOf $jResp "config.request.method"]
set v_Url [CkJsonObject_stringOf $jResp "config.request.url"]
set Accept_self_signed [CkJsonObject_BoolOf $jResp "options.accept_self_signed"]
set Allow_insecure [CkJsonObject_BoolOf $jResp "options.allow_insecure"]
set CheckCertificateRevocation [CkJsonObject_BoolOf $jResp "options.checkCertificateRevocation"]
set ExecutionRule [CkJsonObject_stringOf $jResp "options.ci.executionRule"]
set DisableCors [CkJsonObject_BoolOf $jResp "options.disableCors"]
set DisableCsp [CkJsonObject_BoolOf $jResp "options.disableCsp"]
set Follow_redirects [CkJsonObject_BoolOf $jResp "options.follow_redirects"]
set HttpVersion [CkJsonObject_stringOf $jResp "options.httpVersion"]
set IgnoreServerCertificateError [CkJsonObject_BoolOf $jResp "options.ignoreServerCertificateError"]
set InitialNavigationTimeout [CkJsonObject_IntOf $jResp "options.initialNavigationTimeout"]
set Min_failure_duration [CkJsonObject_IntOf $jResp "options.min_failure_duration"]
set Min_location_failed [CkJsonObject_IntOf $jResp "options.min_location_failed"]
set Monitor_name [CkJsonObject_stringOf $jResp "options.monitor_name"]
set Renotify_interval [CkJsonObject_IntOf $jResp "options.monitor_options.renotify_interval"]
set Monitor_priority [CkJsonObject_IntOf $jResp "options.monitor_priority"]
set NoScreenshot [CkJsonObject_BoolOf $jResp "options.noScreenshot"]
set Count [CkJsonObject_IntOf $jResp "options.retry.count"]
set Interval [CkJsonObject_stringOf $jResp "options.retry.interval"]
set ApplicationId [CkJsonObject_stringOf $jResp "options.rumSettings.applicationId"]
set ClientTokenId [CkJsonObject_IntOf $jResp "options.rumSettings.clientTokenId"]
set IsEnabled [CkJsonObject_BoolOf $jResp "options.rumSettings.isEnabled"]
set Timezone [CkJsonObject_stringOf $jResp "options.scheduling.timezone"]
set Tick_every [CkJsonObject_IntOf $jResp "options.tick_every"]
set v_type [CkJsonObject_stringOf $jResp "type"]
set message [CkJsonObject_stringOf $jResp "message"]
set monitor_id [CkJsonObject_IntOf $jResp "monitor_id"]
set public_id [CkJsonObject_stringOf $jResp "public_id"]
set status [CkJsonObject_stringOf $jResp "status"]
set subtype [CkJsonObject_stringOf $jResp "subtype"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "config.assertions"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set operator [CkJsonObject_stringOf $jResp "config.assertions[i].operator"]
set target [CkJsonObject_IntOf $jResp "config.assertions[i].target"]
set v_type [CkJsonObject_stringOf $jResp "config.assertions[i].type"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "locations"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set strVal [CkJsonObject_stringOf $jResp "locations[i]"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "options.device_ids"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set strVal [CkJsonObject_stringOf $jResp "options.device_ids[i]"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "options.restricted_roles"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set strVal [CkJsonObject_stringOf $jResp "options.restricted_roles[i]"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "options.scheduling.timeframes"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set day [CkJsonObject_IntOf $jResp "options.scheduling.timeframes[i].day"]
set from [CkJsonObject_stringOf $jResp "options.scheduling.timeframes[i].from"]
set v_to [CkJsonObject_stringOf $jResp "options.scheduling.timeframes[i].to"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "tags"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set strVal [CkJsonObject_stringOf $jResp "tags[i]"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -X GET
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/synthetics/tests/api/:public_id
Postman Collection Item JSON
{
"name": "Get an API test",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/api/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"api",
":public_id"
],
"variable": [
{
"key": "public_id",
"value": "tempor Ut sed velit"
}
]
},
"description": "Get the detailed configuration associated with\na Synthetic API test."
},
"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/v1/synthetics/tests/api/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"api",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"name\": \"Example test name\",\n \"config\": {\n \"assertions\": [\n {\n \"operator\": \"lessThan\",\n \"target\": 1000,\n \"type\": \"responseTime\"\n }\n ],\n \"request\": {\n \"method\": \"GET\",\n \"url\": \"https://example.com\"\n }\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"options\": {\n \"accept_self_signed\": true,\n \"allow_insecure\": true,\n \"checkCertificateRevocation\": true,\n \"ci\": {\n \"executionRule\": \"non_blocking\"\n },\n \"device_ids\": [\n \"laptop_large\",\n \"laptop_large\"\n ],\n \"disableCors\": false,\n \"disableCsp\": false,\n \"follow_redirects\": true,\n \"httpVersion\": \"http1\",\n \"ignoreServerCertificateError\": false,\n \"initialNavigationTimeout\": 87780679,\n \"min_failure_duration\": -32472759,\n \"min_location_failed\": -5806955,\n \"monitor_name\": \"et deserunt \",\n \"monitor_options\": {\n \"renotify_interval\": 834\n },\n \"monitor_priority\": 3,\n \"noScreenshot\": false,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": -50657150,\n \"interval\": -91565669.0691471\n },\n \"rumSettings\": {\n \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"clientTokenId\": 12345,\n \"isEnabled\": true\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"tick_every\": 384020\n },\n \"type\": \"api\",\n \"message\": \"Notification message\",\n \"monitor_id\": 12345678,\n \"public_id\": \"123-abc-456\",\n \"status\": \"live\",\n \"subtype\": \"http\",\n \"tags\": [\n \"env:production\"\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/v1/synthetics/tests/api/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"api",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "- Synthetic Monitoring is not activated for the user\n- Test is not owned by the user",
"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/v1/synthetics/tests/api/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"api",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\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/v1/synthetics/tests/api/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"api",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
