> ## 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 deployments stop-deployment

> Stop a running preview deployment and release its compute.

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

Stop a running preview deployment and free its compute resources. It keeps its configuration, and you can bring it back with `start-deployment`. It must be `ready` and in a preview <Tooltip tip="A production or preview environment of a Compute app, not the dashboard label on a key.">environment</Tooltip>. Production deployments can't be stopped. Stopping a deployment that's still shutting down from an earlier stop returns a precondition error. The command returns before the instances are gone. Poll `get-deployment` until the status is `stopped`.

## Usage

```bash theme={"system"}
unkey api deployments stop-deployment --deployment-id=<deployment id>
```

## Flags

<ParamField body="--deployment-id" type="string" required>
  ID of the running deployment to stop.
</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:

* `environment.*.stop_deployment` (any environment)
* `environment.<environment_id>.stop_deployment` (a specific environment)

If the deployment doesn't exist or your key doesn't have the permission, you get the same 404: `The requested deployment does not exist.` See [Root key permissions](/docs/platform/root-keys/permissions) for the full catalog.

## Examples

Stop a preview deployment:

```bash theme={"system"}
unkey api deployments stop-deployment --deployment-id=d_1234abcd
```

Send the request body as JSON:

```bash theme={"system"}
unkey api deployments stop-deployment --body='{"deploymentId":"d_1234abcd"}'
```

## API endpoint

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

## Related

<Columns cols={1}>
  <Card title="Production and preview" href="/docs/compute/concepts/production-and-preview#stop-and-start">
    Stop and start in preview environments and the automatic stop timers.
  </Card>
</Columns>