Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ably Status API

The Status API from Ably — 3 operation(s) for status.

Ably Status API is one of 12 APIs that Ably publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Status. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 3 operations across 3 paths, and defines 8 schemas. It is described by OpenAPI 3.0.1, at version 1.0.32.

Requests are made against a single base URL, https://control.ably.net/v1.

3 operations 3 paths 8 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.32
Base URL
https://rest.ably.io
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Ably Status API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearer_auth).

  • bearer_auth — Control API uses bearer authentication. You need to generate an access token for use with this API. More details can be found in the Ably docs .

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Status 3
GET
/channels/{channel_id}/presence
Get presence of a channel
getPresenceOfChannel 6 params → 200default
GET
/channels/{channel_id}
Get metadata of a channel
getMetadataOfChannel 3 params → 200default
GET
/channels
Enumerate all active channels of the application
getMetadataOfAllChannels 5 params → 2XXdefault

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are PresenceMessage (8 properties), Push (5 properties), Occupancy (5 properties), Error (5 properties). Each schema is shown below with its type and property counts.

ChannelDetails
object
4 properties 1 required
PresenceMessage
object
8 properties
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 g…
5 properties
Extras
object
Extras object. Currently only allows for [push](https://www.ably.io/documentation/general/push/publishchannel-broadcast-example) extra.
1 property
Push
object
5 properties
ChannelStatus
object
A ChannelStatus instance.
2 properties 1 required
Notification
object
5 properties
Error
object
Returned error from failed REST.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ably-status-api-openapi.yml Raw ↑

Other APIs Ably publishes across the network.

Ably apps API
Ably Authentication API
Ably History API
Ably keys API
Ably namespaces API
Ably Publishing API
Ably Push API
Ably queues API
Ably rules API
Ably Stats API
Ably tokens API