Skip to main content

POST /api/parameters/remove

Remove a key server parameter. Permission is checked HERE, before the wire.

Removes the parameter named by key.

WARNING: this route runs its own writers check, on this tier, before anything is sent -- and it FAILS CLOSED where the key server FAILS OPEN. The engine guards the removal with a check that short-circuits on an EMPTY writers list and therefore permits everyone; this surface uses the predicate that is false on an empty list. The two fail in opposite directions, and this one is the stricter. Which tier is right is unresolved product-wide; this surface inherits the stricter answer rather than deciding it.

writers in the response is the parameter's writer ROLE IDS as lowercase hex, which is the comparison key. Role NAMES are display-only and are never compared.

WARNING: there is no read-back and no verified flag on this route, deliberately. The only read available REJECTS for a key that does not exist rather than resolving an absence, so a post-removal read cannot distinguish "removed" from "the connection failed", and a verified computed from it would be reporting a guess. The 200 means the removal was sent and the key server did not refuse it.

The raw reply is not returned: its shape is in no contract, and echoing it would export the wire format as part of this API.

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
keystringyesA bare key string -- note this operation takes a bare string where the parameter read and write take an object. That asymmetry is the key server's and is not normalised here.

Example

{
"key": "..."
}

Responses

200

The removal was sent and not refused. It has not been read back.

FieldTypeRequiredDescription
removedtrue (constant)yes
keystringyes
writersarray of stringyesWriter role ids
detailstringyes

Example

{
"removed": true,
"key": "...",
"writers": [
"..."
],
"detail": "..."
}

400

The request was refused before anything was sent to the key server.

Most 400s on this surface carry code: BAD_REQUEST and a detail naming the field and saying what the key server would otherwise have done with it. A large share of them exist because the value would have been ACCEPTED downstream and quietly meant something else -- an empty string that reaches the wire as "mint a new key", a zero-length identifier that names no object, a numeric flag word that clears bits the caller did not name.

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

NOT_WRITABLE -- the parameter's writers list does not include any role you hold, or it is EMPTY (refused here, permitted by the key server -- see the warning), or the parameter could not be read at all so it has no writers to check against. Nothing was sent to the key server except the read that produced this list.

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 codedetail is written for a human debugging the call and its wording is not part of the contract. See the error model.

StatusMeaning
400The request was refused before anything was sent to the key server. Most 400s on this surface carry code: BAD_REQUEST and a detail naming the field and saying what the key server would otherwise have done with it. A large share of them exist because the value would have been ACCEPTED downstream and quietly meant something else -- an empty string that reaches the wire as "mint a new key", a zero-length identifier that names no object, a numeric flag word that clears bits the caller did not name.
401No 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.
403NOT_WRITABLE -- the parameter's writers list does not include any role you hold, or it is EMPTY (refused here, permitted by the key server -- see the warning), or the parameter could not be read at all so it has no writers to check against. Nothing was sent to the key server except the read that produced this list.
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.