Skip to content

Revoke a channel's handshake

POST
/api/v1/channels/captured/{realmName}/{channelName}/handshake/revoke
curl --request POST \
--url http://localhost:11044/api/v1/channels/captured/example/example/handshake/revoke \
--header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

JSON fields: installationId, expectedRevision.

realmName
required
string

Name of the captured realm installed in the signed-in owner’s world; non-blank, at most 256 UTF-8 bytes, no control characters and not all * (400 otherwise). 409 when its live installation is not the one named by the body’s installationId and expectedRevision

channelName
required
string

Channel the realm declares, by the name the channel list gives; same text rules as the realm name. 404 when undeclared, 400 when the channel declares no handshake or no dial credential, or its handshake operation is undeclared, outside the egress policy, or its credential is unbound; 409 when its handshake is not approved

OK

Media type*/*

Where one channel’s pre-connect handshake approval stands after POST …/handshake/grant or …/handshake/revoke on /channels/captured/{realmName}/{channelName}

object
approved
required

True when the handshake is now approved to run its declared operation under the channel’s own credential; false when the approval was revoked

boolean
channel
required

Name of the channel, as the realm declares it

string
installationId
required

The realm installation the approval was recorded on

string
realmName
required

Name of the captured realm the channel belongs to

string
revision
required

The installation’s revision after the change: what the next start, stop or handshake decision must send back as expectedRevision

integer format: int64