Sign in
workloads

Export workload configuration

Export a workload's run configuration as JSON

get/api/v1beta/workloads/{name}/export

Path parameters

namestring required

Workload name

Response

OK

audit_config_pathstring

DEPRECATED: Middleware configuration. AuditConfigPath is the path to the audit configuration file

authz_config_pathstring

DEPRECATED: Middleware configuration. AuthzConfigPath is the path to the authorization configuration file

base_namestring

BaseName is the base name used for the container (without prefixes)

cmd_argsstring[]

CmdArgs are the arguments to pass to the container

container_labelsobject

ContainerLabels are the labels to apply to the container

container_namestring

ContainerName is the name of the container

debugboolean

Debug indicates whether debug mode is enabled

endpoint_prefixstring

EndpointPrefix is an explicit prefix to prepend to SSE endpoint URLs. This is used to handle path-based ingress routing scenarios.

env_file_dirstring

DEPRECATED: No longer appears to be used. EnvFileDir is the directory path to load environment files from

env_varsobject

EnvVars are the parsed environment variables as key-value pairs

groupstring

Group is the name of the group this workload belongs to, if any

hoststring

Host is the host for the HTTP proxy

imagestring

Image is the Docker image to run

isolate_networkboolean

IsolateNetwork indicates whether to isolate the network for the container

jwks_auth_token_filestring

DEPRECATED: No longer appears to be used. JWKSAuthTokenFile is the path to file containing auth token for JWKS/OIDC requests

k8s_pod_template_patchstring

K8sPodTemplatePatch is a JSON string to patch the Kubernetes pod template Only applicable when using Kubernetes runtime

namestring

Name is the name of the MCP server

permission_profile_name_or_pathstring

PermissionProfileNameOrPath is the name or path of the permission profile

portinteger

Port is the port for the HTTP proxy to listen on (host port)

proxy_mode'sse' | 'streamable-http'

ProxyMode is the proxy mode for stdio transport ("sse" or "streamable-http") Note: "sse" is deprecated; use "streamable-http" instead.

remote_urlstring

RemoteURL is the URL of the remote MCP server (if running remotely)

schema_versionstring

SchemaVersion is the version of the RunConfig schema

secretsstring[]

Secrets are the secret parameters to pass to the container Format: "<secret name>,target=<target environment variable>"

target_hoststring

TargetHost is the host to forward traffic to (only applicable to SSE transport)

target_portinteger

TargetPort is the port for the container to expose (only applicable to SSE transport)

thv_ca_bundlestring

DEPRECATED: No longer appears to be used. ThvCABundle is the path to the CA certificate bundle for ToolHive HTTP operations

tools_filterstring[]

DEPRECATED: Middleware configuration. ToolsFilter is the list of tools to filter

tools_overrideobject

DEPRECATED: Middleware configuration. ToolsOverride is a map from an actual tool to its overridden name and/or description

transport'stdio' | 'sse' | 'streamable-http' | 'inspector'

Transport is the transport mode (stdio, sse, or streamable-http)

trust_proxy_headersboolean

TrustProxyHeaders indicates whether to trust X-Forwarded-* headers from reverse proxies

volumesstring[]

Volumes are the directory mounts to pass to the container Format: "host-path:container-path[:ro]"

Example response

{
  "remote_auth_config": {
    "timeout": "5m"
  }
}

Changes