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