Chilkat Online Tools

phpExt / Datadog API Collection / Get all global variables

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$http = new CkHttp();

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

$sbResponseBody = new CkStringBuilder();
$success = $http->QuickGetSb('https://api.app.ddog-gov.com/api/v1/synthetics/variables',$sbResponseBody);
if ($success == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

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

$respStatusCode = $http->get_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)

// {
//   "variables": [
//     {
//       "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": "id Ut Excepteur commodo consectetur",
//       "parse_test_options": {
//         "type": "http_body",
//         "field": "content-type",
//         "localVariableName": "LOCAL_VARIABLE",
//         "parser": {
//           "type": "regex",
//           "value": ".*"
//         }
//       },
//       "parse_test_public_id": "abc-def-123"
//     },
//     {
//       "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": "consectetur enim magna",
//       "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

$i = 0;
$count_i = $jResp->SizeOfArray('variables');
while ($i < $count_i) {
    $jResp->put_I($i);
    $description = $jResp->stringOf('variables[i].description');
    $name = $jResp->stringOf('variables[i].name');
    $Secure = $jResp->BoolOf('variables[i].value.secure');
    $Value = $jResp->stringOf('variables[i].value.value');
    $id = $jResp->stringOf('variables[i].id');
    $v_Type = $jResp->stringOf('variables[i].parse_test_options.type');
    $Field = $jResp->stringOf('variables[i].parse_test_options.field');
    $LocalVariableName = $jResp->stringOf('variables[i].parse_test_options.localVariableName');
    $ParserType = $jResp->stringOf('variables[i].parse_test_options.parser.type');
    $ParserValue = $jResp->stringOf('variables[i].parse_test_options.parser.value');
    $parse_test_public_id = $jResp->stringOf('variables[i].parse_test_public_id');
    $j = 0;
    $count_j = $jResp->SizeOfArray('variables[i].tags');
    while ($j < $count_j) {
        $jResp->put_J($j);
        $strVal = $jResp->stringOf('variables[i].tags[j]');
        $j = $j + 1;
    }

    $j = 0;
    $count_j = $jResp->SizeOfArray('variables[i].attributes.restricted_roles');
    while ($j < $count_j) {
        $jResp->put_J($j);
        $strVal = $jResp->stringOf('variables[i].attributes.restricted_roles[j]');
        $j = $j + 1;
    }

    $i = $i + 1;
}


?>

Curl Command

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

Postman Collection Item JSON

{
  "name": "Get all global variables",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v1/synthetics/variables",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "synthetics",
        "variables"
      ]
    },
    "description": "Get the list of all Synthetic global variables."
  },
  "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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "variables"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"variables\": [\n    {\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\": \"id Ut Excepteur commodo consectetur\",\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    },\n    {\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\": \"consectetur enim magna\",\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    }\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/variables",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "variables"
          ]
        }
      },
      "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": "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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "variables"
          ]
        }
      },
      "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}"
    }
  ]
}