Chilkat Online Tools

phpExt / Datadog API Collection / Get IP Allowlist

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/v2/ip_allowlist',$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)

// {
//   "data": {
//     "type": "ip_allowlist",
//     "attributes": {
//       "enabled": "<boolean>",
//       "entries": [
//         {
//           "data": {
//             "type": "ip_allowlist_entry",
//             "attributes": {
//               "cidr_block": "<string>",
//               "created_at": "<dateTime>",
//               "modified_at": "<dateTime>",
//               "note": "<string>"
//             },
//             "id": "<string>"
//           }
//         },
//         {
//           "data": {
//             "type": "ip_allowlist_entry",
//             "attributes": {
//               "cidr_block": "<string>",
//               "created_at": "<dateTime>",
//               "modified_at": "<dateTime>",
//               "note": "<string>"
//             },
//             "id": "<string>"
//           }
//         }
//       ]
//     },
//     "id": "<string>"
//   }
// }

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

$v_Type = $jResp->stringOf('data.type');
$Enabled = $jResp->stringOf('data.attributes.enabled');
$Id = $jResp->stringOf('data.id');
$i = 0;
$count_i = $jResp->SizeOfArray('data.attributes.entries');
while ($i < $count_i) {
    $jResp->put_I($i);
    $dataType = $jResp->stringOf('data.attributes.entries[i].data.type');
    $Cidr_block = $jResp->stringOf('data.attributes.entries[i].data.attributes.cidr_block');
    $Created_at = $jResp->stringOf('data.attributes.entries[i].data.attributes.created_at');
    $Modified_at = $jResp->stringOf('data.attributes.entries[i].data.attributes.modified_at');
    $Note = $jResp->stringOf('data.attributes.entries[i].data.attributes.note');
    $dataId = $jResp->stringOf('data.attributes.entries[i].data.id');
    $i = $i + 1;
}


?>

Curl Command

curl -X GET
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/ip_allowlist

Postman Collection Item JSON

{
  "name": "Get IP Allowlist",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/ip_allowlist",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "ip_allowlist"
      ]
    },
    "description": "Returns the IP allowlist and its enabled or disabled state."
  },
  "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/v2/ip_allowlist",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "ip_allowlist"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\n    \"type\": \"ip_allowlist\",\n    \"attributes\": {\n      \"enabled\": \"<boolean>\",\n      \"entries\": [\n        {\n          \"data\": {\n            \"type\": \"ip_allowlist_entry\",\n            \"attributes\": {\n              \"cidr_block\": \"<string>\",\n              \"created_at\": \"<dateTime>\",\n              \"modified_at\": \"<dateTime>\",\n              \"note\": \"<string>\"\n            },\n            \"id\": \"<string>\"\n          }\n        },\n        {\n          \"data\": {\n            \"type\": \"ip_allowlist_entry\",\n            \"attributes\": {\n              \"cidr_block\": \"<string>\",\n              \"created_at\": \"<dateTime>\",\n              \"modified_at\": \"<dateTime>\",\n              \"note\": \"<string>\"\n            },\n            \"id\": \"<string>\"\n          }\n        }\n      ]\n    },\n    \"id\": \"<string>\"\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/v2/ip_allowlist",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "ip_allowlist"
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\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/v2/ip_allowlist",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "ip_allowlist"
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\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/v2/ip_allowlist",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "ip_allowlist"
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    }
  ]
}