Get UI configuration | Unleash Documentation

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

{
  "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",
  "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,
  "frontendApiOrigins": [
    "*"
  ],
  "flags": {
    "messageBanner": {
      "name": "disabled",
      "enabled": false
    },
    "featuresExportImport": true
  },
  "links": [
    {
      "value": "Documentation",
      "icon": "library_books",
      "href": "https://docs.getunleash.io/docs",
      "title": "User documentation"
    },
    {
      "value": "GitHub",
      "icon": "c_github",
      "href": "https://github.com/Unleash/unleash",
      "title": "Source code on GitHub"
    }
  ],
  "authenticationType": "enterprise",
  "oidcConfiguredThroughEnv": false,
  "samlConfiguredThroughEnv": false,
  "maxSessionsCount": 10,
  "unleashContext": {}
}

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

sloganstring

The slogan to display in the UI footer.

namestring

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

environmentstring

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

billingenum

The billing model in use for this Unleash instance.

Allowed values:

edgeUrlstring

The URL of the Unleash Edge instance.

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.

resourceLimitsobject

A map of resource names and their limits.

prometheusAPIAvailableboolean

Whether a Prometheus API is available.

frontendApiOriginslist of strings

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

flagsmap from strings to booleans or objects

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

linkslist of objects

Relevant links to use in the UI.

authenticationTypeenum

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.

maxSessionsCountdouble

The maximum number of sessions that a user has.

unleashContextobject

The context object used to configure the Unleash instance.