---
title: "Get a computer"
description: "Returns the current lifecycle, address, visibility, and network state for one computer."
canonical: "https://www.cool.computer/docs/api-reference/computers/get-a-computer"
---
# Get a computer

> Returns the current lifecycle, address, visibility, and network state for one computer.

```http
GET https://api.cool.computer/api/computers/{id}
```

Returns the current lifecycle, address, visibility, and network state for one computer.

## Authorization

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

## Parameters

- `id` (path, string, at least 1 characters, 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.

## Responses

- `200`: The current computer state.
  - `application/json` (object)
    - `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.
    - `url` (string, uri)
    - `email_address` (string, email)
    - `visibility` ("private" or "public", required)
    - `access` ("owner" or "can_use" or "claim_key", 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.
    - `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.
      - `mode` ("open" or "none" or "allowlist", required)
      - `allowed_hosts` (array of string, at most 100 items): Required and non-empty only when mode is allowlist. Each value is a hostname, public IP, or leading wildcard such as \*.example.com, without a scheme, port, path, or CIDR.
    - `created_at` (string, date-time, required)
    - `auto_delete_at` (string or null, date-time): 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)
- `401`: Unauthorized.
- `404`: Not Found. `computer_not_found`: the computer does not exist or is not yours.
- `429`: Too Many Requests. If the problem code is api_request_rate_exceeded, wait for Retry-After seconds; other problem codes describe a separate limit.
- `500`: Internal Server Error.
- `default`: A machine-readable API error with a stable code and recovery instruction.

An error is an `application/problem+json` document with a stable `code`; [API errors](/docs/api-reference/errors) says how to handle one.

## Example

```sh
curl "https://api.cool.computer/api/computers/$PARAM_ID" \
  -H "authorization: Bearer $TOKEN"
```
