Upload Volume File Endpoint

POST /v1/volumes/{volume_id}/files/upload

Authentication

Requires authentication via: OAuth2PasswordBearer.

Parameters

Name	In	Type	Required	Description	Constraints
volume_id	path	string	Yes
X-API-Key	header	string | null	No		nullable

Request Body

Required: Yes

multipart/form-data

Resolved schema:

{
  "properties": {
    "file": {
      "type": "string",
      "format": "binary",
      "title": "File"
    },
    "path": {
      "type": "string",
      "title": "Path"
    },
    "overwrite": {
      "type": "boolean",
      "title": "Overwrite",
      "default": false
    }
  },
  "type": "object",
  "required": [
    "file",
    "path"
  ],
  "title": "Body_upload_volume_file_endpoint_v1_volumes__volume_id__files_upload_post"
}

Field details:

Field	Type	Required	Description	Constraints
file	string	Yes		format=binary
path	string	Yes
overwrite	boolean	No		default=false

Responses

200

Successful Response

application/json

Resolved schema:

{
  "properties": {
    "path": {
      "type": "string",
      "title": "Path"
    },
    "filename": {
      "type": "string",
      "title": "Filename"
    },
    "size": {
      "type": "integer",
      "title": "Size"
    }
  },
  "type": "object",
  "required": [
    "path",
    "filename",
    "size"
  ],
  "title": "VolumeFileUploadResponse"
}

Field details:

Field	Type	Required	Description	Constraints
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