Sandbox / SnapshotListOpts

Interface: SnapshotListOpts

Options for listing snapshots.

Extends

• Omit<SandboxApiOpts, "signal">

Properties

apiHeaders?

optional apiHeaders?: Record<string, string>

Additional headers to send with AgentBox API requests.

Inherited from

SandboxForkOpts.apiHeaders

---

apiKey?

optional apiKey?: string

AgentBox API key to use for authentication.

Default

AGENTBOX_API_KEY // environment variable

Inherited from

SandboxForkOpts.apiKey

---

domain?

optional domain?: string

Domain to use for the API.

Default

AGENTBOX_DOMAIN // environment variable or agentbox-runtime.ru

Inherited from

SandboxForkOpts.domain

---

limit?

optional limit?: number

Number of snapshots to return per page.

Default

100

---

name?

optional name?: string

Filter snapshots by name or ID, optionally tag-qualified (e.g. "my-snapshot", "my-project/my-snapshot" or "my-snapshot:v1").

---

nextToken?

optional nextToken?: string

Token to the next page.

---

requestTimeoutMs?

optional requestTimeoutMs?: number

Timeout for requests to the API in milliseconds.

Default

60_000 // 60 seconds

Inherited from

SandboxForkOpts.requestTimeoutMs

---

sandboxId?

optional sandboxId?: string

Filter snapshots by source sandbox ID.