Skip to main content
POST
Create 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.

Headers

Idempotency-Key
string

A caller-generated key for safely retrying this side effect. The server retains the key and response for 24 hours. Reusing it with the same request replays the original response; reusing it with different input returns 409.

Required string length: 1 - 128
Pattern: ^[!-~]+$
Example:

"req_01J6M6Y9TF9Q9QF6M1ZP8K4R2A"

Body

application/json
slug
string

Optional stable name. The service names api, mail, and www are reserved.

Pattern: ^[a-z0-9]{1,63}$
blank
boolean
default:false
visibility
enum<string>
default:public
Available options:
private,
public
auto_delete_after
string

Positive Go duration such as 24h.

network_policy
object

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.

start
object
Example:

Response

The current computer state.

id
string
required
hostname
string
required
slug
string
required
ip
string
required
status
string
required
visibility
enum<string>
required
Available options:
private,
public
access
enum<string>
required
Available options:
owner,
can_use
site
boolean
required

The URL serves the computer's published files: from the edge, or from its VM's built-in site server, which answers what no file matches with the program on the exposed port.

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
public_url
string<uri>
email_address
string<email>
auto_delete_at
string<date-time> | null
creation_mode
string