---
title: "Get UI configuration"
method: GET
path: "/api/admin/ui-config"
tags: ["Admin UI"]
---

# Get UI configuration

`GET /api/admin/ui-config`

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

## Response `200`

uiConfigSchema

- UiConfigSchema — A collection of properties used to configure the Unleash Admin UI.
  - `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
  - `billing` 'subscription' | 'pay-as-you-go' — The billing model in use for this Unleash instance.
  - `edgeUrl` string — The URL of the Unleash Edge instance.
  - `unleashUrl` string, required — The URL of the Unleash instance.
  - `logRocketAppId` string — The LogRocket app ID used to initialize session replay in the admin UI. Only used when the `logRocketEnabled` flag is on.
  - `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.
  - `resourceLimits` ResourceLimitsSchema — 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 — 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 backend and frontend 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 — The maximum number of projects allowed.
    - `segments` integer, required — The maximum number of segments allowed.
    - `featureFlags` integer, required — The maximum number of feature flags you can have at the same time. Archived flags do not count towards this limit.
    - `releaseTemplates` integer, required — The maximum number of release templates allowed.
    - `readOnlyUsers` integer — The maximum number of read-only users allowed.
  - `prometheusAPIAvailable` boolean — Whether a Prometheus API is available.
  - `impactMetrics` 'disabled' | 'unconfigured' | 'external' | 'internal' | 'full' — 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.
  - `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.
  - `links` object[] — Relevant links to use in the UI.
  - `authenticationType` 'open-source' | 'demo' | 'enterprise' | 'hosted' | 'custom' | 'none' — The type of authentication enabled for this Unleash instance
  - `versionInfo` VersionSchema, 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](https://github.com/Unleash/unleash/)
      - `enterprise` string — The Enterpris version of Unleash used to build this instance, represented as a git revision belonging to the [Unleash Enterprise](https://github.com/ivarconr/unleash-enterprise) repository. Will be an empty string if no enterprise version was used,
    - `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
      - `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
    - `buildDate` string, date-time, nullable — The date and time of when this Unleash instance version was built
  - `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.
  - `maxSessionsCount` number — The maximum number of sessions that a user has.
  - `unleashContext` object — The context object used to configure the Unleash instance.
  - `storiesPageEnabled` boolean — Whether the internal `/_stories` component gallery route is enabled. Controlled by the `ENABLE_STORIES_PAGE` environment variable.

---

[API](https://skmtc.net/unleash/apis/unleash-api-3.md) · [All operations](https://skmtc.net/unleash/apis/unleash-api-3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/unleash/unleash-api-3/revisions/b2c3116e633e/schema)