Chilkat Online Tools

Ruby / Datadog API Collection / Get all processes

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("search","<string>")
queryParams.UpdateString("tags","<string>")
queryParams.UpdateString("from","<long>")
queryParams.UpdateString("to","<long>")
queryParams.UpdateInt("page[limit]",1000)
queryParams.UpdateString("page[cursor]","<string>")

http.SetRequestHeader("Accept","application/json")

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/processes",queryParams)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

# 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

After = jResp.stringOf("meta.page.after")
Size = jResp.stringOf("meta.page.size")
i = 0
count_i = jResp.SizeOfArray("data")
while i < count_i
    jResp.put_I(i)
    Cmdline = jResp.stringOf("data[i].attributes.cmdline")
    Host = jResp.stringOf("data[i].attributes.host")
    Pid = jResp.stringOf("data[i].attributes.pid")
    Ppid = jResp.stringOf("data[i].attributes.ppid")
    Start = jResp.stringOf("data[i].attributes.start")
    Timestamp = jResp.stringOf("data[i].attributes.timestamp")
    User = jResp.stringOf("data[i].attributes.user")
    id = jResp.stringOf("data[i].id")
    v_type = jResp.stringOf("data[i].type")
    j = 0
    count_j = jResp.SizeOfArray("data[i].attributes.tags")
    while j < count_j
        jResp.put_J(j)
        strVal = jResp.stringOf("data[i].attributes.tags[j]")
        j = j + 1
    end
    i = i + 1
end

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}"
    }
  ]
}