List Volume Files Endpoint

GET /v1/volumes/{volume_id}/files

Authentication

Requires authentication via: OAuth2PasswordBearer.

Parameters

Name	In	Type	Required	Description	Constraints
volume_id	path	string	Yes
prefix	query	string	No		default="", minLength=0
recursive	query	boolean	No		default=true
limit	query	integer	No		default=1000, min=1, max=5000
X-API-Key	header	string | null	No		nullable

Responses

200

Successful Response

application/json

Resolved schema:

{
  "type": "array",
  "items": {
    "properties": {
      "path": {
        "type": "string",
        "title": "Path"
      },
      "filename": {
        "type": "string",
        "title": "Filename"
      },
      "size": {
        "type": "integer",
        "title": "Size"
      }
    },
    "type": "object",
    "required": [
      "path",
      "filename",
      "size"
    ],
    "title": "VolumeFileListEntryResponse"
  },
  "title": "Response List Volume Files Endpoint V1 Volumes  Volume Id  Files Get"
}

Field details:

Field	Type	Required	Description	Constraints
[]	object	Yes
[].path	string	Yes
[].filename	string	Yes
[].size	integer	Yes

422

Validation Error

application/json

Resolved schema:

{
  "properties": {
    "detail": {
      "items": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

Field details:

Field	Type	Required	Description	Constraints
detail	array<object>	No
detail[]	object	No
detail[].loc	array<string | integer>	No
detail[].loc[]	string | integer	No
detail[].msg	string	No
detail[].type	string	No