Deel: Files schemas
9 Deel schemas with complete fields and constraints.
← Files operations · All schemas
Check file upload status — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
file_id | string | Required within parent | Unique file identifier. Format: uuid |
status | string | Required within parent | Upload status: pending (virus scan in progress), ready (claimable), or failed (virus scan failed). |
Complete a multipart upload — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
parts | array | Required within parent | Uploaded parts, in any order. |
parts[] | Model | Each item | Expand Complete a multipart upload — request body — body data parts item |
upload_id | string | Required within parent | S3 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
etag | string | Required within parent | ETag returned by S3 in the response header after uploading the part. |
number | number | Required within parent | Part number (1-indexed) matching the register response. Format: double |
Create a file upload — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
file_id | string | Required within parent | Unique file identifier. Format: uuid |
one_time_secret | string | Required within parent | One-time secret for claiming ownership. Pass to domain endpoints when ready to claim the file. |
upload_id | string | Optional | S3 multipart upload ID. Present only when the server selected multipart — pass to POST /rest/files/{fileid}/complete. |
upload_parts | array | Required within parent | Presigned upload targets (always present). Single-part: one presigned POST form with fields. Multipart: multiple presigned PUT URLs without fields. |
upload_parts[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
fields | Model | Optional | Expand 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. |
number | JSON | Optional | |
number (anyOf 1) | number | Alternative | Part number (1-indexed). Format: double |
number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
size | JSON | Optional | |
size (anyOf 1) | number | Alternative | Maximum bytes for this part. Format: double |
size (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
url | string | Optional | Presigned 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Form 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
expiry | number | Optional | Presigned URL expiry in seconds. Format: double |
filename | string | Required within parent | Original filename with extension; used to detect the content type. |
is_attachment | boolean | Optional | Whether the file should be served as an attachment (download) rather than inline. |
size | number | Optional | Actual file size in bytes (max 1GB). Drives the server-side multipart decision when x-upload-method: multipart is set. Format: double |