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 Publishing API

The Publishing API from Ably — 1 operation(s) for publishing.

Ably Publishing 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 Publishing. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 1 operation across 1 path, and defines 5 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.

1 operations 1 paths 5 schemas 1 POST

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 Publishing 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 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Publishing 1
POST
/channels/{channel_id}/messages
Publish a message to a channel
publishMessagesToChannel 3 params body → 2XXdefault

Schemas 5

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

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
Message
object
Message object.
8 properties
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-publishing-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 Push API
Ably queues API
Ably rules API
Ably Stats API
Ably Status API
Ably tokens API