v43

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0163155274.5 KB
workloads

Get workload details

Get details of a specific workload

get/api/v1beta/workloads/{name}

Path parameters

namestring required

Workload name

Response

OK

allow_docker_gatewayboolean

Whether to permit outbound connections to Docker gateway addresses (host.docker.internal, gateway.docker.internal, 172.17.0.1). These are blocked by default in the egress proxy even when network isolation is on. Only applicable to Docker deployments with network isolation enabled.

authz_configstring

Authorization configuration

cmd_argumentsstring[]

Command arguments to pass to the container

env_varsobject

Environment variables to set in the container

groupstring

Group name this workload belongs to

hoststring

Host to bind to

imagestring

Docker image to use

namestring

Name of the workload

network_isolationboolean

Whether network isolation is turned on. This applies the rules in the permission profile. Pointer so that omitting the field defaults to network isolation ENABLED (matching the thv run CLI default); set it explicitly to false to disable network isolation. This also applies on update: a request that omits this field enables isolation, so clients that build update requests from scratch should send it explicitly to avoid unintentionally turning isolation on for a workload that had it off.

proxy_modestring

Proxy mode to use

proxy_portinteger

Port for the HTTP proxy to listen on

registrystring

Registry is the optional registry name to resolve the server from (e.g. "default").

serverstring

Server is the optional server name in the registry (e.g. "io.github.stacklok/fetch"). When both Registry and Server are set, thv resolves the server metadata server-side, filling in image, transport, env vars, permissions, etc. User-provided fields always override registry defaults.

target_portinteger

Port to expose from the container

toolsstring[]

Tools filter

tools_overrideobject

Tools override

transportstring

Transport configuration

trust_proxy_headersboolean

Whether to trust X-Forwarded-* headers from reverse proxies

urlstring

Remote server specific fields

volumesstring[]

Volume mounts