Skip to content
Aura

List Files

POST
/api/v1/files/list
curl --request POST \
  --url https://aura.strangeworks.com/api/v1/files/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "deployment_name": "example", "limit": 50, "offset": 0, "path_prefix": "example", "project_id": "example", "snapshot_id": "example", "source": "deployment" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
FileListRequest
object
deployment_name
Any of:
string
limit
Limit
integer
default: 50 >= 1 <= 200
offset
Offset
integer
0
path_prefix
Any of:
string
project_id
Any of:
string
snapshot_id
Any of:
string
source
required
Source
string
Allowed values: deployment workspace snapshot

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
FileListResponse
object
files
required
Files
Array<object>
FileEntry

One file in a container.

content_type/modified/source are populated where the container can supply them: the workspace reads them from its ProjectFile index; deployments and snapshots list straight from storage, so source is null and content_type is derived from the extension.

object
content_type
Any of:
string
modified
Any of:
string format: date-time
path
required
Path
string
size
required
Size
integer
source
Any of:
string
limit
required
Limit
integer
offset
required
Offset
integer
total
required
Total
integer
Examplegenerated
{
  "files": [
    {
      "content_type": "example",
      "modified": "2026-04-15T12:00:00Z",
      "path": "example",
      "size": 1,
      "source": "example"
    }
  ],
  "limit": 1,
  "offset": 1,
  "total": 1
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}