Get UI configuration

GET

https://app.unleash-instance.example.com/api/admin/ui-config

GET

/api/admin/ui-config

curl https://app.unleash-instance.example.com/api/admin/ui-config \
     -H "Authorization: <apiKey>"

200Retrieved

{
  "version": "5.3.0-main",
  "unleashUrl": "https://unleash.mycompany.com/enterprise",
  "baseUriPath": "/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"
  },
  "slogan": "The enterprise-ready feature flag service.",
  "name": "Unleash enterprise",
  "environment": "Enterprise",
  "billing": "subscription",
  "edgeUrl": "https://yourcompany.edge.getunleash.io",
  "logRocketAppId": "1knhci/unleash-sandbox",
  "hubspotPortalId": "1234567",
  "feedbackUriPath": "/feedback",
  "disablePasswordAuth": false,
  "emailEnabled": true,
  "maintenanceMode": false,
  "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": {
    "featuresExportImport": true,
    "messageBanner": {
      "enabled": false,
      "name": "disabled"
    }
  },
  "links": [
    {
      "href": "https://docs.getunleash.io",
      "icon": "library_books",
      "title": "User documentation",
      "value": "Documentation"
    },
    {
      "href": "https://github.com/Unleash/unleash",
      "icon": "c_github",
      "title": "Source code on GitHub",
      "value": "GitHub"
    }
  ],
  "authenticationType": "enterprise",
  "oidcConfiguredThroughEnv": false,
  "samlConfiguredThroughEnv": false,
  "maxSessionsCount": 10,
  "unleashContext": {},
  "storiesPageEnabled": false
}

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

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Response

uiConfigSchema

versionstring

The current version of Unleash

unleashUrlstring

The URL of the Unleash instance.

baseUriPathstring

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

versionInfoobject

Detailed information about an Unleash version

sloganstringOptional

The slogan to display in the UI footer.

namestringOptional

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

environmentstringOptional

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

billingenumOptional

The billing model in use for this Unleash instance.

Allowed values:

edgeUrlstringOptional

The URL of the Unleash Edge instance.

logRocketAppIdstringOptional

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

hubspotPortalIdstringOptional

The HubSpot portal ID. Currently used to load the customer support chat widget when the hubspotChatEnabled flag is on and the instance is a PAYG trial; may be reused by future HubSpot integrations.

feedbackUriPathstringOptional

The URI path at which the feedback endpoint is listening.

disablePasswordAuthbooleanOptional

Whether password authentication should be disabled or not.

emailEnabledbooleanOptional

Whether this instance can send out emails or not.

maintenanceModebooleanOptional

Whether maintenance mode is currently active or not.

resourceLimitsobjectOptional

A map of resource names and their limits.

prometheusAPIAvailablebooleanOptional

Whether a Prometheus API is available.

impactMetricsenumOptional

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.

Allowed values:

frontendApiOriginslist of stringsOptional

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

flagsmap from strings to booleans or objectsOptional

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

linkslist of objectsOptional

Relevant links to use in the UI.

authenticationTypeenumOptional

The type of authentication enabled for this Unleash instance

oidcConfiguredThroughEnvbooleanOptional

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

samlConfiguredThroughEnvbooleanOptional

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

maxSessionsCountdoubleOptional

The maximum number of sessions that a user has.

unleashContextobjectOptional

The context object used to configure the Unleash instance.

storiesPageEnabledbooleanOptional

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