Sandbox administration common objects¶
Fields follow the current model JSON tags. Internal bindings, tokens, roles, requests, payloads, and reservation records are not returned.
Sandbox¶
Field |
Type |
Description |
|---|---|---|
|
object, optional |
Optional administrative projection. The current Provider supplies at least ID/owner_id; names and account names are not guaranteed. |
|
string |
Object identifier; currently the remote resource name for a sandbox. |
|
string |
Resource-owning workspace, not the workspace in the authentication header. |
|
string |
User fact from remote resource labels. |
|
string |
Display name. |
|
string |
unknown, provisioning, ready, error, or deleting; not the complete IAM cleanup state. |
|
string |
Associated execution environment identifier. |
|
string |
Currently limited or unrestricted; may be empty when historical labels are missing. This update does not switch modes. |
|
string (array of strings), optional |
Tool egress allowlist; may be omitted when empty. |
|
object (array of objects), optional |
Explicit host/ports egress allowlist; may be omitted when empty. |
|
string |
Specification projection; may be empty for historical labels. Creation enums do not imply this field was historically required. |
|
integer |
Disk size in GiB; may be 0 if remote labels are missing or unparseable. This does not permit creation with 0. |
|
string, optional |
Optional associated compute resource ID. |
|
string |
Creation time in RFC3339. |
|
string |
Update time in RFC3339; not guaranteed suitable for concurrency version control. |
|
boolean / null |
boolean or null. null means current image comparison information is insufficient; do not treat it as false. |
SandboxAdminWorkspace¶
Field |
Type |
Description |
|---|---|---|
|
string |
Object identifier; currently the remote resource name for a sandbox. |
|
string, optional |
Optional workspace name; not supplied by the current Provider. |
|
string, optional |
Workspace owner projection, currently from the remote user label; may be omitted. |
|
string, optional |
Optional account name; not supplied by the current OpenShell adapter. |
SandboxEgressEndpoint¶
Field |
Type |
Description |
|---|---|---|
|
string |
Lowercase hostname without scheme, port, or path. IP addresses and localhost are not accepted. |
|
integer (array of integers) |
Array of ports from 1 to 65535. |
SandboxQuota¶
Field |
Type |
Description |
|---|---|---|
|
string |
Resource-owning workspace, not the workspace in the authentication header. |
|
integer |
Managed sandbox limit, from 0 to 100. 0 can be persisted without immediately deleting existing resources. |
|
integer |
Independent ephemeral sandbox limit, from 0 to 100; distinct from the managed sandbox limit. |
|
integer |
Numeric 0 inherits the deployment default, 1 enables, and 2 disables. Requests use the string auto_ephemeral. |
|
string |
Most recent updating principal. |
|
string |
Update time in RFC3339; not guaranteed suitable for concurrency version control. |
SandboxAdminListResult¶
Field |
Type |
Description |
|---|---|---|
|
object (array of objects) |
Managed sandboxes on this page; excludes ephemeral and pool resources. |
|
integer |
Page limit; no total field. |
|
integer |
Offset in the filtered matching set. |
|
string |
More results may exist. May also be true when the scan budget is reached; does not guarantee unlimited further pagination. |
Projection and recovery boundaries¶
The administrative Provider currently populates only id/owner_id in workspace. name/account_name are optional; no directory enrichment is implied. disk_gi=0 may result from unparseable historical labels and does not change new-creation specification constraints. Keep update_available=null as unknown and check presence for optional typed SDK fields.
Saved managed-network overrides are separate from actual remote policies. GET applies saved overrides, so reading GET alone after an error does not prove remote recovery. Quota responses contain the full saved quota. Regular GET quota provides only current/limit/default_egress_endpoints and optional capability projections; it is not an administrative configuration backup.