Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
// 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"
// }
loJson = createobject("CkJsonObject")
loJson.UpdateString("name","")
loJson.UpdateString("filter.query","source:python")
loJson.UpdateString("id","consequat elit non")
loJson.UpdateBool("is_enabled",.T.)
loJson.UpdateBool("is_read_only",.T.)
loJson.UpdateString("processors[0].source","message")
loJson.UpdateString("processors[0].grok.match_rules","rule_name_1 foo" + Chr(10) + "rule_name_2 bar" + Chr(10))
loJson.UpdateString("processors[0].grok.support_rules","rule_name_1 foo" + Chr(10) + "rule_name_2 bar" + Chr(10))
loJson.UpdateString("processors[0].type","grok-parser")
loJson.UpdateBool("processors[0].is_enabled",.F.)
loJson.UpdateString("processors[0].name","nostrud Excepteur")
loJson.UpdateString("processors[0].samples[0]","sit ea ullamco")
loJson.UpdateString("processors[0].samples[1]","sunt est laboris")
loJson.UpdateString("processors[1].source","message")
loJson.UpdateString("processors[1].grok.match_rules","rule_name_1 foo" + Chr(10) + "rule_name_2 bar" + Chr(10))
loJson.UpdateString("processors[1].grok.support_rules","rule_name_1 foo" + Chr(10) + "rule_name_2 bar" + Chr(10))
loJson.UpdateString("processors[1].type","grok-parser")
loJson.UpdateBool("processors[1].is_enabled",.F.)
loJson.UpdateString("processors[1].name","exercitation do Ut")
loJson.UpdateString("processors[1].samples[0]","ut")
loJson.UpdateString("processors[1].samples[1]","nulla tempor amet")
loJson.UpdateString("type","pipeline")
loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("Accept","application/json")
loSbRequestBody = createobject("CkStringBuilder")
loJson.EmitSb(loSbRequestBody)
loResp = loHttp.PTextSb("PUT","https://api.app.ddog-gov.com/api/v1/logs/config/pipelines/:pipeline_id",loSbRequestBody,"utf-8","application/json",.F.,.F.)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loJson
release loSbRequestBody
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loJson
release loSbRequestBody
release loSbResponseBody
release loJResp
return
endif
release loResp
// 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
lcName = loJResp.StringOf("name")
lcQuery = loJResp.StringOf("filter.query")
lcId = loJResp.StringOf("id")
llIs_enabled = loJResp.BoolOf("is_enabled")
llIs_read_only = loJResp.BoolOf("is_read_only")
lcV_type = loJResp.StringOf("type")
i = 0
lnCount_i = loJResp.SizeOfArray("processors")
do while i < lnCount_i
loJResp.I = i
lcSource = loJResp.StringOf("processors[i].source")
lcMatch_rules = loJResp.StringOf("processors[i].grok.match_rules")
lcSupport_rules = loJResp.StringOf("processors[i].grok.support_rules")
lcV_type = loJResp.StringOf("processors[i].type")
llIs_enabled = loJResp.BoolOf("processors[i].is_enabled")
lcName = loJResp.StringOf("processors[i].name")
j = 0
lnCount_j = loJResp.SizeOfArray("processors[i].samples")
do while j < lnCount_j
loJResp.J = j
lcStrVal = loJResp.StringOf("processors[i].samples[j]")
j = j + 1
enddo
i = i + 1
enddo
release loHttp
release loJson
release loSbRequestBody
release loSbResponseBody
release loJResp
Curl Command
curl -X PUT
-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/:pipeline_id
Postman Collection Item JSON
{
"name": "Update a pipeline",
"request": {
"method": "PUT",
"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/:pipeline_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipelines",
":pipeline_id"
],
"variable": [
{
"key": "pipeline_id",
"value": "tempor Ut sed velit"
}
]
},
"description": "Update a given pipeline configuration to change it’s processors or their order.\n\n**Note**: Using this method updates your pipeline configuration by **replacing**\nyour current configuration with the new one sent to your Datadog organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"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/: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": "PUT",
"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/: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": "PUT",
"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/: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": "PUT",
"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/: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}"
}
]
}
