Chilkat Online Tools

C / Datadog API Collection / Get an archive

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkStringBuilder sbResponseBody;
    HCkJsonObject jResp;
    int respStatusCode;
    const char *strVal;
    const char *v_Type;
    const char *Name;
    const char *Query;
    const char *Storage_account;
    const char *Container;
    const char *Tenant_id;
    const char *Client_id;
    const char *DestinationType;
    const char *Path;
    const char *Region;
    BOOL Include_tags;
    const char *Rehydration_max_scan_size_in_gb;
    const char *State;
    const char *Id;
    int i;
    int count_i;

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

    http = CkHttp_Create();

    CkHttp_SetRequestHeader(http,"Accept","application/json");

    sbResponseBody = CkStringBuilder_Create();
    success = CkHttp_QuickGetSb(http,"https://api.app.ddog-gov.com/api/v2/logs/config/archives/:archive_id",sbResponseBody);
    if (success == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkStringBuilder_Dispose(sbResponseBody);
        return;
    }

    jResp = CkJsonObject_Create();
    CkJsonObject_LoadSb(jResp,sbResponseBody);
    CkJsonObject_putEmitCompact(jResp,FALSE);

    printf("Response Body:\n");
    printf("%s\n",CkJsonObject_emit(jResp));

    respStatusCode = CkHttp_getLastStatus(http);
    printf("Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        printf("Response Header:\n");
        printf("%s\n",CkHttp_lastHeader(http));
        printf("Failed.\n");
        CkHttp_Dispose(http);
        CkStringBuilder_Dispose(sbResponseBody);
        CkJsonObject_Dispose(jResp);
        return;
    }

    // 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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    v_Type = CkJsonObject_stringOf(jResp,"data.type");
    Name = CkJsonObject_stringOf(jResp,"data.attributes.name");
    Query = CkJsonObject_stringOf(jResp,"data.attributes.query");
    Storage_account = CkJsonObject_stringOf(jResp,"data.attributes.destination.storage_account");
    Container = CkJsonObject_stringOf(jResp,"data.attributes.destination.container");
    Tenant_id = CkJsonObject_stringOf(jResp,"data.attributes.destination.integration.tenant_id");
    Client_id = CkJsonObject_stringOf(jResp,"data.attributes.destination.integration.client_id");
    DestinationType = CkJsonObject_stringOf(jResp,"data.attributes.destination.type");
    Path = CkJsonObject_stringOf(jResp,"data.attributes.destination.path");
    Region = CkJsonObject_stringOf(jResp,"data.attributes.destination.region");
    Include_tags = CkJsonObject_BoolOf(jResp,"data.attributes.include_tags");
    Rehydration_max_scan_size_in_gb = CkJsonObject_stringOf(jResp,"data.attributes.rehydration_max_scan_size_in_gb");
    State = CkJsonObject_stringOf(jResp,"data.attributes.state");
    Id = CkJsonObject_stringOf(jResp,"data.id");
    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"data.attributes.rehydration_tags");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        strVal = CkJsonObject_stringOf(jResp,"data.attributes.rehydration_tags[i]");
        i = i + 1;
    }



    CkHttp_Dispose(http);
    CkStringBuilder_Dispose(sbResponseBody);
    CkJsonObject_Dispose(jResp);

    }

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}"
    }
  ]
}