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

The Push API from Ably — 6 operation(s) for push.

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

This API exposes 13 operations across 6 paths, 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.

13 operations 6 paths 5 schemas 3 DELETE5 GET1 PATCH3 POST1 PUT

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 Push 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 13

Across 6 paths, the API surfaces 13 operations — 3 DELETE, 5 GET, 1 PATCH, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Push 13
GET
/push/deviceRegistrations
List devices registered for receiving push notifications
getRegisteredPushDevices 5 params → 2XXdefault
POST
/push/deviceRegistrations
Register a device for receiving push notifications
registerPushDevice 2 params body → 2XXdefault
DELETE
/push/deviceRegistrations
Unregister matching devices for push notifications
unregisterAllPushDevices 4 params → 2XXdefault
GET
/push/deviceRegistrations/{device_id}
Get a device registration
getPushDeviceDetails 3 params → 2XXdefault
PUT
/push/deviceRegistrations/{device_id}
Update a device registration
putPushDeviceDetails 3 params body → 2XXdefault
PATCH
/push/deviceRegistrations/{device_id}
Update a device registration
patchPushDeviceDetails 3 params body → 2XXdefault
DELETE
/push/deviceRegistrations/{device_id}
Unregister a single device for push notifications
unregisterPushDevice 3 params → 2XXdefault
GET
/push/deviceRegistrations/{device_id}/resetUpdateToken
Reset a registered device's update token
updatePushDeviceDetails 3 params → 2XXdefault
GET
/push/channelSubscriptions
List channel subscriptions
getPushSubscriptionsOnChannels 6 params → 2XXdefault
POST
/push/channelSubscriptions
Subscribe a device to a channel
subscribePushDeviceToChannel 2 params body → 2XXdefault
DELETE
/push/channelSubscriptions
Delete a registered device's update token
deletePushDeviceDetails 5 params → 2XXdefault
GET
/push/channels
List all channels with at least one subscribed device
getChannelsWithPushSubscribers 2 params → 2XXdefault
POST
/push/publish
Publish a push notification to device(s)
publishPushNotificationToDevices 2 params body → 2XXdefault

Schemas 5

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

DeviceDetails
object
8 properties
Push
object
5 properties
Recipient
object
Push recipient details for a device.
6 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-push-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 queues API
Ably rules API
Ably Stats API
Ably Status API
Ably tokens API