Query parameters

• limit integer

  Default value is 100.

• prefix string

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

• by string

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

  Values are value or id.

Responses

• 2XX

  OK

  Hide headers attribute Show headers attribute

  • link string Required

    Links to related resources, in the format defined by RFC 5988. This will potentially include a link with relation type next, first, and current, where appropiate.

    Format should match the following pattern: (<(.*)?>; rel=\"(first|current|last)?\",)*(<(.*)?>; rel=\"(first|current|last)?\")+.

  One of:

  array-1 array[object] array-2 array[string]

  Hide attributes Show attributes

  • channelId string Required

    The required name of the channel including any qualifier, if any.

  • region string

    In events relating to the activity of a channel in a specific region, this optionally identifies the region.

  • isGlobalMaster boolean

    In events relating to the activity of a channel in a specific region, this optionally identifies whether or not that region is responsible for global coordination of the channel.

  • status object

    A ChannelStatus instance.

    Hide status attributes Show status attributes object

    • isActive boolean Required

      A required boolean value indicating whether the channel that is the subject of the event is active. For events indicating regional activity of a channel this indicates activity in that region, not global activity.

    • occupancy object

      An Occupancy instance indicating the occupancy of a channel. For events indicating regional activity of a channel this indicates activity in that region, not global activity.

      Hide occupancy attributes Show occupancy attributes object

      • publishers integer

        The number of connections attached to the channel that are authorised to publish.

      • subscribers integer

        The number of connections attached that are authorised to subscribe to messages.

      • presenceSubscribers integer

        The number of connections that are authorised to subscribe to presence messages.

      • presenceConnections integer

        The number of connections that are authorised to enter members into the presence channel.

      • presenceMembers integer

        The number of members currently entered into the presence channel.
• default

  Error

  Hide headers attributes Show headers attributes

  • x-ably-errorcode integer

    The error code.

  • x-ably-errormessage string

    The error message.

  • x-ably-serverid string Required

    The ID for the server communicated with.

  Hide response attributes Show response attributes object

  • message string

    Message explaining the error's cause.

  • code integer

    Error code.

  • statusCode integer

    Status error code.

  • href string

    Link to help with error.

  • serverId string

    Server ID with which error was encountered.