Chilkat Online Tools

TCL / GP-API Collection / Ping GP-API

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

# Adds the "Authorization: Bearer {{token}}" header.
CkHttp_put_AuthToken $http "{{token}}"
CkHttp_SetRequestHeader $http "X-GP-Version" "2020-12-22"

set sbResponseBody [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://{{url}}/ucp/ping" $sbResponseBody]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    exit
}

puts "Response status code = [CkHttp_get_LastStatus $http]"
puts [CkStringBuilder_getAsString $sbResponseBody]

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody

Curl Command

curl -X GET
	-H "Authorization: Bearer {{token}}"
	-H "X-GP-Version: 2020-12-22"
https://{{url}}/ucp/ping

Postman Collection Item JSON

{
  "name": "Ping GP-API",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Authorization",
        "value": "Bearer {{token}}"
      },
      {
        "key": "X-GP-Version",
        "value": "2020-12-22"
      }
    ],
    "url": {
      "raw": "https://{{url}}/ucp/ping",
      "protocol": "https",
      "host": [
        "{{url}}"
      ],
      "path": [
        "ucp",
        "ping"
      ]
    },
    "description": "This request can be sent to periodically check if the API is up"
  },
  "response": [
  ]
}