Optional
additionalA container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.
Optional
createdCreation timestamp (UNIX time in seconds)
Always included in service level objective responses.
Optional
creatorObject describing the creator of the shared element.
Optional
descriptionA user-defined description of the service level objective.
Always included in service level objective responses (but may be null
).
Optional in create/update requests.
Optional
groupsA list of (up to 100) monitor groups that narrow the scope of a monitor service level objective.
Included in service level objective responses if it is not empty. Optional in
create/update requests for monitor service level objectives, but may only be
used when then length of the monitor_ids
field is one.
Optional
idA unique identifier for the service level objective object.
Always included in service level objective responses.
Optional
modifiedModification timestamp (UNIX time in seconds)
Always included in service level objective responses.
Optional
monitorA list of monitor ids that defines the scope of a monitor service level
objective. Required if type is monitor
.
Optional
monitorThe union of monitor tags for all monitors referenced by the monitor_ids
field.
Always included in service level objective responses for monitor-based service level
objectives (but may be empty). Ignored in create/update requests. Does not
affect which monitors are included in the service level objective (that is
determined entirely by the monitor_ids
field).
The name of the service level objective object.
Optional
queryA metric-based SLO. Required if type is metric
. Note that Datadog only allows the sum by aggregator
to be used because this will sum up all request counts instead of averaging them, or taking the max or
min of all of those requests.
Optional
sliA generic SLI specification. This is currently used for time-slice SLOs only.
Optional
tagsA list of tags associated with this service level objective. Always included in service level objective responses (but may be empty). Optional in create/update requests.
Optional
targetThe target threshold such that when the service level indicator is above this threshold over the given timeframe, the objective is being met.
The thresholds (timeframes and associated targets) for this service level objective object.
Optional
timeframeThe SLO time window options. Note that "custom" is not a valid option for creating or updating SLOs. It is only used when querying SLO history over custom timeframes.
The type of the service level objective.
Optional
warningThe optional warning threshold such that when the service level indicator is below this value for the given threshold, but above the target threshold, the objective appears in a "warning" state. This value must be greater than the target threshold.
Generated using TypeDoc
A service level objective object includes a service level indicator, thresholds for one or more timeframes, and metadata (
name
,description
,tags
, etc.).