Skip to content
API referencePlatformProject.settings

Get project settings

GET
/platform/v1/project/settings

Returns project-scoped device authorization and lifecycle settings. Accessible to the project Owner (or a global SuperAdmin via the D-006 bypass).

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/settings" \  -H "X-Project-Id: 11111111-1111-1111-1111-111111111111"
{  "ephemeral_cleanup_minutes": 5,  "machine_auth_policy": "manual",  "node_key_grace_period_minutes": 5,  "node_key_lifetime_days": 90,  "project_id": "11111111-1111-1111-1111-111111111111",  "updated_at": "2026-04-22T12: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"}