Skip to main content
POST
Stop API Box

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

API Box ID.

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

Response

Accepted

​
created_at
string<date-time>
required

API Box creation time.

​
endpoint
string
required

Base URL of the API Box's API. Send the API Box's token in X-Continuous-APIBox-Token.

​
error
object | null
required

Why its last run stopped without a stop request, or null.

​
id
string
required

API Box ID.

Pattern: ^abx_[0-9A-HJKMNP-TV-Z]{26}$
​
include_sample_data
boolean
required

Whether the API Box started with the Snapshot's sample data.

​
metadata
any
required

Customer JSON metadata, or null.

​
name
string
required

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

Maximum string length: 128
​
snapshot_id
string
required

The API Box Snapshot it started from.

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

starting while its runtime boots; running while it serves requests; stopping while it saves its state; stopped when it holds no runtime. A start resumes the saved state.

Available options:
starting,
running,
stopping,
stopped