Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

Hiloop API key sent as an HTTP Bearer token.

Path Parameters

id
string
required

The sandbox id to update.

Body

application/json

A sandbox update that includes a lifecycle transition.

state
enum<string>
required

New desired lifecycle state. Omit it to leave lifecycle state unchanged.

Available options:
running,
stopped
ttl_seconds
integer<uint32>

New positive lifetime in seconds from the time of this update. Omit it to leave expiry unchanged; zero is invalid.

Required range: x >= 1
metadata
object

Replacement metadata: at most 50 entries, keys at most 128 characters, and at most 4096 bytes of total value content.

idle_timeout_seconds
integer<uint32>

New idle-stop duration in seconds, from 60 through 86400. Omit it to leave the current value unchanged.

Required range: 60 <= x <= 86400

Response

Accepted

id
string
required

The sandbox id whose update was accepted.

request_state
enum<string>
required

The accepted mutation-request state, distinct from observed sandbox lifecycle state.

Available options:
requested
network_access_receipt
object

Present after policy objects select the exact live pod incarnation.