Back to Collection Items
IncludeFile "CkJsonArray.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkJsonObject.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://api.app.ddog-gov.com/api/v1/logs/config/pipelines",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jarrResp.i = CkJsonArray::ckCreate()
If jarrResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonArray::ckLoadSb(jarrResp,sbResponseBody)
CkJsonArray::setCkEmitCompact(jarrResp, 0)
Debug "Response Body:"
Debug CkJsonArray::ckEmit(jarrResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonArray::ckDispose(jarrResp)
ProcedureReturn
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; [
; {
; "name": "",
; "filter": {
; "query": "source:python"
; },
; "id": "enim nostrud in Lorem cillum",
; "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": "commodo dolor et",
; "samples": [
; "qui commodo Duis sunt dolor",
; "Duis dolore ipsum"
; ]
; },
; {
; "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": "quis",
; "samples": [
; "ut nisi in proident",
; "magna esse occaecat"
; ]
; }
; ],
; "type": "pipeline"
; },
; {
; "name": "",
; "filter": {
; "query": "source:python"
; },
; "id": "non enim mollit",
; "is_enabled": false,
; "is_read_only": false,
; "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": "cupidatat consectetur",
; "samples": [
; "officia sunt",
; "irure"
; ]
; },
; {
; "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": "in tempor id ullamco aute",
; "samples": [
; "culpa id ullamco",
; "aute enim"
; ]
; }
; ],
; "type": "pipeline"
; }
; ]
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
json.i
name.s
Query.s
id.s
is_enabled.i
is_read_only.i
v_type.s
j.i
count_j.i
source.s
Match_rules.s
Support_rules.s
k.i
count_k.i
strVal.s
i.i = 0
count_i.i = CkJsonArray::ckSize(jarrResp)
While i < count_i
json = CkJsonArray::ckObjectAt(jarrResp,i)
name = CkJsonObject::ckStringOf(json,"name")
Query = CkJsonObject::ckStringOf(json,"filter.query")
id = CkJsonObject::ckStringOf(json,"id")
is_enabled = CkJsonObject::ckBoolOf(json,"is_enabled")
is_read_only = CkJsonObject::ckBoolOf(json,"is_read_only")
v_type = CkJsonObject::ckStringOf(json,"type")
j = 0
count_j = CkJsonObject::ckSizeOfArray(json,"processors")
While j < count_j
CkJsonObject::setCkJ(json, j)
source = CkJsonObject::ckStringOf(json,"processors[j].source")
Match_rules = CkJsonObject::ckStringOf(json,"processors[j].grok.match_rules")
Support_rules = CkJsonObject::ckStringOf(json,"processors[j].grok.support_rules")
v_type = CkJsonObject::ckStringOf(json,"processors[j].type")
is_enabled = CkJsonObject::ckBoolOf(json,"processors[j].is_enabled")
name = CkJsonObject::ckStringOf(json,"processors[j].name")
k = 0
count_k = CkJsonObject::ckSizeOfArray(json,"processors[j].samples")
While k < count_k
CkJsonObject::setCkK(json, k)
strVal = CkJsonObject::ckStringOf(json,"processors[j].samples[k]")
k = k + 1
Wend
j = j + 1
Wend
CkJsonObject::ckDispose(json)
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonArray::ckDispose(jarrResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X GET
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/logs/config/pipelines
Postman Collection Item JSON
{
"name": "Get all pipelines",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/pipelines",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"pipelines"
]
},
"description": "Get all pipelines 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",
"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 {\n \"name\": \"\",\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"id\": \"enim nostrud in Lorem cillum\",\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\": \"commodo dolor et\",\n \"samples\": [\n \"qui commodo Duis sunt dolor\",\n \"Duis dolore ipsum\"\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\": \"quis\",\n \"samples\": [\n \"ut nisi in proident\",\n \"magna esse occaecat\"\n ]\n }\n ],\n \"type\": \"pipeline\"\n },\n {\n \"name\": \"\",\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"id\": \"non enim mollit\",\n \"is_enabled\": false,\n \"is_read_only\": false,\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\": \"cupidatat consectetur\",\n \"samples\": [\n \"officia sunt\",\n \"irure\"\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\": \"in tempor id ullamco aute\",\n \"samples\": [\n \"culpa id ullamco\",\n \"aute enim\"\n ]\n }\n ],\n \"type\": \"pipeline\"\n }\n]"
},
{
"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",
"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": "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",
"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}"
}
]
}
