Skip to main content
GET
Get workspace private network

Authorizations

Authorization
string
header
required

Company API key (mwk_) or personal access token (mel_). A PAT requires X-Workspace-ID on company-scoped routes. An API key implies its own company.

Headers

X-Workspace-ID
string<uuid>

Company UUID for a personal token on company-scoped operations. A company API key already binds its company.

Path Parameters

id
string
required

id from the corresponding authorized response.

Response

{private_network:PrivateNetwork|null}, where null means none is connected. PrivateNetwork is {provider:"tailscale"|"headscale",enabled:boolean,client_id:string,tags:string[],login_server:string,accept_routes:boolean,accept_dns:boolean,generation:integer,configured_by:UUID,configured_at:timestamp,verified_at:timestamp|null,last_error:string}. client_id and tags apply to Tailscale, login_server to Headscale. verified_at is the last successful check (null until one succeeds); last_error the last failure.

private_network
object | null
required