Skip to main content

Get UI configuration

GET <your-unleash-url>/api/admin/ui-config

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

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

Request​

Responses

uiConfigSchema

Schema
  • slogan string

    The slogan to display in the UI footer.

  • name string

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

  • version string required

    The current version of Unleash

  • environment string

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

  • unleashUrl string required

    The URL of the Unleash instance.

  • baseUriPath string required

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

  • feedbackUriPath string

    The URI path at which the feedback endpoint is listening.

  • disablePasswordAuth boolean

    Whether password authentication should be disabled or not.

  • emailEnabled boolean

    Whether this instance can send out emails or not.

  • maintenanceMode boolean

    Whether maintenance mode is currently active or not.

  • segmentValuesLimit number deprecated

    The maximum number of values that can be used in a single segment.

  • strategySegmentsLimit number deprecated

    The maximum number of segments that can be applied to a single strategy.

  • resourceLimits object

    A map of resource names and their limits.

  • segmentValues integer required

    The maximum number of values per segment allowed.

  • strategySegments integer required

    The maximum number of strategy segments allowed.

  • actionSetActions integer required

    The maximum number of actions per action set allowed.

  • actionSetsPerProject integer required

    The maximum number of action set definitions per project allowed.

  • actionSetFilters integer required

    The maximum number of filters per action set allowed.

  • actionSetFilterValues integer required

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

  • signalEndpoints integer required

    The maximum number of signal endpoints allowed.

  • signalTokensPerEndpoint integer required

    The maximum number of signal tokens per endpoint allowed.

  • featureEnvironmentStrategies integer required

    The maximum number of feature environment strategies allowed.

  • constraintValues integer required

    The maximum number of values for a single constraint.

  • constraints integer required

    The maximum number of constraints in a single strategy.

  • environments integer required

    Possible values: >= 1

    The maximum number of environments allowed.

  • apiTokens integer required

    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.

  • projects integer required

    Possible values: >= 1

    The maximum number of projects allowed.

  • segments integer required

    The maximum number of segments allowed.

  • featureFlags integer required

    Possible values: >= 1

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

  • networkViewEnabled boolean

    Whether to enable the Unleash network view or not.

  • frontendApiOrigins string[]

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

  • flags object

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

  • anyOf
  • links object[]

    Relevant links to use in the UI.

  • authenticationType string

    Possible values: [open-source, demo, enterprise, hosted, custom, none]

    The type of authentication enabled for this Unleash instance

  • versionInfo objectrequired

    Detailed information about an Unleash version

  • current objectrequired

    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

  • 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,

  • latest objectrequired

    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

  • enterprise string

    The latest available Enterprise version of Unleash

  • isLatest boolean required

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

  • instanceId string

    The instance identifier of the Unleash instance

  • oidcConfiguredThroughEnv boolean

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

  • samlConfiguredThroughEnv boolean

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

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

Request

Base URL
<your-unleash-url>
Security Scheme
apiKey
curl / cURL
curl -L -X GET '<your-unleash-url>/api/admin/ui-config' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'