Claude Platform Docs

Environment

Buat Environment
POST/v1/environments

Buat environment baru dengan konfigurasi yang ditentukan.

Daftar Environment
GET/v1/environments

Daftar environment dengan dukungan paginasi.

Dapatkan Environment
GET/v1/environments/{environment_id}

Ambil environment tertentu berdasarkan ID.

Perbarui Environment
POST/v1/environments/{environment_id}

Perbarui konfigurasi environment yang sudah ada.

Hapus Environment
DELETE/v1/environments/{environment_id}

Hapus environment berdasarkan ID. Mengembalikan konfirmasi penghapusan.

Arsipkan Environment
POST/v1/environments/{environment_id}/archive

Arsipkan environment berdasarkan ID. Environment yang diarsipkan tidak dapat digunakan untuk membuat sesi baru.

Models
BetaCloudConfig object{ type: "cloud", networking, packages }

cloud environment configuration.

BetaCloudConfigParams object{ type: "cloud", networking, packages }

Request params for cloud environment configuration.

Fields default to null; on update, omitted fields preserve the existing value.

BetaEnvironment object{ type: "environment", id, archived_at, 7 more }

Unified Environment resource for both cloud and self-hosted environments.

BetaEnvironmentDeleteResponse object{ type: "environment_deleted", id }

Response after deleting an environment.

type: "environment_deleted"

The type of response

defaultenvironment_deleted
id: string

Environment identifier

BetaLimitedNetwork object{ type: "limited", allow_mcp_servers, allow_package_managers, allowed_hosts }

Limited network access.

type: "limited"

Network policy type

allow_mcp_servers: boolean

Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the allowed_hosts array.

allow_package_managers: boolean

Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the allowed_hosts array.

allowed_hosts: array of string

Specifies domains the container can reach.

BetaLimitedNetworkParams object{ type: "limited", allow_mcp_servers, allow_package_managers, allowed_hosts }

Limited network request params.

Fields default to null; on update, omitted fields preserve the existing value.

type: "limited"

Network policy type

allow_mcp_servers: optional boolean or null

Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the allowed_hosts array. Defaults to false.

allow_package_managers: optional boolean or null

Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the allowed_hosts array. Defaults to false on creation. Must be true when packages are specified.

allowed_hosts: optional array of string or null

Specifies domains the container can reach.

BetaPackages object{ type: "packages", apt, cargo, 4 more }

Packages (and their versions) available in this environment.

type: optional "packages"

Package configuration type

defaultpackages
apt: array of string

Ubuntu/Debian packages to install

cargo: array of string

Rust packages to install

gem: array of string

Ruby packages to install

go: array of string

Go packages to install

npm: array of string

Node.js packages to install

pip: array of string

Python packages to install

BetaPackagesParams object{ type: "packages", apt, cargo, 4 more }

Specify packages (and optionally their versions) available in this environment.

When versioning, use the version semantics relevant for the package manager, e.g. for pip use package==1.0.0. You are responsible for validating the package and version exist. Unversioned installs the latest.

Under limited networking, requires networking.allow_package_managers to be true.

BetaSelfHostedConfig object{ type: "self_hosted" }

Configuration for self-hosted environments.

type: "self_hosted"

Environment type

BetaSelfHostedConfigParams object{ type: "self_hosted" }

Request params for self_hosted environment configuration.

type: "self_hosted"

Environment type

BetaUnrestrictedNetwork object{ type: "unrestricted" }

Unrestricted network access.

type: "unrestricted"

Network policy type

EnvironmentPekerjaan

Dapatkan Item Pekerjaan
GET/v1/environments/{environment_id}/work/{work_id}

Catatan: endpoint ini dipanggil secara otomatis oleh environment worker siap pakai yang disediakan dalam SDK dan CLI, untuk mengorkestrasi sesi dengan environment sandbox yang di-hosting sendiri. Endpoint ini disertakan di sini sebagai referensi; Anda tidak perlu memanggilnya secara langsung.

Poll untuk Pekerjaan
GET/v1/environments/{environment_id}/work/poll

Catatan: endpoint ini dipanggil secara otomatis oleh environment worker siap pakai yang disediakan dalam SDK dan CLI, untuk mengorkestrasi sesi dengan environment sandbox yang di-hosting sendiri. Endpoint ini disertakan di sini sebagai referensi; Anda tidak perlu memanggilnya secara langsung.

Konfirmasi Pekerjaan
POST/v1/environments/{environment_id}/work/{work_id}/ack

Catatan: endpoint ini dipanggil secara otomatis oleh environment worker siap pakai yang disediakan dalam SDK dan CLI, untuk mengorkestrasi sesi dengan environment sandbox yang di-hosting sendiri. Endpoint ini disertakan di sini sebagai referensi; Anda tidak perlu memanggilnya secara langsung.

Catat Heartbeat
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat

Catatan: endpoint ini dipanggil secara otomatis oleh environment worker siap pakai yang disediakan dalam SDK dan CLI, untuk mengorkestrasi sesi dengan environment sandbox yang di-hosting sendiri. Endpoint ini disertakan di sini sebagai referensi; Anda tidak perlu memanggilnya secara langsung.

Hentikan Pekerjaan
POST/v1/environments/{environment_id}/work/{work_id}/stop

Catatan: endpoint ini dipanggil secara otomatis oleh environment worker siap pakai yang disediakan dalam SDK dan CLI, untuk mengorkestrasi sesi dengan environment sandbox yang di-hosting sendiri. Endpoint ini disertakan di sini sebagai referensi; Anda tidak perlu memanggilnya secara langsung.

Daftar Item Pekerjaan
GET/v1/environments/{environment_id}/work

Catatan: endpoint ini dipanggil secara otomatis oleh environment worker siap pakai yang disediakan dalam SDK dan CLI, untuk mengorkestrasi sesi dengan environment sandbox yang di-hosting sendiri. Endpoint ini disertakan di sini sebagai referensi; Anda tidak perlu memanggilnya secara langsung.

Perbarui Item Pekerjaan
POST/v1/environments/{environment_id}/work/{work_id}

Catatan: endpoint ini dipanggil secara otomatis oleh environment worker siap pakai yang disediakan dalam SDK dan CLI, untuk mengorkestrasi sesi dengan environment sandbox yang di-hosting sendiri. Endpoint ini disertakan di sini sebagai referensi; Anda tidak perlu memanggilnya secara langsung.

Dapatkan Statistik Antrean
GET/v1/environments/{environment_id}/work/stats

Dapatkan statistik tentang antrean pekerjaan untuk sebuah environment.