> ## Documentation Index
> Fetch the complete documentation index at: https://unkey.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Unkey is two separate products. Compute builds, deploys, and runs apps behind a gateway. API Management issues API keys, enforces rate limits, manages identities and permissions, and reports usage. Say which product a page belongs to; a reader can use either without the other.
> Every Unkey API endpoint is an HTTP POST to https://api.unkey.com/v2/{service}.{procedure} with a root key in the Authorization: Bearer header. Root keys are workspace scoped.
> Error codes have the form err:{system}:{category}:{specific} and each has a page at /errors/{system}/{category}/{specific}.
> The word environment means production or preview in Compute. Rate limiting has four meanings on this site; the glossary lists them.

# unkey api apps update-app

> Rename an app or change its slug, repository, image, or delete protection.

<Note>
  You need a root key with the permissions listed on this page. Create one in the dashboard under **Settings > Root Keys**. See [Permission reference](/docs/platform/root-keys/permissions-legacy) for every permission.
</Note>

Update an <Tooltip tip="A Compute app: a deployable service inside a project. Not your application in general.">app</Tooltip>'s name, slug, GitHub repository connection, image, or delete protection. Flags you omit leave the stored value unchanged.

* Changing the slug changes the hostnames of the app's deployments.
* `--git` with a JSON object connects or changes the repository, and `--git=null` disconnects it. It only works on a GitHub app.
* `--oci` changes the image of an image app. It only works on an image app.
* A request with nothing to update returns `Provide at least one field to update.`

## Usage

```bash theme={"system"}
unkey api apps update-app --project=<project> --app=<app> [--name=<name>] [--slug=<slug>] [--git=<json>|null] [--oci=<json>] [--delete-protection[=false]]
```

## Flags

<ParamField body="--app" type="string" required>
  App ID or slug.
</ParamField>

<ParamField body="--delete-protection" type="boolean">
  Enable (`--delete-protection`) or disable (`--delete-protection=false`) delete protection. Omit the flag to leave the current setting unchanged.
</ParamField>

<ParamField body="--git" type="string">
  GitHub repository update as a JSON object, or `null` to disconnect the repository.
</ParamField>

<ParamField body="--oci" type="string">
  OCI image update as a JSON object with an `image` field. The reference needs an explicit tag or digest.
</ParamField>

<ParamField body="--name" type="string">
  New human-readable name, 1 to 256 characters.
</ParamField>

<ParamField body="--project" type="string" required>
  Project ID or slug. Both forms resolve to the same project.
</ParamField>

<ParamField body="--slug" type="string">
  New app slug, 3 to 255 characters matching `^[a-zA-Z0-9_-]+$`. Must stay unique in the project; a duplicate returns a 409 conflict.
</ParamField>

### Shared flags

Every `unkey api` command accepts these; [CLI output and shared flags](/docs/platform/cli/output-and-flags) describes them in full.

<ParamField body="--body" type="string">
  A JSON document sent as the request body instead of building it from the flags above. It is mutually exclusive with the request-building flags, and unknown fields are rejected locally. See [Send a raw body](/docs/platform/cli/output-and-flags#send-a-raw-body).
</ParamField>

<ParamField body="--root-key" type="string">
  Root key for the request. Falls back to `UNKEY_ROOT_KEY`, then to the config file written by `unkey auth login`. See [CLI authentication](/docs/platform/cli/authentication).
</ParamField>

<ParamField body="--api-url" type="string" default="https://api.unkey.com">
  Base URL of the API. Falls back to `UNKEY_API_BASE_URL`. You don't normally need to set it.
</ParamField>

<ParamField body="--config" type="string" default="~/.unkey/config.toml">
  Path of the TOML file that `unkey auth login` writes. Falls back to `UNKEY_CONFIG`.
</ParamField>

<ParamField body="--output" type="string">
  Output format. Falls back to `UNKEY_OUTPUT`. Set `json` to print the full response envelope (`meta` and `data`) for piping; any other value prints the request ID followed by `data`.
</ParamField>

## Required permissions

Your root key needs one of:

* `app.*.update_app` (any app)
* `app.<app_id>.update_app` (a specific app)

When you pass `--git`, your key also needs `app.*.connect_repository` or `app.<app_id>.connect_repository`.

Without a matching permission the API answers 403 and the CLI prints `Permission denied:` followed by the detail. See [Root key permissions](/docs/platform/root-keys/permissions) for the full catalog.

## Examples

Rename an app:

```bash theme={"system"}
unkey api apps update-app --project=payments --app=app_1234abcd --name='Payments API'
```

Connect a repository:

```bash theme={"system"}
unkey api apps update-app --project=payments --app=payments-api --git='{"repository":"unkeyed/api","defaultBranch":"main"}'
```

Disconnect the repository:

```bash theme={"system"}
unkey api apps update-app --project=payments --app=payments-api --git=null
```

Point the app at a different image:

```bash theme={"system"}
unkey api apps update-app --project=payments --app=payments-api --oci='{"image":"ghcr.io/acme/payments:v1.3.0"}'
```

Send the request body as JSON:

```bash theme={"system"}
unkey api apps update-app --body='{"project":"payments","app":"payments-api","deleteProtection":true}'
```

## API endpoint

The command calls [`POST /v2/apps.updateApp`](/docs/compute/api-reference/apps/update-app) and prints its response. The request fields carry the same names as the flags in camelCase, which is the shape `--body` expects.