Revoke a policy gate signing key
DELETE
https://forumulate.com/api /orgs/{orgId}/spaces/{spaceId}/policy-gate/keys/{kid} Stops a key verifying immediately — for a leaked secret. Tickets and tokens it signed fail from now on; if it was the signing key, the next request mints a new one (rotate to see its secret).
Requires token scope: admin — see "Token scopes" under Authentication.
Parameters
orgIdstringpathrequiredThe organization: its uuid, or its
slug. One you are not a member of is a 404.spaceIdstringpathrequiredThe space: its uuid, or its slug within the organization. An id further down the path that belongs to a DIFFERENT space is a 404, not a cross-space read.
kidstringpathrequiredforumulate-versionstringheaderAPI version negotiation. Send
forumulate-version: 2027-03-01 on every request from a new integration; it is optional only so that integrations written before versioning keep working. Each version includes everything before it:Idempotency-KeystringheaderMakes this write safe to retry. Optional — send any unique string (a UUID is ideal) and the first request runs while its response is remembered under that key for 24 hours; an identical retry replays that same status and body instead of acting twice, so a timeout or a 5xx from the edge can be retried without creating a second row. A retry sent while the first request is still in flight is refused with
409. The key is scoped to the method and path, so the same key on a different endpoint is a different request. Error responses of 5xx are never cached — those retries re-run. A key is bound to the BODY it was first used with: reusing it with a different body is a 409 idempotency.key_reused, not a replay, because replaying would tell you a write landed that never ran. Generate one key per request, never per process or per session.dryRunbooleanquerytrue: authenticate, authorize and validate this request (body, query and path), then answer 200 {dryRun: true, ok: true, operation, checks} WITHOUT carrying it out — nothing is written, queued, mailed or announced. It does not compute a diff, and a write that passes may still be refused by a state check at write time (a slug taken in between). Anything other than true/false is a 422.Code samples
cURL
curl -X DELETE "https://forumulate.com/api/orgs/{orgId}/spaces/{spaceId}/policy-gate/keys/{kid}" \
-H "Authorization: Bearer $FORUMULATE_API_KEY" \
-H "forumulate-version: <value>" \
-H "Idempotency-Key: <value>"TypeScript
Python
Go
PHP
Ruby
Java
Responses
200 Success.
Example
{
"keys": [
{
"active": true,
"createdAt": "string",
"kid": "string",
"primary": true,
"retiresAt": "string",
"revokedAt": "string"
}
]
}Schema
keysPolicyGateKeySummary[]requiredShow child parameters
activebooleanrequiredcreatedAtstringrequiredkidstringrequiredprimarybooleanrequiredretiresAtstringrequiredrevokedAtstringrequired400 The request could not be understood — a malformed header, path or query value (
request.malformed). A value that was understood but is not acceptable is a 422 validation.failed.Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"docs": "string",
"reason": "string",
"slugs": [
"string"
],
"conflict": {
"etag": "string",
"ops": [
{}
]
}
},
"requestId": "string"
}Schema
errorobjectrequiredShow child parameters
codestringrequiredStable, machine-readable error code, e.g.
rbac.forbidden.messagestringrequiredHuman-readable explanation.
detailsobjectField-level validation problems, keyed by field path (422 only).
docsstringWhere the vocabulary or format this error is about is published — an absolute URL, or an API route such as
GET /space-types/{type}/presets. Present on errors over a controlled list, so the answer to "what am I allowed to send?" is in the error itself.reasonstringWhy a credential was refused, as one stable word, where one status has several causes — e.g. an external_jwt redeem answers
iat_too_old, iat_in_future, bad_signature, bad_issuer, bad_audience, expired and more. Branch on this, not on message.slugsstring[]The exact slugs that collided, on a slug-conflict 409 —
space.slug_taken, page.slug_taken, collection.slug_taken, site.slug_taken or badge.slug_taken.conflictobjectOn a 409 from a content entry field write (
PATCH …/entries/{entryId}/fields) whose If-Match was stale.Show child parameters
etagstringrequiredThe entry's current fields etag.
opsarrayrequiredThe field operations since your
If-Match that touch a path your own operations touch. Empty: none did — retry the batch unchanged under etag. null: the history no longer reaches your tag — re-read the entry first.requestIdstringThe id of this request — the same value as the
x-request-id and x-forumulate-request-id response headers. Quote it in a bug report: it is the only thing that finds your exact request in our logs. It is in the body because that is the part that survives — an SDK that throws the parsed body, a serverless log that keeps the body and drops the headers, a ticket with the JSON pasted in.401 No credential, or one that is expired or revoked (
auth.required). Send a Bearer token or the session cookie.Same as 400 · DELETE /orgs/{orgId}/spaces/{spaceId}/policy-gate/keys/{kid}
403 Authenticated, and not allowed — always
rbac.forbidden, whether what is missing is the capability, the token scope, or a resource the token is pinned away from. The message names the capability and, for a scope refusal, the scopes that would grant it. A refusal because of the PLAN is a 402 with quota.exceeded, not this.Same as 400 · DELETE /orgs/{orgId}/spaces/{spaceId}/policy-gate/keys/{kid}
404 No such thing — one of the ids in the path does not resolve, or resolves to something this caller may not see (
*.not_found).Same as 400 · DELETE /orgs/{orgId}/spaces/{spaceId}/policy-gate/keys/{kid}
429 Rate limited — see the RateLimit-* headers.
Same as 400 · DELETE /orgs/{orgId}/spaces/{spaceId}/policy-gate/keys/{kid}
default Error — the stable { error: { code, message } } envelope.
Same as 400 · DELETE /orgs/{orgId}/spaces/{spaceId}/policy-gate/keys/{kid}
The Forumulate teamUpdated