Skip to main content
GET
Check feature gate

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

gate
enum<string>
required
Available options:
custom_domains,
dedicated_runtime,
dedicated_gateway,
sso,
dedicated_control_plane,
dedicated_database,
byoc,
collaborators,
projects,
sla

Query Parameters

current_count
integer | null

Current resource count for count-based gates.

Required range: x >= 0
project_reference
string

Optional project ID or slug. When supplied for a gate other than projects, checks the project owner and requires project.read. The projects gate always checks the caller.

Minimum string length: 1

Response

Feature gate check result. A denied gate answers allowed false.

gate
enum<string>
required

The gate that was checked

Available options:
custom_domains,
dedicated_runtime,
dedicated_gateway,
sso,
dedicated_control_plane,
dedicated_database,
byoc,
collaborators,
projects,
sla
allowed
boolean
required

Whether the plan allows the gate

required_tier
string | null
required

Tier required when access is denied. Null when allowed.

limit
number | null
required

Numeric limit of a count-based gate. Null for other gates.

current_count
number | null
required

The current_count the check was given, for a gate checked against a limit. Null otherwise.