Skip to main content
POST
storage.object.restore

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
versionId
string

Version identifier in your own storage account.

Required string length: 1 - 1024
days
integer
default:1

Days to retain a restored copy, 1 to 365.

Required range: 1 <= x <= 365
tier
enum<string>
default:standard

Restore speed. Expedited can cost more and must be explicitly requested.

Available options:
standard,
bulk,
expedited

Response

The result

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
requested
boolean
required

Restore was requested or is already in progress.