Sign in
internal
workspaces

Get Workspace Neon Roles

Branch-scoped Neon role consumption.

The default read serves the stored census plus a fresh keep-set — app-DB only, so it never wakes the branch. refresh=true reads pg_roles live via the pooled sandbox seam (waking a suspended branch) and stores the new census; the busy/unreachable 503s can only occur on that path.

get/api/v1/internal/workspaces/{workspace_id}/neon-roles

Path parameters

workspace_idstring uuid required

Query parameters

refreshboolean

Response

Successful Response

provisionedboolean required
role_countinteger nullable required
role_capinteger required
project_role_countinteger nullable required
live_project_role_countinteger nullable required
orphan_role_countinteger nullable required
live_project_countinteger nullable required
on_shared_self_serve_projectboolean nullable required
read_atstring date-time nullable required
from_cacheboolean required

Changes

Changed in 1 of the 30 revisions of this API.1