Chilkat Online Tools

VB.NET / Datadog API Collection / Get an API test

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/api/:public_id",sbResponseBody)
If (success = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())

Dim respStatusCode As Integer = http.LastStatus
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(http.LastHeader)
    Debug.WriteLine("Failed.")
    Exit Sub
End If


' 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



Dim operator As String
Dim target As Integer
Dim strVal As String
Dim day As Integer
Dim from As String
Dim v_to As String

Dim name As String = jResp.StringOf("name")
Dim Method As String = jResp.StringOf("config.request.method")
Dim v_Url As String = jResp.StringOf("config.request.url")
Dim Accept_self_signed As Boolean = jResp.BoolOf("options.accept_self_signed")
Dim Allow_insecure As Boolean = jResp.BoolOf("options.allow_insecure")
Dim CheckCertificateRevocation As Boolean = jResp.BoolOf("options.checkCertificateRevocation")
Dim ExecutionRule As String = jResp.StringOf("options.ci.executionRule")
Dim DisableCors As Boolean = jResp.BoolOf("options.disableCors")
Dim DisableCsp As Boolean = jResp.BoolOf("options.disableCsp")
Dim Follow_redirects As Boolean = jResp.BoolOf("options.follow_redirects")
Dim HttpVersion As String = jResp.StringOf("options.httpVersion")
Dim IgnoreServerCertificateError As Boolean = jResp.BoolOf("options.ignoreServerCertificateError")
Dim InitialNavigationTimeout As Integer = jResp.IntOf("options.initialNavigationTimeout")
Dim Min_failure_duration As Integer = jResp.IntOf("options.min_failure_duration")
Dim Min_location_failed As Integer = jResp.IntOf("options.min_location_failed")
Dim Monitor_name As String = jResp.StringOf("options.monitor_name")
Dim Renotify_interval As Integer = jResp.IntOf("options.monitor_options.renotify_interval")
Dim Monitor_priority As Integer = jResp.IntOf("options.monitor_priority")
Dim NoScreenshot As Boolean = jResp.BoolOf("options.noScreenshot")
Dim Count As Integer = jResp.IntOf("options.retry.count")
Dim Interval As String = jResp.StringOf("options.retry.interval")
Dim ApplicationId As String = jResp.StringOf("options.rumSettings.applicationId")
Dim ClientTokenId As Integer = jResp.IntOf("options.rumSettings.clientTokenId")
Dim IsEnabled As Boolean = jResp.BoolOf("options.rumSettings.isEnabled")
Dim Timezone As String = jResp.StringOf("options.scheduling.timezone")
Dim Tick_every As Integer = jResp.IntOf("options.tick_every")
Dim v_type As String = jResp.StringOf("type")
Dim message As String = jResp.StringOf("message")
Dim monitor_id As Integer = jResp.IntOf("monitor_id")
Dim public_id As String = jResp.StringOf("public_id")
Dim status As String = jResp.StringOf("status")
Dim subtype As String = jResp.StringOf("subtype")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("config.assertions")
While i < 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
End While
i = 0
count_i = jResp.SizeOfArray("locations")
While i < count_i
    jResp.I = i
    strVal = jResp.StringOf("locations[i]")
    i = i + 1
End While
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
End While
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
End While
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
End While
i = 0
count_i = jResp.SizeOfArray("tags")
While i < count_i
    jResp.I = i
    strVal = jResp.StringOf("tags[i]")
    i = i + 1
End While

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}"
    }
  ]
}