Chilkat Online Tools

Swift / Datadog API Collection / Get an index

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/:name", 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)

    // {
    //   "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": true
    //     }
    //   ],
    //   "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 Sample_rate: Int
    var filterQuery: String?
    var is_enabled: Bool

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


}

Curl Command

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

Postman Collection Item JSON

{
  "name": "Get an index",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v1/logs/config/indexes/:name",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "logs",
        "config",
        "indexes",
        ":name"
      ],
      "variable": [
        {
          "key": "name",
          "value": "tempor Ut sed velit"
        }
      ]
    },
    "description": "Get one log index from your organization. This endpoint takes no JSON arguments."
  },
  "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/:name",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "logs",
            "config",
            "indexes",
            ":name"
          ],
          "variable": [
            {
              "key": "name"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\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\": true\n    }\n  ],\n  \"is_rate_limited\": false,\n  \"num_retention_days\": 15\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/:name",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "logs",
            "config",
            "indexes",
            ":name"
          ],
          "variable": [
            {
              "key": "name"
            }
          ]
        }
      },
      "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": "Not Found",
      "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/:name",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "logs",
            "config",
            "indexes",
            ":name"
          ],
          "variable": [
            {
              "key": "name"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "null"
    },
    {
      "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/:name",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "logs",
            "config",
            "indexes",
            ":name"
          ],
          "variable": [
            {
              "key": "name"
            }
          ]
        }
      },
      "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}"
    }
  ]
}