Skip to content

Create an API key

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.

Parameters

#
labelstring
Label to identify the key in api-key view. Use one line of up to 200 bytes.
expiresstring
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.
commandsstring[]
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.
organizationstring
Organization name or ID. A credential, named resource or sole membership can select the organization for you.
scopeobject
Resource scope by pool, Computer or tag. Any matching list grants access within your permissions; each list accepts up to 64 entries.
Show 3 attributesHide attributes
computersstring[]
Computer name or ID in the key's resource scope.
poolsstring[]
Pool name or ID to include with its Computers in the key's resource scope.
tagsstring[]
Tag whose Computers are in the key's resource scope.

Returns

#
dataobjectAlways present
An API key's identity, permissions and lifetime.
Show 13 attributesHide attributes
cmdsstring[] | nullAlways present
Permitted commands, subject to your permissions. * permits all commands for a sign-in key.
computer_namesmap<string, string>
Names of the Computers its scope names, by ID, those its organization still has. May be omitted.
created_atstring (date-time)Always present
When the key was created.
expires_atstring (date-time) | nullAlways present
When the key expires, or null if it has no expiry.
idstringAlways present
Key ID for editing, rotation or revocation.
labelstringAlways present
User-assigned label.
last_used_atstring (date-time) | nullAlways present
Last recorded use, or null if no use has been recorded.
organizationstring
Organization the key acts in. Sign-in keys can omit this to select an organization per request. May be omitted.
previous_secret_expires_atstring (date-time)
Expiry of the replaced secret, included while it remains accepted. May be omitted.
revoked_atstring (date-time) | nullAlways present
When the key was revoked, or null if it has not been revoked.
rotated_atstring (date-time) | nullAlways present
When its secret was last rotated, or null if it has not been rotated.
scopeobject
Resource restrictions in addition to your permissions. An absent scope adds no restriction. May be omitted.
Show 3 attributesHide attributes
computersstring[]
Computer IDs included in the key's scope. May be omitted.
poolsstring[]
Pool IDs included in the key's scope. May be omitted.
tagsstring[]
Tags selecting Computers the key can reach. May be omitted.
tokenstring
Newly issued secret, returned only on creation or rotation. May be omitted.

Errors

#
CodeStatusWhat happened
invalid400An input is missing or invalid.
unauthenticated401The credential is missing, invalid, expired or revoked.
denied403The caller lacks permission for this action.
not_found404The resource is absent or inaccessible to this caller.
conflict409The request conflicts with the current resource state or an earlier request.
over_capacity409The request exceeds a resource or credential allowance.
access_list_full409The change would exceed the access-list allowance.
payment_required402Payment or credit is required.
rate_limited429The caller's request rate exceeds its limit.
busy429Too much work is in progress to accept this request.
unknown503The outcome is unconfirmed; a change may have happened.
unavailable503The 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.