Chilkat Online Tools

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

Dim http As New ChilkatHttp
Dim success As Long

http.SetRequestHeader "Accept","application/json"

Dim sbResponseBody As New ChilkatStringBuilder
success = http.QuickGetSb("https://api.app.ddog-gov.com/api/v2/logs/config/archives",sbResponseBody)
If (success = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

Debug.Print "Response Body:"
Debug.Print jResp.Emit()

Dim respStatusCode As Long
respStatusCode = http.LastStatus
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print http.LastHeader
    Debug.Print "Failed."
    Exit Sub
End If

' 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

Dim v_type As String
Dim Name As String
Dim Query As String
Dim Storage_account As String
Dim Container As String
Dim Tenant_id As String
Dim Client_id As String
Dim v_Type As String
Dim Path As String
Dim Region As String
Dim Include_tags As Long
Dim Rehydration_max_scan_size_in_gb As String
Dim State As String
Dim id As String
Dim j As Long
Dim count_j As Long
Dim strVal As String

Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("data")
Do While i < count_i
    jResp.I = i
    v_type = jResp.StringOf("data[i].type")
    Name = jResp.StringOf("data[i].attributes.name")
    Query = jResp.StringOf("data[i].attributes.query")
    Storage_account = jResp.StringOf("data[i].attributes.destination.storage_account")
    Container = jResp.StringOf("data[i].attributes.destination.container")
    Tenant_id = jResp.StringOf("data[i].attributes.destination.integration.tenant_id")
    Client_id = jResp.StringOf("data[i].attributes.destination.integration.client_id")
    v_Type = jResp.StringOf("data[i].attributes.destination.type")
    Path = jResp.StringOf("data[i].attributes.destination.path")
    Region = jResp.StringOf("data[i].attributes.destination.region")
    Include_tags = jResp.BoolOf("data[i].attributes.include_tags")
    Rehydration_max_scan_size_in_gb = jResp.StringOf("data[i].attributes.rehydration_max_scan_size_in_gb")
    State = jResp.StringOf("data[i].attributes.state")
    id = jResp.StringOf("data[i].id")
    j = 0
    count_j = jResp.SizeOfArray("data[i].attributes.rehydration_tags")
    Do While j < count_j
        jResp.J = j
        strVal = jResp.StringOf("data[i].attributes.rehydration_tags[j]")
        j = j + 1
    Loop
    i = i + 1
Loop

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