Sign in
Environments

Create environment

Creates a server-owned environment definition in the environment catalog. REST environment requests only accept inline Dockerfile content; local Dockerfile paths are supported by workflow/settings files but rejected by this API.

post/api/v1/environments

Request body

idstring required
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

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

Response

Environment created

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