---
title: "Inspect a file"
description: "Returns type, size, ownership, mode, and modification time for one path, including a published file under /home/runtime/app on a published site with no VM."
canonical: "https://www.cool.computer/docs/api-reference/files/inspect-a-file"
---
# Inspect a file

> Returns type, size, ownership, mode, and modification time for one path, including a published file under /home/runtime/app on a published site with no VM.

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

Returns type, size, ownership, mode, and modification time for one path, including a published file under /home/runtime/app on a published site with no VM.

## 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.
- `path` (query, string, at least 1 characters, required): Path inside the computer. A relative path is relative to /home/runtime, or to /home/runtime/app on a published site without a VM.

## Responses

- `200`: File metadata.
  - `application/json` (object)
    - `name` (string, required)
    - `type` ("file" or "directory" or "symlink", required)
    - `size` (integer, int64, at least 0, required)
    - `mtime` (string, date-time, required)
    - `mode` (string, required)
    - `uid` (integer, at least 0, required)
    - `gid` (integer, at least 0, required)
- `400`: Bad Request.
- `401`: Unauthorized.
- `402`: Payment Required. `pro_required`: this computer has a VM and the account is not Pro, which fences it; a site without a VM works on Free. Start Pro with cool billing upgrade, or fix a lapsed subscription with cool billing portal, or use the Account page.
- `403`: Forbidden.
- `404`: Not Found. `computer_not_found`: the computer does not exist or is not yours. `file_not_found`: the path does not exist on it.
- `409`: Conflict. `outside_published_files`: the computer is a published site with no VM, which has only /home/runtime/app; name a path there.
- `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.
- `503`: Service Unavailable. `computer_starting` means the computer is starting, or stopped and being started again; wait for Retry-After seconds, then retry. Otherwise inspect the problem code and resolution.
- `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/files/stat" \
  --url-query "path=$PARAM_PATH" \
  -H "authorization: Bearer $TOKEN"
```

`--url-query` encodes the value it sends and needs curl 7.87 or later.
