Skip to main content
POST
storage.object.upload-url

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

Where the file will be stored, e.g. users/42.png.

Maximum string length: 1024
overwrite
boolean
default:false

Replace an existing file at this path. Default false: the upload fails if the file exists.

Response

The result

uploadUrl
string
required

Signed URL to PUT the file to. It is a credential: hand it only to the uploader.

method
string
required

Always PUT.

Allowed value: "PUT"
expiresAt
string

When the URL stops working, ISO 8601, when known.