Chilkat Online Tools

DataFlex / Datadog API Collection / Get a pipeline

Back to Collection Items

Use ChilkatAx-9.5.0-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Handle hoJResp
    Integer iRespStatusCode
    String sSource
    String sMatch_rules
    String sSupport_rules
    Integer j
    Integer iCount_j
    String sStrVal
    String sName
    String sQuery
    String sId
    Boolean iIs_enabled
    Boolean iIs_read_only
    String sV_type
    Integer i
    Integer iCount_i
    String sTemp1

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    Send ComSetRequestHeader To hoHttp "Accept" "application/json"

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComQuickGetSb Of hoHttp "https://api.app.ddog-gov.com/api/v1/logs/config/pipelines/:pipeline_id" vSbResponseBody To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
    If (Not(IsComObjectCreated(hoJResp))) Begin
        Send CreateComObject of hoJResp
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
    Set ComEmitCompact Of hoJResp To False

    Showln "Response Body:"
    Get ComEmit Of hoJResp To sTemp1
    Showln sTemp1

    Get ComLastStatus Of hoHttp To iRespStatusCode
    Showln "Response Status Code = " iRespStatusCode
    If (iRespStatusCode >= 400) Begin
        Showln "Response Header:"
        Get ComLastHeader Of hoHttp To sTemp1
        Showln sTemp1
        Showln "Failed."
        Procedure_Return
    End

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

    // {
    //   "name": "",
    //   "filter": {
    //     "query": "source:python"
    //   },
    //   "id": "consequat elit non",
    //   "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": "nostrud Excepteur",
    //       "samples": [
    //         "sit ea ullamco",
    //         "sunt est laboris"
    //       ]
    //     },
    //     {
    //       "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": "exercitation do Ut",
    //       "samples": [
    //         "ut",
    //         "nulla tempor amet"
    //       ]
    //     }
    //   ],
    //   "type": "pipeline"
    // }

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

    Get ComStringOf Of hoJResp "name" To sName
    Get ComStringOf Of hoJResp "filter.query" To sQuery
    Get ComStringOf Of hoJResp "id" To sId
    Get ComBoolOf Of hoJResp "is_enabled" To iIs_enabled
    Get ComBoolOf Of hoJResp "is_read_only" To iIs_read_only
    Get ComStringOf Of hoJResp "type" To sV_type
    Move 0 To i
    Get ComSizeOfArray Of hoJResp "processors" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJResp To i
        Get ComStringOf Of hoJResp "processors[i].source" To sSource
        Get ComStringOf Of hoJResp "processors[i].grok.match_rules" To sMatch_rules
        Get ComStringOf Of hoJResp "processors[i].grok.support_rules" To sSupport_rules
        Get ComStringOf Of hoJResp "processors[i].type" To sV_type
        Get ComBoolOf Of hoJResp "processors[i].is_enabled" To iIs_enabled
        Get ComStringOf Of hoJResp "processors[i].name" To sName
        Move 0 To j
        Get ComSizeOfArray Of hoJResp "processors[i].samples" To iCount_j
        While (j < iCount_j)
            Set ComJ Of hoJResp To j
            Get ComStringOf Of hoJResp "processors[i].samples[j]" To sStrVal
            Move (j + 1) To j
        Loop

        Move (i + 1) To i
    Loop



End_Procedure

Curl Command

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

Postman Collection Item JSON

{
  "name": "Get a pipeline",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v1/logs/config/pipelines/:pipeline_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "logs",
        "config",
        "pipelines",
        ":pipeline_id"
      ],
      "variable": [
        {
          "key": "pipeline_id",
          "value": "tempor Ut sed velit"
        }
      ]
    },
    "description": "Get a specific pipeline 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/:pipeline_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "logs",
            "config",
            "pipelines",
            ":pipeline_id"
          ],
          "variable": [
            {
              "key": "pipeline_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"name\": \"\",\n  \"filter\": {\n    \"query\": \"source:python\"\n  },\n  \"id\": \"consequat elit non\",\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\": \"nostrud Excepteur\",\n      \"samples\": [\n        \"sit ea ullamco\",\n        \"sunt est laboris\"\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\": \"exercitation do Ut\",\n      \"samples\": [\n        \"ut\",\n        \"nulla tempor amet\"\n      ]\n    }\n  ],\n  \"type\": \"pipeline\"\n}"
    },
    {
      "name": "Bad Request",
      "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/:pipeline_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "logs",
            "config",
            "pipelines",
            ":pipeline_id"
          ],
          "variable": [
            {
              "key": "pipeline_id"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "null"
    },
    {
      "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/:pipeline_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "logs",
            "config",
            "pipelines",
            ":pipeline_id"
          ],
          "variable": [
            {
              "key": "pipeline_id"
            }
          ]
        }
      },
      "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/:pipeline_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "logs",
            "config",
            "pipelines",
            ":pipeline_id"
          ],
          "variable": [
            {
              "key": "pipeline_id"
            }
          ]
        }
      },
      "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}"
    }
  ]
}