Skip to main content

Get UI configuration

GET 

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

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

Responses

uiConfigSchema

Schema
    sloganstring

    The slogan to display in the UI footer.

    Example: The enterprise-ready feature flag service.
    namestring

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

    Example: Unleash enterprise
    versionstringrequired

    The current version of Unleash

    Example: 5.3.0-main
    environmentstring

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

    Example: Enterprise
    billingstring

    The billing model in use for this Unleash instance.

    Possible values: [subscription, pay-as-you-go]

    Example: subscription
    unleashUrlstringrequired

    The URL of the Unleash instance.

    Example: https://unleash.mycompany.com/enterprise
    baseUriPathstringrequired

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

    Example: /enterprise
    feedbackUriPathstring

    The URI path at which the feedback endpoint is listening.

    Example: /feedback
    disablePasswordAuthboolean

    Whether password authentication should be disabled or not.

    Example: false
    emailEnabledboolean

    Whether this instance can send out emails or not.

    Example: true
    maintenanceModeboolean

    Whether maintenance mode is currently active or not.

    Example: false
    segmentValuesLimitnumberdeprecated

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

    Example: 1000
    strategySegmentsLimitnumberdeprecated

    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.

    segmentValuesintegerrequired

    The maximum number of values per segment allowed.

    Example: 10
    strategySegmentsintegerrequired

    The maximum number of strategy segments allowed.

    Example: 10
    actionSetActionsintegerrequired

    The maximum number of actions per action set allowed.

    Example: 10
    actionSetsPerProjectintegerrequired

    The maximum number of action set definitions per project allowed.

    Example: 10
    actionSetFiltersintegerrequired

    The maximum number of filters per action set allowed.

    Example: 10
    actionSetFilterValuesintegerrequired

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

    Example: 10
    signalEndpointsintegerrequired

    The maximum number of signal endpoints allowed.

    Example: 10
    signalTokensPerEndpointintegerrequired

    The maximum number of signal tokens per endpoint allowed.

    Example: 10
    featureEnvironmentStrategiesintegerrequired

    The maximum number of feature environment strategies allowed.

    Example: 30
    constraintValuesintegerrequired

    The maximum number of values for a single constraint.

    Example: 250
    constraintsintegerrequired

    The maximum number of constraints in a single strategy.

    Example: 30
    environmentsintegerrequired

    The maximum number of environments allowed.

    Possible values: >= 1

    Example: 50
    apiTokensintegerrequired

    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
    projectsintegerrequired

    The maximum number of projects allowed.

    Possible values: >= 1

    Example: 500
    segmentsintegerrequired

    The maximum number of segments allowed.

    Example: 300
    featureFlagsintegerrequired

    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
    networkViewEnabledboolean

    Whether to enable the Unleash network view or not.

    Example: true
    frontendApiOriginsstring[]

    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
    boolean
    linksobject[]

    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"}]
    authenticationTypestring

    The type of authentication enabled for this Unleash instance

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

    Example: enterprise
    versionInfo objectrequired

    Detailed information about an Unleash version

    current objectrequired

    The current version of Unleash.

    ossstring

    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
    enterprisestring

    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 objectrequired

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

    ossstring

    The latest available OSS version of Unleash

    Example: 5.1.5
    enterprisestring

    The latest available Enterprise version of Unleash

    Example: 5.1.5
    isLatestbooleanrequired

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

    Example: true
    instanceIdstring

    The instance identifier of the Unleash instance

    Example: 0d652a82-43db-4144-8e02-864b0b030710
    oidcConfiguredThroughEnvboolean

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

    Example: false
    samlConfiguredThroughEnvboolean

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

    Example: false
    maxSessionsCountnumber

    The maximum number of sessions that a user has.

    Example: 10

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API
curl -L '<your-unleash-url>/api/admin/ui-config' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>'
Request Collapse all
Base URL
<your-unleash-url>
Auth
ResponseClear

Click the Send API Request button above and see the response here!