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")
loHttp.SetRequestHeader("Accept","application/json")
loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://api.app.ddog-gov.com/api/v1/logs/config/pipelines/:pipeline_id",loSbResponseBody)
if (llSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loSbResponseBody
return
endif
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loHttp.LastHeader
? "Failed."
release loHttp
release loSbResponseBody
release loJResp
return
endif
// 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 loSbResponseBody
release loJResp
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}"
}
]
}
