Skip to main content
POST
Put an object in one request.

Authorizations

Authorization
string
header
required

Bearer JWT token or API Key (sk-*).

Body

application/json
name
string
required

Object name.

Example:

"logo.png"

data
required

Object payload. For binary payloads send a base64 string and set dataEncoding to "base64".

Example:

"iVBORw0KGgoAAAANSUhEUgAAAAUA"

retention
object | null

File retention. Omit for the caller default, or set null for no expiration.

parentStorageEntryId
string

Parent folder id. Omit for root.

Example:

"00000000-0000-4000-8000-000000000000"

storageProviderConfigId
string

Optional configured storage id for root-level writes. Omit for managed default storage.

Example:

"00000000-0000-4000-8000-000000000001"

replaceStorageEntryId
string

Existing file entry id to replace.

Example:

"00000000-0000-4000-8000-000000000002"

dataEncoding
enum<string>

Payload encoding.

Available options:
utf8,
base64
Example:

"base64"

mimeType
string

Mime type of the object.

Example:

"image/png"

computeStats
enum<string>

Post-write compute mode. Defaults to sync for text/* objects and none for other binary objects; an explicit value always overrides the default.

Available options:
none,
sync,
async
Example:

"sync"

restricted
boolean

Whether the finalized entry should be restricted.

groups
string[]

Explicit allowed group ids.

users
string[]

Explicit allowed user ids.

refId
string

Optional external reference id.

refType
string

Optional external reference type.

refVer
number

Optional external reference version.

metadata
object | null

Entry metadata. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use.

Example:
ignoreEvent
boolean

Suppress Storage lifecycle events for this file. Omit to preserve the existing setting on replacement; false explicitly enables events.

tier
enum<string>

Logical storage lifecycle tier. Select only when creating a new file or upload session; existing files keep their tier. HOT: Active files used in live workflows, previews, and frequent downloads. WARM: Completed or less-active business files that are still occasionally accessed. COLD: Compliance snapshots, historic imports, and retained evidence that is rarely opened. FROZEN: Deep archive or legal-hold data kept mainly for audit or recovery obligations.

Available options:
HOT,
WARM,
COLD,
FROZEN
Example:

"HOT"

Response

200

OK.