v7

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-013764062.2 MB

Admin UI

Get UI configuration

Retrieves the full configuration used to set up the Unleash Admin UI.

get/api/admin/ui-config

Response

uiConfigSchema

sloganstring

The slogan to display in the UI footer.

namestring

The name of this Unleash instance. Used to build the text in the footer.

versionstring required

The current version of Unleash

environmentstring

What kind of Unleash instance it is: Enterprise, Pro, or Open source

billing'subscription' | 'pay-as-you-go'

The billing model in use for this Unleash instance.

edgeUrlstring

The URL of the Unleash Edge instance.

unleashUrlstring required

The URL of the Unleash instance.

logRocketAppIdstring

The LogRocket app ID used to initialize session replay in the admin UI. Only used when the logRocketEnabled flag is on.

baseUriPathstring required

The base URI path at which this Unleash instance is listening.

feedbackUriPathstring

The URI path at which the feedback endpoint is listening.

disablePasswordAuthboolean

Whether password authentication should be disabled or not.

emailEnabledboolean

Whether this instance can send out emails or not.

maintenanceModeboolean

Whether maintenance mode is currently active or not.

prometheusAPIAvailableboolean

Whether a Prometheus API is available.

impactMetrics'disabled' | 'unconfigured' | 'external' | 'internal' | 'full'

Impact metrics availability for this instance. disabled when the killswitch is on; unconfigured when no source is set up yet; internal/external/full depending on which data sources are available.

frontendApiOriginsstring[]

The list of origins that the front-end API should accept requests from.

flagsobject

Additional (largely experimental) features that are enabled in this Unleash instance.

linksobject[]

Relevant links to use in the UI.

The type of authentication enabled for this Unleash instance

oidcConfiguredThroughEnvboolean

Whether the OIDC configuration is set through environment variables or not.

samlConfiguredThroughEnvboolean

Whether the SAML configuration is set through environment variables or not.

maxSessionsCountnumber

The maximum number of sessions that a user has.

unleashContextobject

The context object used to configure the Unleash instance.

storiesPageEnabledboolean

Whether the internal /_stories component gallery route is enabled. Controlled by the ENABLE_STORIES_PAGE environment variable.

Example response

{
  "slogan": "The enterprise-ready feature flag service.",
  "name": "Unleash enterprise",
  "version": "5.3.0-main",
  "environment": "Enterprise",
  "billing": "subscription",
  "edgeUrl": "https://yourcompany.edge.getunleash.io",
  "unleashUrl": "https://unleash.mycompany.com/enterprise",
  "logRocketAppId": "1knhci/unleash-sandbox",
  "baseUriPath": "/enterprise",
  "feedbackUriPath": "/feedback",
  "emailEnabled": true,
  "resourceLimits": {
    "segmentValues": 10,
    "strategySegments": 10,
    "actionSetActions": 10,
    "actionSetsPerProject": 10,
    "actionSetFilters": 10,
    "actionSetFilterValues": 10,
    "signalEndpoints": 10,
    "signalTokensPerEndpoint": 10,
    "featureEnvironmentStrategies": 30,
    "constraintValues": 250,
    "constraints": 30,
    "environments": 50,
    "apiTokens": 2000,
    "projects": 500,
    "segments": 300,
    "featureFlags": 5000,
    "releaseTemplates": 5,
    "readOnlyUsers": 50
  },
  "prometheusAPIAvailable": true,
  "impactMetrics": "internal",
  "frontendApiOrigins": [
    "*"
  ],
  "flags": {
    "messageBanner": {
      "name": "disabled",
      "enabled": false
    },
    "featuresExportImport": true
  },
  "links": [
    {
      "value": "Documentation",
      "icon": "library_books",
      "href": "https://docs.getunleash.io",
      "title": "User documentation"
    },
    {
      "value": "GitHub",
      "icon": "c_github",
      "href": "https://github.com/Unleash/unleash",
      "title": "Source code on GitHub"
    }
  ],
  "authenticationType": "enterprise",
  "versionInfo": {
    "current": {
      "oss": "5.3.0-main",
      "enterprise": "5.3.0-main+2105.45ed03c9"
    },
    "latest": {
      "oss": "5.1.5",
      "enterprise": "5.1.5"
    },
    "isLatest": true,
    "instanceId": "0d652a82-43db-4144-8e02-864b0b030710",
    "buildDate": "2023-06-30T11:41:00.123Z"
  },
  "maxSessionsCount": 10
}