Claude Platform Docs

Environnements

Créer un environnement
$ ant beta:environments create
POST/v1/environments

Créer un nouvel environnement avec la configuration spécifiée.

Lister les environnements
$ ant beta:environments list
GET/v1/environments

Lister les environnements avec prise en charge de la pagination.

Obtenir un environnement
$ ant beta:environments retrieve
GET/v1/environments/{environment_id}

Récupérer un environnement spécifique par son identifiant.

Mettre à jour un environnement
$ ant beta:environments update
POST/v1/environments/{environment_id}

Mettre à jour la configuration d'un environnement existant.

Supprimer un environnement
$ ant beta:environments delete
DELETE/v1/environments/{environment_id}

Supprimer un environnement par son identifiant. Renvoie une confirmation de la suppression.

Archiver un environnement
$ ant beta:environments archive
POST/v1/environments/{environment_id}/archive

Archiver un environnement par son identifiant. Les environnements archivés ne peuvent pas être utilisés pour créer de nouvelles sessions.

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

cloud environment configuration.

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

Request params for cloud environment configuration.

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

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

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

beta_environment_delete_response: object{ type: "environment_deleted", id }

Response after deleting an environment.

type: "environment_deleted"

The type of response

id: string

Environment identifier

beta_limited_network: 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.

beta_limited_network_params: 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

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

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

Specifies domains the container can reach.

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

Packages (and their versions) available in this environment.

type: optional "packages"

Package configuration type

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

beta_packages_params: 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.

type: optional "packages"

Package configuration type

apt: optional array of string

Ubuntu/Debian packages to install

cargo: optional array of string

Rust packages to install

gem: optional array of string

Ruby packages to install

go: optional array of string

Go packages to install

npm: optional array of string

Node.js packages to install

pip: optional array of string

Python packages to install

beta_self_hosted_config: object{ type: "self_hosted" }

Configuration for self-hosted environments.

type: "self_hosted"

Environment type

beta_self_hosted_config_params: object{ type: "self_hosted" }

Request params for self_hosted environment configuration.

type: "self_hosted"

Environment type

beta_unrestricted_network: object{ type: "unrestricted" }

Unrestricted network access.

type: "unrestricted"

Network policy type

EnvironnementsTravail

Obtenir un élément de travail
$ ant beta:environments:work retrieve
GET/v1/environments/{environment_id}/work/{work_id}

Remarque : ces points de terminaison sont appelés automatiquement par le worker d'environnement préconstruit fourni dans les SDK et la CLI, afin d'orchestrer les sessions avec des environnements sandbox auto-hébergés. Ils sont inclus ici à titre de référence ; vous n'avez pas besoin de les invoquer directement.

Interroger pour obtenir du travail
$ ant beta:environments:work poll
GET/v1/environments/{environment_id}/work/poll

Remarque : ces points de terminaison sont appelés automatiquement par le worker d'environnement préconstruit fourni dans les SDK et la CLI, afin d'orchestrer les sessions avec des environnements sandbox auto-hébergés. Ils sont inclus ici à titre de référence ; vous n'avez pas besoin de les invoquer directement.

Accuser réception d'un travail
$ ant beta:environments:work ack
POST/v1/environments/{environment_id}/work/{work_id}/ack

Remarque : ces points de terminaison sont appelés automatiquement par le worker d'environnement préconstruit fourni dans les SDK et la CLI, afin d'orchestrer les sessions avec des environnements sandbox auto-hébergés. Ils sont inclus ici à titre de référence ; vous n'avez pas besoin de les invoquer directement.

Enregistrer un signal de présence
$ ant beta:environments:work heartbeat
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat

Remarque : ces points de terminaison sont appelés automatiquement par le worker d'environnement préconstruit fourni dans les SDK et la CLI, afin d'orchestrer les sessions avec des environnements sandbox auto-hébergés. Ils sont inclus ici à titre de référence ; vous n'avez pas besoin de les invoquer directement.

Arrêter un travail
$ ant beta:environments:work stop
POST/v1/environments/{environment_id}/work/{work_id}/stop

Remarque : ces points de terminaison sont appelés automatiquement par le worker d'environnement préconstruit fourni dans les SDK et la CLI, afin d'orchestrer les sessions avec des environnements sandbox auto-hébergés. Ils sont inclus ici à titre de référence ; vous n'avez pas besoin de les invoquer directement.

Lister les éléments de travail
$ ant beta:environments:work list
GET/v1/environments/{environment_id}/work

Remarque : ces points de terminaison sont appelés automatiquement par le worker d'environnement préconstruit fourni dans les SDK et la CLI, afin d'orchestrer les sessions avec des environnements sandbox auto-hébergés. Ils sont inclus ici à titre de référence ; vous n'avez pas besoin de les invoquer directement.

Mettre à jour un élément de travail
$ ant beta:environments:work update
POST/v1/environments/{environment_id}/work/{work_id}

Remarque : ces points de terminaison sont appelés automatiquement par le worker d'environnement préconstruit fourni dans les SDK et la CLI, afin d'orchestrer les sessions avec des environnements sandbox auto-hébergés. Ils sont inclus ici à titre de référence ; vous n'avez pas besoin de les invoquer directement.

Obtenir les statistiques de la file d'attente
$ ant beta:environments:work stats
GET/v1/environments/{environment_id}/work/stats

Obtenir des statistiques sur la file d'attente de travail d'un environnement.