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_9_5_0.Http")
Local $bSuccess
$oHttp.SetRequestHeader "Accept","application/json"
$oSbResponseBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://api.app.ddog-gov.com/api/v1/synthetics/tests/:public_id",$oSbResponseBody)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJResp = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oHttp.LastHeader & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
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
Local $sDescription
Local $strVal
Local $iDay
Local $sFrom
Local $sV_to
Local $bAllowFailure
Local $bIsCritical
Local $bNoScreenshot
Local $iTimeout
Local $bAllow_insecure = $oJResp.BoolOf("config.request.allow_insecure")
Local $sPassword = $oJResp.StringOf("config.request.basicAuth.password")
Local $sUsername = $oJResp.StringOf("config.request.basicAuth.username")
Local $sV_Type = $oJResp.StringOf("config.request.basicAuth.type")
Local $sBody = $oJResp.StringOf("config.request.body")
Local $sBodyType = $oJResp.StringOf("config.request.bodyType")
Local $sCallType = $oJResp.StringOf("config.request.callType")
Local $sContent = $oJResp.StringOf("config.request.certificate.cert.content")
Local $sFilename = $oJResp.StringOf("config.request.certificate.cert.filename")
Local $sUpdatedAt = $oJResp.StringOf("config.request.certificate.cert.updatedAt")
Local $sKeyContent = $oJResp.StringOf("config.request.certificate.key.content")
Local $sKeyFilename = $oJResp.StringOf("config.request.certificate.key.filename")
Local $sKeyUpdatedAt = $oJResp.StringOf("config.request.certificate.key.updatedAt")
Local $sCompressedJsonDescriptor = $oJResp.StringOf("config.request.compressedJsonDescriptor")
Local $sDnsServer = $oJResp.StringOf("config.request.dnsServer")
Local $iDnsServerPort = $oJResp.IntOf("config.request.dnsServerPort")
Local $bFollow_redirects = $oJResp.BoolOf("config.request.follow_redirects")
Local $sDolor77f = $oJResp.StringOf("config.request.headers.dolor77f")
Local $sExcepteur5 = $oJResp.StringOf("config.request.headers.Excepteur5")
Local $sCupidatatb2 = $oJResp.StringOf("config.request.headers.cupidatatb2")
Local $sHost = $oJResp.StringOf("config.request.host")
Local $sMessage = $oJResp.StringOf("config.request.message")
Local $sCillum_f = $oJResp.StringOf("config.request.metadata.cillum_f")
Local $sQuicbd = $oJResp.StringOf("config.request.metadata.quicbd")
Local $sDolore2_7 = $oJResp.StringOf("config.request.metadata.dolore2_7")
Local $sMethod = $oJResp.StringOf("config.request.method")
Local $bNoSavingResponseBody = $oJResp.BoolOf("config.request.noSavingResponseBody")
Local $iNumberOfPackets = $oJResp.IntOf("config.request.numberOfPackets")
Local $bPersistCookies = $oJResp.BoolOf("config.request.persistCookies")
Local $iPort = $oJResp.IntOf("config.request.port")
Local $sV_Url = $oJResp.StringOf("config.request.proxy.url")
Local $sUt_a = $oJResp.StringOf("config.request.proxy.headers.ut_a")
Local $sServername = $oJResp.StringOf("config.request.servername")
Local $sService = $oJResp.StringOf("config.request.service")
Local $bShouldTrackHops = $oJResp.BoolOf("config.request.shouldTrackHops")
Local $sTimeout = $oJResp.StringOf("config.request.timeout")
Local $sRequestUrl = $oJResp.StringOf("config.request.url")
Local $sV_Email = $oJResp.StringOf("creator.email")
Local $sHandle = $oJResp.StringOf("creator.handle")
Local $sName = $oJResp.StringOf("creator.name")
Local $sMessage = $oJResp.StringOf("message")
Local $iMonitor_id = $oJResp.IntOf("monitor_id")
Local $sName = $oJResp.StringOf("name")
Local $bAccept_self_signed = $oJResp.BoolOf("options.accept_self_signed")
Local $bOptionsAllow_insecure = $oJResp.BoolOf("options.allow_insecure")
Local $bCheckCertificateRevocation = $oJResp.BoolOf("options.checkCertificateRevocation")
Local $sExecutionRule = $oJResp.StringOf("options.ci.executionRule")
Local $bDisableCors = $oJResp.BoolOf("options.disableCors")
Local $bDisableCsp = $oJResp.BoolOf("options.disableCsp")
Local $bOptionsFollow_redirects = $oJResp.BoolOf("options.follow_redirects")
Local $sHttpVersion = $oJResp.StringOf("options.httpVersion")
Local $bIgnoreServerCertificateError = $oJResp.BoolOf("options.ignoreServerCertificateError")
Local $iInitialNavigationTimeout = $oJResp.IntOf("options.initialNavigationTimeout")
Local $iMin_failure_duration = $oJResp.IntOf("options.min_failure_duration")
Local $iMin_location_failed = $oJResp.IntOf("options.min_location_failed")
Local $sMonitor_name = $oJResp.StringOf("options.monitor_name")
Local $iRenotify_interval = $oJResp.IntOf("options.monitor_options.renotify_interval")
Local $iMonitor_priority = $oJResp.IntOf("options.monitor_priority")
Local $bNoScreenshot = $oJResp.BoolOf("options.noScreenshot")
Local $iCount = $oJResp.IntOf("options.retry.count")
Local $sInterval = $oJResp.StringOf("options.retry.interval")
Local $sApplicationId = $oJResp.StringOf("options.rumSettings.applicationId")
Local $iClientTokenId = $oJResp.IntOf("options.rumSettings.clientTokenId")
Local $bIsEnabled = $oJResp.BoolOf("options.rumSettings.isEnabled")
Local $sTimezone = $oJResp.StringOf("options.scheduling.timezone")
Local $iTick_every = $oJResp.IntOf("options.tick_every")
Local $sPublic_id = $oJResp.StringOf("public_id")
Local $status = $oJResp.StringOf("status")
Local $subtype = $oJResp.StringOf("subtype")
Local $sV_type = $oJResp.StringOf("type")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("config.configVariables")
While $i < $iCount_i
$oJResp.I = $i
$sDescription = $oJResp.StringOf("config.configVariables[i].description")
$sV_type = $oJResp.StringOf("config.configVariables[i].type")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("config.variables")
While $i < $iCount_i
$oJResp.I = $i
$sDescription = $oJResp.StringOf("config.variables[i].description")
$sV_type = $oJResp.StringOf("config.variables[i].type")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("locations")
While $i < $iCount_i
$oJResp.I = $i
$strVal = $oJResp.StringOf("locations[i]")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("options.device_ids")
While $i < $iCount_i
$oJResp.I = $i
$strVal = $oJResp.StringOf("options.device_ids[i]")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("options.restricted_roles")
While $i < $iCount_i
$oJResp.I = $i
$strVal = $oJResp.StringOf("options.restricted_roles[i]")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("options.scheduling.timeframes")
While $i < $iCount_i
$oJResp.I = $i
$iDay = $oJResp.IntOf("options.scheduling.timeframes[i].day")
$sFrom = $oJResp.StringOf("options.scheduling.timeframes[i].from")
$sV_to = $oJResp.StringOf("options.scheduling.timeframes[i].to")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("steps")
While $i < $iCount_i
$oJResp.I = $i
$bAllowFailure = $oJResp.BoolOf("steps[i].allowFailure")
$bIsCritical = $oJResp.BoolOf("steps[i].isCritical")
$sName = $oJResp.StringOf("steps[i].name")
$bNoScreenshot = $oJResp.BoolOf("steps[i].noScreenshot")
$iTimeout = $oJResp.IntOf("steps[i].timeout")
$sV_type = $oJResp.StringOf("steps[i].type")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("tags")
While $i < $iCount_i
$oJResp.I = $i
$strVal = $oJResp.StringOf("tags[i]")
$i = $i + 1
Wend
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}"
}
]
}
