Update a metrics account soft limit

PUT 
/v1/account-management/metrics-accounts/:metricsAccountId/soft-limit

Sets the soft limit of a Consumption metrics account.

The soft limit caps the number of unique time series (UTS) the metrics account is allowed to ingest. It takes effect only when it is greater than the account's plan UTS: a lower or equal value, including 0, is stored but ignored, and the account is then limited by its plan instead.

A soft limit cannot be removed once set - there is no way to set it back to null.

The soft limits of all metrics accounts of the owner account together must not exceed the owner account's metrics budget, otherwise the request returns 400.

Available for Consumption accounts only. If the account is not a Consumption account, the request returns 400.

Please ensure to change the region in the URL to match your account's region.

Request

Path Parameters

metricsAccountId integerrequired

ID of the metrics account.

application/json

Body

required

softLimitUniqueMetricsConsumption integerrequired

The account's soft limit, in unique time series (UTS). Must not be negative.

Responses

200

OK

application/json

Schema

Schema

metricsAccountId integer

ID of the metrics account.

softLimitUniqueMetricsConsumption integer

The account's soft limit, in unique time series (UTS).

Example (from schema)

{
  "metricsAccountId": 0,
  "softLimitUniqueMetrics": 0
}

400

The account is not a Consumption account, softLimitUniqueMetrics is negative, or the soft limits of all the owner account's metrics accounts together would exceed its metrics budget.

Loading...