Check container name

POST

/api/v1/containers/check-name

• Local development server

Reports whether a container name is available, and if not, whether the existing container is Warden-managed.

Request Body ^required

Container name to check

One of:

object

object

object

Container name to check

object

name

Name is the container name to check.

string

Responses

200

OK

object

available

Available is true when no container with this name exists.

boolean

managed

Managed is true when an existing container has the app.warden.managed label. When true, the user can choose to replace it via ForceReplace.

boolean

state

State is the Docker container state (running, exited, etc.) when a container exists with this name.

string

400

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 CONTAINER_EXISTS NOT_CONFIGURED STALE_MOUNTS BUDGET_EXCEEDED PROXY_ERROR INTERNAL

error

string

503

Service Unavailable

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 CONTAINER_EXISTS NOT_CONFIGURED STALE_MOUNTS BUDGET_EXCEEDED PROXY_ERROR INTERNAL

error

string