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/api/: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)
# {
# "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
$name = $jResp.StringOf("name")
$Method = $jResp.StringOf("config.request.method")
$v_Url = $jResp.StringOf("config.request.url")
$Accept_self_signed = $jResp.BoolOf("options.accept_self_signed")
$Allow_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")
$Follow_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")
$v_type = $jResp.StringOf("type")
$message = $jResp.StringOf("message")
$monitor_id = $jResp.IntOf("monitor_id")
$public_id = $jResp.StringOf("public_id")
$status = $jResp.StringOf("status")
$subtype = $jResp.StringOf("subtype")
$i = 0
$count_i = $jResp.SizeOfArray("config.assertions")
while ($i -lt $count_i) {
$jResp.I = $i
$operator = $jResp.StringOf("config.assertions[i].operator")
$target = $jResp.IntOf("config.assertions[i].target")
$v_type = $jResp.StringOf("config.assertions[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("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/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}"
}
]
}
