# Create an API key

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

Create an API key for one organization, limited by your permissions, its command list and any resource scope. With a resource scope, access follows pool membership and tags. The response returns the secret only once.

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

## Parameters

- `label` (string): Label to identify the key in `api-key view`. Use one line of up to 200 bytes.
- `expires` (string): Key lifetime from creation, from 1s through 365d, or `never`. Omit to keep the key until it is removed, or, from a credential that expires, until that credential does. A delegated key cannot outlive the credential that creates it.
- `commands` (string[]): Command as named by `help`, such as `restart`. Omit for the default read commands if no scope is set, or for the full set of commands available to scoped keys, including writes, if a scope is set. `*` alone requires a browser sign-in and an unscoped key.
- `organization` (string): Organization name or ID. A credential, named resource or sole membership can select the organization for you.
- `scope` (object): Resource scope by pool, Computer or tag. Any matching list grants access within your permissions; each list accepts up to 64 entries.
  - `computers` (string[]): Computer name or ID in the key's resource scope.
  - `pools` (string[]): Pool name or ID to include with its Computers in the key's resource scope.
  - `tags` (string[]): Tag whose Computers are in the key's resource scope.

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

- A key that expires cannot give a key a later expiry than its own, and CLI and MCP sign-ins last 90 days. Use management SSH or the dashboard for a longer expiry or `never`.
- API key permission: `api-key create`.

## Examples

```sh tab="heaven CLI"
heaven api-key create
  [--label LABEL]
  [--expires DURATION]
  [--command COMMAND ...]
  [--scope-pool SCOPE-POOL ...]
  [--scope-computer SCOPE-COMPUTER ...]
  [--scope-tag SCOPE-TAG ...]
  [--organization ORGANIZATION]
```

```sh tab="SSH"
ssh cli@heaven.dev api-key create
  [--label LABEL]
  [--expires DURATION]
  [--command COMMAND ...]
  [--scope-pool SCOPE-POOL ...]
  [--scope-computer SCOPE-COMPUTER ...]
  [--scope-tag SCOPE-TAG ...]
  [--organization ORGANIZATION]
```

```sh tab="cURL"
curl https://heaven.dev/v1/account/api-key/create \
  -H "Authorization: Bearer $HEAVEN_API_KEY" \
  --json '{"label": "deploy", "expires": "7d", "commands": ["view", "restart"]}'
```

```json tab="MCP"
{ "tool": "api-key_create",
  "arguments": { "label": "deploy", "expires": "7d", "commands": ["view", "restart"] } }
```

Response:

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