# SandboxCore


[API catalog](/reference/api/) · [Docker Sandboxes overview](/reference/api/sandboxes/latest/) · [Product manual](https://docs.docker.com/ai/sandboxes-api/) · [OpenAPI specification](/reference/api/sandboxes/api.yaml)

API version: v1


> This API is experimental. Features, interfaces,
> and behavior may change.




Schema constraints and annotations:

```json
{
  "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"
}
```