Share feedback
Answers are generated based on the documentation.

Experimental

Schema

SandboxCore

Type: object

SandboxCore is the backend-neutral sandbox view. At most one of image, imageRef is set.
All constraints apply
agent

Type: string

agent is the named agent profile, empty for raw image/start-command sandboxes.
All schema constraints and annotations
{
  "description": "agent is the named agent profile, empty for raw image/start-command sandboxes.",
  "type": "string"
}
appliedKits

Type: array

applied_kits records kits active in the sandbox.
Array item

Schema: AppliedKit

All schema constraints and annotations
{
  "$ref": "#/components/schemas/AppliedKit"
}
All schema constraints and annotations
{
  "description": "applied_kits records kits active in the sandbox.",
  "items": {
    "$ref": "#/components/schemas/AppliedKit"
  },
  "type": "array"
}
createdAt

Schema: Timestamp

created_at is the creation time.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/Timestamp",
  "description": "created_at is the creation time."
}
endpoint

Schema: SandboxEndpoint

endpoint is where process and file services are served for this sandbox.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/SandboxEndpoint",
  "description": "endpoint is where process and file services are served for this sandbox."
}
environment

Type: object

environment is non-secret environment metadata.
All schema constraints and annotations
{
  "additionalProperties": {
    "title": "value",
    "type": "string"
  },
  "description": "environment is non-secret environment metadata.",
  "type": "object"
}
etag · response only

Type: string

etag identifies the observed version of this resource. It is opaque and strong, changes on every visible change, and is what a mutation sends as its precondition.
All schema constraints and annotations
{
  "description": "etag identifies the observed version of this resource. It is opaque and strong,\nchanges on every visible change, and is what a mutation sends as its precondition.",
  "minLength": 1,
  "pattern": "^\"[^\"\\x00-\\x20\\x7f]*\"$",
  "readOnly": true,
  "type": "string"
}
labels

Type: object

labels are non-secret caller-assigned key/value metadata.
All schema constraints and annotations
{
  "additionalProperties": {
    "title": "value",
    "type": "string"
  },
  "description": "labels are non-secret caller-assigned key/value metadata.",
  "type": "object"
}
origin

Type: string

origin is set by merged views to identify the backend that owns this sandbox.
All schema constraints and annotations
{
  "description": "origin is set by merged views to identify the backend that owns this sandbox.",
  "type": "string"
}
platform

Schema: Platform

platform is the canonical placed platform.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/Platform",
  "description": "platform is the canonical placed platform."
}
ports

Type: array

ports are the currently published ports.
Array item

Schema: PublishedPort

All schema constraints and annotations
{
  "$ref": "#/components/schemas/PublishedPort"
}
All schema constraints and annotations
{
  "description": "ports are the currently published ports.",
  "items": {
    "$ref": "#/components/schemas/PublishedPort"
  },
  "type": "array"
}
resources

Schema: Resources

resources are the sandbox resources.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/Resources",
  "description": "resources are the sandbox resources."
}
status · response only

Schema: SandboxStatus

status is the coarse lifecycle state.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/SandboxStatus",
  "description": "status is the coarse lifecycle state.",
  "not": {
    "enum": [
      "unspecified"
    ]
  },
  "readOnly": true
}
All schema constraints and annotations
{
  "properties": {
    "agent": {
      "description": "agent is the named agent profile, empty for raw image/start-command sandboxes.",
      "type": "string"
    },
    "appliedKits": {
      "description": "applied_kits records kits active in the sandbox.",
      "items": {
        "$ref": "#/components/schemas/AppliedKit"
      },
      "type": "array"
    },
    "createdAt": {
      "$ref": "#/components/schemas/Timestamp",
      "description": "created_at is the creation time."
    },
    "endpoint": {
      "$ref": "#/components/schemas/SandboxEndpoint",
      "description": "endpoint is where process and file services are served for this sandbox."
    },
    "environment": {
      "additionalProperties": {
        "title": "value",
        "type": "string"
      },
      "description": "environment is non-secret environment metadata.",
      "type": "object"
    },
    "etag": {
      "description": "etag identifies the observed version of this resource. It is opaque and strong,\nchanges on every visible change, and is what a mutation sends as its precondition.",
      "minLength": 1,
      "pattern": "^\"[^\"\\x00-\\x20\\x7f]*\"$",
      "readOnly": true,
      "type": "string"
    },
    "labels": {
      "additionalProperties": {
        "title": "value",
        "type": "string"
      },
      "description": "labels are non-secret caller-assigned key/value metadata.",
      "type": "object"
    },
    "origin": {
      "description": "origin is set by merged views to identify the backend that owns this sandbox.",
      "type": "string"
    },
    "platform": {
      "$ref": "#/components/schemas/Platform",
      "description": "platform is the canonical placed platform."
    },
    "ports": {
      "description": "ports are the currently published ports.",
      "items": {
        "$ref": "#/components/schemas/PublishedPort"
      },
      "type": "array"
    },
    "resources": {
      "$ref": "#/components/schemas/Resources",
      "description": "resources are the sandbox resources."
    },
    "status": {
      "$ref": "#/components/schemas/SandboxStatus",
      "description": "status is the coarse lifecycle state.",
      "not": {
        "enum": [
          "unspecified"
        ]
      },
      "readOnly": true
    }
  }
}
image

Type: string

image is the managed Image resource name.
All schema constraints and annotations
{
  "description": "image is the managed Image resource name.",
  "pattern": "^images/[^/]+$",
  "type": "string"
}
imageRef

Type: string

image_ref is an external OCI reference, with the existing backend validation.
All schema constraints and annotations
{
  "description": "image_ref is an external OCI reference, with the existing backend validation.",
  "type": "string"
}
All schema constraints and annotations
{
  "dependentSchemas": {
    "image": {
      "not": {
        "anyOf": [
          {
            "required": [
              "imageRef"
            ]
          }
        ]
      }
    },
    "imageRef": {
      "not": {
        "anyOf": [
          {
            "required": [
              "image"
            ]
          }
        ]
      }
    }
  },
  "properties": {
    "image": {
      "description": "image is the managed Image resource name.",
      "pattern": "^images/[^/]+$",
      "type": "string"
    },
    "imageRef": {
      "description": "image_ref is an external OCI reference, with the existing backend validation.",
      "type": "string"
    }
  }
}
All schema constraints and annotations
{
  "allOf": [
    {
      "properties": {
        "agent": {
          "description": "agent is the named agent profile, empty for raw image/start-command sandboxes.",
          "type": "string"
        },
        "appliedKits": {
          "description": "applied_kits records kits active in the sandbox.",
          "items": {
            "$ref": "#/components/schemas/AppliedKit"
          },
          "type": "array"
        },
        "createdAt": {
          "$ref": "#/components/schemas/Timestamp",
          "description": "created_at is the creation time."
        },
        "endpoint": {
          "$ref": "#/components/schemas/SandboxEndpoint",
          "description": "endpoint is where process and file services are served for this sandbox."
        },
        "environment": {
          "additionalProperties": {
            "title": "value",
            "type": "string"
          },
          "description": "environment is non-secret environment metadata.",
          "type": "object"
        },
        "etag": {
          "description": "etag identifies the observed version of this resource. It is opaque and strong,\nchanges on every visible change, and is what a mutation sends as its precondition.",
          "minLength": 1,
          "pattern": "^\"[^\"\\x00-\\x20\\x7f]*\"$",
          "readOnly": true,
          "type": "string"
        },
        "labels": {
          "additionalProperties": {
            "title": "value",
            "type": "string"
          },
          "description": "labels are non-secret caller-assigned key/value metadata.",
          "type": "object"
        },
        "origin": {
          "description": "origin is set by merged views to identify the backend that owns this sandbox.",
          "type": "string"
        },
        "platform": {
          "$ref": "#/components/schemas/Platform",
          "description": "platform is the canonical placed platform."
        },
        "ports": {
          "description": "ports are the currently published ports.",
          "items": {
            "$ref": "#/components/schemas/PublishedPort"
          },
          "type": "array"
        },
        "resources": {
          "$ref": "#/components/schemas/Resources",
          "description": "resources are the sandbox resources."
        },
        "status": {
          "$ref": "#/components/schemas/SandboxStatus",
          "description": "status is the coarse lifecycle state.",
          "not": {
            "enum": [
              "unspecified"
            ]
          },
          "readOnly": true
        }
      }
    },
    {
      "dependentSchemas": {
        "image": {
          "not": {
            "anyOf": [
              {
                "required": [
                  "imageRef"
                ]
              }
            ]
          }
        },
        "imageRef": {
          "not": {
            "anyOf": [
              {
                "required": [
                  "image"
                ]
              }
            ]
          }
        }
      },
      "properties": {
        "image": {
          "description": "image is the managed Image resource name.",
          "pattern": "^images/[^/]+$",
          "type": "string"
        },
        "imageRef": {
          "description": "image_ref is an external OCI reference, with the existing backend validation.",
          "type": "string"
        }
      }
    }
  ],
  "description": "SandboxCore is the backend-neutral sandbox view. At most one of image, imageRef is set.",
  "required": [
    "status",
    "createdAt",
    "etag"
  ],
  "title": "SandboxCore",
  "type": "object"
}