Sign in

v1

latestOpenAPI 3.0.12026-07-142257126.4 KB
apps

Lists apps

List all applications for the specified account ID.

get/accounts/{account_id}/apps

Path parameters

account_idstring required

The account ID for which to retrieve the associated applications.

Response

List of apps for the specified account are returned

_linksobject nullable

A link self-referencing the app that has been created.

accountIdstring

The ID of your Ably account.

apnsUseSandboxEndpointboolean nullable

Apple Push Notification service endpoint.

idstring

The application ID.

namestring

The application name.

status'enabled' | 'disabled'

The application status. Disabled applications will not accept new connections and will return an error to all clients.

tlsOnlyboolean nullable

Enforce TLS for all connections. This setting overrides any channel setting.

Example response

[
  {
    "accountId": "WgRpOB",
    "id": "28AB6x",
    "name": "Default",
    "status": "enabled",
    "tlsOnly": true
  }
]