Skip to content

Stop one channel

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

JSON fields: installationId, expectedRevision. The channel stays closed until the owner starts it again.

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). 404 when it has no live installation, 409 when that 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

OK

Media type*/*

A captured realm’s channels, as GET /channels/captured/{realmName} and the start and stop calls answer, with the installation and revision the next change must name back

object
channels
required

Every channel the installation declares, each with its state

Array<object>

One channel a captured realm declares, as its owner sees it in the channel list: its transport, where it stands, and what it is waiting on

object
channel
required

Name of the channel: its declaration file’s stem

string
missingCredentials
required

Credentials the channel needs that no wallet item is bound to. Filled only when blocked; otherwise empty

Array<string>
reason

Why a stopped channel stopped, in the host’s words: revoked, rotation, owner or error. Null in any other state

string
state
required

Running (connected or connecting), ready (may connect, not started), stopped (see reason) or blocked (see the three lists)

string
transport
required

Declared transport: websocket, long-poll or webhook

string
ungrantedSources
required

Event sources the channel publishes into that the owner has not approved. Filled only when blocked; otherwise empty

Array<string>
unreadableCredentials
required

Bound credentials whose wallet item holds no usable secret, so the channel cannot use them; any one blocks the channel. Not checked for a channel the owner stopped

Array<string>
installationId
required

The realm installation these channels belong to; a start or stop must send it back

string
realmName
required

Name of the captured realm

string
revision
required

The installation’s current revision; a start, stop or handshake decision must send it back as expectedRevision, and is refused as a conflict when it has moved

integer format: int64