Skip to main content
GET
/
api
/
v1
/
files
/
list
List directory contents
curl --request GET \
  --url http://localhost:3000/api/v1/files/list \
  --header 'Authorization: Bearer <token>'
{
  "ok": true,
  "data": null
}

Authorizations

​
Authorization
string
header
required

API key passed as a Bearer token. Configure via the apiKeys field in polpo.json or the POLPO_API_KEY environment variable.

Query Parameters

​
path
string

Directory path to list. Defaults to the project root.

Example:

".polpo/output"

Response

Directory listing with path and entries array

​
ok
boolean
required
​
data
unknown