Chilkat Online Tools

Swift / Datadog API Collection / Create an archive

Back to Collection Items

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

    let http = CkoHttp()
    var success: Bool

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

    let json = CkoJsonObject()
    json.UpdateString("data.type", value: "archives")
    json.UpdateString("data.attributes.name", value: "<string>")
    json.UpdateString("data.attributes.query", value: "<string>")
    json.UpdateString("data.attributes.destination.storage_account", value: "<string>")
    json.UpdateString("data.attributes.destination.container", value: "<string>")
    json.UpdateString("data.attributes.destination.integration.tenant_id", value: "<string>")
    json.UpdateString("data.attributes.destination.integration.client_id", value: "<string>")
    json.UpdateString("data.attributes.destination.type", value: "azure")
    json.UpdateString("data.attributes.destination.path", value: "<string>")
    json.UpdateString("data.attributes.destination.region", value: "<string>")
    json.UpdateBool("data.attributes.include_tags", value: false)
    json.UpdateString("data.attributes.rehydration_max_scan_size_in_gb", value: "<long>")
    json.UpdateString("data.attributes.rehydration_tags[0]", value: "<string>")
    json.UpdateString("data.attributes.rehydration_tags[1]", value: "<string>")

    http.SetRequestHeader("Content-Type", value: "application/json")
    http.SetRequestHeader("Accept", value: "application/json")

    var resp: CkoHttpResponse? = http.PostJson3("https://api.app.ddog-gov.com/api/v2/logs/config/archives", contentType: "application/json", json: json)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    let sbResponseBody = CkoStringBuilder()
    resp!.GetBodySb(sbResponseBody)

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = resp!.StatusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.Header)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

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

    var strVal: String?

    var v_Type: String? = jResp.StringOf("data.type")
    var Name: String? = jResp.StringOf("data.attributes.name")
    var Query: String? = jResp.StringOf("data.attributes.query")
    var Storage_account: String? = jResp.StringOf("data.attributes.destination.storage_account")
    var Container: String? = jResp.StringOf("data.attributes.destination.container")
    var Tenant_id: String? = jResp.StringOf("data.attributes.destination.integration.tenant_id")
    var Client_id: String? = jResp.StringOf("data.attributes.destination.integration.client_id")
    var DestinationType: String? = jResp.StringOf("data.attributes.destination.type")
    var Path: String? = jResp.StringOf("data.attributes.destination.path")
    var Region: String? = jResp.StringOf("data.attributes.destination.region")
    var Include_tags: Bool = jResp.BoolOf("data.attributes.include_tags")
    var Rehydration_max_scan_size_in_gb: String? = jResp.StringOf("data.attributes.rehydration_max_scan_size_in_gb")
    var State: String? = jResp.StringOf("data.attributes.state")
    var Id: String? = jResp.StringOf("data.id")
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("data.attributes.rehydration_tags").intValue
    while i < count_i {
        jResp.I = i
        strVal = jResp.StringOf("data.attributes.rehydration_tags[i]")
        i = i + 1
    }


}

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