Finish uploading a file

POST

/{resource}/files/complete

curl --request POST \
  --url https://example.com/v1/example/files/complete \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "uploadId": "example" }'

Checks the file was uploaded as the upload allowed, and adds it to the space’s files under its path.

Authorizations

• token

Parameters

Path Parameters

resource

required

string

/^\d+$/

The project ID of the space

Request Body^required

Media typeapplication/json

object

uploadId

required

string

Example ^generated

{
  "uploadId": "example"
}

Responses

200

The file

Media typeapplication/json

object

path

string

key

string

url

string | null

size

integer

contentType

string

Example ^generated

{
  "path": "example",
  "key": "example",
  "url": "example",
  "size": 1,
  "contentType": "example"
}

400

The upload id isn’t valid, has expired or is for another space (invalidUpload)

Media typeapplication/json

object

error

required

A description of the error

string

code

required

A stable identifier for the kind of error

string

issues

For invalidBody: what failed validation, and where

Array<object>

object

Example ^generated

{
  "error": "example",
  "code": "example",
  "issues": [
    {}
  ]
}

401

The token is missing or invalid.

Media typeapplication/json

object

error

required

A description of the error

string

code

required

A stable identifier for the kind of error

string

issues

For invalidBody: what failed validation, and where

Array<object>

object

Example ^generated

{
  "error": "example",
  "code": "example",
  "issues": [
    {}
  ]
}

403

The token has no access to this space.

Media typeapplication/json

object

error

required

A description of the error

string

code

required

A stable identifier for the kind of error

string

issues

For invalidBody: what failed validation, and where

Array<object>

object

Example ^generated

{
  "error": "example",
  "code": "example",
  "issues": [
    {}
  ]
}

409

The file hasn’t been uploaded (notUploaded), or isn’t the one the upload was for (uploadMismatch)

Media typeapplication/json

object

error

required

A description of the error

string

code

required

A stable identifier for the kind of error

string

issues

For invalidBody: what failed validation, and where

Array<object>

object

Example ^generated

{
  "error": "example",
  "code": "example",
  "issues": [
    {}
  ]
}

429

Too many requests. Retry after Retry-After seconds.

Media typeapplication/json

object

error

required

A description of the error

string

code

required

A stable identifier for the kind of error

string

issues

For invalidBody: what failed validation, and where

Array<object>

object

Example ^generated

{
  "error": "example",
  "code": "example",
  "issues": [
    {}
  ]
}

Headers

Retry-After

integer

Seconds to wait before retrying

502

Something upstream failed.

Media typeapplication/json

object

error

required

A description of the error

string

code

required

A stable identifier for the kind of error

string

issues

For invalidBody: what failed validation, and where

Array<object>

object

Example ^generated

{
  "error": "example",
  "code": "example",
  "issues": [
    {}
  ]
}

503

The space is moving between servers. Retry after Retry-After seconds.

Media typeapplication/json

object

error

required

A description of the error

string

code

required

A stable identifier for the kind of error

string

issues

For invalidBody: what failed validation, and where

Array<object>

object

Example ^generated

{
  "error": "example",
  "code": "example",
  "issues": [
    {}
  ]
}

Headers

Retry-After

integer

Seconds to wait before retrying

504

Something upstream timed out.

Media typeapplication/json

object

error

required

A description of the error

string

code

required

A stable identifier for the kind of error

string

issues

For invalidBody: what failed validation, and where

Array<object>

object

Example ^generated

{
  "error": "example",
  "code": "example",
  "issues": [
    {}
  ]
}