List a directory

GET

/servers/{serverId}/files

curl --request GET \
  --url 'https://example.com/api/v1/servers/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/files?path=' \
  --cookie __Host-shardkeep_session=<__Host-shardkeep_session>

Needs files.read. Lists one directory of the server’s files (at most 5,000 entries; truncated says if there are more). Symlinks are listed, never followed. All paths are relative to the server’s root; the Agent refuses anything outside it (invalid_path).

Authorizations

• sessionCookie
• bearerToken

Parameters

Path Parameters

serverId

required

string format: uuid

Query Parameters

path

string

"" <= 1024 characters

A path relative to the server’s root; empty for the root.

Responses

200

The directory.

Media typeapplication/json

object

path

required

string

items

required

Array<object>

object

name

required

string

kind

required

string

Allowed values: FILE DIRECTORY SYMLINK OTHER

sizeBytes

required

integer format: int64

modifiedAt

required

string format: date-time

truncated

required

True when the directory has more than 5,000 entries.

boolean

Example

{
  "items": [
    {
      "kind": "FILE"
    }
  ]
}

400

The request is invalid.

Media typeapplication/problem+json

An RFC 9457 problem with a machine-readable code.

object

type

required

string

title

required

string

status

required

integer

detail

string

code

required

Stable machine-readable error code.

string

Example

{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "code": "conflict"
}

401

Not signed in, or the credentials are invalid.

Media typeapplication/problem+json

An RFC 9457 problem with a machine-readable code.

object

type

required

string

title

required

string

status

required

integer

detail

string

code

required

Stable machine-readable error code.

string

Example

{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "code": "conflict"
}

403

Signed in, but not allowed.

Media typeapplication/problem+json

An RFC 9457 problem with a machine-readable code.

object

type

required

string

title

required

string

status

required

integer

detail

string

code

required

Stable machine-readable error code.

string

Example

{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "code": "conflict"
}

404

Not found, or not visible to you.

Media typeapplication/problem+json

An RFC 9457 problem with a machine-readable code.

object

type

required

string

title

required

string

status

required

integer

detail

string

code

required

Stable machine-readable error code.

string

Example

{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "code": "conflict"
}

409

Clashes with existing data or state.

Media typeapplication/problem+json

An RFC 9457 problem with a machine-readable code.

object

type

required

string

title

required

string

status

required

integer

detail

string

code

required

Stable machine-readable error code.

string

Example

{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "code": "conflict"
}

503

The server’s Node is not connected, or did not answer in time (node_unavailable).

Media typeapplication/problem+json

An RFC 9457 problem with a machine-readable code.

object

type

required

string

title

required

string

status

required

integer

detail

string

code

required

Stable machine-readable error code.

string

Example

{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "code": "conflict"
}