Skip to main content

Feature flags

Route/admin/dashboard/feature-flags
Legacy screen
This surface predates the Hive redesign; it is scheduled under #5272.

A feature flag names one application or feature — the Schema Designer, the AI Assistant, the type registry — so it can be granted by a license or to a single person. Sign in to the admin console and choose Feature Flags in the sidebar: it opens the Licenses screen on its Feature Flags tab.

The Feature Flags tab: six flags with machine names, Preview badges, URL patterns, and one switched offThe Feature Flags tab: six flags with machine names, Preview badges, URL patterns, and one switched off
Route/admin/dashboard/feature-flags

Who gets a flag​

For a person working in a tenant, Apiome decides each flag in this order and stops at the first answer:

  1. The flag is switched off (disabled) — off for everyone.
  2. A per-user grant for that person.
  3. A per-tenant setting for the tenant.
  4. Whether the person's license includes the flag.
  5. Otherwise, off.

The flags a new installation has​

FlagMachine namePreviewOn the plans
Schema DesignerdesignernoFree, Paid, Sponsor
API PathspathsnoPaid, Sponsor
AI Assistantai_assistantyesPaid, Sponsor
RepositoriesrepositoriesyesPaid, Sponsor
Primitives Type Registryprimitives-registryyesPaid, Sponsor

designer and paths are commercial applications: they decide which apps a person sees on the home page and in the top navigation. The type registry is only enforced when the REST API runs with APIOME_PRIMITIVES_REGISTRY_GATING=true; by default every tenant reaches it.

Create or edit a flag​

  1. Click “New Feature Flag” (or a flag's pencil).
  2. Enter the Machine Name — lowercase letters, numbers and underscores, for example partner_sandbox. It cannot be changed after creation.
  3. Enter the Display Label, for example Partner sandbox, and a Description.
  4. Optionally list URL Patterns (one per line) — the paths the flag covers, such as /ade/studio. Apiome stores them with the flag as a record of what it gates; access is decided by the order above, not by matching these paths.
  5. Switch on Mark as Preview to show a Preview badge wherever the flag is listed.
  6. Click “Create Flag” (or “Save Changes”).

To grant the new flag, tick it in a plan under Create or edit a plan, or to one person below.

Switch a flag off​

Click the toggle on a flag's row (Disable / Enable). A switched-off flag reads disabled and is off for everyone, whatever their license or grants say — the quickest way to withdraw a feature from the whole installation.

The trash icon deletes a flag after you confirm; it is removed from every license and every per-user grant that named it.

Flag packages​

A flag package bundles flags you often grant together, so they can be added to a person in one click. Open the Flag packages tab, click “New flag package”, enter a Machine Name and Display Label, tick the Flags in this package, and click “Create Package”.

The Flag packages tab: Design tools with two flags and Preview features with threeThe Flag packages tab: Design tools with two flags and Preview features with three
Route/admin/dashboard/feature-flags

Deleting a package removes only the grouping: its flags stay, and grants already made from it are not changed.

Grant flags to one person​

  1. Open the Assignments tab (on the Licenses screen) and click “Assign” on the person's row.
  2. Click “Override feature flags…”.
  3. In Feature flags — name:
    • under Feature packages, click “Add all” (or “Remove all”) beside a package;
    • or find a flag with Search flags by label or name… and click its + in All flags — add. A green license tag marks a flag the person's plan already includes.
  4. Flags you granted are listed under Granted for this user; click − to remove a grant. Each change saves at once.
Feature flags for Elena Vasquez: AI Assistant and Partner sandbox granted, the other flags ready to add, Schema Designer tagged as on her licenseFeature flags for Elena Vasquez: AI Assistant and Partner sandbox granted, the other flags ready to add, Schema Designer tagged as on her license
Route/admin/dashboard/feature-flags

Removing a grant does not switch the flag off for that person — it hands the decision back to their tenant and license.

With the API​

Flags and packages are edited only here. A workspace member sees the features their tenant's plan turns on in GET /v1/tenants/{tenant_slug}/license — see the API reference.

Where next​