Skip to content
MoltaroMoltaroMoltaro Docs

Create or idempotently resume a managed multipart upload.

POST
/api/workspace/files/uploads
curl --request POST \
  --url https://example.com/api/workspace/files/uploads \
  --header 'Content-Type: application/json' \
  --data '{ "TargetFolderId": "example", "RequestedFileName": "example", "DeclaredMimeType": "example", "DeclaredSizeBytes": 1, "ClientDeclaredSha256": "example", "IdempotencyKey": "example", "OwnerModuleKey": "example", "OwnerResourceKind": "example", "OwnerContextResourceId": "example", "OwnerResourceObjectId": "example", "Description": "example" }'

Authorizations

Section titled “Authorizations”
  • None

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
access_token
string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Request Body

Section titled “Request Body”

Request to create an S3-backed managed FileSystem upload.

object
TargetFolderId
string
nullable
RequestedFileName
string
nullable
DeclaredMimeType
string
nullable
DeclaredSizeBytes
integer format: int64
ClientDeclaredSha256
string
nullable
IdempotencyKey
string
nullable
OwnerModuleKey
string
nullable
OwnerResourceKind
string
nullable
OwnerContextResourceId
string
nullable
OwnerResourceObjectId
string
nullable
Description
string
nullable
Examplegenerated
{
  "TargetFolderId": "example",
  "RequestedFileName": "example",
  "DeclaredMimeType": "example",
  "DeclaredSizeBytes": 1,
  "ClientDeclaredSha256": "example",
  "IdempotencyKey": "example",
  "OwnerModuleKey": "example",
  "OwnerResourceKind": "example",
  "OwnerContextResourceId": "example",
  "OwnerResourceObjectId": "example",
  "Description": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
Data

Public state of a resumable managed file upload. PublishedFileReferenceId is non-null only once the session reaches Available.

object
UploadSessionId
string
nullable
FileBodyGenerationId
string
nullable
TargetFolderId
string
nullable
RequestedFileName
string
nullable
DeclaredMimeType
string
nullable
DeclaredSizeBytes
integer format: int64
ClientDeclaredSha256
string
nullable
PartSizeBytes
integer format: int32
MaximumParallelParts
integer format: int32
ExpiresAtUtc
string format: date-time
ClientChecksumAlgorithm
string
nullable
ClientChecksumRequired
boolean
Status
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11
RowVersion
string format: uuid
AlreadyUploadedParts
Array<object>
nullable

One provider-confirmed uploaded part safe to expose for resume.

object
PartNumber
integer format: int32
SizeBytes
integer format: int64
FailureCode
string
nullable
PublishedFileReferenceId
string
nullable
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
  "Data": {
    "Status": 0,
    "Errors": [
      {
        "Type": 0,
        "Severity": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
Data

Public state of a resumable managed file upload. PublishedFileReferenceId is non-null only once the session reaches Available.

object
UploadSessionId
string
nullable
FileBodyGenerationId
string
nullable
TargetFolderId
string
nullable
RequestedFileName
string
nullable
DeclaredMimeType
string
nullable
DeclaredSizeBytes
integer format: int64
ClientDeclaredSha256
string
nullable
PartSizeBytes
integer format: int32
MaximumParallelParts
integer format: int32
ExpiresAtUtc
string format: date-time
ClientChecksumAlgorithm
string
nullable
ClientChecksumRequired
boolean
Status
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11
RowVersion
string format: uuid
AlreadyUploadedParts
Array<object>
nullable

One provider-confirmed uploaded part safe to expose for resume.

object
PartNumber
integer format: int32
SizeBytes
integer format: int64
FailureCode
string
nullable
PublishedFileReferenceId
string
nullable
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
  "Data": {
    "Status": 0,
    "Errors": [
      {
        "Type": 0,
        "Severity": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Section titled “404”

Not Found

Media typeapplication/json
object
Data

Public state of a resumable managed file upload. PublishedFileReferenceId is non-null only once the session reaches Available.

object
UploadSessionId
string
nullable
FileBodyGenerationId
string
nullable
TargetFolderId
string
nullable
RequestedFileName
string
nullable
DeclaredMimeType
string
nullable
DeclaredSizeBytes
integer format: int64
ClientDeclaredSha256
string
nullable
PartSizeBytes
integer format: int32
MaximumParallelParts
integer format: int32
ExpiresAtUtc
string format: date-time
ClientChecksumAlgorithm
string
nullable
ClientChecksumRequired
boolean
Status
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11
RowVersion
string format: uuid
AlreadyUploadedParts
Array<object>
nullable

One provider-confirmed uploaded part safe to expose for resume.

object
PartNumber
integer format: int32
SizeBytes
integer format: int64
FailureCode
string
nullable
PublishedFileReferenceId
string
nullable
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
  "Data": {
    "Status": 0,
    "Errors": [
      {
        "Type": 0,
        "Severity": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

409

Section titled “409”

Conflict

Media typeapplication/json
object
Data

Public state of a resumable managed file upload. PublishedFileReferenceId is non-null only once the session reaches Available.

object
UploadSessionId
string
nullable
FileBodyGenerationId
string
nullable
TargetFolderId
string
nullable
RequestedFileName
string
nullable
DeclaredMimeType
string
nullable
DeclaredSizeBytes
integer format: int64
ClientDeclaredSha256
string
nullable
PartSizeBytes
integer format: int32
MaximumParallelParts
integer format: int32
ExpiresAtUtc
string format: date-time
ClientChecksumAlgorithm
string
nullable
ClientChecksumRequired
boolean
Status
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11
RowVersion
string format: uuid
AlreadyUploadedParts
Array<object>
nullable

One provider-confirmed uploaded part safe to expose for resume.

object
PartNumber
integer format: int32
SizeBytes
integer format: int64
FailureCode
string
nullable
PublishedFileReferenceId
string
nullable
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
  "Data": {
    "Status": 0,
    "Errors": [
      {
        "Type": 0,
        "Severity": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

429

Section titled “429”

Too Many Requests

Media typeapplication/json
object
Data
nullable
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

503

Section titled “503”

Service Unavailable

Media typeapplication/json
object
Data

Public state of a resumable managed file upload. PublishedFileReferenceId is non-null only once the session reaches Available.

object
UploadSessionId
string
nullable
FileBodyGenerationId
string
nullable
TargetFolderId
string
nullable
RequestedFileName
string
nullable
DeclaredMimeType
string
nullable
DeclaredSizeBytes
integer format: int64
ClientDeclaredSha256
string
nullable
PartSizeBytes
integer format: int32
MaximumParallelParts
integer format: int32
ExpiresAtUtc
string format: date-time
ClientChecksumAlgorithm
string
nullable
ClientChecksumRequired
boolean
Status
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11
RowVersion
string format: uuid
AlreadyUploadedParts
Array<object>
nullable

One provider-confirmed uploaded part safe to expose for resume.

object
PartNumber
integer format: int32
SizeBytes
integer format: int64
FailureCode
string
nullable
PublishedFileReferenceId
string
nullable
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
  "Data": {
    "Status": 0,
    "Errors": [
      {
        "Type": 0,
        "Severity": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}