Skip to main content
POST
storage.object.put

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
bucket
string
required

The bucket name, as returned by storage.buckets.list.

Pattern: ^[A-Za-z0-9][A-Za-z0-9._-]{0,99}$
path
string
required

Exact path inside your bucket.

Maximum string length: 1024
fileId
string

Id of an uploaded file holding The file to store, in place of a public link.

Pattern: ^file_[0-9A-HJKMNP-TV-Z]{26}$
content
string

Base64 bytes, at most 1 MiB.

Maximum string length: 1398104
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
contentType
string

Media type of the bytes.

Maximum string length: 256
Pattern: ^[a-zA-Z0-9!#$&^_.+-]+\/[a-zA-Z0-9!#$&^_.+-]+$
overwrite
boolean
default:false

Replace existing bytes. Default false uses an atomic create-only write.

metadata
object

Custom metadata to store with the bytes.

checksum
object

Verify the transferred bytes against this checksum.

encryption
enum<string>

Use the account default encryption or request managed encryption.

Available options:
default,
managed
tier
enum<string>

Storage tier. Archive choices can cost more and require restoration.

Available options:
standard,
infrequent,
archive,
deep-archive
tags
object[]

Complete tag set, up to ten tags. An empty set clears all tags.

Maximum array length: 10

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.