Parameters
#computerstringRequired
Computer name or ID.
labelstring
Label for identifying the link in
access. At most 100 bytes on one line.expiresstring
Link lifetime, from 1s through 365d, or
never. Defaults to 30d.max_usesstring
Maximum number of different browsers that can claim the link. Each browser counts once. Omit for unlimited claims.
Returns
#dataobjectAlways present
A claimable link granting Web access to a Computer.
Show 8 attributesHide attributes
computer_idstringAlways present
Computer the link reaches.
created_bystringAlways present
User who created the link.
expires_atstring (date-time) | nullAlways present
When the link stops accepting claims, or null if it has no expiry.
idstringAlways present
Share link's ID.
labelstringAlways present
Saved label identifying the link.
max_usesinteger | nullAlways present
Maximum number of claims, or null without a limit.
urlstring
Claimable URL, returned on creation. Anyone holding it can claim access while valid. May be omitted.
usesintegerAlways present
Number of claims already made.
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
#- CLI:
heaven loginwithHEAVEN_API_KEYunset. MCP: Heaven sign-in. cURL:HEAVEN_SIGN_IN_KEYfrom approved device sign-in (POST /v1/auth/create). - A key limited to a command list cannot run this command.