Skip to main content
POST
storage.object.head

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

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
range
object

Optional byte range.

ifMatch
string

Read only when the object matches this revision.

Maximum string length: 256

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
sizeBytes
integer
required

Size in bytes.

Required range: 0 <= x <= 9007199254740991
contentType
string

Media type of the bytes.

Maximum string length: 256
Pattern: ^[a-zA-Z0-9!#$&^_.+-]+\/[a-zA-Z0-9!#$&^_.+-]+$
updatedAt
string<date-time>

Last change time, ISO 8601.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
versionId
string

Version identifier in your own storage account.

Required string length: 1 - 1024