Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
// 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
// }
// ]
loJarr = createobject("CkJsonArray")
loJarr.AddObjectAt(-1)
loJsonObj_1 = loJarr.ObjectAt(loJarr.Size - 1)
loJsonObj_1.UpdateString("check","app.ok")
loJsonObj_1.UpdateInt("status",0)
loJsonObj_1.UpdateString("tags[0]","environment:test")
loJsonObj_1.UpdateString("host_name","app.host1")
loJsonObj_1.UpdateString("message","app is running")
loJsonObj_1.UpdateInt("timestamp",12636800)
release loJsonObj_1
loJarr.AddObjectAt(-1)
loJsonObj_1 = loJarr.ObjectAt(loJarr.Size - 1)
loJsonObj_1.UpdateString("check","app.ok")
loJsonObj_1.UpdateInt("status",0)
loJsonObj_1.UpdateString("tags[0]","environment:test")
loJsonObj_1.UpdateString("host_name","app.host1")
loJsonObj_1.UpdateString("message","app is running")
loJsonObj_1.UpdateInt("timestamp",-99255440)
release loJsonObj_1
loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("Accept","text/json")
loSbRequestBody = createobject("CkStringBuilder")
loJarr.EmitSb(loSbRequestBody)
loResp = loHttp.PTextSb("POST","https://api.app.ddog-gov.com/api/v1/check_run",loSbRequestBody,"utf-8","application/json",.F.,.F.)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loJarr
release loSbRequestBody
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loJarr
release loSbRequestBody
release loSbResponseBody
release loJResp
return
endif
release loResp
// 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
lcStatus = loJResp.StringOf("status")
release loHttp
release loJarr
release loSbRequestBody
release loSbResponseBody
release loJResp
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}"
}
]
}
