Sign in

v1

latestOpenAPI 3.0.12026-07-142257126.4 KB
apps

Creates an app

Creates an application with the specified properties.

post/accounts/{account_id}/apps

Path parameters

account_idstring required

The account ID of the account in which to create the application.

Request body

apnsCertificatestring nullable

The Apple Push Notification service certificate.

apnsPrivateKeystring nullable

The Apple Push Notification service private key.

apnsUseSandboxEndpointboolean nullable

The Apple Push Notification service sandbox endpoint.

fcmKeystring nullable

The Firebase Cloud Messaging key.

namestring required

The name of the application for your reference only.

status'enabled' | 'disabled'

The status of the application. Can be enabled or disabled. Enabled means available to accept inbound connections and all services are available.

tlsOnlyboolean nullable

Enforce TLS for all connections.

Example request

{
  "name": "My App",
  "status": "enabled",
  "tlsOnly": true
}

Response

App created

_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
}