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
$http.SetRequestHeader("Accept","application/json")
$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.QuickGetSb("https://api.app.ddog-gov.com/api/v1/synthetics/tests/:public_id",$sbResponseBody)
if ($success -eq $false) {
$($http.LastErrorText)
exit
}
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false
$("Response Body:")
$($jResp.Emit())
$respStatusCode = $http.LastStatus
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
$("Response Header:")
$($http.LastHeader)
$("Failed.")
exit
}
# 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
$Allow_insecure = $jResp.BoolOf("config.request.allow_insecure")
$Password = $jResp.StringOf("config.request.basicAuth.password")
$Username = $jResp.StringOf("config.request.basicAuth.username")
$v_Type = $jResp.StringOf("config.request.basicAuth.type")
$Body = $jResp.StringOf("config.request.body")
$BodyType = $jResp.StringOf("config.request.bodyType")
$CallType = $jResp.StringOf("config.request.callType")
$Content = $jResp.StringOf("config.request.certificate.cert.content")
$Filename = $jResp.StringOf("config.request.certificate.cert.filename")
$UpdatedAt = $jResp.StringOf("config.request.certificate.cert.updatedAt")
$KeyContent = $jResp.StringOf("config.request.certificate.key.content")
$KeyFilename = $jResp.StringOf("config.request.certificate.key.filename")
$KeyUpdatedAt = $jResp.StringOf("config.request.certificate.key.updatedAt")
$CompressedJsonDescriptor = $jResp.StringOf("config.request.compressedJsonDescriptor")
$DnsServer = $jResp.StringOf("config.request.dnsServer")
$DnsServerPort = $jResp.IntOf("config.request.dnsServerPort")
$Follow_redirects = $jResp.BoolOf("config.request.follow_redirects")
$Dolor77f = $jResp.StringOf("config.request.headers.dolor77f")
$Excepteur5 = $jResp.StringOf("config.request.headers.Excepteur5")
$Cupidatatb2 = $jResp.StringOf("config.request.headers.cupidatatb2")
$Host = $jResp.StringOf("config.request.host")
$Message = $jResp.StringOf("config.request.message")
$Cillum_f = $jResp.StringOf("config.request.metadata.cillum_f")
$Quicbd = $jResp.StringOf("config.request.metadata.quicbd")
$Dolore2_7 = $jResp.StringOf("config.request.metadata.dolore2_7")
$Method = $jResp.StringOf("config.request.method")
$NoSavingResponseBody = $jResp.BoolOf("config.request.noSavingResponseBody")
$NumberOfPackets = $jResp.IntOf("config.request.numberOfPackets")
$PersistCookies = $jResp.BoolOf("config.request.persistCookies")
$Port = $jResp.IntOf("config.request.port")
$v_Url = $jResp.StringOf("config.request.proxy.url")
$Ut_a = $jResp.StringOf("config.request.proxy.headers.ut_a")
$Servername = $jResp.StringOf("config.request.servername")
$Service = $jResp.StringOf("config.request.service")
$ShouldTrackHops = $jResp.BoolOf("config.request.shouldTrackHops")
$Timeout = $jResp.StringOf("config.request.timeout")
$RequestUrl = $jResp.StringOf("config.request.url")
$v_Email = $jResp.StringOf("creator.email")
$Handle = $jResp.StringOf("creator.handle")
$Name = $jResp.StringOf("creator.name")
$message = $jResp.StringOf("message")
$monitor_id = $jResp.IntOf("monitor_id")
$name = $jResp.StringOf("name")
$Accept_self_signed = $jResp.BoolOf("options.accept_self_signed")
$optionsAllow_insecure = $jResp.BoolOf("options.allow_insecure")
$CheckCertificateRevocation = $jResp.BoolOf("options.checkCertificateRevocation")
$ExecutionRule = $jResp.StringOf("options.ci.executionRule")
$DisableCors = $jResp.BoolOf("options.disableCors")
$DisableCsp = $jResp.BoolOf("options.disableCsp")
$optionsFollow_redirects = $jResp.BoolOf("options.follow_redirects")
$HttpVersion = $jResp.StringOf("options.httpVersion")
$IgnoreServerCertificateError = $jResp.BoolOf("options.ignoreServerCertificateError")
$InitialNavigationTimeout = $jResp.IntOf("options.initialNavigationTimeout")
$Min_failure_duration = $jResp.IntOf("options.min_failure_duration")
$Min_location_failed = $jResp.IntOf("options.min_location_failed")
$Monitor_name = $jResp.StringOf("options.monitor_name")
$Renotify_interval = $jResp.IntOf("options.monitor_options.renotify_interval")
$Monitor_priority = $jResp.IntOf("options.monitor_priority")
$NoScreenshot = $jResp.BoolOf("options.noScreenshot")
$Count = $jResp.IntOf("options.retry.count")
$Interval = $jResp.StringOf("options.retry.interval")
$ApplicationId = $jResp.StringOf("options.rumSettings.applicationId")
$ClientTokenId = $jResp.IntOf("options.rumSettings.clientTokenId")
$IsEnabled = $jResp.BoolOf("options.rumSettings.isEnabled")
$Timezone = $jResp.StringOf("options.scheduling.timezone")
$Tick_every = $jResp.IntOf("options.tick_every")
$public_id = $jResp.StringOf("public_id")
$status = $jResp.StringOf("status")
$subtype = $jResp.StringOf("subtype")
$v_type = $jResp.StringOf("type")
$i = 0
$count_i = $jResp.SizeOfArray("config.configVariables")
while ($i -lt $count_i) {
$jResp.I = $i
$description = $jResp.StringOf("config.configVariables[i].description")
$v_type = $jResp.StringOf("config.configVariables[i].type")
$i = $i + 1
}
$i = 0
$count_i = $jResp.SizeOfArray("config.variables")
while ($i -lt $count_i) {
$jResp.I = $i
$description = $jResp.StringOf("config.variables[i].description")
$v_type = $jResp.StringOf("config.variables[i].type")
$i = $i + 1
}
$i = 0
$count_i = $jResp.SizeOfArray("locations")
while ($i -lt $count_i) {
$jResp.I = $i
$strVal = $jResp.StringOf("locations[i]")
$i = $i + 1
}
$i = 0
$count_i = $jResp.SizeOfArray("options.device_ids")
while ($i -lt $count_i) {
$jResp.I = $i
$strVal = $jResp.StringOf("options.device_ids[i]")
$i = $i + 1
}
$i = 0
$count_i = $jResp.SizeOfArray("options.restricted_roles")
while ($i -lt $count_i) {
$jResp.I = $i
$strVal = $jResp.StringOf("options.restricted_roles[i]")
$i = $i + 1
}
$i = 0
$count_i = $jResp.SizeOfArray("options.scheduling.timeframes")
while ($i -lt $count_i) {
$jResp.I = $i
$day = $jResp.IntOf("options.scheduling.timeframes[i].day")
$from = $jResp.StringOf("options.scheduling.timeframes[i].from")
$v_to = $jResp.StringOf("options.scheduling.timeframes[i].to")
$i = $i + 1
}
$i = 0
$count_i = $jResp.SizeOfArray("steps")
while ($i -lt $count_i) {
$jResp.I = $i
$allowFailure = $jResp.BoolOf("steps[i].allowFailure")
$isCritical = $jResp.BoolOf("steps[i].isCritical")
$name = $jResp.StringOf("steps[i].name")
$noScreenshot = $jResp.BoolOf("steps[i].noScreenshot")
$timeout = $jResp.IntOf("steps[i].timeout")
$v_type = $jResp.StringOf("steps[i].type")
$i = $i + 1
}
$i = 0
$count_i = $jResp.SizeOfArray("tags")
while ($i -lt $count_i) {
$jResp.I = $i
$strVal = $jResp.StringOf("tags[i]")
$i = $i + 1
}
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}"
}
]
}
