Skip to main content
GET
Get a computer

Authorizations

Authorization
string
header
required

A Cool Computers API key, user access token, or claimed agent access token in the Authorization header. Follow https://www.cool.computer/auth.md for agent registration and https://www.cool.computer/authentication.md for direct user credentials.

Path Parameters

id
string
required

The computer's name, such as agent-atlas, or its id (cmp_…). Every caller may use either, the computer's own runtime token included.

Minimum string length: 1
Example:

"agent-atlas"

Response

The current computer state.

id
string
required
hostname
string
required
name
string
required
ip
string
required
status
string
required

artifact (no VM), creating, running, stopped while its account's Pro has lapsed (its VM is stopped and deleted at auto_delete_at unless Pro returns; once Pro returns it can show running briefly until the reconciler has started its VM), or deleting from when its deletion begins until it is gone.

visibility
enum<string>
required
Available options:
private,
public
access
enum<string>
required

What the caller holds: owner, can_use for a computer shared with them, or claim_key in the response to a publish without an account, whose claim key republishes to the computer and claims it.

Available options:
owner,
can_use,
claim_key
copy_enabled
boolean
required

People other than the owner may copy the computer into their own accounts (PUT /api/computers/{id}/copy-settings).

site
boolean
required

The URL serves the computer's published files: from the edge, or from its VM's built-in site server until a port is first exposed, when the program on it takes every path but the functions' for good.

network_policy
object
required

Outbound access policy. open allows public destinations, none blocks outbound access, and allowlist permits only the named public hosts. Private and reserved addresses remain blocked.

created_at
string<date-time>
required
url
string<uri>
email_address
string<email>
auto_delete_at
string<date-time> | null

When the computer is deleted by itself: its own auto-delete deadline, or, for a VM of an account whose Pro lapsed, when its stopped VMs are deleted, whichever comes first.

creation_mode
string