GET /channels

Enumerate all active channels of the application

Servers

Request headers

Name Type Required Description
X-Ably-Version String No

The version of the API you wish to use.

Query parameters

Name Type Required Description
format String No

The response format you would like

Possible values:

  • "html"
  • "jsonp"
  • "msgpack"
  • "json"
limit Integer No

Default value: 100

prefix String No

Optionally limits the query to only those channels whose name starts with the given prefix

by String No

optionally specifies whether to return just channel names (by=id) or ChannelDetails (by=value)

Possible values:

  • "id"
  • "value"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.