Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loHttp.SetRequestHeader("Accept","application/json")
loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://api.app.ddog-gov.com/api/v1/synthetics/tests/:public_id",loSbResponseBody)
if (llSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loSbResponseBody
return
endif
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loHttp.LastHeader
? "Failed."
release loHttp
release loSbResponseBody
release loJResp
return
endif
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "config": {
// "configVariables": [
// {
// "description": "Example for the variable.",
// "type": "string"
// },
// {
// "description": "Example for the variable.",
// "type": "string"
// }
// ],
// "request": {
// "allow_insecure": false,
// "basicAuth": {
// "password": "PaSSw0RD!",
// "username": "my_username",
// "type": "web"
// },
// "body": "deserunt non",
// "bodyType": "text/plain",
// "callType": "unary",
// "certificate": {
// "cert": {
// "content": "ad dolor",
// "filename": "culpa adipisicing",
// "updatedAt": "ipsum magna irure aliquip"
// },
// "key": {
// "content": "in labore",
// "filename": "sit magna non dolore",
// "updatedAt": "ipsum aute in"
// }
// },
// "compressedJsonDescriptor": "co",
// "dnsServer": "adipisicing dolore fugiat",
// "dnsServerPort": 43085,
// "follow_redirects": false,
// "headers": {
// "dolor77f": "laboris aliquip in",
// "Excepteur5": "in ullamco est repr",
// "cupidatatb2": "ex magna dolore"
// },
// "host": "qui eu",
// "message": "dolore anim tempor minim dolor",
// "metadata": {
// "cillum_f": "elit ad ex ven",
// "quicbd": "ut ipsum Duis cillum dolor",
// "dolore2_7": "pariatur adipisicing enim dolore nulla"
// },
// "method": "deserunt",
// "noSavingResponseBody": true,
// "numberOfPackets": 9,
// "persistCookies": false,
// "port": -81939613,
// "proxy": {
// "url": "https://example.com",
// "headers": {
// "ut_a": "ut"
// }
// },
// "query": {},
// "servername": "adipisicing id dolore",
// "service": "Greeter",
// "shouldTrackHops": false,
// "timeout": 10817249.274777964,
// "url": "https://example.com"
// },
// "variables": [
// {
// "description": "Example for the variable.",
// "type": "string"
// },
// {
// "description": "Example for the variable.",
// "type": "string"
// }
// ]
// },
// "creator": {
// "email": "enim exercitation commodo in",
// "handle": "et nulla eu",
// "name": "cupidatat proident"
// },
// "locations": [
// "aws:eu-west-3"
// ],
// "message": "eu do sunt commodo aliquip",
// "monitor_id": -1517547,
// "name": "deserunt amet occaecat",
// "options": {
// "accept_self_signed": true,
// "allow_insecure": true,
// "checkCertificateRevocation": true,
// "ci": {
// "executionRule": "non_blocking"
// },
// "device_ids": [
// "laptop_large",
// "laptop_large"
// ],
// "disableCors": true,
// "disableCsp": true,
// "follow_redirects": true,
// "httpVersion": "http2",
// "ignoreServerCertificateError": false,
// "initialNavigationTimeout": -26222184,
// "min_failure_duration": 76083858,
// "min_location_failed": -39662994,
// "monitor_name": "paria",
// "monitor_options": {
// "renotify_interval": 214
// },
// "monitor_priority": 4,
// "noScreenshot": true,
// "restricted_roles": [
// "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
// ],
// "retry": {
// "count": 1859540,
// "interval": -51339928.952870026
// },
// "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": 74879
// },
// "public_id": "magna",
// "status": "live",
// "steps": [
// {
// "allowFailure": false,
// "isCritical": true,
// "name": "ea laborum ve",
// "noScreenshot": false,
// "params": {},
// "timeout": 51909556,
// "type": "assertElementContent"
// },
// {
// "allowFailure": false,
// "isCritical": true,
// "name": "pariatur reprehenderit do",
// "noScreenshot": false,
// "params": {},
// "timeout": 72919471,
// "type": "assertElementContent"
// }
// ],
// "subtype": "http",
// "tags": [
// "dolor Ut anim nisi ea",
// "dolore anim ipsum pariatur"
// ],
// "type": "browser"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
llAllow_insecure = loJResp.BoolOf("config.request.allow_insecure")
lcPassword = loJResp.StringOf("config.request.basicAuth.password")
lcUsername = loJResp.StringOf("config.request.basicAuth.username")
lcV_Type = loJResp.StringOf("config.request.basicAuth.type")
lcBody = loJResp.StringOf("config.request.body")
lcBodyType = loJResp.StringOf("config.request.bodyType")
lcCallType = loJResp.StringOf("config.request.callType")
lcContent = loJResp.StringOf("config.request.certificate.cert.content")
lcFilename = loJResp.StringOf("config.request.certificate.cert.filename")
lcUpdatedAt = loJResp.StringOf("config.request.certificate.cert.updatedAt")
lcKeyContent = loJResp.StringOf("config.request.certificate.key.content")
lcKeyFilename = loJResp.StringOf("config.request.certificate.key.filename")
lcKeyUpdatedAt = loJResp.StringOf("config.request.certificate.key.updatedAt")
lcCompressedJsonDescriptor = loJResp.StringOf("config.request.compressedJsonDescriptor")
lcDnsServer = loJResp.StringOf("config.request.dnsServer")
lnDnsServerPort = loJResp.IntOf("config.request.dnsServerPort")
llFollow_redirects = loJResp.BoolOf("config.request.follow_redirects")
lcDolor77f = loJResp.StringOf("config.request.headers.dolor77f")
lcExcepteur5 = loJResp.StringOf("config.request.headers.Excepteur5")
lcCupidatatb2 = loJResp.StringOf("config.request.headers.cupidatatb2")
lcHost = loJResp.StringOf("config.request.host")
lcMessage = loJResp.StringOf("config.request.message")
lcCillum_f = loJResp.StringOf("config.request.metadata.cillum_f")
lcQuicbd = loJResp.StringOf("config.request.metadata.quicbd")
lcDolore2_7 = loJResp.StringOf("config.request.metadata.dolore2_7")
lcMethod = loJResp.StringOf("config.request.method")
llNoSavingResponseBody = loJResp.BoolOf("config.request.noSavingResponseBody")
lnNumberOfPackets = loJResp.IntOf("config.request.numberOfPackets")
llPersistCookies = loJResp.BoolOf("config.request.persistCookies")
lnPort = loJResp.IntOf("config.request.port")
lcV_Url = loJResp.StringOf("config.request.proxy.url")
lcUt_a = loJResp.StringOf("config.request.proxy.headers.ut_a")
lcServername = loJResp.StringOf("config.request.servername")
lcService = loJResp.StringOf("config.request.service")
llShouldTrackHops = loJResp.BoolOf("config.request.shouldTrackHops")
lcTimeout = loJResp.StringOf("config.request.timeout")
lcRequestUrl = loJResp.StringOf("config.request.url")
lcV_Email = loJResp.StringOf("creator.email")
lcHandle = loJResp.StringOf("creator.handle")
lcName = loJResp.StringOf("creator.name")
lcMessage = loJResp.StringOf("message")
lnMonitor_id = loJResp.IntOf("monitor_id")
lcName = loJResp.StringOf("name")
llAccept_self_signed = loJResp.BoolOf("options.accept_self_signed")
llOptionsAllow_insecure = loJResp.BoolOf("options.allow_insecure")
llCheckCertificateRevocation = loJResp.BoolOf("options.checkCertificateRevocation")
lcExecutionRule = loJResp.StringOf("options.ci.executionRule")
llDisableCors = loJResp.BoolOf("options.disableCors")
llDisableCsp = loJResp.BoolOf("options.disableCsp")
llOptionsFollow_redirects = loJResp.BoolOf("options.follow_redirects")
lcHttpVersion = loJResp.StringOf("options.httpVersion")
llIgnoreServerCertificateError = loJResp.BoolOf("options.ignoreServerCertificateError")
lnInitialNavigationTimeout = loJResp.IntOf("options.initialNavigationTimeout")
lnMin_failure_duration = loJResp.IntOf("options.min_failure_duration")
lnMin_location_failed = loJResp.IntOf("options.min_location_failed")
lcMonitor_name = loJResp.StringOf("options.monitor_name")
lnRenotify_interval = loJResp.IntOf("options.monitor_options.renotify_interval")
lnMonitor_priority = loJResp.IntOf("options.monitor_priority")
llNoScreenshot = loJResp.BoolOf("options.noScreenshot")
lnCount = loJResp.IntOf("options.retry.count")
lcInterval = loJResp.StringOf("options.retry.interval")
lcApplicationId = loJResp.StringOf("options.rumSettings.applicationId")
lnClientTokenId = loJResp.IntOf("options.rumSettings.clientTokenId")
llIsEnabled = loJResp.BoolOf("options.rumSettings.isEnabled")
lcTimezone = loJResp.StringOf("options.scheduling.timezone")
lnTick_every = loJResp.IntOf("options.tick_every")
lcPublic_id = loJResp.StringOf("public_id")
lcStatus = loJResp.StringOf("status")
lcSubtype = loJResp.StringOf("subtype")
lcV_type = loJResp.StringOf("type")
i = 0
lnCount_i = loJResp.SizeOfArray("config.configVariables")
do while i < lnCount_i
loJResp.I = i
lcDescription = loJResp.StringOf("config.configVariables[i].description")
lcV_type = loJResp.StringOf("config.configVariables[i].type")
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("config.variables")
do while i < lnCount_i
loJResp.I = i
lcDescription = loJResp.StringOf("config.variables[i].description")
lcV_type = loJResp.StringOf("config.variables[i].type")
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("locations")
do while i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("locations[i]")
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("options.device_ids")
do while i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("options.device_ids[i]")
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("options.restricted_roles")
do while i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("options.restricted_roles[i]")
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("options.scheduling.timeframes")
do while i < lnCount_i
loJResp.I = i
lnDay = loJResp.IntOf("options.scheduling.timeframes[i].day")
lcFrom = loJResp.StringOf("options.scheduling.timeframes[i].from")
lcV_to = loJResp.StringOf("options.scheduling.timeframes[i].to")
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("steps")
do while i < lnCount_i
loJResp.I = i
llAllowFailure = loJResp.BoolOf("steps[i].allowFailure")
llIsCritical = loJResp.BoolOf("steps[i].isCritical")
lcName = loJResp.StringOf("steps[i].name")
llNoScreenshot = loJResp.BoolOf("steps[i].noScreenshot")
lnTimeout = loJResp.IntOf("steps[i].timeout")
lcV_type = loJResp.StringOf("steps[i].type")
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("tags")
do while i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("tags[i]")
i = i + 1
enddo
release loHttp
release loSbResponseBody
release loJResp
Curl Command
curl -X GET
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/synthetics/tests/:public_id
Postman Collection Item JSON
{
"name": "Get a test configuration",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
":public_id"
],
"variable": [
{
"key": "public_id",
"value": "tempor Ut sed velit"
}
]
},
"description": "Get the detailed configuration associated with a Synthetic 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/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"config\": {\n \"configVariables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ],\n \"request\": {\n \"allow_insecure\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"username\": \"my_username\",\n \"type\": \"web\"\n },\n \"body\": \"deserunt non\",\n \"bodyType\": \"text/plain\",\n \"callType\": \"unary\",\n \"certificate\": {\n \"cert\": {\n \"content\": \"ad dolor\",\n \"filename\": \"culpa adipisicing\",\n \"updatedAt\": \"ipsum magna irure aliquip\"\n },\n \"key\": {\n \"content\": \"in labore\",\n \"filename\": \"sit magna non dolore\",\n \"updatedAt\": \"ipsum aute in\"\n }\n },\n \"compressedJsonDescriptor\": \"co\",\n \"dnsServer\": \"adipisicing dolore fugiat\",\n \"dnsServerPort\": 43085,\n \"follow_redirects\": false,\n \"headers\": {\n \"dolor77f\": \"laboris aliquip in\",\n \"Excepteur5\": \"in ullamco est repr\",\n \"cupidatatb2\": \"ex magna dolore\"\n },\n \"host\": \"qui eu\",\n \"message\": \"dolore anim tempor minim dolor\",\n \"metadata\": {\n \"cillum_f\": \"elit ad ex ven\",\n \"quicbd\": \"ut ipsum Duis cillum dolor\",\n \"dolore2_7\": \"pariatur adipisicing enim dolore nulla\"\n },\n \"method\": \"deserunt\",\n \"noSavingResponseBody\": true,\n \"numberOfPackets\": 9,\n \"persistCookies\": false,\n \"port\": -81939613,\n \"proxy\": {\n \"url\": \"https://example.com\",\n \"headers\": {\n \"ut_a\": \"ut\"\n }\n },\n \"query\": {},\n \"servername\": \"adipisicing id dolore\",\n \"service\": \"Greeter\",\n \"shouldTrackHops\": false,\n \"timeout\": 10817249.274777964,\n \"url\": \"https://example.com\"\n },\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"creator\": {\n \"email\": \"enim exercitation commodo in\",\n \"handle\": \"et nulla eu\",\n \"name\": \"cupidatat proident\"\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"message\": \"eu do sunt commodo aliquip\",\n \"monitor_id\": -1517547,\n \"name\": \"deserunt amet occaecat\",\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\": true,\n \"disableCsp\": true,\n \"follow_redirects\": true,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": false,\n \"initialNavigationTimeout\": -26222184,\n \"min_failure_duration\": 76083858,\n \"min_location_failed\": -39662994,\n \"monitor_name\": \"paria\",\n \"monitor_options\": {\n \"renotify_interval\": 214\n },\n \"monitor_priority\": 4,\n \"noScreenshot\": true,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": 1859540,\n \"interval\": -51339928.952870026\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\": 74879\n },\n \"public_id\": \"magna\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"allowFailure\": false,\n \"isCritical\": true,\n \"name\": \"ea laborum ve\",\n \"noScreenshot\": false,\n \"params\": {},\n \"timeout\": 51909556,\n \"type\": \"assertElementContent\"\n },\n {\n \"allowFailure\": false,\n \"isCritical\": true,\n \"name\": \"pariatur reprehenderit do\",\n \"noScreenshot\": false,\n \"params\": {},\n \"timeout\": 72919471,\n \"type\": \"assertElementContent\"\n }\n ],\n \"subtype\": \"http\",\n \"tags\": [\n \"dolor Ut anim nisi ea\",\n \"dolore anim ipsum pariatur\"\n ],\n \"type\": \"browser\"\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/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
":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 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/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
":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/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
":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}"
}
]
}
