Update app

Update an existing app, identified by its id.

The app name, slug, default branch, and delete protection setting can be changed. Omitted fields are left unchanged. Changing the slug affects the deployment domains generated for this app.

Important: The slug cannot collide with an existing app in the same project. A duplicate slug returns a 409 conflict.

Required Permissions

Your root key must have one of the following permissions:

• app.*.update_app (to update any app)
• app.<app_id>.update_app (to update a specific app)

POST /v2/apps.updateApp

Python (SDK)

Python

from unkey.py import Unkey


with Unkey(
    root_key="<YOUR_BEARER_TOKEN_HERE>",
) as unkey:

    res = unkey.apps.update_app(project="payments", app="payments-service", name="Payments API", slug="payments-api", default_branch="main", delete_protection=True)

    # Handle response
    print(res)

200

{
  "data": {
    "createdAt": 1704067200000,
    "defaultBranch": "main",
    "deleteProtection": true,
    "id": "app_1234abcd",
    "isRolledBack": false,
    "name": "Payments API",
    "slug": "payments-api",
    "updatedAt": 1704153600000
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}

Authorizations

Authorization · string · header · required

Unkey uses bearer tokens for authentication. Public integrations use root keys, while the dashboard proxy uses short-lived JWTs. To authenticate, include the token in the Authorization header of each request:

Authorization: Bearer unkey_123

Root keys have specific permissions attached to them, controlling what operations they can perform. Legacy permissions use tuple strings like api.*.create_key; resource permissions use Unkey Resource Names plus actions, like unkey:v1:ws_123:keyspaces/*#create_key. Security best practices:

• Keep root keys secure and never expose them in client-side code
• Use different root keys for different environments
• Rotate keys periodically, especially after team member departures
• Create keys with minimal necessary permissions following least privilege principle
• Monitor key usage with audit logs.

Body

application/json

project · string · required

Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.

Required string length: 3 - 255

Pattern: ^[a-zA-Z0-9_-]+$

Example:

"proj_1234abcd"

app · string · required

Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.

Required string length: 3 - 255

Pattern: ^[a-zA-Z0-9_-]+$

Example:

"proj_1234abcd"

name · string

New human-readable name for the app. Omit this field to leave the current name unchanged.

Required string length: 1 - 256

Example:

"Payments API"

slug · string

Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.

Required string length: 3 - 255

Pattern: ^[a-zA-Z0-9_-]+$

Example:

"proj_1234abcd"

defaultBranch · string

New default git branch deployments track for this app. Omit this field to leave the current branch unchanged.

Required string length: 1 - 256

Example:

"main"

deleteProtection · boolean

Enable or disable delete protection for the app. Omit this field to leave the current setting unchanged.

Example:

true

Response

200

application/json

Successfully updated the app.

meta · object · required

Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The requestId is particularly important when troubleshooting issues with the Unkey support team.

Show child attributes

data · object · required

Show child attributes