Skip to main content
POST
Create Cloud Box

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

Body

application/json
​
snapshot_id
string
required

ID of a ready Snapshot. A Cloud Box from a saved Snapshot keeps the account of the Cloud Box it was saved from.

Pattern: ^bxs_[0-9A-HJKMNP-TV-Z]{26}$
​
metadata
any

Customer JSON metadata, up to 16 KiB and 64 nesting levels. Omission uses null.

​
name
string

Cloud Box name. Omission generates a name.

Maximum string length: 128
​
size
enum<string>

Size of the Cloud Box: the CPU and memory of what it runs, and the settings of the services inside it. small uses the least, large the most. Omission uses medium.

Available options:
small,
medium,
large

Response

Accepted

​
ca_certificate
string | null
required

PEM certificate of the CA the Cloud Box's emulator signs its TLS with, for clients that reach the Cloud Box's service names directly; null until the Cloud Box reports it.

​
console_url
string<uri>
required

Opens the Cloud Box's web console in a browser, signing it in through Continuous.

​
created_at
string<date-time>
required

Cloud Box creation time.

​
digest
string
required

Digest of the catalog image the Cloud Box runs, pinned when the Cloud Box was created.

Pattern: ^sha256:[0-9a-f]{64}$
​
endpoint
string<uri>
required

Base URL of the Cloud Box's data plane: one hostname per Cloud Box and no path.

​
id
string
required

Cloud Box ID.

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

The new Cloud Box's first Key, with its secret.

​
last_active_at
string<date-time>
required

Time of the Cloud Box's last data-plane activity.

​
metadata
any
required

Customer JSON metadata, or null.

​
name
string
required

Cloud Box name. The ID is its identity, and names need not be unique.

Maximum string length: 128
​
restorable_until
string<date-time> | null
required

While stopped, the time after which the Cloud Box can no longer start; otherwise null. A stopped Cloud Box is deleted 30 days after this time; its ready Snapshots are kept.

​
size
enum<string>
required

Size of the Cloud Box, chosen when it was created.

Available options:
small,
medium,
large
​
snapshot_id
string | null
required

ID of the Snapshot the Cloud Box started from, or null once that Snapshot is deleted.

Pattern: ^bx[st]_[0-9A-HJKMNP-TV-Z]{26}$
​
status
enum<string>
required

Current status. starting until the Cloud Box first runs. running serves requests; after a period without requests, the first request can take longer while the Cloud Box resumes. stopping means its state is being saved, and requests are refused; stopped means its state is saved and its quota slot released until you start it.

Available options:
starting,
running,
stopping,
stopped
​
status_changed_at
string<date-time>
required

When the Cloud Box entered its current status, such as how long it has been starting.

​
type
enum<string>
required

Platform the Cloud Box emulates, copied from its Snapshot.

Available options:
aws