Chilkat Online Tools

Ruby / Datadog API Collection / Submit a Service Check

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()

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# [
#   {
#     "check": "app.ok",
#     "status": 0,
#     "tags": [
#       "environment:test"
#     ],
#     "host_name": "app.host1",
#     "message": "app is running",
#     "timestamp": 12636800
#   },
#   {
#     "check": "app.ok",
#     "status": 0,
#     "tags": [
#       "environment:test"
#     ],
#     "host_name": "app.host1",
#     "message": "app is running",
#     "timestamp": -99255440
#   }
# ]

jarr = Chilkat::CkJsonArray.new()

jarr.AddObjectAt(-1)
# jsonObj_1 is a CkJsonObject
jsonObj_1 = jarr.ObjectAt(jarr.get_Size() - 1)
jsonObj_1.UpdateString("check","app.ok")
jsonObj_1.UpdateInt("status",0)
jsonObj_1.UpdateString("tags[0]","environment:test")
jsonObj_1.UpdateString("host_name","app.host1")
jsonObj_1.UpdateString("message","app is running")
jsonObj_1.UpdateInt("timestamp",12636800)

jarr.AddObjectAt(-1)
# jsonObj_1 is a CkJsonObject
jsonObj_1 = jarr.ObjectAt(jarr.get_Size() - 1)
jsonObj_1.UpdateString("check","app.ok")
jsonObj_1.UpdateInt("status",0)
jsonObj_1.UpdateString("tags[0]","environment:test")
jsonObj_1.UpdateString("host_name","app.host1")
jsonObj_1.UpdateString("message","app is running")
jsonObj_1.UpdateInt("timestamp",-99255440)

http.SetRequestHeader("Content-Type","application/json")
http.SetRequestHeader("Accept","text/json")

sbRequestBody = Chilkat::CkStringBuilder.new()
jarr.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("POST","https://api.app.ddog-gov.com/api/v1/check_run",sbRequestBody,"utf-8","application/json",false,false)
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)

# {
#   "status": "ok"
# }

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

status = jResp.stringOf("status")

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Accept: text/json"
	-d '[
  {
    "check": "app.ok",
    "status": 0,
    "tags": [
      "environment:test"
    ],
    "host_name": "app.host1",
    "message": "app is running",
    "timestamp": 12636800
  },
  {
    "check": "app.ok",
    "status": 0,
    "tags": [
      "environment:test"
    ],
    "host_name": "app.host1",
    "message": "app is running",
    "timestamp": -99255440
  }
]'
https://api.app.ddog-gov.com/api/v1/check_run

Postman Collection Item JSON

{
  "name": "Submit a Service Check",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "text/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "[\n  {\n    \"check\": \"app.ok\",\n    \"status\": 0,\n    \"tags\": [\n      \"environment:test\"\n    ],\n    \"host_name\": \"app.host1\",\n    \"message\": \"app is running\",\n    \"timestamp\": 12636800\n  },\n  {\n    \"check\": \"app.ok\",\n    \"status\": 0,\n    \"tags\": [\n      \"environment:test\"\n    ],\n    \"host_name\": \"app.host1\",\n    \"message\": \"app is running\",\n    \"timestamp\": -99255440\n  }\n]",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v1/check_run",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "check_run"
      ]
    },
    "description": "Submit a list of Service Checks.\n\n**Notes**:\n- A valid API key is required.\n- Service checks can be submitted up to 10 minutes in the past."
  },
  "response": [
    {
      "name": "Payload accepted",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "text/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "[\n  {\n    \"check\": \"app.ok\",\n    \"status\": 0,\n    \"tags\": [\n      \"environment:test\"\n    ],\n    \"host_name\": \"app.host1\",\n    \"message\": \"app is running\",\n    \"timestamp\": 12636800\n  },\n  {\n    \"check\": \"app.ok\",\n    \"status\": 0,\n    \"tags\": [\n      \"environment:test\"\n    ],\n    \"host_name\": \"app.host1\",\n    \"message\": \"app is running\",\n    \"timestamp\": -99255440\n  }\n]",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/check_run",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "check_run"
          ]
        }
      },
      "status": "Accepted",
      "code": 202,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"status\": \"ok\"\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "text/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "[\n  {\n    \"check\": \"app.ok\",\n    \"status\": 0,\n    \"tags\": [\n      \"environment:test\"\n    ],\n    \"host_name\": \"app.host1\",\n    \"message\": \"app is running\",\n    \"timestamp\": 12636800\n  },\n  {\n    \"check\": \"app.ok\",\n    \"status\": 0,\n    \"tags\": [\n      \"environment:test\"\n    ],\n    \"host_name\": \"app.host1\",\n    \"message\": \"app is running\",\n    \"timestamp\": -99255440\n  }\n]",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/check_run",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "check_run"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    },
    {
      "name": "Authentication Error",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "text/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "[\n  {\n    \"check\": \"app.ok\",\n    \"status\": 0,\n    \"tags\": [\n      \"environment:test\"\n    ],\n    \"host_name\": \"app.host1\",\n    \"message\": \"app is running\",\n    \"timestamp\": 12636800\n  },\n  {\n    \"check\": \"app.ok\",\n    \"status\": 0,\n    \"tags\": [\n      \"environment:test\"\n    ],\n    \"host_name\": \"app.host1\",\n    \"message\": \"app is running\",\n    \"timestamp\": -99255440\n  }\n]",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/check_run",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "check_run"
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    },
    {
      "name": "Request timeout",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "text/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "[\n  {\n    \"check\": \"app.ok\",\n    \"status\": 0,\n    \"tags\": [\n      \"environment:test\"\n    ],\n    \"host_name\": \"app.host1\",\n    \"message\": \"app is running\",\n    \"timestamp\": 12636800\n  },\n  {\n    \"check\": \"app.ok\",\n    \"status\": 0,\n    \"tags\": [\n      \"environment:test\"\n    ],\n    \"host_name\": \"app.host1\",\n    \"message\": \"app is running\",\n    \"timestamp\": -99255440\n  }\n]",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/check_run",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "check_run"
          ]
        }
      },
      "status": "Request Timeout",
      "code": 408,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    },
    {
      "name": "Payload too large",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "text/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "[\n  {\n    \"check\": \"app.ok\",\n    \"status\": 0,\n    \"tags\": [\n      \"environment:test\"\n    ],\n    \"host_name\": \"app.host1\",\n    \"message\": \"app is running\",\n    \"timestamp\": 12636800\n  },\n  {\n    \"check\": \"app.ok\",\n    \"status\": 0,\n    \"tags\": [\n      \"environment:test\"\n    ],\n    \"host_name\": \"app.host1\",\n    \"message\": \"app is running\",\n    \"timestamp\": -99255440\n  }\n]",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/check_run",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "check_run"
          ]
        }
      },
      "status": "Request Entity Too Large",
      "code": 413,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    },
    {
      "name": "Too many requests",
      "originalRequest": {
        "method": "POST",
        "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  {\n    \"check\": \"app.ok\",\n    \"status\": 0,\n    \"tags\": [\n      \"environment:test\"\n    ],\n    \"host_name\": \"app.host1\",\n    \"message\": \"app is running\",\n    \"timestamp\": 12636800\n  },\n  {\n    \"check\": \"app.ok\",\n    \"status\": 0,\n    \"tags\": [\n      \"environment:test\"\n    ],\n    \"host_name\": \"app.host1\",\n    \"message\": \"app is running\",\n    \"timestamp\": -99255440\n  }\n]",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/check_run",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "check_run"
          ]
        }
      },
      "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}"
    }
  ]
}