Ably Platform REST API

REST discovered

Details Spec supplied by APIs.guru

URL: https://rest.ably.io
Spec: https://api.apis.guru/v2/specs/ably.io/platform/1.1.0/openapi.json
Spec (yaml): https://raw.githubusercontent.com/ably/open-specs/main/definitions/platform-v1.yaml
Docs: https://ably.com/docs/api/rest-api

Authentication

Ably API key + Ably API key Authorization: Basic <credential> discovered

Ably API key basic

Create or manage API keys for an app from the Ably dashboard or via the Control API/CLI. Ably documents API keys as the credential used for Basic auth with the data-plane APIs; the value format is appId.keyId:keySecret and should only be used on trusted servers. See Basic auth and the key-management capability mappings on Access tokens.

Ably data-plane token or JWT + Ably data-plane token or JWT Authorization: Bearer <credential> discovered

Ably data-plane token or JWT compound

For client-safe data-plane access, issue a short-lived token instead of exposing an API key. Ably recommends JWTs: your trusted server uses your Ably API key to mint a JWT as described in Token auth. Ably also supports native Ably tokens issued via Ably's token flow. Use the approach described in Token auth; clients then present the resulting bearer token to Ably.