Create Super Metric

Create Super Metric

Create a SuperMetric with the given name, formula and description

Request
URI
POST
https://{api_host}/suite-api/api/supermetrics
COPY
Request Body

The SuperMetric to create

supermetric of type(s) application/json
Required

Show optional properties

{
    "name": "string",
    "formula": "string"
}
"{\n  \"name\" : \"Example SuperMetric for DataCenter\",\n  \"formula\" : \"sumN(\\\\$This:cpu|demandmhz,2)\",\n  \"description\" : \"Sum the CPU usage in MHZ on the assigned resource and its children\"\n}"
string As uuid As uuid
id
Optional

The unique ID of the SuperMetric. This will be null when creating a
SuperMetric, but it is required when updating an existing SuperMetric.

string As .+
name
Required

The name of the SuperMetric

string As .+
formula
Required

The formula expression of the SuperMetric

string
description
Optional

The description of the SuperMetric

integer As int64 As int64
modificationTime
Optional

Last modification time of the SuperMetric

Authentication
This operation uses the following authentication methods.
Responses
201

The created SuperMetric from the server

Returns supermetric of type(s) application/json
"{\n  \"id\" : \"02a6fd9b-abaf-4f29-a36b-c93931532fdb\",\n  \"name\" : \"Example SuperMetric for DataCenter\",\n  \"formula\" : \"sumN(\\\\$This:cpu|demandmhz,2)\",\n  \"description\" : \"Sum the CPU usage in MHZ on the assigned resource and its children\"\n}"
string As uuid As uuid
id
Optional

The unique ID of the SuperMetric. This will be null when creating a
SuperMetric, but it is required when updating an existing SuperMetric.

string As .+
name
Required

The name of the SuperMetric

string As .+
formula
Required

The formula expression of the SuperMetric

string
description
Optional

The description of the SuperMetric

integer As int64 As int64
modificationTime
Optional

Last modification time of the SuperMetric


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"formula:"string","name:"string"}' https://{api_host}/suite-api/api/supermetrics