Skip to main content
GET
Get Cloud Box connection

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Cloud Box ID.

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

Query Parameters

key_id
string

Key whose access identifier the Connection names. Omission uses the newest active Key.

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

Response

OK

access_key_id
string
required

Access key ID of the Key the connection names. The secret is never returned here.

account_id
string
required

The Cloud Box's 12-digit account ID, stable across stop and start, and kept by Cloud Boxes started from its saved Snapshots.

Pattern: ^[0-9]{12}$
endpoint_url
string<uri>
required

Origin to use as AWS_ENDPOINT_URL.

env
object
required

Environment variables ready to export, without the secret access key.

proxy
object | null
required

The Cloud Box proxy, through which a client calls AWS's own hostnames, such as an API Gateway stage's execute-api URL, and reaches this Cloud Box. Null when the Cloud Box proxy is off.

region
string
required

The Cloud Box's default region.

s3_force_path_style
boolean
required

Always true: S3 clients must use path-style addressing.

type
enum<string>
required

Cloud Box type.

Available options:
aws