Chilkat Online Tools

VB6 / GP-API Collection / Ping GP-API

Back to Collection Items

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

Dim http As New ChilkatHttp
Dim success As Long

' Adds the "Authorization: Bearer {{token}}" header.
http.AuthToken = "{{token}}"
http.SetRequestHeader "X-GP-Version","2020-12-22"

Dim sbResponseBody As New ChilkatStringBuilder
success = http.QuickGetSb("https://{{url}}/ucp/ping",sbResponseBody)
If (success = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Debug.Print "Response status code = " & http.LastStatus
Debug.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": [
  ]
}