Skip to content
AetherAether Docs

Rename an app

PATCH
/v1/apps/{appName}
curl --request PATCH \
  --url https://api.aetherpush.com/v1/apps/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "my-renamed-app" }'

Updates the app’s name. Requires the app.manage permission (Owner). Note that renaming changes the resource path — clients must update their references.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
appName
required
string

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

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

Body shape for renaming an app. All fields optional.

object
name
string
>= 1 characters <= 255 characters
Example
{
  "name": "my-renamed-app"
}

Responses

Section titled “Responses”

200

Section titled “200”

App renamed.

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

403

Section titled “403”

Insufficient permissions (app.manage required).

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

404

Section titled “404”

App not found.

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”

Another 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"
}