Back to Collection Items
IncludeFile "CkJsonArray.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkJsonObject.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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.i = CkJsonArray::ckCreate()
If jarr.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonArray::ckAddObjectAt(jarr,-1)
jsonObj_1.i = CkJsonArray::ckObjectAt(jarr,CkJsonArray::ckSize(jarr) - 1)
CkJsonObject::ckUpdateString(jsonObj_1,"check","app.ok")
CkJsonObject::ckUpdateInt(jsonObj_1,"status",0)
CkJsonObject::ckUpdateString(jsonObj_1,"tags[0]","environment:test")
CkJsonObject::ckUpdateString(jsonObj_1,"host_name","app.host1")
CkJsonObject::ckUpdateString(jsonObj_1,"message","app is running")
CkJsonObject::ckUpdateInt(jsonObj_1,"timestamp",12636800)
CkJsonObject::ckDispose(jsonObj_1)
CkJsonArray::ckAddObjectAt(jarr,-1)
jsonObj_1 = CkJsonArray::ckObjectAt(jarr,CkJsonArray::ckSize(jarr) - 1)
CkJsonObject::ckUpdateString(jsonObj_1,"check","app.ok")
CkJsonObject::ckUpdateInt(jsonObj_1,"status",0)
CkJsonObject::ckUpdateString(jsonObj_1,"tags[0]","environment:test")
CkJsonObject::ckUpdateString(jsonObj_1,"host_name","app.host1")
CkJsonObject::ckUpdateString(jsonObj_1,"message","app is running")
CkJsonObject::ckUpdateInt(jsonObj_1,"timestamp",-99255440)
CkJsonObject::ckDispose(jsonObj_1)
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
CkHttp::ckSetRequestHeader(http,"Accept","text/json")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonArray::ckEmitSb(jarr,sbRequestBody)
resp.i = CkHttp::ckPTextSb(http,"POST","https://api.app.ddog-gov.com/api/v1/check_run",sbRequestBody,"utf-8","application/json",0,0)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonArray::ckDispose(jarr)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonArray::ckDispose(jarr)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(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
status.s = CkJsonObject::ckStringOf(jResp,"status")
CkHttp::ckDispose(http)
CkJsonArray::ckDispose(jarr)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
