Skip to main content
POST
Get path metadata
Get metadata for a file or directory.
See error examples and recovery steps. The complete OpenAPI contract includes every response schema.

Authorizations

Authorization
string
header
required

The server's token (MIRAGE_AUTH_TOKEN) or a JWT. A daemon in the default local mode with no token accepts requests without one.

Path Parameters

workspace_id
string
required

Workspace ID.

Query Parameters

session_id
string

Session ID to use. If omitted, the default session is used.

explain
boolean
default:false

Return what the call would do without running it.

Body

application/json
path
string
required
nofollow
boolean

Act on a symbolic link itself rather than its target.

Response

200 - application/json

entry is what the call returns. With explain=true, explanation says what the call would do; nothing runs.

entry
FileStat · object
required

Metadata for one path. A field the backend does not know is null.