Plane docs
ApiSchemas

Sandbox

One shape from the contract, as it appears on the wire.

Used by sandboxes.get, sandboxes.list, sandboxes.release, sandboxes.resume, sandboxes.snapshot

JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/components/schemas/SandboxId"
    },
    "state": {
      "$ref": "#/components/schemas/SandboxState"
    },
    "provider": {
      "$ref": "#/components/schemas/SandboxProviderName"
    },
    "ownerSessionId": {
      "$ref": "#/components/schemas/SessionId"
    },
    "rootSessionId": {
      "$ref": "#/components/schemas/SessionId"
    },
    "externalId": {
      "type": "string"
    },
    "imageRef": {
      "type": "string",
      "minLength": 1
    },
    "snapshotRef": {
      "type": "string"
    },
    "lastActivityAt": {
      "type": "string"
    },
    "idleSince": {
      "type": "string"
    },
    "snapshotAt": {
      "type": "string"
    },
    "destroyedAt": {
      "type": "string"
    },
    "error": {
      "type": "string"
    },
    "createdAt": {
      "type": "string"
    },
    "snapshots": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SandboxSnapshot"
      }
    }
  },
  "required": [
    "id",
    "state",
    "provider",
    "ownerSessionId",
    "rootSessionId",
    "imageRef",
    "lastActivityAt",
    "createdAt",
    "snapshots"
  ],
  "additionalProperties": false
}

On this page