Replace Slo Pre-Validate Alerts

PUThttps://api.coralogix.com/mgmt/openapi/5/slo/validated/v1

Validates and updates an SLO.

Authorizations

Authorizationstringheaderrequired

API key authentication

The value is a Coralogix API key. Create a personal or team API key and assign its permissions.

Request

Body

application/json

Definition of an SLO

oneOf
• Option 1
• Option 2
• Option 3
• Option 4
object
apmSli#object
Definition of an APM-based SLI with automatic query generation
oneOf
• Option 1
• Option 2
• Option 3
object
apmSli.errorConfig#object
Configuration for error-based APM SLI
apmSli.filters# object[]
Additional label-based filters to apply to the metrics
apmSli.groupingKeys#string[]
Labels to group SLO results by
Example: ["environment","region"]
apmSli.latencyConfig#object
Configuration for latency-based APM SLI
oneOf
• Option 1
• Option 2
• Option 3
object
apmSli.latencyConfig.average#object
Average/mean-based latency measurement
apmSli.latencyConfig.quantile# object
Quantile/percentile-based latency measurement
apmSli.latencyConfig.threshold#float
Threshold in milliseconds. Good when latency <= threshold, bad when latency > threshold.
Example: 500
apmSli.latencyConfig.timeWindow#WindowSloWindow
Window slo window.
Possible values: [WINDOW_SLO_WINDOW_UNSPECIFIED, WINDOW_SLO_WINDOW_1_MINUTE, WINDOW_SLO_WINDOW_5_MINUTES]
apmSli.services#string[]
List of service names to monitor
Example: ["my-service","payment-service"]
apmSliMetadata#object
Definition of an APM-based SLI with automatic query generation
oneOf
• Option 1
• Option 2
• Option 3
object
apmSliMetadata.errorConfig#object
Configuration for error-based APM SLI
apmSliMetadata.filters# object[]
Additional label-based filters to apply to the metrics
apmSliMetadata.groupingKeys#string[]
Labels to group SLO results by
Example: ["environment","region"]
apmSliMetadata.latencyConfig#object
Configuration for latency-based APM SLI
oneOf
• Option 1
• Option 2
• Option 3
object
apmSliMetadata.latencyConfig.average#object
Average/mean-based latency measurement
apmSliMetadata.latencyConfig.quantile# object
Quantile/percentile-based latency measurement
apmSliMetadata.latencyConfig.threshold#float
Threshold in milliseconds. Good when latency <= threshold, bad when latency > threshold.
Example: 500
apmSliMetadata.latencyConfig.timeWindow#WindowSloWindow
Window slo window.
Possible values: [WINDOW_SLO_WINDOW_UNSPECIFIED, WINDOW_SLO_WINDOW_1_MINUTE, WINDOW_SLO_WINDOW_5_MINUTES]
apmSliMetadata.services#string[]
List of service names to monitor
Example: ["my-service","payment-service"]
createTime#date-time

RFC3339 timestamp of when the SLO was created.

creator#string
Email or identifier of the user who created the SLO.
Example: [email protected]
description#string
Human-readable description of the SLO.
Example: A brief description of my SLO
grouping# object
Definition of the SLO grouping fields
id#string
Unique identifier of the SLO.
Example: b11919d5-ef85-4bb1-8655-02640dbe94d9
labels# object
List of labels.
name#string
Human-readable display name for the SLO.
Example: Example Slo Name
ownershipTags# object
Service, environment, and team ownership for the SLO group. At most one SloOwnershipTag per dimension; omit a dimension when unset.
productType#SloProductType

Slo product type.

Possible values: [SLO_PRODUCT_TYPE_UNSPECIFIED, SLO_PRODUCT_TYPE_APM]

requestBasedMetricSli# object
Definition of a request-based SLI based on metrics
revision# object
The revision of the slo, used to differentiate between different versions of the same SLO
sloTimeFrame#SloTimeFrame

Slo time frame.

Possible values: [SLO_TIME_FRAME_UNSPECIFIED, SLO_TIME_FRAME_7_DAYS, SLO_TIME_FRAME_14_DAYS, SLO_TIME_FRAME_21_DAYS, SLO_TIME_FRAME_28_DAYS]

sloType#SloType

Slo type.

Possible values: [SLO_TYPE_REQUEST, SLO_TYPE_WINDOW]

targetThresholdPercentage#float
Target compliance percentage threshold for the SLO (e.g., 99.9 for three nines).
Example: 99.999
type#stringdeprecated
Deprecated: SLO type string. Use slo_type instead.
Example: request
updateTime#date-time

Timestamp of the last update.

windowBasedMetricSli# object
Definition of a window-based SLI based on metrics

Response

200400401500application/json

Response with validated alerts before replacing an existing SLO.

alertsValidationResult# object[]required
The alerts validation result.