Availability Information

Provides information about REST API services availability.

URL

/ping

Method

GET

Headers

None

Request type

None

Response type

Text

URL Parameters

Required:

None

Optional:

restrictToReader: [boolean] - only returns available status if the server is in reader mode, if the server is writer return UNAVAILABLE status

restrictToWriter: [boolean] - only returns available status if the server is in writer mode, if the server is reader return UNAVAILABLE status

Payload

None

Success response

Code: 200

Content: Up, writer: [boolean]

Error response

Code: 503

Content: Down

Notes

None