Chilkat Online Tools

autoit / Datadog API Collection / Get all archives

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oHttp.SetRequestHeader "Accept","application/json"

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://api.app.ddog-gov.com/api/v2/logs/config/archives",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

; 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>"
;     },
;     {
;       "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": "WORKING_AUTH_LEGACY"
;       },
;       "id": "<string>"
;     }
;   ]
; }

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

Local $sV_type
Local $sName
Local $sQuery
Local $sStorage_account
Local $sContainer
Local $sTenant_id
Local $sClient_id
Local $sV_Type
Local $sPath
Local $sRegion
Local $bInclude_tags
Local $sRehydration_max_scan_size_in_gb
Local $sState
Local $sId
Local $iJ
Local $iCount_j
Local $strVal

Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("data")
While $i < $iCount_i
    $oJResp.I = $i
    $sV_type = $oJResp.StringOf("data[i].type")
    $sName = $oJResp.StringOf("data[i].attributes.name")
    $sQuery = $oJResp.StringOf("data[i].attributes.query")
    $sStorage_account = $oJResp.StringOf("data[i].attributes.destination.storage_account")
    $sContainer = $oJResp.StringOf("data[i].attributes.destination.container")
    $sTenant_id = $oJResp.StringOf("data[i].attributes.destination.integration.tenant_id")
    $sClient_id = $oJResp.StringOf("data[i].attributes.destination.integration.client_id")
    $sV_Type = $oJResp.StringOf("data[i].attributes.destination.type")
    $sPath = $oJResp.StringOf("data[i].attributes.destination.path")
    $sRegion = $oJResp.StringOf("data[i].attributes.destination.region")
    $bInclude_tags = $oJResp.BoolOf("data[i].attributes.include_tags")
    $sRehydration_max_scan_size_in_gb = $oJResp.StringOf("data[i].attributes.rehydration_max_scan_size_in_gb")
    $sState = $oJResp.StringOf("data[i].attributes.state")
    $sId = $oJResp.StringOf("data[i].id")
    $iJ = 0
    $iCount_j = $oJResp.SizeOfArray("data[i].attributes.rehydration_tags")
    While $iJ < $iCount_j
        $oJResp.J = $iJ
        $strVal = $oJResp.StringOf("data[i].attributes.rehydration_tags[j]")
        $iJ = $iJ + 1
    Wend
    $i = $i + 1
Wend

Curl Command

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

Postman Collection Item JSON

{
  "name": "Get all archives",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/logs/config/archives",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "logs",
        "config",
        "archives"
      ]
    },
    "description": "Get the list of configured logs archives with their definitions."
  },
  "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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "logs",
            "config",
            "archives"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": [\n    {\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    {\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\": \"WORKING_AUTH_LEGACY\"\n      },\n      \"id\": \"<string>\"\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/v2/logs/config/archives",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "logs",
            "config",
            "archives"
          ]
        }
      },
      "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": "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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "logs",
            "config",
            "archives"
          ]
        }
      },
      "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}"
    }
  ]
}