Chilkat Online Tools

Perl / GP-API Collection / Ping GP-API

Back to Collection Items

use chilkat();

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

$http = chilkat::CkHttp->new();

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

$sbResponseBody = chilkat::CkStringBuilder->new();
$success = $http->QuickGetSb("https://{{url}}/ucp/ping",$sbResponseBody);
if ($success == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

print "Response status code = " . $http->get_LastStatus() . "\r\n";
print $sbResponseBody->getAsString() . "\r\n";

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