Chilkat Online Tools

Swift / Datadog API Collection / Get all indexes

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

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

    let sbResponseBody = CkoStringBuilder()
    success = http.QuickGetSb("https://api.app.ddog-gov.com/api/v1/logs/config/indexes", sbContent: sbResponseBody)
    if success == false {
        print("\(http.LastErrorText)")
        return
    }

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

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

    var respStatusCode: Int = http.LastStatus.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(http.LastHeader)")
        print("Failed.")
        return
    }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "indexes": [
    //     {
    //       "name": "main",
    //       "filter": {
    //         "query": "source:python"
    //       },
    //       "daily_limit": 300000000,
    //       "exclusion_filters": [
    //         {
    //           "name": "payment",
    //           "filter": {
    //             "sample_rate": 1,
    //             "query": "*"
    //           },
    //           "is_enabled": false
    //         },
    //         {
    //           "name": "payment",
    //           "filter": {
    //             "sample_rate": 1,
    //             "query": "*"
    //           },
    //           "is_enabled": false
    //         }
    //       ],
    //       "is_rate_limited": false,
    //       "num_retention_days": 15
    //     },
    //     {
    //       "name": "main",
    //       "filter": {
    //         "query": "source:python"
    //       },
    //       "daily_limit": 300000000,
    //       "exclusion_filters": [
    //         {
    //           "name": "payment",
    //           "filter": {
    //             "sample_rate": 1,
    //             "query": "*"
    //           },
    //           "is_enabled": false
    //         },
    //         {
    //           "name": "payment",
    //           "filter": {
    //             "sample_rate": 1,
    //             "query": "*"
    //           },
    //           "is_enabled": false
    //         }
    //       ],
    //       "is_rate_limited": false,
    //       "num_retention_days": 15
    //     }
    //   ]
    // }

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

    var name: String?
    var Query: String?
    var daily_limit: Int
    var is_rate_limited: Bool
    var num_retention_days: Int
    var j: Int
    var count_j: Int
    var Sample_rate: Int
    var filterQuery: String?
    var is_enabled: Bool

    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("indexes").intValue
    while i < count_i {
        jResp.I = i
        name = jResp.StringOf("indexes[i].name")
        Query = jResp.StringOf("indexes[i].filter.query")
        daily_limit = jResp.IntOf("indexes[i].daily_limit").intValue
        is_rate_limited = jResp.BoolOf("indexes[i].is_rate_limited")
        num_retention_days = jResp.IntOf("indexes[i].num_retention_days").intValue
        j = 0
        count_j = jResp.SizeOfArray("indexes[i].exclusion_filters").intValue
        while j < count_j {
            jResp.J = j
            name = jResp.StringOf("indexes[i].exclusion_filters[j].name")
            Sample_rate = jResp.IntOf("indexes[i].exclusion_filters[j].filter.sample_rate").intValue
            filterQuery = jResp.StringOf("indexes[i].exclusion_filters[j].filter.query")
            is_enabled = jResp.BoolOf("indexes[i].exclusion_filters[j].is_enabled")
            j = j + 1
        }

        i = i + 1
    }


}

Curl Command

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

Postman Collection Item JSON

{
  "name": "Get all indexes",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v1/logs/config/indexes",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "logs",
        "config",
        "indexes"
      ]
    },
    "description": "The Index object describes the configuration of a log index.\nThis endpoint returns an array of the `LogIndex` objects of 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/v1/logs/config/indexes",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "logs",
            "config",
            "indexes"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"indexes\": [\n    {\n      \"name\": \"main\",\n      \"filter\": {\n        \"query\": \"source:python\"\n      },\n      \"daily_limit\": 300000000,\n      \"exclusion_filters\": [\n        {\n          \"name\": \"payment\",\n          \"filter\": {\n            \"sample_rate\": 1,\n            \"query\": \"*\"\n          },\n          \"is_enabled\": false\n        },\n        {\n          \"name\": \"payment\",\n          \"filter\": {\n            \"sample_rate\": 1,\n            \"query\": \"*\"\n          },\n          \"is_enabled\": false\n        }\n      ],\n      \"is_rate_limited\": false,\n      \"num_retention_days\": 15\n    },\n    {\n      \"name\": \"main\",\n      \"filter\": {\n        \"query\": \"source:python\"\n      },\n      \"daily_limit\": 300000000,\n      \"exclusion_filters\": [\n        {\n          \"name\": \"payment\",\n          \"filter\": {\n            \"sample_rate\": 1,\n            \"query\": \"*\"\n          },\n          \"is_enabled\": false\n        },\n        {\n          \"name\": \"payment\",\n          \"filter\": {\n            \"sample_rate\": 1,\n            \"query\": \"*\"\n          },\n          \"is_enabled\": false\n        }\n      ],\n      \"is_rate_limited\": false,\n      \"num_retention_days\": 15\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/v1/logs/config/indexes",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "logs",
            "config",
            "indexes"
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\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/v1/logs/config/indexes",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "logs",
            "config",
            "indexes"
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    }
  ]
}