Feature flags

Read which feature flags are on. Requires settings:manage.

TypeScript

const TOKEN = "hv_..."; // your API key
const headers = { Authorization: `Bearer ${TOKEN}` };

JavaScript

const TOKEN = "hv_..."; // your API key
const headers = { Authorization: `Bearer ${TOKEN}` };

Rust

let token = "hv_..."; // your API key

Go

token := "hv_..." // your API key

cURL

# All examples assume $TOKEN is an API key (hv_...)
AUTH="Authorization: Bearer $TOKEN"

List feature flags

GET /admin/feature-flags

Returns all feature flags and their current status. Flags are backed by the happyview_instance_settings table. A flag is enabled when its stored setting, or its environment variable if none is stored, is "true", ignoring case.

TypeScript

interface FeatureFlag {
  key: string;
  name: string;
  description: string;
  enabled: boolean;
}

const response = await fetch("http://127.0.0.1:3000/admin/feature-flags", {
  headers,
});
const data: FeatureFlag[] = await response.json();

JavaScript

const response = await fetch("http://127.0.0.1:3000/admin/feature-flags", {
  headers,
});
const data = await response.json();

Rust

let client = reqwest::Client::new();
let response = client
    .get("http://127.0.0.1:3000/admin/feature-flags")
    .bearer_auth(token)
    .send()
    .await?;
let data: serde_json::Value = response.json().await?;

Go

req, _ := http.NewRequest("GET", "http://127.0.0.1:3000/admin/feature-flags", nil)
req.Header.Set("Authorization", "Bearer "+token)
resp, err := http.DefaultClient.Do(req)

cURL

curl http://127.0.0.1:3000/admin/feature-flags -H "$AUTH"

Response: 200 OK

[
  {
    "key": "feature.spaces_enabled",
    "name": "Permissioned Spaces",
    "description": "Collaborative data spaces with granular permissions, membership, and invites.",
    "enabled": false
  }
]

Field	Type	Description
key	string	Settings key for the flag
name	string	Human-readable name
description	string	What the flag controls
enabled	boolean	Whether the flag is currently enabled

To toggle a flag, use PUT /admin/settings/{key} with the value "true" or "false". See Instance settings for details.