Replace Slo

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

Updates an existing 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

Query Parameters

silence_data_validations# boolean

Whether to silence data validations.

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#WindowSloWindowrequired
Time window for latency calculations. Required. Omitting it is rejected.
Possible values: [WINDOW_SLO_WINDOW_UNSPECIFIED, WINDOW_SLO_WINDOW_1_MINUTE, WINDOW_SLO_WINDOW_5_MINUTES]
Example: WINDOW_SLO_WINDOW_5_MINUTES
apmSli.services#string[]required
List of service names to monitor. Required. At least one service; an empty list is rejected.
Possible values: >= 1
Example: ["my-service","payment-service"]
description#string
Human-readable description of the SLO.
Example: A brief description of my SLO
id#string
Unique identifier of the SLO.
Example: b11919d5-ef85-4bb1-8655-02640dbe94d9
labels# object
List of labels.
name#stringrequired
Human-readable display name for the SLO. Required. A missing or empty name is rejected.
Possible values: non-empty
Example: Example Slo Name
ownershipTags# object
Service, environment, and team ownership configuration for the SLO group and its permutations.
productType#SloProductType
Product type: APM for application performance monitoring SLOs, UNSPECIFIED for manual/custom SLOs
Possible values: [SLO_PRODUCT_TYPE_UNSPECIFIED, SLO_PRODUCT_TYPE_APM]
Example: SLO_PRODUCT_TYPE_APM
requestBasedMetricSli# object
Definition of a request-based SLI based on metrics
sloTimeFrame#SloTimeFramerequired

Slo time frame.

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

targetThresholdPercentage#float
Target compliance percentage threshold for the SLO (e.g., 99.9 for three nines).
Example: 99.999
windowBasedMetricSli# object
Definition of a window-based SLI based on metrics

Response

200400401500application/json

Response after replacing an existing SLO.

effectedSloAlertIds#string[]

The effected slo alert ids.

slo#objectrequired
Definition of an SLO
oneOf
• Option 1
• Option 2
• Option 3
• Option 4
object
slo.apmSli#object
Definition of an APM-based SLI with automatic query generation
oneOf
• Option 1
• Option 2
• Option 3
object
slo.apmSli.errorConfig#object
Configuration for error-based APM SLI
slo.apmSli.filters# object[]
Additional label-based filters to apply to the metrics
slo.apmSli.groupingKeys#string[]
Labels to group SLO results by
Example: ["environment","region"]
slo.apmSli.latencyConfig#object
Configuration for latency-based APM SLI
oneOf
• Option 1
• Option 2
• Option 3
object
slo.apmSli.latencyConfig.average#object
Average/mean-based latency measurement
slo.apmSli.latencyConfig.quantile# object
Quantile/percentile-based latency measurement
slo.apmSli.latencyConfig.threshold#float
Threshold in milliseconds. Good when latency <= threshold, bad when latency > threshold.
Example: 500
slo.apmSli.latencyConfig.timeWindow#WindowSloWindowrequired
Time window for latency calculations. Required. Omitting it is rejected.
Possible values: [WINDOW_SLO_WINDOW_UNSPECIFIED, WINDOW_SLO_WINDOW_1_MINUTE, WINDOW_SLO_WINDOW_5_MINUTES]
Example: WINDOW_SLO_WINDOW_5_MINUTES
slo.apmSli.services#string[]required
List of service names to monitor. Required. At least one service; an empty list is rejected.
Possible values: >= 1
Example: ["my-service","payment-service"]
slo.apmSliMetadata# object
Server copy of apmSli for APM SLOs. Set by the server; sending it instead of apmSli is rejected.
slo.createTime#date-time
RFC3339 timestamp of when the SLO was created. Set by the server; a value sent by the client is ignored.
slo.creator#string
Email or identifier of the user who created the SLO. Set by the server; a value sent by the client is ignored.
Example: [email protected]
slo.description#string
Human-readable description of the SLO.
Example: A brief description of my SLO
slo.grouping# object
Grouping labels derived by the server from the SLI. A value sent by the client is rejected.
slo.id#string
Unique identifier of the SLO.
Example: b11919d5-ef85-4bb1-8655-02640dbe94d9
slo.labels# object
List of labels.
slo.name#stringrequired
Human-readable display name for the SLO. Required. A missing or empty name is rejected.
Possible values: non-empty
Example: Example Slo Name
slo.ownershipTags# object
Service, environment, and team ownership configuration for the SLO group and its permutations.
slo.productType#SloProductType
Product type: APM for application performance monitoring SLOs, UNSPECIFIED for manual/custom SLOs
Possible values: [SLO_PRODUCT_TYPE_UNSPECIFIED, SLO_PRODUCT_TYPE_APM]
Example: SLO_PRODUCT_TYPE_APM
slo.requestBasedMetricSli# object
Definition of a request-based SLI based on metrics
slo.revision# object
Revision of the SLO. Set by the server; a value sent by the client is ignored.
slo.sloTimeFrame#SloTimeFramerequired
Slo time frame.
Possible values: [SLO_TIME_FRAME_UNSPECIFIED, SLO_TIME_FRAME_1_DAY, SLO_TIME_FRAME_7_DAYS, SLO_TIME_FRAME_14_DAYS, SLO_TIME_FRAME_21_DAYS, SLO_TIME_FRAME_28_DAYS, SLO_TIME_FRAME_30_DAYS]
slo.sloType#SloType
SLO type derived by the server from the SLI. A window-based metric SLI still reads SLO_TYPE_REQUEST. A value sent by the client must match the SLI type; a different value is rejected.
Possible values: [SLO_TYPE_REQUEST, SLO_TYPE_WINDOW]
Example: SLO_TYPE_REQUEST
slo.targetThresholdPercentage#float
Target compliance percentage threshold for the SLO (e.g., 99.9 for three nines).
Example: 99.999
slo.type#stringdeprecated
Deprecated: SLO type string. Set by the server from the SLI; a value sent by the client is ignored.
Example: request
slo.updateTime#date-time
Timestamp of the last update. Set by the server; a value sent by the client is ignored.
slo.windowBasedMetricSli# object
Definition of a window-based SLI based on metrics