Skip to main content
GET
Read a file or directory of a snapshot's system files.

Authorizations

Authorization
string
header
required

Opaque instabox access token (1 hour). Refresh with /v1/auth/refresh (refresh token valid 30 days, rotates on use).

Path Parameters

id
string
required

Snapshot ID (sn_, or im_ for older snapshots, + 26 lowercase base32 characters).

Query Parameters

path
string
default:/

Absolute path, at most 4096 bytes (default "/").

Response

The file or directory.

path
string
required

The path read, with symbolic links resolved.

type
enum<string>
required
Available options:
dir,
file,
other
size
integer<int64>
required

Bytes; 0 for a directory.

mode
string
required

As ls -l, for example drwxr-xr-x.

modTime
string<date-time>
required
entries
object[]

A directory's entries, directories first, then by name.

content
string

A text file's content (UTF-8).

binary
boolean

The file is not UTF-8 text; content is empty.

truncated
boolean

The directory has more entries, or the file more bytes, than returned.