{"@context": "https://schema.org", "@type": "WebAPI", "name": "Platform API API", "description": "The [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.", "provider": {"@type": "Organization", "name": "ably.io"}, "documentation": "https://raw.githubusercontent.com/ably/open-specs/main/definitions/platform-v1.yaml"}
The [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://rest.ably.io
auth: b a s i c ,
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
The [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.
| method | path | what the vendor says it does |
|---|---|---|
GET | /channels | Enumerate all active channels of the application Enumerate all active channels of the application Status |
GET | /channels/{channel_id} | Get metadata of a channel Get metadata of a channel Status |
GET | /channels/{channel_id}/messages | Get message history for a channel Get message history for a channel History |
POST | /channels/{channel_id}/messages | Publish a message to a channel Publish a message to the specified channel Publishing |
GET | /channels/{channel_id}/presence | Get presence of a channel Get presence on a channel Status |
GET | /channels/{channel_id}/presence/history | Get presence history of a channel Get presence on a channel History |
POST | /keys/{keyName}/requestToken | Request an access token This is the means by which clients obtain access tokens to use the service. You can se |
GET | /push/channelSubscriptions | List channel subscriptions Get a list of push notification subscriptions to channels. Push |
POST | /push/channelSubscriptions | Subscribe a device to a channel Subscribe either a single device or all devices associated with a client ID to |
DELETE | /push/channelSubscriptions | Delete a registered device's update token Delete a device details object. Push |
GET | /push/channels | List all channels with at least one subscribed device Returns a paginated response of channel names. Push |
GET | /push/deviceRegistrations | List devices registered for receiving push notifications List of device details of devices registed for push n |
POST | /push/deviceRegistrations | Register a device for receiving push notifications Register a device’s details, including the information nece |
DELETE | /push/deviceRegistrations | Unregister matching devices for push notifications Unregisters devices. All their subscriptions for receiving |
GET | /push/deviceRegistrations/{device_id} | Get a device registration Get the full details of a device. Push |
PUT | /push/deviceRegistrations/{device_id} | Update a device registration Device registrations can be upserted (the existing registration is replaced entir |
PATCH | /push/deviceRegistrations/{device_id} | Update a device registration Specific attributes of an existing registration can be updated. Only clientId, me |
DELETE | /push/deviceRegistrations/{device_id} | Unregister a single device for push notifications Unregisters a single device by its device ID. All its subscr |
GET | /push/deviceRegistrations/{device_id}/resetUpdateToken | Reset a registered device's update token Gets an updated device details object. Push |
POST | /push/publish | Publish a push notification to device(s) A convenience endpoint to deliver a push notification payload to a si |
GET | /stats | Retrieve usage statistics for an application The Ably system can be queried to obtain usage statistics for a g |
GET | /time | Get the service time This returns the service time in milliseconds since the epoch. Stats |
specification origin: https://raw.githubusercontent.com/ably/open-specs/main/definitions/platform-v1.yaml
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.