CubePathDOCS

Object Storage

Create access key

post/object-storage/keys

Create an S3 access key for one tier, read and write or read only, for every bucket of a project or only some of them. The secret is shown only in this response: store it safely.

Authorization

Authorization
Authorization*string

Bearer YOUR_API_TOKEN with an API token. The X-API-Key: YOUR_API_TOKEN header works too.

Request body

Create an access key. The secret is returned once.

application/jsonRequired
name*string
Range1 ≤ length ≤ 100
tier*string
Rangelength ≤ 64
project_id?integer | null
permission*string
Value in"read_write""read_only"
bucket_uuids?array<string> | null

Buckets the key is limited to (omit for every bucket of the project)

Rangeitems ≤ 20
expires_at?string | null
Formatdate-time
bypass_governance?boolean

read_write keys only: may delete objects under governance retention (bypass header)

Defaultfalse

Responses

Successful Response

application/json

detail*string
uuid*string
name*string
access_key_id*string
secret_access_key*string
permission*string
bucket_scope?array<ObjectStorageKeyBucket> | null
Properties (2)
uuid*string
name*string
project_id?integer | null
tier*ObjectStorageTierSummary
Properties (4)
uuid*string
slug*string
name*string
media*string
region*string
endpoint*string
status*string
expires_at?string | null
bypass_governance?boolean
Defaultfalse