Chilkat Online Tools

phpAx / Datadog API Collection / Get a global variable

Back to Collection Items

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

$http->SetRequestHeader('Accept','application/json');

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$success = $http->QuickGetSb('https://api.app.ddog-gov.com/api/v1/synthetics/variables/:variable_id',$sbResponseBody);
if ($success == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $http->LastStatus;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $http->LastHeader . "\n";
    print 'Failed.' . "\n";
    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 < $count_i) {
    $jResp->I = $i;
    $strVal = $jResp->stringOf('tags[i]');
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('attributes.restricted_roles');
while ($i < $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}"
    }
  ]
}