Chilkat Online Tools

Powershell / Datadog API Collection / Get a global variable

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-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/variables/:variable_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)

# {
#   "description": "Example description",
#   "name": "MY_VARIABLE",
#   "tags": [
#     "team:front",
#     "test:workflow-1"
#   ],
#   "value": {
#     "secure": true,
#     "value": "value"
#   },
#   "attributes": {
#     "restricted_roles": [
#       "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
#     ]
#   },
#   "id": "anim irure id cupidatat",
#   "parse_test_options": {
#     "type": "http_body",
#     "field": "content-type",
#     "localVariableName": "LOCAL_VARIABLE",
#     "parser": {
#       "type": "regex",
#       "value": ".*"
#     }
#   },
#   "parse_test_public_id": "abc-def-123"
# }

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

$description = $jResp.StringOf("description")
$name = $jResp.StringOf("name")
$Secure = $jResp.BoolOf("value.secure")
$Value = $jResp.StringOf("value.value")
$id = $jResp.StringOf("id")
$v_Type = $jResp.StringOf("parse_test_options.type")
$Field = $jResp.StringOf("parse_test_options.field")
$LocalVariableName = $jResp.StringOf("parse_test_options.localVariableName")
$ParserType = $jResp.StringOf("parse_test_options.parser.type")
$ParserValue = $jResp.StringOf("parse_test_options.parser.value")
$parse_test_public_id = $jResp.StringOf("parse_test_public_id")
$i = 0
$count_i = $jResp.SizeOfArray("tags")
while ($i -lt $count_i) {
    $jResp.I = $i
    $strVal = $jResp.StringOf("tags[i]")
    $i = $i + 1
}

$i = 0
$count_i = $jResp.SizeOfArray("attributes.restricted_roles")
while ($i -lt $count_i) {
    $jResp.I = $i
    $strVal = $jResp.StringOf("attributes.restricted_roles[i]")
    $i = $i + 1
}

Curl Command

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

Postman Collection Item JSON

{
  "name": "Get a global variable",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v1/synthetics/variables/:variable_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "synthetics",
        "variables",
        ":variable_id"
      ],
      "variable": [
        {
          "key": "variable_id",
          "value": "tempor Ut sed velit"
        }
      ]
    },
    "description": "Get the detailed configuration of a global variable."
  },
  "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/variables/:variable_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "variables",
            ":variable_id"
          ],
          "variable": [
            {
              "key": "variable_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"description\": \"Example description\",\n  \"name\": \"MY_VARIABLE\",\n  \"tags\": [\n    \"team:front\",\n    \"test:workflow-1\"\n  ],\n  \"value\": {\n    \"secure\": true,\n    \"value\": \"value\"\n  },\n  \"attributes\": {\n    \"restricted_roles\": [\n      \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n    ]\n  },\n  \"id\": \"anim irure id cupidatat\",\n  \"parse_test_options\": {\n    \"type\": \"http_body\",\n    \"field\": \"content-type\",\n    \"localVariableName\": \"LOCAL_VARIABLE\",\n    \"parser\": {\n      \"type\": \"regex\",\n      \"value\": \".*\"\n    }\n  },\n  \"parse_test_public_id\": \"abc-def-123\"\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/variables/:variable_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "variables",
            ":variable_id"
          ],
          "variable": [
            {
              "key": "variable_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": "Not found",
      "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/variables/:variable_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "variables",
            ":variable_id"
          ],
          "variable": [
            {
              "key": "variable_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/variables/:variable_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "variables",
            ":variable_id"
          ],
          "variable": [
            {
              "key": "variable_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}"
    }
  ]
}