# Read who has access

URL: https://heaven.dev/docs/reference/computers/access
Updated: 2026-11-21

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

`GET /v1/computer/?view=access`

## Parameters

- `computer` (string, required): Computer name or ID.

## Returns

- `data` (object, always present): The Computer's sharing and website configuration.
  - `computer` (string, always present): Computer name.
  - `default_port` (integer, always present): Image's default website port. Zero means none is known.
  - `domains` (string[] | null, always present): Custom domain names assigned to this Computer.
  - `grants` (object[] | null, always present): People with access and how it was granted.
    - `items` (object): A person's access grant on a Computer.
      - `commands` (string[]): Additional management commands this grant permits. May be omitted.
      - `email` (string, always present): Recipient's email address.
      - `granted_at` (string (date-time), always present): When access was granted.
      - `granted_by` (string, always present): Person who granted access.
      - `link_id` (string): Share link that granted access, when applicable. May be omitted.
      - `name` (string): Recipient's display name, when set. May be omitted.
      - `notice` (string): Latest sharing email status. May be omitted.
      - `picture` (string): Recipient's profile picture URL. May be omitted.
      - `role` (string, always present): Access role. Root permits guest access; ownership is separate.
      - `user_id` (string, always present): Recipient's user ID.
      - `via` (string, always present): How this access was granted.
  - `invitations` (object[] | null, always present): Outstanding or recorded email invitations for this Computer.
    - `items` (object): An email invitation to access a Computer.
      - `commands` (string[] | null, always present): Additional commands the invitation grants.
      - `email` (string, always present): Invited email address.
      - `expires_at` (string (date-time), always present): When the invitation expires.
      - `id` (string, always present): Invitation ID.
      - `invited_at` (string (date-time), always present): When the invitation was sent.
      - `invited_by` (string, always present): Who sent the invitation.
      - `notice` (string | null, always present): Latest invitation email's state, or null without a recorded notice.
      - `role` (string, always present): Role granted when the invitation is accepted.
      - `state` (string, always present): Invitation's current state.
  - `links` (object[] | null, always present): Claimable share links and their current states.
    - `items` (object): A share link's metadata.
      - `created_at` (string (date-time), always present): When it was created.
      - `created_by` (string, always present): Who created the link.
      - `expires_at` (string (date-time) | null, always present): When it expires, or null without expiry.
      - `id` (string, always present): Link ID used for removal.
      - `label` (string, always present): Label identifying the link.
      - `max_uses` (integer | null, always present): Claim limit, or null without a limit.
      - `state` (string, always present): Whether the link is still claimable or has ended.
      - `uses` (integer, always present): Claims already made through the link.
  - `port` (integer, always present): Selected website guest port. Zero uses the image default.
  - `ports` (object[] | null, always present): Published public ports for the Computer.
    - `items` (object): A public port forwarding traffic to a Computer.
      - `address` (string, always present): Public connection address.
      - `computer_id` (string, always present): Computer ID.
      - `guest_port` (integer, always present): Destination port inside the Computer.
      - `name` (string, always present): Computer name.
      - `organization` (string): Computer's organization, when applicable. May be omitted.
      - `port` (integer, always present): Public port to connect to.
      - `published_at` (string (date-time), always present): When the port was published.
  - `public` (boolean, always present): Whether anyone can open the main website.
  - `support_root` (boolean, always present): Whether Heaven support has Root access.
  - `team_commands` (string[]): Additional commands granted to the whole organization. May be omitted.
  - `team_role` (string): Share role granted to the whole organization. May be omitted.
  - `teams` (object[] | null, always present): Shares granted to individual organization teams.
    - `items` (object): A Computer share granted to an organization team.
      - `commands` (string[] | null, always present): Additional commands granted to the team.
      - `granted_at` (string (date-time), always present): When the share was granted.
      - `granted_by` (string, always present): Who granted the share.
      - `role` (string, always present): Team's share role on this Computer.
      - `team` (string, always present): Recipient team's name.
  - `url` (string, always present): Its main website URL.
  - `website_access` (string, always present): Who can open the website: private grantees, the organization or the public. Values: `"private"`, `"organization"`, `"public"`.

## Errors

Each code is explained in full at https://heaven.dev/docs/reference/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. |
| `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

- API key permission: `access`.

## Examples

```sh tab="heaven CLI"
heaven access COMPUTER [--qr]
```

```sh tab="SSH"
ssh cli@heaven.dev access COMPUTER [--qr]
```

```sh tab="cURL"
curl "https://heaven.dev/v1/computer/?view=access&computer=my-site" \
  -H "Authorization: Bearer $HEAVEN_API_KEY"
```

```json tab="MCP"
{ "tool": "access",
  "arguments": { "computer": "my-site" } }
```

Response:

```json title="Response excerpt"
{
  "version": 1,
  "data": {
    "computer": "my-site",
    "default_port": 0,
    "domains": [],
    "grants": [],
    "invitations": [],
    "links": [],
    "port": 0,
    "ports": [],
    "public": false,
    "support_root": false,
    "teams": [],
    "url": "https://my-site.heaven.dev/",
    "website_access": "private"
  }
}
```
