Own Platform? Customize your docs with AI search, analytics, and more.

Claim your docs

Platform

Powered by Specway

Own Platform? Customize your docs with AI search, analytics, and more.

Claim your docs

Platform

Powered by Specway

Endpoints

Enumerate all active channels of the applicationGET
Get message history for a channelGET
Get metadata of a channelGET
Get presence history of a channelGET
Get presence of a channelGET
Publish a message to a channelPOST

Request an access tokenPOST

Delete a registered device's update tokenDELETE
Get a device registrationGET
List all channels with at least one subscribed deviceGET
List channel subscriptionsGET
List devices registered for receiving push notificationsGET
Publish a push notification to device(s)POST
Register a device for receiving push notificationsPOST
Reset a registered device's update tokenGET
Subscribe a device to a channelPOST
Unregister a single device for push notificationsDELETE
Unregister matching devices for push notificationsDELETE
Update a device registrationPUT
Update a device registrationPATCH

Retrieve usage statistics for an applicationGET

Get the service timeGET

Endpoints

Enumerate all active channels of the applicationGET
Get message history for a channelGET
Get metadata of a channelGET
Get presence history of a channelGET
Get presence of a channelGET
Publish a message to a channelPOST

Request an access tokenPOST

Delete a registered device's update tokenDELETE
Get a device registrationGET
List all channels with at least one subscribed deviceGET
List channel subscriptionsGET
List devices registered for receiving push notificationsGET
Publish a push notification to device(s)POST
Register a device for receiving push notificationsPOST
Reset a registered device's update tokenGET
Subscribe a device to a channelPOST
Unregister a single device for push notificationsDELETE
Unregister matching devices for push notificationsDELETE
Update a device registrationPUT
Update a device registrationPATCH

Retrieve usage statistics for an applicationGET

Get the service timeGET

Authentication

How to authenticate with the Platform API API.

basicAuth

http

Basic Authentication using an [API key](https://www.ably.io/documentation/core-features/authentication#basic-authentication).

bearerAuth

http

Token Authentication using an [Ably Token](https://www.ably.io/documentation/core-features/authentication#basic-authentication), or optionally an [Ably JWT](https://www.ably.io/documentation/core-features/authentication#ably-jwt-process).

Authentication

How to authenticate with the Platform API API.

basicAuth

http

Basic Authentication using an [API key](https://www.ably.io/documentation/core-features/authentication#basic-authentication).

bearerAuth

http

Token Authentication using an [Ably Token](https://www.ably.io/documentation/core-features/authentication#basic-authentication), or optionally an [Ably JWT](https://www.ably.io/documentation/core-features/authentication#ably-jwt-process).