Skip to content
Aura

Plan Upload

POST
/api/v1/files/upload
curl --request POST \
  --url https://aura.strangeworks.com/api/v1/files/upload \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "content_type": "application/octet-stream", "deployment_name": "example", "path": "example", "project_id": "example", "size": 1, "snapshot_id": "example", "source": "deployment" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
FileUploadRequest
object
content_type
Content Type
string
default: application/octet-stream <= 255 characters
deployment_name
Any of:
string
path
required
Path
string
>= 1 characters
project_id
Any of:
string
size
required
Size
integer
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
UploadPlanResponse
object
plan
required
One of: discriminator: mode
SinglePutPlan
object
expires_at
required
Expires At
string format: date-time
headers
required
Headers
object
key
additional properties
string
method
required
Method
string
mode
Mode
string
default: single_put
Allowed value: single_put
url
required
Url
string
upload_token
required
Upload Token
string
Example
{
  "plan": {
    "mode": "single_put"
  }
}

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"
    }
  ]
}