Chilkat Online Tools

phpAx / Datadog API Collection / Get an archive

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/v2/logs/config/archives/:archive_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)

// {
//   "data": {
//     "type": "archives",
//     "attributes": {
//       "name": "<string>",
//       "query": "<string>",
//       "destination": {
//         "storage_account": "<string>",
//         "container": "<string>",
//         "integration": {
//           "tenant_id": "<string>",
//           "client_id": "<string>"
//         },
//         "type": "azure",
//         "path": "<string>",
//         "region": "<string>"
//       },
//       "include_tags": false,
//       "rehydration_max_scan_size_in_gb": "<long>",
//       "rehydration_tags": [
//         "<string>",
//         "<string>"
//       ],
//       "state": "FAILING"
//     },
//     "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');
$Name = $jResp->stringOf('data.attributes.name');
$Query = $jResp->stringOf('data.attributes.query');
$Storage_account = $jResp->stringOf('data.attributes.destination.storage_account');
$Container = $jResp->stringOf('data.attributes.destination.container');
$Tenant_id = $jResp->stringOf('data.attributes.destination.integration.tenant_id');
$Client_id = $jResp->stringOf('data.attributes.destination.integration.client_id');
$DestinationType = $jResp->stringOf('data.attributes.destination.type');
$Path = $jResp->stringOf('data.attributes.destination.path');
$Region = $jResp->stringOf('data.attributes.destination.region');
$Include_tags = $jResp->BoolOf('data.attributes.include_tags');
$Rehydration_max_scan_size_in_gb = $jResp->stringOf('data.attributes.rehydration_max_scan_size_in_gb');
$State = $jResp->stringOf('data.attributes.state');
$Id = $jResp->stringOf('data.id');
$i = 0;
$count_i = $jResp->SizeOfArray('data.attributes.rehydration_tags');
while ($i < $count_i) {
    $jResp->I = $i;
    $strVal = $jResp->stringOf('data.attributes.rehydration_tags[i]');
    $i = $i + 1;
}


?>

Curl Command

curl -X GET
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/logs/config/archives/:archive_id

Postman Collection Item JSON

{
  "name": "Get an archive",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/logs/config/archives/:archive_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "logs",
        "config",
        "archives",
        ":archive_id"
      ],
      "variable": [
        {
          "key": "archive_id",
          "value": "<string>"
        }
      ]
    },
    "description": "Get a specific archive from your organization."
  },
  "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/logs/config/archives/:archive_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "logs",
            "config",
            "archives",
            ":archive_id"
          ],
          "variable": [
            {
              "key": "archive_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\n    \"type\": \"archives\",\n    \"attributes\": {\n      \"name\": \"<string>\",\n      \"query\": \"<string>\",\n      \"destination\": {\n        \"storage_account\": \"<string>\",\n        \"container\": \"<string>\",\n        \"integration\": {\n          \"tenant_id\": \"<string>\",\n          \"client_id\": \"<string>\"\n        },\n        \"type\": \"azure\",\n        \"path\": \"<string>\",\n        \"region\": \"<string>\"\n      },\n      \"include_tags\": false,\n      \"rehydration_max_scan_size_in_gb\": \"<long>\",\n      \"rehydration_tags\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"state\": \"FAILING\"\n    },\n    \"id\": \"<string>\"\n  }\n}"
    },
    {
      "name": "Bad Request",
      "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/logs/config/archives/:archive_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "logs",
            "config",
            "archives",
            ":archive_id"
          ],
          "variable": [
            {
              "key": "archive_id"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<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/logs/config/archives/:archive_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "logs",
            "config",
            "archives",
            ":archive_id"
          ],
          "variable": [
            {
              "key": "archive_id"
            }
          ]
        }
      },
      "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/logs/config/archives/:archive_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "logs",
            "config",
            "archives",
            ":archive_id"
          ],
          "variable": [
            {
              "key": "archive_id"
            }
          ]
        }
      },
      "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/logs/config/archives/:archive_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "logs",
            "config",
            "archives",
            ":archive_id"
          ],
          "variable": [
            {
              "key": "archive_id"
            }
          ]
        }
      },
      "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}"
    }
  ]
}