Skip to main content
POST
Create Cloud Box Key

Authorizations

​
Authorization
string
header
required

Use a Continuous API key. Send it in the Authorization header as a Bearer token.

Headers

​
Idempotency-Key
string

Optional key for retrying this create safely. A retry with the same key and request returns the original result with its status; the same key with a different request returns 409 idempotency_conflict. Without a key, each request creates a new resource.

Maximum string length: 256

Path Parameters

​
id
string
required

Cloud Box ID.

Pattern: ^box_[0-9A-HJKMNP-TV-Z]{26}$

Response

Created

​
cloudbox_id
string
required

ID of the Cloud Box the Key authenticates to.

Pattern: ^box_[0-9A-HJKMNP-TV-Z]{26}$
​
created_at
string<date-time>
required

Key creation time.

​
id
string
required

Key ID.

Pattern: ^bxk_[0-9A-HJKMNP-TV-Z]{26}$
​
public
object
required

What identifies the Key without its secret, in every response.

​
revoked_at
string<date-time> | null
required

Revocation time, or null.

​
secret
object | null
required

The Key's secret when the Key is created; null in every other response.

​
status
enum<string>
required

Whether the Key authenticates.

Available options:
active,
revoked
​
type
enum<string>
required

Platform of the Key; it decides the shape of public and secret.

Available options:
aws