Liveness probe
GET
/v1/health
const url = 'https://api.spirby.com/v1/health';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.spirby.com/v1/healthResponses
Section titled “ Responses ”Successful response
Media type application/json
object
data
Example generated
{ "data": "example"}Validation failed
Media type application/json
object
error
required
object
code
required
string
details
object
key
additional properties
message
required
string
Example generated
{ "error": { "code": "example", "details": { "additionalProperty": "example" }, "message": "example" }}Internal error
Media type application/json
object
error
required
object
code
required
string
details
object
key
additional properties
message
required
string
Example generated
{ "error": { "code": "example", "details": { "additionalProperty": "example" }, "message": "example" }}