Skip to content

Get container config

GET
/api/v1/projects/{projectId}/{agentType}/container/config

Returns the editable configuration of the project’s container, including name, image, project path, bind mounts, environment variables, and network settings.

projectId
required
string

Project ID

OK

object
agentType

AgentType identifies the CLI agent running in this project (e.g. “claude-code”, “codex”).

string
Allowed values: claude-code codex claude-code
allowedDomains

AllowedDomains lists domains accessible when NetworkMode is “restricted”.

Array<string>
cloneURL

CloneURL is the git repository URL (remote projects only).

string
costBudget

CostBudget is the per-project cost limit in USD (0 = use global default).

number
enabledAccessItems

EnabledAccessItems lists active access item IDs (e.g. [“git”,“ssh”]).

Array<string>
enabledRuntimes

EnabledRuntimes lists active runtime IDs (e.g. [“node”,“python”,“go”]).

Array<string>
envVars
object
key
additional properties
string
forwardedPorts

ForwardedPorts lists container ports exposed via the reverse proxy.

Array<integer>
image
string
mounts
Array<object>
object
containerPath

ContainerPath is the absolute path inside the container.

string
hostPath

HostPath is the absolute path on the host.

string
readOnly

ReadOnly mounts the path as read-only inside the container.

boolean
name
string
networkMode

NetworkMode controls the container’s network isolation level.

string
Allowed values: full restricted none
projectPath
string
skipPermissions
boolean
temporary

Temporary is true when a remote project’s workspace is ephemeral.

boolean

Bad Request

object
code
string
Allowed values: INVALID_BODY INVALID_CONTAINER_ID INVALID_CONTAINER_NAME INVALID_WORKTREE_ID INVALID_WORKTREE_NAME REQUIRED_FIELD INVALID_PATH INVALID_NETWORK_CONFIG NOT_A_DIRECTORY NOT_FOUND NAME_TAKEN NOT_CONFIGURED STALE_MOUNTS BUDGET_EXCEEDED PROXY_ERROR INTERNAL
error
string

Not Found

object
code
string
Allowed values: INVALID_BODY INVALID_CONTAINER_ID INVALID_CONTAINER_NAME INVALID_WORKTREE_ID INVALID_WORKTREE_NAME REQUIRED_FIELD INVALID_PATH INVALID_NETWORK_CONFIG NOT_A_DIRECTORY NOT_FOUND NAME_TAKEN NOT_CONFIGURED STALE_MOUNTS BUDGET_EXCEEDED PROXY_ERROR INTERNAL
error
string

Internal Server Error

object
code
string
Allowed values: INVALID_BODY INVALID_CONTAINER_ID INVALID_CONTAINER_NAME INVALID_WORKTREE_ID INVALID_WORKTREE_NAME REQUIRED_FIELD INVALID_PATH INVALID_NETWORK_CONFIG NOT_A_DIRECTORY NOT_FOUND NAME_TAKEN NOT_CONFIGURED STALE_MOUNTS BUDGET_EXCEEDED PROXY_ERROR INTERNAL
error
string