Chilkat Online Tools

phpExt / Datadog API Collection / Get a pipeline

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$http = new CkHttp();

$http->SetRequestHeader('Accept','application/json');

$sbResponseBody = new CkStringBuilder();
$success = $http->QuickGetSb('https://api.app.ddog-gov.com/api/v1/logs/config/pipelines/:pipeline_id',$sbResponseBody);
if ($success == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $http->get_LastStatus();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $http->lastHeader() . "\n";
    print 'Failed.' . "\n";
    exit;
}

// 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

$name = $jResp->stringOf('name');
$Query = $jResp->stringOf('filter.query');
$id = $jResp->stringOf('id');
$is_enabled = $jResp->BoolOf('is_enabled');
$is_read_only = $jResp->BoolOf('is_read_only');
$v_type = $jResp->stringOf('type');
$i = 0;
$count_i = $jResp->SizeOfArray('processors');
while ($i < $count_i) {
    $jResp->put_I($i);
    $source = $jResp->stringOf('processors[i].source');
    $Match_rules = $jResp->stringOf('processors[i].grok.match_rules');
    $Support_rules = $jResp->stringOf('processors[i].grok.support_rules');
    $v_type = $jResp->stringOf('processors[i].type');
    $is_enabled = $jResp->BoolOf('processors[i].is_enabled');
    $name = $jResp->stringOf('processors[i].name');
    $j = 0;
    $count_j = $jResp->SizeOfArray('processors[i].samples');
    while ($j < $count_j) {
        $jResp->put_J($j);
        $strVal = $jResp->stringOf('processors[i].samples[j]');
        $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/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}"
    }
  ]
}