# Rotate an API key

URL: https://heaven.dev/docs/reference/api-keys/rotate
Updated: 2026-11-21

Replace an active API key's secret and return the new secret once. The old secret works for up to 24 hours by default, bounded by the key's expiration. Use `overlap` 0 to revoke it immediately. An API key can rotate only itself.

`POST /v1/account/api-key/modify`

## Parameters

- `key` (string, required): The key's ID (see `api-key view`).
- `overlap` (string): How long the old secret can still authenticate, from 0 to 7d. Defaults to 24h. Use 0 to revoke it immediately. The key's own expiration still applies.

## Returns

- `data` (object, always present): An API key's identity, permissions and lifetime.
  - `cmds` (string[] | null, always present): Permitted commands, subject to your permissions. `*` permits all commands for a sign-in key.
  - `computer_names` (map<string, string>): Names of the Computers its scope names, by ID, those its organization still has. May be omitted.
  - `created_at` (string (date-time), always present): When the key was created.
  - `expires_at` (string (date-time) | null, always present): When the key expires, or null if it has no expiry.
  - `id` (string, always present): Key ID for editing, rotation or revocation.
  - `label` (string, always present): User-assigned label.
  - `last_used_at` (string (date-time) | null, always present): Last recorded use, or null if no use has been recorded.
  - `organization` (string): Organization the key acts in. Sign-in keys can omit this to select an organization per request. May be omitted.
  - `previous_secret_expires_at` (string (date-time)): Expiry of the replaced secret, included while it remains accepted. May be omitted.
  - `revoked_at` (string (date-time) | null, always present): When the key was revoked, or null if it has not been revoked.
  - `rotated_at` (string (date-time) | null, always present): When its secret was last rotated, or null if it has not been rotated.
  - `scope` (object): Resource restrictions in addition to your permissions. An absent scope adds no restriction. May be omitted.
    - `computers` (string[]): Computer IDs included in the key's scope. May be omitted.
    - `pools` (string[]): Pool IDs included in the key's scope. May be omitted.
    - `tags` (string[]): Tags selecting Computers the key can reach. May be omitted.
  - `token` (string): Newly issued secret, returned only on creation or rotation. May be omitted.

## Errors

Each code is explained in full at https://heaven.dev/docs/reference/errors.

| Code | Status | What happened |
|---|---:|---|
| `invalid` | 400 | An input is missing or invalid. |
| `unauthenticated` | 401 | The credential is missing, invalid, expired or revoked. |
| `denied` | 403 | The caller lacks permission for this action. |
| `not_found` | 404 | The resource is absent or inaccessible to this caller. |
| `conflict` | 409 | The request conflicts with the current resource state or an earlier request. |
| `over_capacity` | 409 | The request exceeds a resource or credential allowance. |
| `access_list_full` | 409 | The change would exceed the access-list allowance. |
| `payment_required` | 402 | Payment or credit is required. |
| `rate_limited` | 429 | The caller's request rate exceeds its limit. |
| `busy` | 429 | Too much work is in progress to accept this request. |
| `unknown` | 503 | The outcome is unconfirmed; a change may have happened. |
| `unavailable` | 503 | The service or requested feature is unavailable. |

## Notes

- This example uses management SSH. A key, including a CLI or MCP sign-in, can rotate only itself.
- API key permission: `api-key rotate`.

## Examples

```sh
ssh cli@heaven.dev api-key rotate KEY [--overlap OVERLAP]
```

Response:

```json title="Response excerpt"
{
  "version": 1,
  "data": {
    "cmds": [
      "help",
      "account view",
      "view"
    ],
    "created_at": "2026-11-16T12:00:00Z",
    "expires_at": "2026-12-16T12:00:00Z",
    "id": "5ad2f04d-1fdc-46c5-aa17-47acd11e5ca8",
    "label": "deploy",
    "last_used_at": null,
    "organization": "acme",
    "previous_secret_expires_at": "2026-11-16T13:00:00Z",
    "revoked_at": null,
    "rotated_at": "2026-11-16T12:00:00Z",
    "token": "heaven1.YjAwZDg2NWZmYzc3ODU4NmEwYmFlY2MxM2FlN2Y0ZGY"
  }
}
```
