Skip to main content
Salfio Docs

Search documentation

Type to search this documentation.

On this pageOverview

Authenticated health check

Returns `{"status":"ok"}` when the presented bearer token is valid. Used by callers to verify their token and the end-to-end routing from `api.salfio.com` to the Salfio API service.

GET

/health

bearerAuth``

AuthorizationBearer <token>

Salfio API tokens start with the literal prefix sk_live_ followed by 32 base62 characters (≈190 bits of entropy). Tokens are hashed at rest with argon2id and shown to the user only once at creation.

In: header

application/json

application/json

application/json

curl -X GET "https://api.salfio.com/v1/health"

{
  "data": {
    "status": "ok"
  },
  "meta": {}
}

{
  "error": {
    "code": "unauthorized",
    "message": "Authentication required"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Rate limit exceeded",
    "details": {
      "retry_after_seconds": 30
    }
  }
}
Export
Suggest an edit to this page

Documentation menu