Create an application to connect reported metrics

POST <your-unleash-url>/api/admin/metrics/applications/:appName

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

Is used to report usage as well which sdk the application uses

Request

Path Parameters

appName string required

application/json

Body

required

createApplicationSchema

appName string
Name of the application
sdkVersion string
Which SDK and version the application reporting uses. Typically represented as <identifier>:<version>
strategies string[]
Which strategies the application has loaded. Useful when trying to figure out if your custom strategy has been loaded in the SDK
url string
A link to reference the application reporting the metrics. Could for instance be a GitHub link to the repository of the application
color string
Css color to be used to color the application's entry in the application list
icon string
An URL to an icon file to be used for the applications's entry in the application list

Responses

This response has no body.

The request data does not match what we expect.

application/json

Schema
Example (from schema)

Schema

id string
The ID of the error instance
name string
The name of the error kind
message string
A description of what went wrong.

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "ValidationError",
  "message": "The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent []."
}

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema
Example (from schema)

Schema

id string
The ID of the error instance
name string
The name of the error kind
message string
A description of what went wrong.

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

application/json

Schema
Example (from schema)

Schema

id string
The ID of the error instance
name string
The name of the error kind
message string
A description of what went wrong.

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

Request

Base URL

<your-unleash-url>

Security Scheme

apiKey

appName — path required

Body required

{
  "appName": "accounting",
  "sdkVersion": "unleash-client-java:8.0.0",
  "strategies": [
    "standard",
    "gradualRollout",
    "mySpecialCustomStrategy"
  ],
  "url": "https://github.com/Unleash/unleash-proxy-client-js",
  "color": "red",
  "icon": "https://github.com/favicon.ico"
}

curl / cURL
curl -L -X POST '<your-unleash-url>/api/admin/metrics/applications/:appName' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "appName": "accounting",
  "sdkVersion": "unleash-client-java:8.0.0",
  "strategies": [
    "standard",
    "gradualRollout",
    "mySpecialCustomStrategy"
  ],
  "url": "https://github.com/Unleash/unleash-proxy-client-js",
  "color": "red",
  "icon": "https://github.com/favicon.ico"
}'

python / requests
curl -L -X POST '<your-unleash-url>/api/admin/metrics/applications/:appName' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "appName": "accounting",
  "sdkVersion": "unleash-client-java:8.0.0",
  "strategies": [
    "standard",
    "gradualRollout",
    "mySpecialCustomStrategy"
  ],
  "url": "https://github.com/Unleash/unleash-proxy-client-js",
  "color": "red",
  "icon": "https://github.com/favicon.ico"
}'

go / native
curl -L -X POST '<your-unleash-url>/api/admin/metrics/applications/:appName' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "appName": "accounting",
  "sdkVersion": "unleash-client-java:8.0.0",
  "strategies": [
    "standard",
    "gradualRollout",
    "mySpecialCustomStrategy"
  ],
  "url": "https://github.com/Unleash/unleash-proxy-client-js",
  "color": "red",
  "icon": "https://github.com/favicon.ico"
}'

nodejs / native
curl -L -X POST '<your-unleash-url>/api/admin/metrics/applications/:appName' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "appName": "accounting",
  "sdkVersion": "unleash-client-java:8.0.0",
  "strategies": [
    "standard",
    "gradualRollout",
    "mySpecialCustomStrategy"
  ],
  "url": "https://github.com/Unleash/unleash-proxy-client-js",
  "color": "red",
  "icon": "https://github.com/favicon.ico"
}'

ruby / Net::HTTP
curl -L -X POST '<your-unleash-url>/api/admin/metrics/applications/:appName' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "appName": "accounting",
  "sdkVersion": "unleash-client-java:8.0.0",
  "strategies": [
    "standard",
    "gradualRollout",
    "mySpecialCustomStrategy"
  ],
  "url": "https://github.com/Unleash/unleash-proxy-client-js",
  "color": "red",
  "icon": "https://github.com/favicon.ico"
}'

csharp / httpclient
curl -L -X POST '<your-unleash-url>/api/admin/metrics/applications/:appName' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "appName": "accounting",
  "sdkVersion": "unleash-client-java:8.0.0",
  "strategies": [
    "standard",
    "gradualRollout",
    "mySpecialCustomStrategy"
  ],
  "url": "https://github.com/Unleash/unleash-proxy-client-js",
  "color": "red",
  "icon": "https://github.com/favicon.ico"
}'

php / cURL
curl -L -X POST '<your-unleash-url>/api/admin/metrics/applications/:appName' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "appName": "accounting",
  "sdkVersion": "unleash-client-java:8.0.0",
  "strategies": [
    "standard",
    "gradualRollout",
    "mySpecialCustomStrategy"
  ],
  "url": "https://github.com/Unleash/unleash-proxy-client-js",
  "color": "red",
  "icon": "https://github.com/favicon.ico"
}'

java / OkHttp
curl -L -X POST '<your-unleash-url>/api/admin/metrics/applications/:appName' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "appName": "accounting",
  "sdkVersion": "unleash-client-java:8.0.0",
  "strategies": [
    "standard",
    "gradualRollout",
    "mySpecialCustomStrategy"
  ],
  "url": "https://github.com/Unleash/unleash-proxy-client-js",
  "color": "red",
  "icon": "https://github.com/favicon.ico"
}'

powershell / RestMethod
curl -L -X POST '<your-unleash-url>/api/admin/metrics/applications/:appName' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "appName": "accounting",
  "sdkVersion": "unleash-client-java:8.0.0",
  "strategies": [
    "standard",
    "gradualRollout",
    "mySpecialCustomStrategy"
  ],
  "url": "https://github.com/Unleash/unleash-proxy-client-js",
  "color": "red",
  "icon": "https://github.com/favicon.ico"
}'

Create an application to connect reported metrics

Authorization

Request​

Path Parameters

Body

Authorization

Request

Request