Storage API

Object storage (S3-compatible)

REST API endpoints for Storage. 9 operations.

List buckets

plaintext

GET /v1/storage/buckets

Returns all storage buckets for the caller's project.

Auth: Bearer API key

Responses

Status	Description
`200`	Bucket list
`401`	Missing or invalid API key
`500`	Internal error

operationId: listBuckets

Create a bucket

plaintext

POST /v1/storage/buckets

Creates a new storage bucket.

Auth: Bearer API key

Responses

Status	Description
`201`	Bucket created
`401`	Missing or invalid API key
`500`	Internal error

operationId: createBucket

List objects

plaintext

GET /v1/storage/buckets/{bucket}/objects

Returns the objects in a bucket, optionally filtered by key prefix.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`bucket`	path	`string`	Yes	Bucket name
`prefix`	query	`string`	No	Key prefix filter
`limit`	query	`integer (int64)`	No	Max objects to return (default 100)

Responses

Status	Description
`200`	Object listing
`401`	Missing or invalid API key
`500`	Internal error

operationId: listObjects

Delete an object

plaintext

DELETE /v1/storage/buckets/{bucket}/objects/{key}

Removes an object from a bucket.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`bucket`	path	`string`	Yes	Bucket name
`key`	path	`string`	Yes	Object key

Responses

Status	Description
`200`	Object deleted
`401`	Missing or invalid API key
`500`	Internal error

operationId: deleteObject

Get an object

plaintext

GET /v1/storage/buckets/{bucket}/objects/{key}

Downloads the contents of an object from a bucket.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`bucket`	path	`string`	Yes	Bucket name
`key`	path	`string`	Yes	Object key

Responses

Status	Description
`200`	Object content
`401`	Missing or invalid API key
`404`	Resource not found
`500`	Internal error

operationId: getObject

Get object metadata

plaintext

HEAD /v1/storage/buckets/{bucket}/objects/{key}

Returns an object's metadata headers without its body.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`bucket`	path	`string`	Yes	Bucket name
`key`	path	`string`	Yes	Object key

Responses

Status	Description
`200`	Object metadata headers
`401`	Missing or invalid API key
`404`	Resource not found
`500`	Internal error

operationId: headObject

Upload an object

plaintext

PUT /v1/storage/buckets/{bucket}/objects/{key}

Stores raw bytes as an object in a bucket.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`bucket`	path	`string`	Yes	Bucket name
`key`	path	`string`	Yes	Object key

Request body

application/octet-stream (required) — schema string.

Responses

Status	Description
`200`	Object stored
`401`	Missing or invalid API key
`500`	Internal error

operationId: putObject

Delete a bucket

plaintext

DELETE /v1/storage/buckets/{name}

Removes a storage bucket by name.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`name`	path	`string`	Yes	Bucket name

Responses

Status	Description
`200`	Bucket deleted
`401`	Missing or invalid API key
`500`	Internal error

operationId: deleteBucket

Presign an object URL

plaintext

POST /v1/storage/presign

Returns a presigned URL for direct upload or download of an object.

Auth: Bearer API key

Request body

application/json (required) — schema object.

Responses

Status	Description
`200`	Presigned URL
`401`	Missing or invalid API key
`500`	Internal error

operationId: presignObject