Access keys
An access key lets a program or an AI agent work with your account’s clusters without a person signing in. Owners and admins of an account create them in the control plane under Settings → Access Keys — see Managing access keys for the walkthrough.
Two kinds of key
Section titled “Two kinds of key”| Kind | Looks like | Used with |
|---|---|---|
| REST API | sk-hk-api01-… |
The REST API, at https://api.hyperkub.com/v1 |
| MCP | sk-hk-mcp01-… |
The MCP server, at https://mcp.hyperkub.com/mcp |
A key works on its own endpoint only. A REST key sent to the MCP server, or an
MCP key sent to the REST API, is refused with 401. The kind is chosen when the
key is created and cannot be changed.
Permissions
Section titled “Permissions”A key can do only what its permissions allow. Each permission is a resource and an action: read lists and fetches, write creates and changes, delete removes. Write and delete include read — a key cannot change what it cannot see.
| Resource | Read | Write | Delete |
|---|---|---|---|
| Clusters | List and get clusters and their upgrades | Create, rename, upgrade, enable high availability | Delete clusters |
| Node pools | List and get pools | Create pools, change their node count, labels and taints | Delete pools |
| Nodes | List and get nodes | Restart nodes | — |
| Domains | List and get custom domains | Add domains | Remove domains |
| Cluster credentials | List and get issued kubeconfigs | Issue kubeconfigs | — |
| Kubeconfig download | Download issued kubeconfigs | — | — |
| Activity | Read the account’s activity | — | — |
| Regions and sizes | List regions, versions and node sizes | — | — |
Start from read only and add what the program actually changes. A monitoring script needs read on clusters, node pools and nodes; a CI job that scales a pool before a load test needs write on node pools too.
Cluster limit
Section titled “Cluster limit”By default a key reaches every cluster in the account, including clusters
created later. Limit it to some clusters, and everything outside them —
the clusters themselves and their pools, nodes, domains and credentials — is
answered 404, as if it did not exist.
A key limited to some clusters cannot create new ones.
The account’s activity is not split by cluster: a key with read on activity sees all of it.
Who a key acts as
Section titled “Who a key acts as”A key acts as itself, not as the person who created it. Every change it makes shows in the account’s activity under the key’s name.
It acts with its creator’s authority at most: only owners and admins can create keys, and a key stops working as soon as the person who created it is no longer an owner or admin of the account — removed, or changed to a member role. Create keys from an account that will outlive the project, and create a new key when the person who made one leaves.
Expiry
Section titled “Expiry”A key expires after 30 days, 90 days or a year, or never — chosen when it is
created. An expired key is refused with 401 from that moment, and cannot be
extended: create a new one. Within the hour it is also marked revoked, leaves
the list of active keys and frees its place in the account’s limit; the
account’s activity records that it expired.
How many keys
Section titled “How many keys”An account can hold 10 active keys. Revoked and expired keys do not count. To get more, an owner or admin asks with Request Limit Increase in the account’s quota panel, under Settings → General, where Access keys shows how many are in use.
Who is told
Section titled “Who is told”When a key is created, the account’s other owners and admins get a notification, linked to the activity. A key can reach the account’s clusters without anyone signing in, so the people responsible for the account hear of every new one.
Changing a key
Section titled “Changing a key”Keys are not edited. To give a program other permissions or clusters, create a new key with them, switch the program over, then revoke the old one. A key’s permissions are therefore always the ones it was handed out with.
Revoking a key
Section titled “Revoking a key”Revoke a key under Settings → Access Keys with Revoke in its row menu. It is refused from its next request on, and cannot be restored.
Revoke a key as soon as you suspect it leaked. The secret is shown only once, when the key is created, and Hyperkub stores only a hash of it, so a lost key cannot be recovered either: revoke it and create a new one.