Chilkat Online Tools

VB6 / Datadog API Collection / Get a private location

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 ChilkatHttp
Dim success As Long

http.SetRequestHeader "Accept","application/json"

Dim sbResponseBody As New ChilkatStringBuilder
success = http.QuickGetSb("https://api.app.ddog-gov.com/api/v1/synthetics/private-locations/:location_id",sbResponseBody)
If (success = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

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

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

' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)

' {
'   "name": "New private location",
'   "description": "Description of private location",
'   "tags": [
'     "team:front"
'   ],
'   "id": "Duis incididunt ea Lorem",
'   "metadata": {
'     "restricted_roles": [
'       "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
'     ]
'   },
'   "secrets": {
'     "authentication": {
'       "id": "quis aliqua dolor reprehenderit",
'       "key": "laboris pariatur"
'     },
'     "config_decryption": {
'       "key": "voluptate mollit commodo deserunt"
'     }
'   }
' }

' Sample code for parsing the JSON response...
' Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Dim strVal As String

Dim name As String
name = jResp.StringOf("name")
Dim description As String
description = jResp.StringOf("description")
Dim id As String
id = jResp.StringOf("id")
Dim Id As String
Id = jResp.StringOf("secrets.authentication.id")
Dim Key As String
Key = jResp.StringOf("secrets.authentication.key")
Dim Config_decryptionKey As String
Config_decryptionKey = jResp.StringOf("secrets.config_decryption.key")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("tags")
Do While i < count_i
    jResp.I = i
    strVal = jResp.StringOf("tags[i]")
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("metadata.restricted_roles")
Do While i < count_i
    jResp.I = i
    strVal = jResp.StringOf("metadata.restricted_roles[i]")
    i = i + 1
Loop

Curl Command

curl -X GET
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/synthetics/private-locations/:location_id

Postman Collection Item JSON

{
  "name": "Get a private location",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v1/synthetics/private-locations/:location_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "synthetics",
        "private-locations",
        ":location_id"
      ],
      "variable": [
        {
          "key": "location_id",
          "value": "tempor Ut sed velit"
        }
      ]
    },
    "description": "Get a Synthetic private location."
  },
  "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/private-locations/:location_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "private-locations",
            ":location_id"
          ],
          "variable": [
            {
              "key": "location_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"name\": \"New private location\",\n  \"description\": \"Description of private location\",\n  \"tags\": [\n    \"team:front\"\n  ],\n  \"id\": \"Duis incididunt ea Lorem\",\n  \"metadata\": {\n    \"restricted_roles\": [\n      \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n    ]\n  },\n  \"secrets\": {\n    \"authentication\": {\n      \"id\": \"quis aliqua dolor reprehenderit\",\n      \"key\": \"laboris pariatur\"\n    },\n    \"config_decryption\": {\n      \"key\": \"voluptate mollit commodo deserunt\"\n    }\n  }\n}"
    },
    {
      "name": "- Synthetic private locations are not activated for the user\n- Private location does not exist",
      "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/private-locations/:location_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "private-locations",
            ":location_id"
          ],
          "variable": [
            {
              "key": "location_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/private-locations/:location_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "private-locations",
            ":location_id"
          ],
          "variable": [
            {
              "key": "location_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}"
    }
  ]
}