Parameters
#public_keystring
SSH public key text, such as the contents of
~/.ssh/id_ed25519.pub. To create a private website token, omit the public key and give computer.labelstring
Label to identify the key in
ssh-key view. A website token's key defaults to site token.tagstring
Limit an SSH key to Computers with this tag. Use one tag of lowercase letters, digits and hyphens. Use this field or
computer.computerstring
Name or ID of the only Computer this key can reach. Without a public key, creates a token for that Computer's private website. Use this field or
tag.Returns
#dataobjectAlways present
A registered SSH key or a private-site token.
Show 2 attributesHide attributes
alternative-1object
A registered SSH public key and its access restrictions.
Show 8 attributesHide attributes
computerobject
Single Computer this key can reach, when it is limited to one. May be omitted.
Show 2 attributesHide attributes
idstringAlways present
Selected Computer's ID.
namestringAlways present
Current name; empty during deletion or after you lose access.
created_atstring (date-time)
Time the key was added. May be omitted.
fingerprintstringAlways present
Public key fingerprint.
idstringAlways present
Registered key's ID.
labelstringAlways present
User-assigned label.
last_used_atstring (date-time) | nullAlways present
Last recorded SSH sign-in; null if none is recorded. Updates can take five minutes.
public_keystringAlways present
SSH public key.
tagstring
Tag limiting the key to matching Computers, when set. May be omitted.
alternative-2object
A token for a Computer's private website and the key that signed it.
Show 3 attributesHide attributes
keyobjectAlways present
Registered key that signed the token.
Show 8 attributesHide attributes
computerobject
Single Computer this key can reach, when it is limited to one. May be omitted.
Show 2 attributesHide attributes
idstringAlways present
Selected Computer's ID.
namestringAlways present
Current name; empty during deletion or after you lose access.
created_atstring (date-time)
Time the key was added. May be omitted.
fingerprintstringAlways present
Public key fingerprint.
idstringAlways present
Registered key's ID.
labelstringAlways present
User-assigned label.
last_used_atstring (date-time) | nullAlways present
Last recorded SSH sign-in; null if none is recorded. Updates can take five minutes.
public_keystringAlways present
SSH public key.
tagstring
Tag limiting the key to matching Computers, when set. May be omitted.
sitestringAlways present
Private website this token reaches.
tokenstringAlways present
Private-site token, returned only on creation.
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
#- Requires the dashboard or management SSH with a registered key.
- A key limited to a command list cannot run this command.