Skip to content

Read project template

GET
/api/v1/template

Reads and parses a .warden.json file from the given path. Used to import templates from outside the project directory.

path
required
string

Absolute path to .warden.json

OK

Template holds project template values loaded from .warden.json, if present.

object
agents
object
key
additional properties
object
allowedDomains
Array<string>
costBudget
number
forwardedPorts
Array<integer>
image
string
networkMode

NetworkMode controls the container’s network isolation level.

string
Allowed values: full restricted none
runtimes
Array<string>
skipPermissions
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