Skip to main content
Extend a sandbox lifetime

Authorizations

Authorization
string
header
required

BoxRouter API key; never an upstream provider key.

Headers

Idempotency-Key
string

Optional for this operation. Preserve the same stable identifier when retrying an uncertain response; never reuse it for new work. If omitted where allowed, Cloud generates a request-scoped key that cannot reconcile a later retry. Do not include credentials or payloads. Stable identifier for one logical mutation.

Required string length: 1 - 128

Path Parameters

sandbox_id
string
required

Workspace-owned BoxRouter sandbox ID, not an upstream ID.

Minimum string length: 1
Pattern: ^[^\u0000]*$

Body

application/json
lifetime_seconds
integer
required

The new total running-time budget, not an increment.

Required range: x >= 1

Response

The lifetime as it now stands.

How long the sandbox may live. It counts from the provider's create, as with the provider's own SDK (BoxRouter's clock starts when it sends the create). Whether paused time counts depends on the provider.

seconds
integer | null
required

The lifetime in seconds. 0 only for a sandbox that has no lifetime record (one that ended before lifetimes were recorded). Null for a sandbox created with no lifetime (lifetime_seconds: null), which runs until it is destroyed.

Required range: x >= 0
remaining_seconds
integer | null
required

As of observed_at. Equal to seconds while creating, and frozen while the sandbox is not running. Null for a sandbox with no lifetime.

Required range: x >= 0
ends_at
string<date-time> | null
required

Set only while running. The end never comes before it; how soon after is not promised. Null while creating, paused or ended, and for a sandbox with no lifetime.

kept_until
string<date-time> | null
required

While paused: when the sandbox is destroyed if it is not resumed, 30 days after it last ran, sooner where the provider keeps it for less. Where the lifetime keeps counting while paused, the sandbox ends when the lifetime runs out, so kept_until is that moment when it falls inside the 30 days; extending the lifetime moves it. Where the clock stops while paused, the full 30 days apply.

at_end
enum<string> | null
required

What happens when the lifetime is used up. Null for a sandbox with no lifetime.

Available options:
destroy,
pause,
null
max_seconds
required

The route's longest single run, from one start to the next pause or end, as narrowed for this account. A declared number: an integer, "unlimited", "unknown" or a floor.

Required range: x >= 1
extendable
boolean
required