ably.io – platform

OpenAPI apis-guru cloud

The for Ably.

Homepage: https://api.apis.guru/v2/specs/ably.io:platform/1.1.0.json
Provider: ably.io:platform / platform
OpenAPI version: 3.0.1
Spec (JSON): https://api.apis.guru/v2/specs/ably.io/platform/1.1.0/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/ably.io/platform/1.1.0/openapi.yaml

Tools (24)

Extracted live via the executor SDK.

authentication.requestAccessToken

This is the means by which clients obtain access tokens to use the service. You can see how to construct an Ably TokenRequest in the documentation, although we recommend you use an Ably SDK rather to create a TokenRequest, as the construction of a TokenRequest is complex. The resulting token response object contains the token properties as defined in Ably TokenRequest spec. Authentication is not required if using a Signed TokenRequest.
history.getMessagesByChannel

Get message history for a channel
history.getPresenceHistoryOfChannel

Get presence on a channel
publishing.publishMessagesToChannel

Publish a message to the specified channel
push.deletePushDeviceDetails

Delete a device details object.
push.getChannelsWithPushSubscribers

Returns a paginated response of channel names.
push.getPushDeviceDetails

Get the full details of a device.
push.getPushSubscriptionsOnChannels

Get a list of push notification subscriptions to channels.
push.getRegisteredPushDevices

List of device details of devices registed for push notifications.
push.patchPushDeviceDetails

Specific attributes of an existing registration can be updated. Only clientId, metadata and push.recipient are mutable.
push.publishPushNotificationToDevices

A convenience endpoint to deliver a push notification payload to a single device or set of devices identified by their client identifier.
push.putPushDeviceDetails

Device registrations can be upserted (the existing registration is replaced entirely) with a PUT operation. Only clientId, metadata and push.recipient are mutable.
push.registerPushDevice

Register a device’s details, including the information necessary to deliver push notifications to it. Requires "push-admin" capability.
push.subscribePushDeviceToChannel

Subscribe either a single device or all devices associated with a client ID to receive push notifications from messages sent to a channel.
push.unregisterAllPushDevices

Unregisters devices. All their subscriptions for receiving push notifications through channels will also be deleted.
push.unregisterPushDevice

Unregisters a single device by its device ID. All its subscriptions for receiving push notifications through channels will also be deleted.
push.updatePushDeviceDetails

Gets an updated device details object.
stats.getStats

The Ably system can be queried to obtain usage statistics for a given application, and results are provided aggregated across all channels in use in the application in the specified period. Stats may be used to track usage against account quotas.
stats.getTime

This returns the service time in milliseconds since the epoch.
status.getMetadataOfAllChannels

Enumerate all active channels of the application
status.getMetadataOfChannel

Get metadata of a channel
status.getPresenceOfChannel

Get presence on a channel
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools