Health check

curl --request GET \
  --url https://api.example.com/api/health \
  --header 'Authorization: Bearer <token>'

{
  "status": "ok"
}

GET

api

health

Health check

curl --request GET \
  --url https://api.example.com/api/health \
  --header 'Authorization: Bearer <token>'

{
  "status": "ok"
}

Authorization

string

header

required

Send either a Sourcebot API key (sbk_...) or, on EE instances with OAuth enabled, an OAuth access token (sboa_...) in the Authorization header.

200 - application/json

Service is healthy.

status

enum<string>

required

Available options:

ok

⌘I