v54

latestSwagger 2.0AGPL-3.0raw.githubusercontent.com2026-08-03397565628.8 KB
Enterprise

Register workspace proxy

post/api/v2/workspaceproxies/me/register

Request body

access_urlstring

AccessURL that hits the workspace proxy api.

derp_enabledboolean

DerpEnabled indicates whether the proxy should be included in the DERP map or not.

derp_onlyboolean

DerpOnly indicates whether the proxy should only be included in the DERP map and should not be used for serving apps.

hostnamestring

ReplicaHostname is the OS hostname of the machine that the proxy is running on. This is only used for tracking purposes in the replicas table.

replica_errorstring

ReplicaError is the error that the replica encountered when trying to dial it's peers. This is stored in the replicas table for debugging purposes but does not affect the proxy's ability to register.

This value is only stored on subsequent requests to the register endpoint, not the first request.

replica_idstring

ReplicaID is a unique identifier for the replica of the proxy that is registering. It should be generated by the client on startup and persisted (in memory only) until the process is restarted.

replica_relay_addressstring

ReplicaRelayAddress is the DERP address of the replica that other replicas may use to connect internally for DERP meshing.

versionstring

Version is the Coder version of the proxy.

wildcard_hostnamestring

WildcardHostname that the workspace proxy api is serving for subdomain apps.

Response

Created

derp_force_websocketsboolean
derp_mesh_keystring
derp_region_idinteger