Skip to content

List host channel approvals

GET
/api/v1/channels
curl --request GET \
--url http://localhost:11044/api/v1/channels \
--header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Approval and runtime state. No credential is included.

OK

Media type*/*
Array<object>

One built-in channel’s approval in the signed-in owner’s world, and whether it is running; holds no wallet key and no secret. Answered by GET /channels and the /channels/{name} adopt, upgrade, start, stop and revoke routes

object
autoStart
required

Whether the channel starts by itself when the owner’s world activates

boolean
lifecycle
required

Runtime state, lowercase: running or stopped, or unavailable when nothing on this host can run a host channel

string
name
required

Name of the channel, as named in the route path

string
provider
required

Messaging provider, lowercase: discord, slack or telegram

string
revision
required

This approval’s revision; send it back as expectedRevision on start, stop, upgrade or revoke

integer format: int64
revoked
required

Whether the approval has been revoked; a revoked channel can still be stopped

boolean
sourceId
required

Id of this approval; send it back as sourceId on start, stop, upgrade or revoke

string