Chilkat Online Tools

TCL / Datadog API Collection / Get all pipelines

Back to Collection Items

load ./chilkat.dll

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set http [new_CkHttp]

CkHttp_SetRequestHeader $http "Accept" "application/json"

set sbResponseBody [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://api.app.ddog-gov.com/api/v1/logs/config/pipelines" $sbResponseBody]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jarrResp [new_CkJsonArray]

CkJsonArray_LoadSb $jarrResp $sbResponseBody
CkJsonArray_put_EmitCompact $jarrResp 0

puts "Response Body:"
puts [CkJsonArray_emit $jarrResp]

set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttp_lastHeader $http]
    puts "Failed."
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonArray $jarrResp
    exit
}

# 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

# json is a CkJsonObject

set i 0
set count_i [CkJsonArray_get_Size $jarrResp]
while {$i < $count_i} {
    set json [CkJsonArray_ObjectAt $jarrResp $i]
    set name [CkJsonObject_stringOf $json "name"]
    set Query [CkJsonObject_stringOf $json "filter.query"]
    set id [CkJsonObject_stringOf $json "id"]
    set is_enabled [CkJsonObject_BoolOf $json "is_enabled"]
    set is_read_only [CkJsonObject_BoolOf $json "is_read_only"]
    set v_type [CkJsonObject_stringOf $json "type"]
    set j 0
    set count_j [CkJsonObject_SizeOfArray $json "processors"]
    while {$j < $count_j} {
        CkJsonObject_put_J $json $j
        set source [CkJsonObject_stringOf $json "processors[j].source"]
        set Match_rules [CkJsonObject_stringOf $json "processors[j].grok.match_rules"]
        set Support_rules [CkJsonObject_stringOf $json "processors[j].grok.support_rules"]
        set v_type [CkJsonObject_stringOf $json "processors[j].type"]
        set is_enabled [CkJsonObject_BoolOf $json "processors[j].is_enabled"]
        set name [CkJsonObject_stringOf $json "processors[j].name"]
        set k 0
        set count_k [CkJsonObject_SizeOfArray $json "processors[j].samples"]
        while {$k < $count_k} {
            CkJsonObject_put_K $json $k
            set strVal [CkJsonObject_stringOf $json "processors[j].samples[k]"]
            set k [expr $k + 1]
        }
        set j [expr $j + 1]
    }
    delete_CkJsonObject $json

    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonArray $jarrResp

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