Skip to content

Liveness probe

GET
/v1/health
curl --request GET \
--url https://api.spirby.com/v1/health

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"
}
}