Other

Ping the API

This method requires the Ping permission to be associated with your role.

GET

/ping

Ping the API

curl --request GET \
  --url https://api.catch-e.com/ping \
  --header 'Authorization: <api-key>'

{
  "pong": {
    "ack": 1549518571.2226,
    "auditOrigin": "external",
    "authorizedName": "Joe Citizen",
    "clientId": "example",
    "environment": "example",
    "tokenExpiry": 1549604518,
    "version": 1
  }
}

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Response

Success

pongobject

Show child attributes

Still need help? Ask the team