The GET or POST method of the ping endpoint can be used to validate that the API is active and receiving requests. This endpoint does not require authentication and simply returns a status indicating the timestamp and version of the API.
This endpoint may not be called more frequently than once every 60 seconds.
The following example validates that the API is active and receiving requests.
https://api.statebook.com/api/v1/ping
GET /api/v1/ping HTTP/1.1 Host: api.statebook.com Content-Type: application/json var response = { "status": { "id": "6a75a1f5-7cf8-4e2a-8493-234b3415fd03", "timestamp": "2020-01-15T19:23:33.121935Z", "version": "1.0.0", "license": "The data returned from this StateBook Data API call is restricted and may only be used in accordance with the terms of a current and valid StateBook Data API license. Any other use is strictly prohibited." } }
Comments
0 comments
Article is closed for comments.