Chilkat Online Tools

unicodeCpp / Datadog API Collection / Submit a Service Check

Back to Collection Items

#include <CkHttpW.h>
#include <CkJsonArrayW.h>
#include <CkJsonObjectW.h>
#include <CkStringBuilderW.h>
#include <CkHttpResponseW.h>

void ChilkatSample(void)
    {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttpW http;
    bool success;

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

    CkJsonArrayW jarr;

    jarr.AddObjectAt(-1);
    CkJsonObjectW *jsonObj_1 = jarr.ObjectAt(jarr.get_Size() - 1);
    jsonObj_1->UpdateString(L"check",L"app.ok");
    jsonObj_1->UpdateInt(L"status",0);
    jsonObj_1->UpdateString(L"tags[0]",L"environment:test");
    jsonObj_1->UpdateString(L"host_name",L"app.host1");
    jsonObj_1->UpdateString(L"message",L"app is running");
    jsonObj_1->UpdateInt(L"timestamp",12636800);
    delete jsonObj_1;

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

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

    CkStringBuilderW sbRequestBody;
    jarr.EmitSb(sbRequestBody);

    CkHttpResponseW *resp = http.PTextSb(L"POST",L"https://api.app.ddog-gov.com/api/v1/check_run",sbRequestBody,L"utf-8",L"application/json",false,false);
    if (http.get_LastMethodSuccess() == false) {
        wprintf(L"%s\n",http.lastErrorText());
        return;
    }

    CkStringBuilderW sbResponseBody;
    resp->GetBodySb(sbResponseBody);

    CkJsonObjectW jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",jResp.emit());

    int respStatusCode = resp->get_StatusCode();
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",resp->header());
        wprintf(L"Failed.\n");
        delete resp;
        return;
    }

    delete resp;

    // 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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    const wchar_t *status = jResp.stringOf(L"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}"
    }
  ]
}