Chilkat Online Tools

Swift / Datadog API Collection / Get all pipelines

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/pipelines", sbContent: sbResponseBody)
    if success == false {
        print("\(http.LastErrorText)")
        return
    }

    let jarrResp = CkoJsonArray()
    jarrResp.LoadSb(sbResponseBody)
    jarrResp.EmitCompact = false

    print("Response Body:")
    print("\(jarrResp.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": "",
    //     "filter": {
    //       "query": "source:python"
    //     },
    //     "id": "enim nostrud in Lorem cillum",
    //     "is_enabled": true,
    //     "is_read_only": true,
    //     "processors": [
    //       {
    //         "source": "message",
    //         "grok": {
    //           "match_rules": "rule_name_1 foo\nrule_name_2 bar\n",
    //           "support_rules": "rule_name_1 foo\nrule_name_2 bar\n"
    //         },
    //         "type": "grok-parser",
    //         "is_enabled": false,
    //         "name": "commodo dolor et",
    //         "samples": [
    //           "qui commodo Duis sunt dolor",
    //           "Duis dolore ipsum"
    //         ]
    //       },
    //       {
    //         "source": "message",
    //         "grok": {
    //           "match_rules": "rule_name_1 foo\nrule_name_2 bar\n",
    //           "support_rules": "rule_name_1 foo\nrule_name_2 bar\n"
    //         },
    //         "type": "grok-parser",
    //         "is_enabled": false,
    //         "name": "quis",
    //         "samples": [
    //           "ut nisi in proident",
    //           "magna esse occaecat"
    //         ]
    //       }
    //     ],
    //     "type": "pipeline"
    //   },
    //   {
    //     "name": "",
    //     "filter": {
    //       "query": "source:python"
    //     },
    //     "id": "non enim mollit",
    //     "is_enabled": false,
    //     "is_read_only": false,
    //     "processors": [
    //       {
    //         "source": "message",
    //         "grok": {
    //           "match_rules": "rule_name_1 foo\nrule_name_2 bar\n",
    //           "support_rules": "rule_name_1 foo\nrule_name_2 bar\n"
    //         },
    //         "type": "grok-parser",
    //         "is_enabled": false,
    //         "name": "cupidatat consectetur",
    //         "samples": [
    //           "officia sunt",
    //           "irure"
    //         ]
    //       },
    //       {
    //         "source": "message",
    //         "grok": {
    //           "match_rules": "rule_name_1 foo\nrule_name_2 bar\n",
    //           "support_rules": "rule_name_1 foo\nrule_name_2 bar\n"
    //         },
    //         "type": "grok-parser",
    //         "is_enabled": false,
    //         "name": "in tempor id ullamco aute",
    //         "samples": [
    //           "culpa id ullamco",
    //           "aute enim"
    //         ]
    //       }
    //     ],
    //     "type": "pipeline"
    //   }
    // ]

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

    var json: CkoJsonObject?
    var name: String?
    var Query: String?
    var id: String?
    var is_enabled: Bool
    var is_read_only: Bool
    var v_type: String?
    var j: Int
    var count_j: Int
    var source: String?
    var Match_rules: String?
    var Support_rules: String?
    var k: Int
    var count_k: Int
    var strVal: String?

    var i: Int = 0
    var count_i: Int = jarrResp.Size.intValue
    while i < count_i {
        json = jarrResp.ObjectAt(i)
        name = json!.StringOf("name")
        Query = json!.StringOf("filter.query")
        id = json!.StringOf("id")
        is_enabled = json!.BoolOf("is_enabled")
        is_read_only = json!.BoolOf("is_read_only")
        v_type = json!.StringOf("type")
        j = 0
        count_j = json!.SizeOfArray("processors").intValue
        while j < count_j {
            json.J = j
            source = json!.StringOf("processors[j].source")
            Match_rules = json!.StringOf("processors[j].grok.match_rules")
            Support_rules = json!.StringOf("processors[j].grok.support_rules")
            v_type = json!.StringOf("processors[j].type")
            is_enabled = json!.BoolOf("processors[j].is_enabled")
            name = json!.StringOf("processors[j].name")
            k = 0
            count_k = json!.SizeOfArray("processors[j].samples").intValue
            while k < count_k {
                json.K = k
                strVal = json!.StringOf("processors[j].samples[k]")
                k = k + 1
            }

            j = j + 1
        }

        json = nil
        i = i + 1
    }


}

Curl Command

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

Postman Collection Item JSON

{
  "name": "Get all pipelines",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v1/logs/config/pipelines",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "logs",
        "config",
        "pipelines"
      ]
    },
    "description": "Get all pipelines from your organization.\nThis 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/pipelines",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "logs",
            "config",
            "pipelines"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "[\n  {\n    \"name\": \"\",\n    \"filter\": {\n      \"query\": \"source:python\"\n    },\n    \"id\": \"enim nostrud in Lorem cillum\",\n    \"is_enabled\": true,\n    \"is_read_only\": true,\n    \"processors\": [\n      {\n        \"source\": \"message\",\n        \"grok\": {\n          \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n          \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n        },\n        \"type\": \"grok-parser\",\n        \"is_enabled\": false,\n        \"name\": \"commodo dolor et\",\n        \"samples\": [\n          \"qui commodo Duis sunt dolor\",\n          \"Duis dolore ipsum\"\n        ]\n      },\n      {\n        \"source\": \"message\",\n        \"grok\": {\n          \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n          \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n        },\n        \"type\": \"grok-parser\",\n        \"is_enabled\": false,\n        \"name\": \"quis\",\n        \"samples\": [\n          \"ut nisi in proident\",\n          \"magna esse occaecat\"\n        ]\n      }\n    ],\n    \"type\": \"pipeline\"\n  },\n  {\n    \"name\": \"\",\n    \"filter\": {\n      \"query\": \"source:python\"\n    },\n    \"id\": \"non enim mollit\",\n    \"is_enabled\": false,\n    \"is_read_only\": false,\n    \"processors\": [\n      {\n        \"source\": \"message\",\n        \"grok\": {\n          \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n          \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n        },\n        \"type\": \"grok-parser\",\n        \"is_enabled\": false,\n        \"name\": \"cupidatat consectetur\",\n        \"samples\": [\n          \"officia sunt\",\n          \"irure\"\n        ]\n      },\n      {\n        \"source\": \"message\",\n        \"grok\": {\n          \"match_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\",\n          \"support_rules\": \"rule_name_1 foo\\nrule_name_2 bar\\n\"\n        },\n        \"type\": \"grok-parser\",\n        \"is_enabled\": false,\n        \"name\": \"in tempor id ullamco aute\",\n        \"samples\": [\n          \"culpa id ullamco\",\n          \"aute enim\"\n        ]\n      }\n    ],\n    \"type\": \"pipeline\"\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/pipelines",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "logs",
            "config",
            "pipelines"
          ]
        }
      },
      "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/pipelines",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "logs",
            "config",
            "pipelines"
          ]
        }
      },
      "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}"
    }
  ]
}