DELETE /api/v1/session
End a session. Idempotent.
Closes the session named by the Authorization header, if there is one, and answers
204.
It is idempotent and unauthenticated by contract, not by accident. A caller
presenting no credential at all, a dead one, or the same one twice, all get 204. A
double logout is not an error, and this route never consults the session guard. No cookie
is cleared, because this surface sets none.
Authentication
No session required. This operation is reachable without an Authorization header. See Authenticating.
Request
No request body.
Responses
204
The session is gone, or was already gone, or was never named. These are not distinguished, deliberately.
413
PAYLOAD_TOO_LARGE (retryable: false) -- the request body is larger than this
deployment accepts. It was refused before it was parsed, and the connection is closed.
Nothing was sent to the key server.
503
A capacity ceiling or a missing deployment prerequisite. retryable says which.
A scope of session or process names the ceiling that was hit, and the response
carries Retry-After.
BUILD_NOT_ADMITTED (scope: process, retryable: true, Retry-After): the key server
does not admit this Gateway's client build. Every key-server connection the Gateway opens
attests the signed release it runs (TE_RELEASE_MANIFEST) right after it authenticates;
while that attestation is refused -- the release is not registered at the key server's
code-signing level, the level was raised under it, or the installed files no longer
match the signed manifest -- every route but GET /api/v1/health and GET /api/v1/ready
answers this, and detail names the cause. It is never a 401 or a 403: no credential
or role of the caller's is at fault. The Gateway re-attempts on a timer and recovers
without a restart once the key server admits it; GET /api/v1/ready says when.
CAPACITY_UNAVAILABLE (scope: process, retryable: true, Retry-After): this Gateway
is serving its maximum number of requests at once, or cannot track another allowance, or
(on a certificate login) is recording its maximum of live certificate sessions -- in which
case the session the login created has been closed. Nothing else was sent to the key
server. See "Rate and capacity limits" above.
Error handling
Every failure answers JSON carrying at least code and detail. Match on code — detail is written for a human debugging the call and its wording is not part of the contract. See the error model.
| Status | Meaning |
|---|---|
413 | PAYLOAD_TOO_LARGE (retryable: false) -- the request body is larger than this deployment accepts. It was refused before it was parsed, and the connection is closed. Nothing was sent to the key server. |
503 | A capacity ceiling or a missing deployment prerequisite. retryable says which. A scope of session or process names the ceiling that was hit, and the response carries Retry-After. BUILD_NOT_ADMITTED (scope: process, retryable: true, Retry-After): the key server does not admit this Gateway's client build. Every key-server connection the Gateway opens attests the signed release it runs (TE_RELEASE_MANIFEST) right after it authenticates; while that attestation is refused -- the release is not registered at the key server's code-signing level, the level was raised under it, or the installed files no longer match the signed manifest -- every route but GET /api/v1/health and GET /api/v1/ready answers this, and detail names the cause. It is never a 401 or a 403: no credential or role of the caller's is at fault. The Gateway re-attempts on a timer and recovers without a restart once the key server admits it; GET /api/v1/ready says when. CAPACITY_UNAVAILABLE (scope: process, retryable: true, Retry-After): this Gateway is serving its maximum number of requests at once, or cannot track another allowance, or (on a certificate login) is recording its maximum of live certificate sessions -- in which case the session the login created has been closed. Nothing else was sent to the key server. See "Rate and capacity limits" above. |