Chilkat Online Tools

Xojo / Datadog API Collection / Create an archive

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 Chilkat.Http
Dim success As Boolean

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

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

Dim json As New Chilkat.JsonObject
success = json.UpdateString("data.type","archives")
success = json.UpdateString("data.attributes.name","<string>")
success = json.UpdateString("data.attributes.query","<string>")
success = json.UpdateString("data.attributes.destination.storage_account","<string>")
success = json.UpdateString("data.attributes.destination.container","<string>")
success = json.UpdateString("data.attributes.destination.integration.tenant_id","<string>")
success = json.UpdateString("data.attributes.destination.integration.client_id","<string>")
success = json.UpdateString("data.attributes.destination.type","azure")
success = json.UpdateString("data.attributes.destination.path","<string>")
success = json.UpdateString("data.attributes.destination.region","<string>")
success = json.UpdateBool("data.attributes.include_tags",False)
success = json.UpdateString("data.attributes.rehydration_max_scan_size_in_gb","<long>")
success = json.UpdateString("data.attributes.rehydration_tags[0]","<string>")
success = json.UpdateString("data.attributes.rehydration_tags[1]","<string>")

http.SetRequestHeader "Content-Type","application/json"
http.SetRequestHeader "Accept","application/json"

Dim resp As Chilkat.HttpResponse
resp = http.PostJson3("https://api.app.ddog-gov.com/api/v2/logs/config/archives","application/json",json)
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(resp.Header)
    System.DebugLog("Failed.")

    Return
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>"
//   }
// }

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

Dim strVal As String

Dim v_Type As String
v_Type = jResp.StringOf("data.type")
Dim Name As String
Name = jResp.StringOf("data.attributes.name")
Dim Query As String
Query = jResp.StringOf("data.attributes.query")
Dim Storage_account As String
Storage_account = jResp.StringOf("data.attributes.destination.storage_account")
Dim Container As String
Container = jResp.StringOf("data.attributes.destination.container")
Dim Tenant_id As String
Tenant_id = jResp.StringOf("data.attributes.destination.integration.tenant_id")
Dim Client_id As String
Client_id = jResp.StringOf("data.attributes.destination.integration.client_id")
Dim DestinationType As String
DestinationType = jResp.StringOf("data.attributes.destination.type")
Dim Path As String
Path = jResp.StringOf("data.attributes.destination.path")
Dim Region As String
Region = jResp.StringOf("data.attributes.destination.region")
Dim Include_tags As Boolean
Include_tags = jResp.BoolOf("data.attributes.include_tags")
Dim Rehydration_max_scan_size_in_gb As String
Rehydration_max_scan_size_in_gb = jResp.StringOf("data.attributes.rehydration_max_scan_size_in_gb")
Dim State As String
State = jResp.StringOf("data.attributes.state")
Dim Id As String
Id = jResp.StringOf("data.id")
Dim i As Int32
i = 0
Dim count_i As Int32
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
Wend

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "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>"
      ]
    }
  }
}'
https://api.app.ddog-gov.com/api/v2/logs/config/archives

Postman Collection Item JSON

{
  "name": "Create an archive",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\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    }\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v2/logs/config/archives",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "logs",
        "config",
        "archives"
      ]
    },
    "description": "Create an archive in your organization."
  },
  "response": [
    {
      "name": "OK",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\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    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "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    \"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": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\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    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/logs/config/archives",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "logs",
            "config",
            "archives"
          ]
        }
      },
      "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": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\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    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "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": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\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    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "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}"
    }
  ]
}