Get UI configuration

GET 
/api/admin/ui-config

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

Responses

200

uiConfigSchema

application/json

Schema

Schema

slogan string
The slogan to display in the UI footer.
Example: The enterprise-ready feature flag service.
name string
The name of this Unleash instance. Used to build the text in the footer.
Example: Unleash enterprise
version stringrequired
The current version of Unleash
Example: 5.3.0-main
environment string
What kind of Unleash instance it is: Enterprise, Pro, or Open source
Example: Enterprise
billing string
The billing model in use for this Unleash instance.
Possible values: [subscription, pay-as-you-go]
Example: subscription
unleashUrl stringrequired
The URL of the Unleash instance.
Example: https://unleash.mycompany.com/enterprise
baseUriPath stringrequired
The base URI path at which this Unleash instance is listening.
Example: /enterprise
feedbackUriPath string
The URI path at which the feedback endpoint is listening.
Example: /feedback
disablePasswordAuth boolean
Whether password authentication should be disabled or not.
Example: false
emailEnabled boolean
Whether this instance can send out emails or not.
Example: true
maintenanceMode boolean
Whether maintenance mode is currently active or not.
Example: false
segmentValuesLimit numberdeprecated
The maximum number of values that can be used in a single segment.
Example: 1000
strategySegmentsLimit numberdeprecated
The maximum number of segments that can be applied to a single strategy.
Example: 5

resourceLimits

object

A map of resource names and their limits.

segmentValues integerrequired

The maximum number of values per segment allowed.

Example: 10

strategySegments integerrequired

The maximum number of strategy segments allowed.

Example: 10

actionSetActions integerrequired

The maximum number of actions per action set allowed.

Example: 10

actionSetsPerProject integerrequired

The maximum number of action set definitions per project allowed.

Example: 10

actionSetFilters integerrequired

The maximum number of filters per action set allowed.

Example: 10

actionSetFilterValues integerrequired

The maximum number of filter values inside an action set allowed.

Example: 10

signalEndpoints integerrequired

The maximum number of signal endpoints allowed.

Example: 10

signalTokensPerEndpoint integerrequired

The maximum number of signal tokens per endpoint allowed.

Example: 10

featureEnvironmentStrategies integerrequired

The maximum number of feature environment strategies allowed.

Example: 30

constraintValues integerrequired

The maximum number of values for a single constraint.

Example: 250

constraints integerrequired

The maximum number of constraints in a single strategy.

Example: 30

environments integerrequired

The maximum number of environments allowed.

Possible values: >= 1

Example: 50

apiTokens integerrequired

The maximum number of SDK and admin API tokens you can have at the same time. This limit applies only to server-side and client-side SDK tokens and to admin tokens. Personal access tokens are not subject to this limit. The limit applies to the total number of tokens across all projects in your organization.

Example: 2000

projects integerrequired

The maximum number of projects allowed.

Possible values: >= 1

Example: 500

segments integerrequired

The maximum number of segments allowed.

Example: 300

featureFlags integerrequired

The maximum number of feature flags you can have at the same time. Archived flags do not count towards this limit.

Possible values: >= 1

Example: 5000
networkViewEnabled boolean
Whether to enable the Unleash network view or not.
Example: true
frontendApiOrigins string[]
The list of origins that the front-end API should accept requests from.
Example: ["*"]

flags

object

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

property name*

object

anyOf

MOD1

boolean

variantFlagSchema

A representation of an evaluated Unleash feature variant.

name string

The name of the variant. Will always be disabled if enabled is false.

Example: blue

enabled boolean

Whether the variant is enabled or not.

Example: true

payload

object

Additional data associated with this variant.

type string

The type of data contained.

Possible values: [string, json, csv, number]

Example: json

value string

The actual associated data

Example: { "starter": "squirtle" }

feature_enabled boolean

Whether the feature is enabled or not.

Example: true

featureEnabled booleandeprecated

Use feature_enabled instead.

Example: true
links object[]
Relevant links to use in the UI.
Example: [{"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 string
The type of authentication enabled for this Unleash instance
Possible values: [open-source, demo, enterprise, hosted, custom, none]
Example: enterprise

versionInfo

object

required

Detailed information about an Unleash version

current

object

required

The current version of Unleash.

oss string

The OSS version used when building this Unleash instance, represented as a git revision belonging to the main Unleash git repo

Example: 5.3.0-main

enterprise string

The Enterpris version of Unleash used to build this instance, represented as a git revision belonging to the Unleash Enterprise repository. Will be an empty string if no enterprise version was used,

Example: 5.3.0-main+2105.45ed03c9

latest

object

required

Information about the latest available Unleash releases. Will be an empty object if no data is available.

oss string

The latest available OSS version of Unleash

Example: 5.1.5

enterprise string

The latest available Enterprise version of Unleash

Example: 5.1.5

isLatest booleanrequired

Whether the Unleash server is running the latest release (true) or if there are updates available (false)

Example: true

instanceId string

The instance identifier of the Unleash instance

Example: 0d652a82-43db-4144-8e02-864b0b030710
oidcConfiguredThroughEnv boolean
Whether the OIDC configuration is set through environment variables or not.
Example: false
samlConfiguredThroughEnv boolean
Whether the SAML configuration is set through environment variables or not.
Example: false
unleashAIAvailable boolean
Whether Unleash AI is available.
Example: false

Example (from schema)

{
  "slogan": "The enterprise-ready feature flag service.",
  "name": "Unleash enterprise",
  "version": "5.3.0-main",
  "environment": "Enterprise",
  "billing": "subscription",
  "unleashUrl": "https://unleash.mycompany.com/enterprise",
  "baseUriPath": "/enterprise",
  "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
  },
  "networkViewEnabled": 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",
  "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"
  },
  "oidcConfiguredThroughEnv": false,
  "samlConfiguredThroughEnv": false,
  "unleashAIAvailable": false
}

Loading...