Authentication

Log out

POST/api/auth/logout

Ends the current authentication session by removing its stored token when Redis-backed sessions are enabled.

Headers

Name	Type	Description
Authorizationrequired	string	Authentication credentials, e.g. `Bearer <token>`.

200The operation completed successfully.

Name	Type	Description
okrequired	any	Whether the operation succeeded.

200 example

{
  "ok": {}
}

401Unauthorized.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

401 example

{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized.",
    "status": 401
  }
}

cURL

curl -X POST 'https://api.example.com/api/auth/logout' \
  -H 'Authorization: Bearer <token>'