Skip to main content
POST
Get file metadata

Authorizations

Authorization
string
header
required

API key passed as Bearer token

Path Parameters

id
string
required

Machine ID (e.g. mch_a1b2c3d4)

Body

application/json
path
string
required

Machine path to target. Absolute paths may target valid machine locations such as /workspace, /data, /tmp, or /context where present. Relative paths resolve from the machine cwd when set, otherwise from the selected user's home when user is provided, otherwise from /workspace.

user
string

Optional machine user for relative-path resolution and ownership.

Response

200 - application/json

File metadata

name
string
required
path
string
required

Absolute resolved filesystem path. For machine routes this is an absolute machine path; for volume routes this is an absolute volume-internal path rooted at /.

is_dir
boolean
required
size
integer<uint64>
required
type
string
required

Entry type (e.g. "file", "directory", "symlink")

Example:

"file"

mode
string
Example:

"0644"

permissions
string
Example:

"0644"

owner
string
group
string
modified_time
string<date-time>