Get Slo

GEThttps://api.coralogix.com/mgmt/openapi/5/slo/slos/v1/{id}

Returns the details of the specified 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

Path Parameters

id# stringrequired

Unique identifier.

Response

200400401500application/json

Response containing the details of a specific SLO.

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#WindowSloWindow
Window slo window.
Possible values: [WINDOW_SLO_WINDOW_UNSPECIFIED, WINDOW_SLO_WINDOW_1_MINUTE, WINDOW_SLO_WINDOW_5_MINUTES]
slo.apmSli.services#string[]
List of service names to monitor
Example: ["my-service","payment-service"]
slo.apmSliMetadata#object
Definition of an APM-based SLI with automatic query generation
oneOf
• Option 1
• Option 2
• Option 3
object
slo.apmSliMetadata.errorConfig#object
Configuration for error-based APM SLI
slo.apmSliMetadata.filters# object[]
Additional label-based filters to apply to the metrics
slo.apmSliMetadata.groupingKeys#string[]
Labels to group SLO results by
Example: ["environment","region"]
slo.apmSliMetadata.latencyConfig#object
Configuration for latency-based APM SLI
oneOf
• Option 1
• Option 2
• Option 3
object
slo.apmSliMetadata.latencyConfig.average#object
Average/mean-based latency measurement
slo.apmSliMetadata.latencyConfig.quantile# object
Quantile/percentile-based latency measurement
slo.apmSliMetadata.latencyConfig.threshold#float
Threshold in milliseconds. Good when latency <= threshold, bad when latency > threshold.
Example: 500
slo.apmSliMetadata.latencyConfig.timeWindow#WindowSloWindow
Window slo window.
Possible values: [WINDOW_SLO_WINDOW_UNSPECIFIED, WINDOW_SLO_WINDOW_1_MINUTE, WINDOW_SLO_WINDOW_5_MINUTES]
slo.apmSliMetadata.services#string[]
List of service names to monitor
Example: ["my-service","payment-service"]
slo.createTime#date-time
RFC3339 timestamp of when the SLO was created.
slo.creator#string
Email or identifier of the user who created the SLO.
Example: [email protected]
slo.description#string
Human-readable description of the SLO.
Example: A brief description of my SLO
slo.grouping# object
Definition of the SLO grouping fields
slo.id#string
Unique identifier of the SLO.
Example: b11919d5-ef85-4bb1-8655-02640dbe94d9
slo.labels# object
List of labels.
slo.name#string
Human-readable display name for the SLO.
Example: Example Slo Name
slo.ownershipTags# object
Service, environment, and team ownership for the SLO group. At most one SloOwnershipTag per dimension; omit a dimension when unset.
slo.productType#SloProductType
Slo product type.
Possible values: [SLO_PRODUCT_TYPE_UNSPECIFIED, SLO_PRODUCT_TYPE_APM]
slo.requestBasedMetricSli# object
Definition of a request-based SLI based on metrics
slo.revision# object
The revision of the slo, used to differentiate between different versions of the same SLO
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]
slo.sloType#SloType
Slo type.
Possible values: [SLO_TYPE_REQUEST, SLO_TYPE_WINDOW]
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. Use slo_type instead.
Example: request
slo.updateTime#date-time
Timestamp of the last update.
slo.windowBasedMetricSli# object
Definition of a window-based SLI based on metrics