Skip to main content
PUT
/
api
/
storage
/
buckets
/
{bucketName}
/
objects
/
{objectKey}
Upload Object
curl --request PUT \
  --url https://api.example.com/api/storage/buckets/{bucketName}/objects/{objectKey} \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: <api-key>' \
  --form file='@example-file'
{
  "bucket": "avatars",
  "key": "user123.jpg",
  "size": 102400,
  "mimeType": "image/jpeg",
  "uploadedAt": "2024-01-21T10:30:00Z",
  "url": "/api/storage/buckets/avatars/objects/user123.jpg"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
bucketName
string
required
​
objectKey
string
required

Object key (can include forward slashes for pseudo-folders)

Body

multipart/form-data
​
file
file
required

File to upload

Response

Object uploaded successfully

​
bucket
string
required

Name of the bucket containing the object

Example:

"avatars"

​
key
string
required

Unique key identifying the object within the bucket

Example:

"user123.jpg"

​
size
integer
required

Size of the file in bytes

Example:

102400

​
uploadedAt
string<date-time>
required

ISO timestamp when the file was uploaded

Example:

"2024-01-15T10:30:00Z"

​
url
string
required

URL to download the file

Example:

"/api/storage/buckets/avatars/objects/user123.jpg"

​
mimeType
string

MIME type of the file

Example:

"image/jpeg"