Chilkat Online Tools

Ruby / Datadog API Collection / Get a private location

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

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

sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://api.app.ddog-gov.com/api/v1/synthetics/private-locations/:location_id",sbResponseBody)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print http.lastHeader() + "\n";
    print "Failed." + "\n";
    exit
end

# 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

name = jResp.stringOf("name")
description = jResp.stringOf("description")
id = jResp.stringOf("id")
Id = jResp.stringOf("secrets.authentication.id")
Key = jResp.stringOf("secrets.authentication.key")
Config_decryptionKey = jResp.stringOf("secrets.config_decryption.key")
i = 0
count_i = jResp.SizeOfArray("tags")
while i < count_i
    jResp.put_I(i)
    strVal = jResp.stringOf("tags[i]")
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("metadata.restricted_roles")
while i < count_i
    jResp.put_I(i)
    strVal = jResp.stringOf("metadata.restricted_roles[i]")
    i = i + 1
end

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