Get UI configuration
GET<your-unleash-url>/api/admin/ui-config
Retrieves the full configuration used to set up the Unleash Admin UI.
Responses
- 200
uiConfigSchema
- application/json
- Schema
- Example (auto)
Schema
The slogan to display in the UI footer.
The enterprise-ready feature flag service.
The name of this Unleash instance. Used to build the text in the footer.
Unleash enterprise
The current version of Unleash
5.3.0-main
What kind of Unleash instance it is: Enterprise, Pro, or Open source
Enterprise
The billing model in use for this Unleash instance.
Possible values: [subscription
, pay-as-you-go
]
subscription
The URL of the Unleash instance.
https://unleash.mycompany.com/enterprise
The base URI path at which this Unleash instance is listening.
/enterprise
The URI path at which the feedback endpoint is listening.
/feedback
Whether password authentication should be disabled or not.
false
Whether this instance can send out emails or not.
true
Whether maintenance mode is currently active or not.
false
The maximum number of values that can be used in a single segment.
1000
The maximum number of segments that can be applied to a single strategy.
5
resourceLimits object
Whether to enable the Unleash network view or not.
true
The list of origins that the front-end API should accept requests from.
["*"]
flags object
Relevant links to use in the UI.
[{"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"}]
The type of authentication enabled for this Unleash instance
Possible values: [open-source
, demo
, enterprise
, hosted
, custom
, none
]
enterprise
versionInfo objectrequired
Whether the OIDC configuration is set through environment variables or not.
false
Whether the SAML configuration is set through environment variables or not.
false
The maximum number of sessions that a user has.
10
{
"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,
"maxSessionsCount": 10
}
Authorization: Authorization
name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L '<your-unleash-url>/api/admin/ui-config' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>'