v4

latestSwagger 2.02026-08-0343714211.7 MB

file_actions

File Upload Parts

Begin File Upload

post/file_actions/begin_upload/{path}

Path parameters

pathstring required

Path to operate on.

Response

The FileActions object.

sendobject

Content-Type and File to send

actionstring

Type of upload

ask_about_overwritesboolean

If true, this file exists and you may wish to ask the user for overwrite confirmation

available_partsinteger

Number of parts in the upload

expiresstring

Date/time of when this Upload part expires and the URL cannot be used any more

headersobject

Additional upload headers to provide as part of the upload

http_methodstring

HTTP Method to use for uploading the part, usually PUT

next_partsizeinteger

Size in bytes for this part

parallel_partsboolean

If true, multiple parts may be uploaded in parallel. If false, be sure to only upload one part at a time, in order.

retry_partsboolean

If true, parts may be retried. If false, a part cannot be retried and the upload should be restarted.

parametersobject

Additional HTTP parameters to send with the upload

part_numberinteger

Number of this upload part

partsizeinteger

Size in bytes for the next upload part

pathstring

New file path

refstring

Reference name for this upload part

upload_uristring

URI to upload this part to

Example response

[
  {
    "send": {
      "key": "example value"
    },
    "action": "multipart",
    "ask_about_overwrites": true,
    "available_parts": 1,
    "expires": "example",
    "headers": {
      "key": "example value"
    },
    "http_method": "PUT",
    "next_partsize": 1,
    "parallel_parts": true,
    "retry_parts": true,
    "parameters": {
      "key": "example value"
    },
    "part_number": 1,
    "partsize": 1,
    "path": "path",
    "ref": "upload-1",
    "upload_uri": "example",
    "direct_connection_info": {
      "version": 1,
      "server_name": "example",
      "addresses": [
        "example"
      ],
      "direct_uri": "example",
      "ca_pem": "example"
    }
  }
]