Create an application to connect reported metrics

POST 
/api/admin/metrics/applications/:appName

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

Request

Path Parameters

appName stringrequired

application/json

Body

required

createApplicationSchema

appName string
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"]
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
Css color to be 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

Responses

202

This response has no body.

400

The request data does not match what we expect.

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: ValidationError
message string
A description of what went wrong.
Example: The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent [].

Example (from schema)

{
  "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 []."
}

401

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

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: AuthenticationRequired
message string
A description of what went wrong.
Example: 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.

Example (from schema)

{
  "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."
}

403

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

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: NoAccessError
message string
A description of what went wrong.
Example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.

Example (from schema)

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

Loading...