PUT /api/revocation/issuers/{digest}/policy
Set the revocation policy for ONE issuing CA.
Writes Policy.X509.Revocation.Issuer.<DIGEST>, which the key server consults before
Policy.X509.Revocation.Default for certificates issued by that CA, and verifies it with a
FRESH read. The key server reads it per check: there is nothing to restart.
The value is validated with the revocation-policy grammar BEFORE it is sent --
evidence=crl|none;max-age=<n><s|m|h|d>;refresh=<n><s|m|h|d>;fallback=refuse|allow, with
optional url=http://... and retry=<n><s|m|h|d> -- so a malformed policy is a 400
naming the clause and never reaches the key server.
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.
There is no session cookie on any response and none is read on any request. Do not set credentials: "include" on a browser fetch.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
digest | path | yes | string | The issuing CA's digest: 64 hex digits (SHA-256), or 96 (SHA-384, for an EC key of 384 bits or more). Either case is accepted; the key server's parameter is written upper-case. Read it off GET /api/trusted-cas (revocationDigest) or an evidence row (digest). |
Request
| Field | Type | Required | Description |
|---|---|---|---|
policy | string | yes |
Example
{
"policy": "evidence=crl;max-age=24h;refresh=1h;fallback=refuse"
}
Responses
200
Written and read back.
| Field | Type | Required | Description |
|---|---|---|---|
code | string | no | Absent on success; NOT_VERIFIED / NOT_REMOVED when the read-back disagrees. |
saved | boolean | no | PUT only. |
removed | boolean | no | DELETE only. |
digest | string | no | The digest |
key | string | no | Policy.X509.Revocation.Issuer.<DIGEST> -- the parameter written. |
policy | string | no | PUT only. The value written |
was | string or null | no | The value before the call; null when the parameter was absent. |
readBack | string or null | no | What a FRESH read shows after the call. |
detail | string | no |
Example
{
"code": "...",
"saved": true,
"removed": true,
"digest": "...",
"key": "...",
"policy": "...",
"was": "...",
"readBack": "...",
"detail": "..."
}
400
BAD_DIGEST, POLICY_REQUIRED, or INVALID_POLICY -- the grammar refused the value; detail names the key and the clause. Nothing was sent.
401
No live session, or a DPoP proof that did not verify.
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.
403
Authenticated, and refused. The codes differ in what they say about where the refusal
came from: ACCESS_DENIED, PRINCIPAL_DISABLED and DELEGATOR_REFUSED are the key
server's -- the last one on a DELEGATED session whose delegator has since been disabled,
lost its DELEGATION flag, been unenrolled or had its certificate revoked (ADR-0123); its
detail is the key server's sentence naming the delegator, and no new login helps until
an administrator restores it -- while
NOT_WRITABLE, BUILT_IN_PRINCIPAL, OWN_ACCOUNT and
OBJECT_NOT_IN_CREDENTIAL_SCOPE are decided by the Gateway before anything is sent.
409
NOT_VERIFIED -- the write was not refused, and a fresh read does not show it.
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.
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 |
|---|---|
400 | BAD_DIGEST, POLICY_REQUIRED, or INVALID_POLICY -- the grammar refused the value; detail names the key and the clause. Nothing was sent. |
401 | No live session, or a DPoP proof that did not verify. 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. |
403 | Authenticated, and refused. The codes differ in what they say about where the refusal came from: ACCESS_DENIED, PRINCIPAL_DISABLED and DELEGATOR_REFUSED are the key server's -- the last one on a DELEGATED session whose delegator has since been disabled, lost its DELEGATION flag, been unenrolled or had its certificate revoked (ADR-0123); its detail is the key server's sentence naming the delegator, and no new login helps until an administrator restores it -- while NOT_WRITABLE, BUILT_IN_PRINCIPAL, OWN_ACCOUNT and OBJECT_NOT_IN_CREDENTIAL_SCOPE are decided by the Gateway before anything is sent. |
409 | NOT_VERIFIED -- the write was not refused, and a fresh read does not show it. |
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. |