v1

latestOpenAPI 3.0.0CoreStack Inc License2026-07-248001,5071.7 MB
Custom Metric Configuration

Update Custom Metric Configuration

Update Custom Metric Configuration is used to update the already created custom metrics for a cloud account.

post/v1/metric_configuration/item/{metric_configuration_id}

Path parameters

metric_configuration_idstring required

Specify the Id of metric configuration to update, metric configuration id is unique can be obtained from the list custom metrics.

Request body

service_account_idstring required

Cloud Account Id for which custom metrics needs to be created.

regionsstring[]

Region in which custom metrics to be created.

resource_categorystring required

Name of the Resource category.

resource_typestring required

Type of the Resource.

resourcestring required

Name of the Resource.

metric_namespacestring required

The namespace for the metric specified in metric_name.

metric_namestring

The name for the metric associated with the alarm.

status'completed' | 'pending' | 'in_progress' | 'error'

Status of the custom Metric Configuration

thresholdinteger

The value against which the specified statistics is compared.

comparison_operator'GreaterThanOrEqualTo' | 'GreaterThan' | 'LessThanOrEqualTo' | 'LessThan'

The arithmetic operation to use when comparing the specified statistics and threshold.

statistic'Average' | 'Maximum' | 'Minimum' | 'SampleCount' | 'Sum'

The statistics for the metric specified in MetricName.

periodinteger

Length in seconds used each time when metric is evaluated. Valid values are 10, 30 and any multiple of 60.

evaluation_periodinteger

The number of periods over which data is compared to the specified threshold.

priorityinteger

Order of priority if there is multiple rules for same metric under a cloud account for a region

eventsstring[]

List events for a selected resource in Event subscription

Example request

{
  "status": "completed",
  "comparison_operator": "GreaterThanOrEqualTo",
  "statistic": "Average",
  "events": [
    "maintenance"
  ]
}

Response

Success

string required