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

provider'local' | 'docker' | 'daytona' required

Desired environment provider.

cwdstring nullable

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

labelsStringMap required
envobject required

Example request

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

Response

Environment replaced

idstring required
revisionstring required

Stable revision used with If-Match for optimistic concurrency.

provider'local' | 'docker' | 'daytona' required

Desired environment provider.

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",
  "cwd": "/srv/fabro/workspaces/team-a"
}

Changes

Changed in 3 of the 134 revisions of this API.113

  • fbe22f7c5ef72See the full diff
    • ○

      added the new optional request property cwd

      new-optional-request-property

    • ○

      added the optional property cwd to the response with the 200 status

      response-optional-property-added

  • de85d055604011See the full diff
    • ▲

      removed the required property volumes from the response with the 200 status

      response-required-property-removed

    • ●

      removed the request property volumes

      request-property-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 254ffe92951a1See the full diff
    • ○

      endpoint added

      endpoint-added