Skip to content

Deel: Files schemas

9 Deel schemas with complete fields and constraints.

← Files operations · All schemas

Check file upload status — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Check file upload status — 200 response body — data

Referenced models: Check file upload status — 200 response body — data

Check file upload status — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
file_idstringRequired within parentUnique file identifier.
Format: uuid
statusstringRequired within parentUpload status: pending (virus scan in progress), ready (claimable), or failed (virus scan failed).

Complete a multipart upload — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
partsarrayRequired within parentUploaded parts, in any order.
parts[]ModelEach itemExpand Complete a multipart upload — request body — body data parts item
upload_idstringRequired within parentS3 multipart upload ID from the register response.

Referenced models: Complete a multipart upload — request body — body data parts item

Complete a multipart upload — request body — body data parts item

FieldTypePresenceDescription and constraints
$objectRoot
etagstringRequired within parentETag returned by S3 in the response header after uploading the part.
numbernumberRequired within parentPart number (1-indexed) matching the register response.
Format: double

Create a file upload — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create a file upload — 201 response body — data

Referenced models: Create a file upload — 201 response body — data

Create a file upload — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
file_idstringRequired within parentUnique file identifier.
Format: uuid
one_time_secretstringRequired within parentOne-time secret for claiming ownership. Pass to domain endpoints when ready to claim the file.
upload_idstringOptionalS3 multipart upload ID. Present only when the server selected multipart — pass to POST /rest/files/{fileid}/complete.
upload_partsarrayRequired within parentPresigned upload targets (always present). Single-part: one presigned POST form with fields. Multipart: multiple presigned PUT URLs without fields.
upload_parts[]ModelEach itemExpand Create a file upload — 201 response body — data upload parts item

Referenced models: Create a file upload — 201 response body — data upload parts item

Create a file upload — 201 response body — data upload parts item

FieldTypePresenceDescription and constraints
$objectRoot
fieldsModelOptionalExpand Create a file upload — 201 response body — data upload parts item fields
Form fields to submit with the presigned POST form. Present for the single-part POST upload; absent for multipart PUT parts.
numberJSONOptional
number (anyOf 1)numberAlternativePart number (1-indexed).
Format: double
number (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sizeJSONOptional
size (anyOf 1)numberAlternativeMaximum bytes for this part.
Format: double
size (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
urlstringOptionalPresigned upload URL for this part.

Referenced models: Create a file upload — 201 response body — data upload parts item fields

Create a file upload — 201 response body — data upload parts item fields

FieldTypePresenceDescription and constraints
$objectRootForm fields to submit with the presigned POST form. Present for the single-part POST upload; absent for multipart PUT parts.

Create a file upload — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
expirynumberOptionalPresigned URL expiry in seconds.
Format: double
filenamestringRequired within parentOriginal filename with extension; used to detect the content type.
is_attachmentbooleanOptionalWhether the file should be served as an attachment (download) rather than inline.
sizenumberOptionalActual file size in bytes (max 1GB). Drives the server-side multipart decision when x-upload-method: multipart is set.
Format: double

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.