Skip to content

Revoke a Realm API operation's approval

POST
/api/v1/handlers/realms/{realmName}/api-approvals/{operation}/revoke
curl --request POST \
--url http://localhost:11044/api/v1/handlers/realms/example/api-approvals/example/revoke \
--header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

JSON fields: installationId, expectedRevision, and operation when the path does not name one. A key holding a slash goes in the body: an encoded slash never reaches a route.

realmName
required
string

Name of the admitted Realm

operation
required
string

The operation’s key or call name, when the body does not name it

The approvals as they now stand

Media type*/*
object

The Realm’s API declaration or credential cannot be approved; detail carries the declaration reader’s code as reason and, where it knows them, the field it points at and the rule it states

Media type*/*

A refusal with a machine-readable code and a plain-language message. ApiErrorAdvice answers it for a failed validation, a missing resource or a conflicting state, and some controllers answer it directly

object
code
required

Machine-readable key to branch on, such as validation_failed, unknown_field, not_found or conflict. Open: a surface may answer codes of its own

string
detail

Extra context where there is some: a sentence, such as the fields a body may carry, or an object of machine fields in the server’s own words, such as api_approval_unapprovable’s reason (the declaration reader’s code, MALFORMED or FIELD_INVALID), field (where it points, [0].headers[1] or apis/spec.json#/paths/~1things/post) and rule (the sentence the reader states for it), or a refused Realm capture’s reason (SYMLINK, TOO_LARGE, …) and file (the path relative to the Realm root); never the caller’s or a Realm’s text; null otherwise

message
required

A plain-language explanation, written to be shown. Never carries an exception message

string