Get a single app

GET

/v1/apps/{appName}

const url = 'https://api.aetherpush.com/v1/apps/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.aetherpush.com/v1/apps/example \
  --header 'Authorization: Bearer <token>'

Returns app metadata including deployment names and the collaborator map.

Authorizations

accessKeyAuth
apiKeyAuth
read

Parameters

Path Parameters

appName

required

string

The app name. Note that renaming an app changes this path.

Responses

200

App details with deployment names and collaborators.

application/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",
    "collaborators": {
      "alice@example.com": {
        "permission": "Owner",
        "isCurrentAccount": true
      },
      "bob@example.com": {
        "permission": "Developer"
      },
      "carol@example.com": {
        "permission": "Viewer"
      }
    },
    "deployments": [
      "Production",
      "Staging"
    ],
    "capabilities": [
      "app.read"
    ]
  }
}

401

Unauthenticated.

application/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"
}

404

App not found.

application/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"
}