Ping endpoint

GET /ping

Used to check uptime

Responses

Ping response

Schema

object

{}

Service unavailable

Schema

errors

object[]

required

Errors

Array [

source stringrequired

Possible values: non-empty and <= 100 characters

The application name that generated this error.

reasonCode stringrequired

Possible values: non-empty and <= 100 characters

A unique constant identifying the error case encountered during request processing.

BAD_REQUEST - Malformed request, please advice the description and details fields for more information
FORBIDDEN - Insufficient scope to access the resource
INTERNAL_SERVER_ERROR - Unexpected server error
METHOD_NOT_ALLOWED - Method not allowed
UNSUPPORTED_MEDIA_TYPE - Unsupported media type
SERVICE_UNAVAILABLE - Service is unavailable

description stringrequired

Possible values: <= 1000 characters

Short description of the reasonCode field.

recoverable booleanrequired

Indicates whether this error will always be returned for this request, or retrying could change the outcome.

]

{
  "errors": [
    {
      "source": "string",
      "reasonCode": "string",
      "description": "string",
      "recoverable": false
    }
  ]
}