Back to Collection Items
use chilkat();
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = chilkat::CkHttp->new();
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "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"
# }
$json = chilkat::CkJsonObject->new();
$json->UpdateString("name","");
$json->UpdateString("filter.query","source:python");
$json->UpdateString("id","consequat elit non");
$json->UpdateBool("is_enabled",1);
$json->UpdateBool("is_read_only",1);
$json->UpdateString("processors[0].source","message");
$json->UpdateString("processors[0].grok.match_rules","rule_name_1 foo\nrule_name_2 bar\n");
$json->UpdateString("processors[0].grok.support_rules","rule_name_1 foo\nrule_name_2 bar\n");
$json->UpdateString("processors[0].type","grok-parser");
$json->UpdateBool("processors[0].is_enabled",0);
$json->UpdateString("processors[0].name","nostrud Excepteur");
$json->UpdateString("processors[0].samples[0]","sit ea ullamco");
$json->UpdateString("processors[0].samples[1]","sunt est laboris");
$json->UpdateString("processors[1].source","message");
$json->UpdateString("processors[1].grok.match_rules","rule_name_1 foo\nrule_name_2 bar\n");
$json->UpdateString("processors[1].grok.support_rules","rule_name_1 foo\nrule_name_2 bar\n");
$json->UpdateString("processors[1].type","grok-parser");
$json->UpdateBool("processors[1].is_enabled",0);
$json->UpdateString("processors[1].name","exercitation do Ut");
$json->UpdateString("processors[1].samples[0]","ut");
$json->UpdateString("processors[1].samples[1]","nulla tempor amet");
$json->UpdateString("type","pipeline");
$http->SetRequestHeader("Content-Type","application/json");
$http->SetRequestHeader("Accept","application/json");
# resp is a HttpResponse
$resp = $http->PostJson3("https://api.app.ddog-gov.com/api/v1/logs/config/pipelines","application/json",$json);
if ($http->get_LastMethodSuccess() == 0) {
print $http->lastErrorText() . "\r\n";
exit;
}
$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);
$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);
print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";
$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
print "Response Header:" . "\r\n";
print $resp->header() . "\r\n";
print "Failed." . "\r\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 POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"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"
}'
https://api.app.ddog-gov.com/api/v1/logs/config/pipelines
Postman Collection Item JSON
{
"name": "Create a pipeline",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipelines",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipelines"
]
},
"description": "Create a pipeline in your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"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 \"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": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipelines",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipelines"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "null"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"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": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"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}"
}
]
}
