Chilkat Online Tools

Python / GP-API Collection / Ping GP-API

Back to Collection Items

import sys
import chilkat

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

http = chilkat.CkHttp()

# Adds the "Authorization: Bearer {{token}}" header.
http.put_AuthToken("{{token}}")
http.SetRequestHeader("X-GP-Version","2020-12-22")

sbResponseBody = chilkat.CkStringBuilder()
success = http.QuickGetSb("https://{{url}}/ucp/ping",sbResponseBody)
if (success == False):
    print(http.lastErrorText())
    sys.exit()

print("Response status code = " + str(http.get_LastStatus()))
print(sbResponseBody.getAsString())

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": [
  ]
}