Sign in
Environments

Replace environment

Replaces an environment definition when If-Match matches the current environment revision. The path id is authoritative; the request body omits id.

put/api/v1/environments/{id}

Path parameters

idstring required

Unique environment identifier.

Headers

If-Matchstring required

Current resource revision used for optimistic concurrency, as returned in the ETag response header.

Request body

providerstring required

Sandbox provider kind. local, docker, and daytona are bundled with the server; any other value names a sandbox-driver plugin configured under server.sandbox.providers.<kind>.

cwdstring nullable

Local-provider command working directory for this environment. Docker and Daytona ignore this value.

labelsStringMap required
envobject required

Example request

{
  "provider": "docker",
  "cwd": "/srv/fabro/workspaces/team-a"
}

Response

Environment replaced

idstring required
revisionstring required

Stable revision used with If-Match for optimistic concurrency.

providerstring required

Sandbox provider kind. local, docker, and daytona are bundled with the server; any other value names a sandbox-driver plugin configured under server.sandbox.providers.<kind>.

cwdstring nullable

Local-provider command working directory for this environment. Docker and Daytona ignore this value.

labelsStringMap required
envobject required

Example response

{
  "id": "docker",
  "revision": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
  "provider": "docker",
  "cwd": "/srv/fabro/workspaces/team-a"
}

Changes