Skip to content
AetherAether Docs

Create a new app

POST
/v1/apps
curl --request POST \
  --url https://api.aetherpush.com/v1/apps \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "my-react-native-app", "manuallyProvisionDeployments": false }'

Creates a new app under the current account. By default, two deployments named Production and Staging are auto-provisioned. Pass manuallyProvisionDeployments: true to skip this and create deployments manually.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
>= 1 characters <= 255 characters
manuallyProvisionDeployments

When true, the app is created without the default Production and Staging deployments. Defaults to false.

boolean
Example
{
  "name": "my-react-native-app",
  "manuallyProvisionDeployments": false
}

Responses

Section titled “Responses”

201

Section titled “201”

App created.

Media typeapplication/json
object
app
required
object
name
required
string
<= 255 characters
collaborators

Map keyed by collaborator email.

object
key
additional properties
object
permission
required

App role. Owner controls the app; Admin manages collaborators and deployments on top of Developer; Developer performs release operations; Viewer is read-only.

string
Allowed values: Owner Admin Developer Viewer
isCurrentAccount
boolean
deployments

List of deployment names registered under this app.

Array<string>
capabilities

Named permissions the requesting account holds on this app.

Array<string>
Allowed values: app.read app.manage app.delete app.transfer collaborators.manage deployments.manage releases.deploy releases.promote releases.rollback metrics.read deploymentKeys.read
Example
{
  "app": {
    "name": "my-react-native-app",
    "deployments": [
      "Production",
      "Staging"
    ]
  }
}

Headers

Section titled “Headers”
Location
string

400

Section titled “400”

Validation error.

Media typeapplication/json
One of:
object
error
required

Human-readable error message.

string
requestId

Unique identifier for the request, also exposed as the X-Request-Id response header.

string
Example
{
  "error": "The requested resource was not found.",
  "requestId": "req_abc123"
}

401

Section titled “401”

Unauthenticated.

Media typeapplication/json
object
error
required

Human-readable error message.

string
requestId

Unique identifier for the request, also exposed as the X-Request-Id response header.

string
Example
{
  "error": "The requested resource was not found.",
  "requestId": "req_abc123"
}

409

Section titled “409”

An app with that name already exists.

Media typeapplication/json
object
error
required

Human-readable error message.

string
requestId

Unique identifier for the request, also exposed as the X-Request-Id response header.

string
Example
{
  "error": "The requested resource was not found.",
  "requestId": "req_abc123"
}