# Get UI configuration

GET https://app.unleash-instance.example.com/api/admin/ui-config

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

Reference: https://docs.getunleash.io/api/get-ui-config

## OpenAPI Specification

```yaml
openapi: 3.1.1
info:
  title: Get UI configuration
  version: endpoint_adminUi.getUiConfig
paths:
  /api/admin/ui-config:
    get:
      operationId: get-ui-config
      summary: Get UI configuration
      description: Retrieves the full configuration used to set up the Unleash Admin UI.
      tags:
        - - subpackage_adminUi
      parameters:
        - name: Authorization
          in: header
          description: Header authentication of the form `undefined <token>`
          required: true
          schema:
            type: string
      responses:
        '200':
          description: uiConfigSchema
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/uiConfigSchema'
components:
  schemas:
    UiConfigSchemaBilling:
      type: string
      enum:
        - value: subscription
        - value: pay-as-you-go
    resourceLimitsSchema:
      type: object
      properties:
        segmentValues:
          type: integer
          description: The maximum number of values per segment allowed.
        strategySegments:
          type: integer
          description: The maximum number of strategy segments allowed.
        actionSetActions:
          type: integer
          description: The maximum number of actions per action set allowed.
        actionSetsPerProject:
          type: integer
          description: The maximum number of action set definitions per project allowed.
        actionSetFilters:
          type: integer
          description: The maximum number of filters per action set allowed.
        actionSetFilterValues:
          type: integer
          description: The maximum number of filter values inside an action set allowed.
        signalEndpoints:
          type: integer
          description: The maximum number of signal endpoints allowed.
        signalTokensPerEndpoint:
          type: integer
          description: The maximum number of signal tokens per endpoint allowed.
        featureEnvironmentStrategies:
          type: integer
          description: The maximum number of feature environment strategies allowed.
        constraintValues:
          type: integer
          description: The maximum number of values for a single constraint.
        constraints:
          type: integer
          description: The maximum number of constraints in a single strategy.
        environments:
          type: integer
          description: The maximum number of environments allowed.
        apiTokens:
          type: integer
          description: >-
            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:
          type: integer
          description: The maximum number of projects allowed.
        segments:
          type: integer
          description: The maximum number of segments allowed.
        featureFlags:
          type: integer
          description: >-
            The maximum number of feature flags you can have at the same time.
            Archived flags do not count towards this limit.
        releaseTemplates:
          type: integer
          description: The maximum number of release templates allowed.
        readOnlyUsers:
          type: integer
          description: The maximum number of read-only users allowed.
      required:
        - segmentValues
        - strategySegments
        - actionSetActions
        - actionSetsPerProject
        - actionSetFilters
        - actionSetFilterValues
        - signalEndpoints
        - signalTokensPerEndpoint
        - featureEnvironmentStrategies
        - constraintValues
        - constraints
        - environments
        - apiTokens
        - projects
        - segments
        - featureFlags
        - releaseTemplates
    VariantFlagSchemaPayloadType:
      type: string
      enum:
        - value: string
        - value: json
        - value: csv
        - value: number
    VariantFlagSchemaPayload:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/VariantFlagSchemaPayloadType'
          description: The type of data contained.
        value:
          type: string
          description: The actual associated data
    variantFlagSchema:
      type: object
      properties:
        name:
          type: string
          description: >-
            The name of the variant. Will always be disabled if `enabled` is
            false.
        enabled:
          type: boolean
          description: Whether the variant is enabled or not.
        payload:
          $ref: '#/components/schemas/VariantFlagSchemaPayload'
          description: Additional data associated with this variant.
        feature_enabled:
          type: boolean
          description: Whether the feature is enabled or not.
        featureEnabled:
          type: boolean
          description: Use `feature_enabled` instead.
    UiConfigSchemaFlags:
      oneOf:
        - type: boolean
        - $ref: '#/components/schemas/variantFlagSchema'
    UiConfigSchemaLinksItems:
      type: object
      properties: {}
    UiConfigSchemaAuthenticationType:
      type: string
      enum:
        - value: open-source
        - value: demo
        - value: enterprise
        - value: hosted
        - value: custom
        - value: none
    VersionSchemaCurrent:
      type: object
      properties:
        oss:
          type: string
          description: >-
            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:
          type: string
          description: >-
            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,
    VersionSchemaLatest:
      type: object
      properties:
        oss:
          type: string
          description: The latest available OSS version of Unleash
        enterprise:
          type: string
          description: The latest available Enterprise version of Unleash
    versionSchema:
      type: object
      properties:
        current:
          $ref: '#/components/schemas/VersionSchemaCurrent'
          description: The current version of Unleash.
        latest:
          $ref: '#/components/schemas/VersionSchemaLatest'
          description: >-
            Information about the latest available Unleash releases. Will be an
            empty object if no data is available.
        isLatest:
          type: boolean
          description: >-
            Whether the Unleash server is running the latest release (`true`) or
            if there are updates available (`false`)
        instanceId:
          type: string
          description: The instance identifier of the Unleash instance
        buildDate:
          type:
            - string
            - 'null'
          format: date-time
          description: The date and time of when this Unleash instance version was built
      required:
        - current
        - latest
        - isLatest
    UiConfigSchemaUnleashContext:
      type: object
      properties: {}
    uiConfigSchema:
      type: object
      properties:
        slogan:
          type: string
          description: The slogan to display in the UI footer.
        name:
          type: string
          description: >-
            The name of this Unleash instance. Used to build the text in the
            footer.
        version:
          type: string
          description: The current version of Unleash
        environment:
          type: string
          description: 'What kind of Unleash instance it is: Enterprise, Pro, or Open source'
        billing:
          $ref: '#/components/schemas/UiConfigSchemaBilling'
          description: The billing model in use for this Unleash instance.
        edgeUrl:
          type: string
          description: The URL of the Unleash Edge instance.
        unleashUrl:
          type: string
          description: The URL of the Unleash instance.
        baseUriPath:
          type: string
          description: The base URI path at which this Unleash instance is listening.
        feedbackUriPath:
          type: string
          description: The URI path at which the feedback endpoint is listening.
        disablePasswordAuth:
          type: boolean
          description: Whether password authentication should be disabled or not.
        emailEnabled:
          type: boolean
          description: Whether this instance can send out emails or not.
        maintenanceMode:
          type: boolean
          description: Whether maintenance mode is currently active or not.
        resourceLimits:
          $ref: '#/components/schemas/resourceLimitsSchema'
          description: A map of resource names and their limits.
        prometheusAPIAvailable:
          type: boolean
          description: Whether a Prometheus API is available.
        frontendApiOrigins:
          type: array
          items:
            type: string
          description: >-
            The list of origins that the front-end API should accept requests
            from.
        flags:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/UiConfigSchemaFlags'
          description: >-
            Additional (largely experimental) features that are enabled in this
            Unleash instance.
        links:
          type: array
          items:
            $ref: '#/components/schemas/UiConfigSchemaLinksItems'
          description: Relevant links to use in the UI.
        authenticationType:
          $ref: '#/components/schemas/UiConfigSchemaAuthenticationType'
          description: The type of authentication enabled for this Unleash instance
        versionInfo:
          $ref: '#/components/schemas/versionSchema'
        oidcConfiguredThroughEnv:
          type: boolean
          description: >-
            Whether the OIDC configuration is set through environment variables
            or not.
        samlConfiguredThroughEnv:
          type: boolean
          description: >-
            Whether the SAML configuration is set through environment variables
            or not.
        maxSessionsCount:
          type: number
          format: double
          description: The maximum number of sessions that a user has.
        unleashContext:
          $ref: '#/components/schemas/UiConfigSchemaUnleashContext'
          description: The context object used to configure the Unleash instance.
      required:
        - version
        - unleashUrl
        - baseUriPath
        - versionInfo

```

## SDK Code Examples

```python
import requests

url = "https://app.unleash-instance.example.com/api/admin/ui-config"

headers = {"Authorization": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://app.unleash-instance.example.com/api/admin/ui-config';
const options = {method: 'GET', headers: {Authorization: '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.unleash-instance.example.com/api/admin/ui-config"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://app.unleash-instance.example.com/api/admin/ui-config")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://app.unleash-instance.example.com/api/admin/ui-config")
  .header("Authorization", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://app.unleash-instance.example.com/api/admin/ui-config', [
  'headers' => [
    'Authorization' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://app.unleash-instance.example.com/api/admin/ui-config");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://app.unleash-instance.example.com/api/admin/ui-config")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```