Skip to content
API referencePlatformProject.settings

Get tenant MagicDNS policy

GET
/platform/v1/project/dns

Returns the project-wide MagicDNS policy (master toggle, default nameservers, override-local-DNS, search domains, split-DNS routes, static records, and the branded mesh suffix) the project applies to all of its consumers' meshes. Accessible to a project Admin+ (or a global SuperAdmin via the D-006 bypass). MagicDNS is default-on + free, so an unset policy returns the base feature ENABLED with empty paid sub-fields (operators can opt out by disabling the master toggle).

Authorization

bearer_auth
AuthorizationBearer <token>

In: header

Header Parameters

X-Project-Id*string

UUID of the project that scopes consumer accounts, devices, sessions, and VSpaces for the request.

Formatuuid

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/platform/v1/project/dns" \  -H "X-Project-Id: 11111111-1111-1111-1111-111111111111"
{  "branded_suffix": "acme.mesh.fvpn.net",  "custom_domain_id": null,  "enabled": true,  "extra_records": [],  "override_local_dns": true,  "project_id": "11111111-1111-1111-1111-111111111111",  "resolvers": [    {      "addr": "1.1.1.1",      "use_with_exit_node": true    }  ],  "routes": [],  "search_domains": [    "corp.example.com"  ],  "updated_at": "2026-06-17T12:00:00Z"}
{  "detail": "Pool slug must be unique.",  "instance": "urn:forestvpn:trace:a1b2c3d4",  "title": "Validation Error",  "type": "https://fvpn.net/errors/validation"}
{  "detail": "Pool slug must be unique.",  "instance": "urn:forestvpn:trace:a1b2c3d4",  "title": "Validation Error",  "type": "https://fvpn.net/errors/validation"}