Skip to content

Read who has access

Read a Computer's HTTPS address, website access, shares and share-link status. The response also lists verified custom domains and published TCP ports.

Parameters

#
computerstringRequired
Computer name or ID.

Returns

#
dataobjectAlways present
The Computer's sharing and website configuration.
Show 15 attributesHide attributes
computerstringAlways present
Computer name.
default_portintegerAlways present
Image's default website port. Zero means none is known.
domainsstring[] | nullAlways present
Custom domain names assigned to this Computer.
grantsobject[] | nullAlways present
People with access and how it was granted.
Show 1 attributeHide attributes
itemsobject
A person's access grant on a Computer.
Show 11 attributesHide attributes
commandsstring[]
Additional management commands this grant permits. May be omitted.
emailstringAlways present
Recipient's email address.
granted_atstring (date-time)Always present
When access was granted.
granted_bystringAlways present
Person who granted access.
namestring
Recipient's display name, when set. May be omitted.
noticestring
Latest sharing email status. May be omitted.
picturestring
Recipient's profile picture URL. May be omitted.
rolestringAlways present
Access role. Root permits guest access; ownership is separate.
user_idstringAlways present
Recipient's user ID.
viastringAlways present
How this access was granted.
invitationsobject[] | nullAlways present
Outstanding or recorded email invitations for this Computer.
Show 1 attributeHide attributes
itemsobject
An email invitation to access a Computer.
Show 9 attributesHide attributes
commandsstring[] | nullAlways present
Additional commands the invitation grants.
emailstringAlways present
Invited email address.
expires_atstring (date-time)Always present
When the invitation expires.
idstringAlways present
Invitation ID.
invited_atstring (date-time)Always present
When the invitation was sent.
invited_bystringAlways present
Who sent the invitation.
noticestring | nullAlways present
Latest invitation email's state, or null without a recorded notice.
rolestringAlways present
Role granted when the invitation is accepted.
statestringAlways present
Invitation's current state.
portintegerAlways present
Selected website guest port. Zero uses the image default.
portsobject[] | nullAlways present
Published public ports for the Computer.
Show 1 attributeHide attributes
itemsobject
A public port forwarding traffic to a Computer.
Show 7 attributesHide attributes
addressstringAlways present
Public connection address.
computer_idstringAlways present
Computer ID.
guest_portintegerAlways present
Destination port inside the Computer.
namestringAlways present
Computer name.
organizationstring
Computer's organization, when applicable. May be omitted.
portintegerAlways present
Public port to connect to.
published_atstring (date-time)Always present
When the port was published.
publicbooleanAlways present
Whether anyone can open the main website.
support_rootbooleanAlways present
Whether Heaven support has Root access.
team_commandsstring[]
Additional commands granted to the whole organization. May be omitted.
team_rolestring
Share role granted to the whole organization. May be omitted.
teamsobject[] | nullAlways present
Shares granted to individual organization teams.
Show 1 attributeHide attributes
itemsobject
A Computer share granted to an organization team.
Show 5 attributesHide attributes
commandsstring[] | nullAlways present
Additional commands granted to the team.
granted_atstring (date-time)Always present
When the share was granted.
granted_bystringAlways present
Who granted the share.
rolestringAlways present
Team's share role on this Computer.
teamstringAlways present
Recipient team's name.
urlstringAlways present
Its main website URL.
website_accessstringAlways present
Who can open the website: private grantees, the organization or the public. Values: "private", "organization", "public".

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

#
  • API key permission: access.