Skip to main content

POST /api/v1/keys/expire

Expire keys -- every later use is refused, and each key's record is kept.

Expires the keys named by hiddenLinks. An expired key's record is kept -- it still has its access control list, and POST /api/v1/keys/acl/get still reads it, with expired: true -- and every later use of it is refused 410 KEY_EXPIRED: a decrypt, an encrypt under its t-Tag, an export, an access-control grant or update. The refusal holds on every key server of the deployment from the key's next use. An expiry is never undone; to delete a key, use POST /api/v1/keys/remove.

The answer carries one result per hidden link, in request order, each with the state the Gateway read back afterwards (readBack). Each link is applied independently: one refused link neither stops nor undoes the others. Expiring a key that is already expired answers already-expired and changes nothing.

If every link was applied the status is 200. If any link was refused, the status is the one that refusal has -- 404 KEY_NOT_FOUND, 403 ACL_DENIED, 403 ACCESS_DENIED, 400 BAD_HIDDEN_LINK -- and the error body carries every result, the applied ones included.

The caller needs a role granting Expire Key and the OWNER right on each key.

remove is deprecated: true deletes the keys exactly as POST /api/v1/keys/remove does. A request that carries remove is answered with Deprecation and Link: <...>; rel="deprecation" naming that operation. It must be a literal boolean and is never inferred from truthiness.

accepted and verified are deprecated constants; read results.

An empty hiddenLinks array is refused before anything is sent.

Authentication​

Send the session id as Authorization: Bearer <session id>, and an RFC 9449 DPoP proof in the DPoP header if your session is bound to a key. The two are required together, not as alternatives — see Authenticating and Proving you hold your key.

This surface sets no cookie

There is no session cookie on any response and none is read on any request. Do not set credentials: "include" on a browser fetch.

Request​

FieldTypeRequiredDescription
hiddenLinksarray of stringyesCanonical base64.
removebooleannoDeprecated -- use POST /api/v1/keys/remove. true DELETES the keys irreversibly. Omit it to expire. Must be a real boolean.

Example

{
  "hiddenLinks": [
    "..."
  ],
  "remove": true
}

Responses​

200​

Every link was applied. results says what became of each.

FieldTypeRequiredDescription
removedbooleanyesTrue when the keys were DELETED rather than expired.
keysRequestedintegeryes
acceptedtrue (constant)yes
verifiedfalse (constant)yes
resultsarray of KeyLifecycleResultyesWhat became of one hidden link of an expire or remove request, in request order. Each link is applied independently: one refused link neither stops nor undoes the others.
detailstringyes

Example

{
  "removed": true,
  "keysRequested": 0,
  "accepted": true,
  "verified": false,
  "results": [
    {
      "hiddenLink": "...",
      "outcome": "expired",
      "code": 0,
      "readBack": "expired"
    }
  ],
  "detail": "..."
}

400​

BAD_REQUEST -- refused before anything was sent (hiddenLinks absent, empty or not canonical base64; remove not a boolean). BAD_HIDDEN_LINK -- the key server refused a hidden link as malformed (empty, or shorter than any key's); the body carries results. INVALID_ARGUMENT -- the key server refused another argument, in its own sentence.

401​

No live session, a DPoP proof that did not verify, or a certificate session whose certificate the key server now refuses.

SESSION_NOT_FOUND -- the credential names no session this Gateway holds. SESSION_EXPIRED -- it aged out. Both carry reauth: true; obtain a new credential rather than retrying.

PROOF_* -- the sender constraint refused. See the DPoP section of this document for the full table; PROOF_MALFORMED is a 400 and PROOF_REPLAY_CACHE_FULL a 503, and the rest are here.

SCOPED_CREDENTIAL_EXPIRED -- a scoped browser credential passed its fixed lifetime. Use does not extend it: an idle timeout would be refreshed by exactly the traffic a stolen handle produces.

CERTIFICATE_REVOKED -- on a session established by certificate login, the key server re-checks the certificate that session was established with on its operations, and it is now named by revocation evidence. detail is the key server's sentence. The Gateway answers this once and then ENDS everything that service holds or minted here -- its sessions, the delegated sessions and the scoped credentials it minted -- so a later operation on any of them is SESSION_NOT_FOUND. Log in with a different certificate.

SSO_SESSION_EXPIRED -- a single-sign-on session (POST /api/v1/session/oidc) reached its lifetime, or was idle past its binding's idle bound; it has been ended. Sign in again.

SENDER_KEY_RETIRED -- the session's registered sender key was rotated out and its overlap has passed (see "The registered service's credential lifecycle"); the session is closed with this answer. SERVICE_REGISTRATION_ENDED -- the registration a service credential was issued under was removed or narrowed on this Gateway; it has ended. Both are final for that credential.

403​

OBJECT_NOT_IN_CREDENTIAL_SCOPE (decided before anything is sent) or ACCESS_DENIED (no role grants Expire Key) or ACL_DENIED (a key's access control list does not make the caller its OWNER); a key-server refusal carries results.

404​

KEY_NOT_FOUND -- a hidden link names no key; the body carries results.

500​

A fault rather than a refusal.

OP_FAILED is the catch-all: the key server refused in words that match no classified pattern, so the Gateway cannot say more than that the operation did not happen. Some key server refusals that are conceptually a caller error arrive here rather than as a 4xx, because the wire carries no distinguishing code -- where a route can recognise one from its message it maps it, and each such mapping is documented on the operation.

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.

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.

429​

RATE_LIMITED (retryable: true, Retry-After) -- the allowance this request is charged to is spent: the login allowance of its network source (before authentication), or the allowance, the concurrency ceiling or the live-session ceiling of the identity it was verified as -- shared by every session that identity holds, including every delegated and scoped credential a service minted. It carries no scope. Nothing was sent to the key server; on a login refused after authentication, the session it created has been closed. 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.

StatusMeaning
400BAD_REQUEST -- refused before anything was sent (hiddenLinks absent, empty or not canonical base64; remove not a boolean). BAD_HIDDEN_LINK -- the key server refused a hidden link as malformed (empty, or shorter than any key's); the body carries results. INVALID_ARGUMENT -- the key server refused another argument, in its own sentence.
401No live session, a DPoP proof that did not verify, or a certificate session whose certificate the key server now refuses. SESSION_NOT_FOUND -- the credential names no session this Gateway holds. SESSION_EXPIRED -- it aged out. Both carry reauth: true; obtain a new credential rather than retrying. PROOF_* -- the sender constraint refused. See the DPoP section of this document for the full table; PROOF_MALFORMED is a 400 and PROOF_REPLAY_CACHE_FULL a 503, and the rest are here. SCOPED_CREDENTIAL_EXPIRED -- a scoped browser credential passed its fixed lifetime. Use does not extend it: an idle timeout would be refreshed by exactly the traffic a stolen handle produces. CERTIFICATE_REVOKED -- on a session established by certificate login, the key server re-checks the certificate that session was established with on its operations, and it is now named by revocation evidence. detail is the key server's sentence. The Gateway answers this once and then ENDS everything that service holds or minted here -- its sessions, the delegated sessions and the scoped credentials it minted -- so a later operation on any of them is SESSION_NOT_FOUND. Log in with a different certificate. SSO_SESSION_EXPIRED -- a single-sign-on session (POST /api/v1/session/oidc) reached its lifetime, or was idle past its binding's idle bound; it has been ended. Sign in again. SENDER_KEY_RETIRED -- the session's registered sender key was rotated out and its overlap has passed (see "The registered service's credential lifecycle"); the session is closed with this answer. SERVICE_REGISTRATION_ENDED -- the registration a service credential was issued under was removed or narrowed on this Gateway; it has ended. Both are final for that credential.
403OBJECT_NOT_IN_CREDENTIAL_SCOPE (decided before anything is sent) or ACCESS_DENIED (no role grants Expire Key) or ACL_DENIED (a key's access control list does not make the caller its OWNER); a key-server refusal carries results.
404KEY_NOT_FOUND -- a hidden link names no key; the body carries results.
500A fault rather than a refusal. OP_FAILED is the catch-all: the key server refused in words that match no classified pattern, so the Gateway cannot say more than that the operation did not happen. Some key server refusals that are conceptually a caller error arrive here rather than as a 4xx, because the wire carries no distinguishing code -- where a route can recognise one from its message it maps it, and each such mapping is documented on the operation.
503A 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.
413PAYLOAD_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.
429RATE_LIMITED (retryable: true, Retry-After) -- the allowance this request is charged to is spent: the login allowance of its network source (before authentication), or the allowance, the concurrency ceiling or the live-session ceiling of the identity it was verified as -- shared by every session that identity holds, including every delegated and scoped credential a service minted. It carries no scope. Nothing was sent to the key server; on a login refused after authentication, the session it created has been closed. See "Rate and capacity limits" above.