Chilkat Online Tools

TCL / Datadog API Collection / Get all processes

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

set queryParams [new_CkJsonObject]

CkJsonObject_UpdateString $queryParams "search" "<string>"
CkJsonObject_UpdateString $queryParams "tags" "<string>"
CkJsonObject_UpdateString $queryParams "from" "<long>"
CkJsonObject_UpdateString $queryParams "to" "<long>"
CkJsonObject_UpdateInt $queryParams "page[limit]" 1000
CkJsonObject_UpdateString $queryParams "page[cursor]" "<string>"

CkHttp_SetRequestHeader $http "Accept" "application/json"

# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://api.app.ddog-gov.com/api/v2/processes" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $queryParams
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkJsonObject $queryParams
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "data": [
#     {
#       "attributes": {
#         "cmdline": "<string>",
#         "host": "<string>",
#         "pid": "<long>",
#         "ppid": "<long>",
#         "start": "<string>",
#         "tags": [
#           "<string>",
#           "<string>"
#         ],
#         "timestamp": "<string>",
#         "user": "<string>"
#       },
#       "id": "<string>",
#       "type": "process"
#     },
#     {
#       "attributes": {
#         "cmdline": "<string>",
#         "host": "<string>",
#         "pid": "<long>",
#         "ppid": "<long>",
#         "start": "<string>",
#         "tags": [
#           "<string>",
#           "<string>"
#         ],
#         "timestamp": "<string>",
#         "user": "<string>"
#       },
#       "id": "<string>",
#       "type": "process"
#     }
#   ],
#   "meta": {
#     "page": {
#       "after": "<string>",
#       "size": "<integer>"
#     }
#   }
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

set After [CkJsonObject_stringOf $jResp "meta.page.after"]
set Size [CkJsonObject_stringOf $jResp "meta.page.size"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "data"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set Cmdline [CkJsonObject_stringOf $jResp "data[i].attributes.cmdline"]
    set Host [CkJsonObject_stringOf $jResp "data[i].attributes.host"]
    set Pid [CkJsonObject_stringOf $jResp "data[i].attributes.pid"]
    set Ppid [CkJsonObject_stringOf $jResp "data[i].attributes.ppid"]
    set Start [CkJsonObject_stringOf $jResp "data[i].attributes.start"]
    set Timestamp [CkJsonObject_stringOf $jResp "data[i].attributes.timestamp"]
    set User [CkJsonObject_stringOf $jResp "data[i].attributes.user"]
    set id [CkJsonObject_stringOf $jResp "data[i].id"]
    set v_type [CkJsonObject_stringOf $jResp "data[i].type"]
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "data[i].attributes.tags"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set strVal [CkJsonObject_stringOf $jResp "data[i].attributes.tags[j]"]
        set j [expr $j + 1]
    }
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

curl -G -d "search=%3Cstring%3E"
	-d "tags=%3Cstring%3E"
	-d "from=%3Clong%3E"
	-d "to=%3Clong%3E"
	-d "page[limit]=1000"
	-d "page[cursor]=%3Cstring%3E"
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/processes

Postman Collection Item JSON

{
  "name": "Get all processes",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/processes?search=<string>&tags=<string>&from=<long>&to=<long>&page[limit]=1000&page[cursor]=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "processes"
      ],
      "query": [
        {
          "key": "search",
          "value": "<string>",
          "description": "String to search processes by."
        },
        {
          "key": "tags",
          "value": "<string>",
          "description": "Comma-separated list of tags to filter processes by."
        },
        {
          "key": "from",
          "value": "<long>",
          "description": "Unix timestamp (number of seconds since epoch) of the start of the query window.\nIf not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
        },
        {
          "key": "to",
          "value": "<long>",
          "description": "Unix timestamp (number of seconds since epoch) of the end of the query window.\nIf not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
        },
        {
          "key": "page[limit]",
          "value": "1000",
          "description": "Maximum number of results returned."
        },
        {
          "key": "page[cursor]",
          "value": "<string>",
          "description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.page.after`."
        }
      ]
    },
    "description": "Get all processes for your organization."
  },
  "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/v2/processes?search=<string>&tags=<string>&from=<long>&to=<long>&page[limit]=1000&page[cursor]=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "processes"
          ],
          "query": [
            {
              "key": "search",
              "value": "<string>",
              "description": "String to search processes by."
            },
            {
              "key": "tags",
              "value": "<string>",
              "description": "Comma-separated list of tags to filter processes by."
            },
            {
              "key": "from",
              "value": "<long>",
              "description": "Unix timestamp (number of seconds since epoch) of the start of the query window.\nIf not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
            },
            {
              "key": "to",
              "value": "<long>",
              "description": "Unix timestamp (number of seconds since epoch) of the end of the query window.\nIf not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
            },
            {
              "key": "page[limit]",
              "value": "1000",
              "description": "Maximum number of results returned."
            },
            {
              "key": "page[cursor]",
              "value": "<string>",
              "description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.page.after`."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": [\n    {\n      \"attributes\": {\n        \"cmdline\": \"<string>\",\n        \"host\": \"<string>\",\n        \"pid\": \"<long>\",\n        \"ppid\": \"<long>\",\n        \"start\": \"<string>\",\n        \"tags\": [\n          \"<string>\",\n          \"<string>\"\n        ],\n        \"timestamp\": \"<string>\",\n        \"user\": \"<string>\"\n      },\n      \"id\": \"<string>\",\n      \"type\": \"process\"\n    },\n    {\n      \"attributes\": {\n        \"cmdline\": \"<string>\",\n        \"host\": \"<string>\",\n        \"pid\": \"<long>\",\n        \"ppid\": \"<long>\",\n        \"start\": \"<string>\",\n        \"tags\": [\n          \"<string>\",\n          \"<string>\"\n        ],\n        \"timestamp\": \"<string>\",\n        \"user\": \"<string>\"\n      },\n      \"id\": \"<string>\",\n      \"type\": \"process\"\n    }\n  ],\n  \"meta\": {\n    \"page\": {\n      \"after\": \"<string>\",\n      \"size\": \"<integer>\"\n    }\n  }\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/v2/processes?search=<string>&tags=<string>&from=<long>&to=<long>&page[limit]=1000&page[cursor]=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "processes"
          ],
          "query": [
            {
              "key": "search",
              "value": "<string>",
              "description": "String to search processes by."
            },
            {
              "key": "tags",
              "value": "<string>",
              "description": "Comma-separated list of tags to filter processes by."
            },
            {
              "key": "from",
              "value": "<long>",
              "description": "Unix timestamp (number of seconds since epoch) of the start of the query window.\nIf not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
            },
            {
              "key": "to",
              "value": "<long>",
              "description": "Unix timestamp (number of seconds since epoch) of the end of the query window.\nIf not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
            },
            {
              "key": "page[limit]",
              "value": "1000",
              "description": "Maximum number of results returned."
            },
            {
              "key": "page[cursor]",
              "value": "<string>",
              "description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.page.after`."
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    },
    {
      "name": "Authentication Error",
      "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/v2/processes?search=<string>&tags=<string>&from=<long>&to=<long>&page[limit]=1000&page[cursor]=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "processes"
          ],
          "query": [
            {
              "key": "search",
              "value": "<string>",
              "description": "String to search processes by."
            },
            {
              "key": "tags",
              "value": "<string>",
              "description": "Comma-separated list of tags to filter processes by."
            },
            {
              "key": "from",
              "value": "<long>",
              "description": "Unix timestamp (number of seconds since epoch) of the start of the query window.\nIf not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
            },
            {
              "key": "to",
              "value": "<long>",
              "description": "Unix timestamp (number of seconds since epoch) of the end of the query window.\nIf not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
            },
            {
              "key": "page[limit]",
              "value": "1000",
              "description": "Maximum number of results returned."
            },
            {
              "key": "page[cursor]",
              "value": "<string>",
              "description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.page.after`."
            }
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\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/v2/processes?search=<string>&tags=<string>&from=<long>&to=<long>&page[limit]=1000&page[cursor]=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "processes"
          ],
          "query": [
            {
              "key": "search",
              "value": "<string>",
              "description": "String to search processes by."
            },
            {
              "key": "tags",
              "value": "<string>",
              "description": "Comma-separated list of tags to filter processes by."
            },
            {
              "key": "from",
              "value": "<long>",
              "description": "Unix timestamp (number of seconds since epoch) of the start of the query window.\nIf not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
            },
            {
              "key": "to",
              "value": "<long>",
              "description": "Unix timestamp (number of seconds since epoch) of the end of the query window.\nIf not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
            },
            {
              "key": "page[limit]",
              "value": "1000",
              "description": "Maximum number of results returned."
            },
            {
              "key": "page[cursor]",
              "value": "<string>",
              "description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.page.after`."
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    }
  ]
}