Get all applications

GET 
/api/admin/metrics/applications

Returns all applications registered with Unleash. Applications can be created via metrics reporting or manual creation

Request

Query Parameters

query string

The search query for the application name

offset string

The number of applications to skip when returning a page. By default it is set to 0.

limit string

The number of applications to return in a page. By default it is set to 1000.

sortBy string

The field to sort the results by. By default it is set to "appName".

sortOrder string

The sort order for the sortBy. By default it is det to "asc".

Responses

200

applicationsSchema

application/json

Schema

Schema

total integerrequired
The total number of project applications.
Example: 50

applications

object[]

required

The list of applications that have connected to this Unleash instance.

Array [

appName stringrequired

Name of the application

Example: accounting

sdkVersion string

Which SDK and version the application reporting uses. Typically represented as <identifier>:<version>

Example: unleash-client-java:8.0.0

strategies string[]

Which strategies the application has loaded. Useful when trying to figure out if your custom strategy has been loaded in the SDK

Example: ["standard","gradualRollout","mySpecialCustomStrategy"]

description string

Extra information added about the application reporting the metrics. Only present if added via the Unleash Admin interface

Example: Application for reporting page visits

url string

A link to reference the application reporting the metrics. Could for instance be a GitHub link to the repository of the application

Example: https://github.com/Unleash/unleash-proxy-client-js

color string

The CSS color that is used to color the application's entry in the application list

Example: red

icon string

An URL to an icon file to be used for the applications's entry in the application list

Example: https://github.com/favicon.ico

usage

object[]

The list of projects the application has been using.

Array [

project stringrequired

Name of the project

Example: main-project

environments string[]required

Which environments have been accessed in this project.

Example: ["development","production"]

]

]

Example (from schema)

{
  "total": 50,
  "applications": [
    {
      "appName": "accounting",
      "sdkVersion": "unleash-client-java:8.0.0",
      "strategies": [
        "standard",
        "gradualRollout",
        "mySpecialCustomStrategy"
      ],
      "description": "Application for reporting page visits",
      "url": "https://github.com/Unleash/unleash-proxy-client-js",
      "color": "red",
      "icon": "https://github.com/favicon.ico",
      "usage": [
        {
          "project": "main-project",
          "environments": [
            "development",
            "production"
          ]
        }
      ]
    }
  ]
}

Loading...