@@ -338,6 +338,16 @@ components:
338338 required: true
339339 schema:
340340 type: string
341+ DisableCorrections:
342+ description: Whether to exclude correction windows from the SLO status calculation.
343+ Defaults to false.
344+ in: query
345+ name: disable_corrections
346+ required: false
347+ schema:
348+ default: false
349+ example: false
350+ type: boolean
341351 EntityID:
342352 description: UUID or Entity Ref.
343353 in: path
@@ -449,6 +459,15 @@ components:
449459 required: false
450460 schema:
451461 $ref: '#/components/schemas/RelationType'
462+ FromTimestamp:
463+ description: The starting timestamp for the SLO status query in epoch seconds.
464+ in: query
465+ name: from_ts
466+ required: true
467+ schema:
468+ example: 1690901870
469+ format: int64
470+ type: integer
452471 GCPSTSServiceAccountID:
453472 description: Your GCP STS enabled service account's unique ID.
454473 in: path
@@ -1088,6 +1107,14 @@ components:
10881107 required: false
10891108 schema:
10901109 type: boolean
1110+ SloID:
1111+ description: The ID of the SLO.
1112+ in: path
1113+ name: slo_id
1114+ required: true
1115+ schema:
1116+ example: 00000000-0000-0000-0000-000000000000
1117+ type: string
10911118 SpansMetricIDParameter:
10921119 description: The name of the span-based metric.
10931120 in: path
@@ -1109,6 +1136,15 @@ components:
11091136 required: true
11101137 schema:
11111138 type: string
1139+ ToTimestamp:
1140+ description: The ending timestamp for the SLO status query in epoch seconds.
1141+ in: query
1142+ name: to_ts
1143+ required: true
1144+ schema:
1145+ example: 1706803070
1146+ format: int64
1147+ type: integer
11121148 UserID:
11131149 description: The ID of the user.
11141150 in: path
@@ -43864,6 +43900,22 @@ components:
4386443900 from the other indexes
4386543901 type: string
4386643902 type: object
43903+ RawErrorBudgetRemaining:
43904+ description: The raw error budget remaining for the SLO.
43905+ properties:
43906+ unit:
43907+ description: The unit of the error budget (for example, `seconds`, `requests`).
43908+ example: seconds
43909+ type: string
43910+ value:
43911+ description: The numeric value of the remaining error budget.
43912+ example: 86400.5
43913+ format: double
43914+ type: number
43915+ required:
43916+ - value
43917+ - unit
43918+ type: object
4386743919 ReadinessGate:
4386843920 description: Used to merge multiple branches into a single branch.
4386943921 properties:
@@ -49256,18 +49308,6 @@ components:
4925649308 meta:
4925749309 $ref: '#/components/schemas/ResponseMetaAttributes'
4925849310 type: object
49259- SecurityMonitoringPaginatedSuppressionsResponse:
49260- description: Response object containing the available suppression rules with
49261- pagination metadata.
49262- properties:
49263- data:
49264- description: A list of suppressions objects.
49265- items:
49266- $ref: '#/components/schemas/SecurityMonitoringSuppression'
49267- type: array
49268- meta:
49269- $ref: '#/components/schemas/SecurityMonitoringSuppressionsMeta'
49270- type: object
4927149311 SecurityMonitoringReferenceTable:
4927249312 description: Reference tables used in the queries.
4927349313 properties:
@@ -51417,31 +51457,6 @@ components:
5141751457 data:
5141851458 $ref: '#/components/schemas/SecurityMonitoringSuppression'
5141951459 type: object
51420- SecurityMonitoringSuppressionSort:
51421- description: The sort parameters used for querying suppression rules.
51422- enum:
51423- - name
51424- - start_date
51425- - expiration_date
51426- - update_date
51427- - enabled
51428- - -name
51429- - -start_date
51430- - -expiration_date
51431- - -update_date
51432- - -enabled
51433- type: string
51434- x-enum-varnames:
51435- - NAME
51436- - START_DATE
51437- - EXPIRATION_DATE
51438- - UPDATE_DATE
51439- - ENABLED
51440- - NAME_DESCENDING
51441- - START_DATE_DESCENDING
51442- - EXPIRATION_DATE_DESCENDING
51443- - UPDATE_DATE_DESCENDING
51444- - ENABLED_DESCENDING
5144551460 SecurityMonitoringSuppressionType:
5144651461 default: suppressions
5144751462 description: The type of the resource. The value should always be `suppressions`.
@@ -51537,31 +51552,6 @@ components:
5153751552 required:
5153851553 - data
5153951554 type: object
51540- SecurityMonitoringSuppressionsMeta:
51541- description: Metadata for the suppression list response.
51542- properties:
51543- page:
51544- $ref: '#/components/schemas/SecurityMonitoringSuppressionsPageMeta'
51545- type: object
51546- SecurityMonitoringSuppressionsPageMeta:
51547- description: Pagination metadata.
51548- properties:
51549- pageNumber:
51550- description: Current page number.
51551- example: 0
51552- format: int64
51553- type: integer
51554- pageSize:
51555- description: Current page size.
51556- example: 2
51557- format: int64
51558- type: integer
51559- totalCount:
51560- description: Total count of suppressions.
51561- example: 2
51562- format: int64
51563- type: integer
51564- type: object
5156551555 SecurityMonitoringSuppressionsResponse:
5156651556 description: Response object containing the available suppression rules.
5156751557 properties:
@@ -54050,6 +54040,70 @@ components:
5405054040 required:
5405154041 - attributes
5405254042 type: object
54043+ SloStatusData:
54044+ description: The data portion of the SLO status response.
54045+ properties:
54046+ attributes:
54047+ $ref: '#/components/schemas/SloStatusDataAttributes'
54048+ id:
54049+ description: The ID of the SLO.
54050+ example: 00000000-0000-0000-0000-000000000000
54051+ type: string
54052+ type:
54053+ $ref: '#/components/schemas/SloStatusType'
54054+ required:
54055+ - id
54056+ - type
54057+ - attributes
54058+ type: object
54059+ SloStatusDataAttributes:
54060+ description: The attributes of the SLO status.
54061+ properties:
54062+ error_budget_remaining:
54063+ description: The percentage of error budget remaining.
54064+ example: 99.5
54065+ format: double
54066+ type: number
54067+ raw_error_budget_remaining:
54068+ $ref: '#/components/schemas/RawErrorBudgetRemaining'
54069+ sli:
54070+ description: The current Service Level Indicator (SLI) value as a percentage.
54071+ example: 99.95
54072+ format: double
54073+ type: number
54074+ span_precision:
54075+ description: The precision of the time span in seconds.
54076+ example: 2
54077+ format: int64
54078+ type: integer
54079+ state:
54080+ description: The current state of the SLO (for example, `breached`, `warning`,
54081+ `ok`).
54082+ example: ok
54083+ type: string
54084+ required:
54085+ - sli
54086+ - error_budget_remaining
54087+ - raw_error_budget_remaining
54088+ - state
54089+ - span_precision
54090+ type: object
54091+ SloStatusResponse:
54092+ description: The SLO status response.
54093+ properties:
54094+ data:
54095+ $ref: '#/components/schemas/SloStatusData'
54096+ required:
54097+ - data
54098+ type: object
54099+ SloStatusType:
54100+ description: The type of the SLO status resource.
54101+ enum:
54102+ - slo_status
54103+ example: slo_status
54104+ type: string
54105+ x-enum-varnames:
54106+ - SLO_STATUS
5405354107 SoftwareCatalogTriggerWrapper:
5405454108 description: Schema for a Software Catalog-based trigger.
5405554109 properties:
@@ -85732,29 +85786,12 @@ paths:
8573285786 required: false
8573385787 schema:
8573485788 type: string
85735- - description: Attribute used to sort the list of suppression rules. Prefix
85736- with `-` to sort in descending order.
85737- in: query
85738- name: sort
85739- required: false
85740- schema:
85741- $ref: '#/components/schemas/SecurityMonitoringSuppressionSort'
85742- - description: Size for a given page. Use `-1` to return all items.
85743- in: query
85744- name: page[size]
85745- required: false
85746- schema:
85747- default: -1
85748- example: 10
85749- format: int64
85750- type: integer
85751- - $ref: '#/components/parameters/PageNumber'
8575285789 responses:
8575385790 '200':
8575485791 content:
8575585792 application/json:
8575685793 schema:
85757- $ref: '#/components/schemas/SecurityMonitoringPaginatedSuppressionsResponse '
85794+ $ref: '#/components/schemas/SecurityMonitoringSuppressionsResponse '
8575885795 description: OK
8575985796 '403':
8576085797 $ref: '#/components/responses/NotAuthorizedResponse'
@@ -88256,6 +88293,63 @@ paths:
8825688293 x-unstable: '**Note**: This feature is in private beta. To request access, use
8825788294 the request access form in the [Service Level Objectives](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-csv-export)
8825888295 docs.'
88296+ /api/v2/slo/{slo_id}/status:
88297+ get:
88298+ description: 'Get the status of a Service Level Objective (SLO) for a given
88299+ time period.
88300+
88301+
88302+ This endpoint returns the current SLI value, error budget remaining, and other
88303+ status information for the specified SLO.'
88304+ operationId: GetSloStatus
88305+ parameters:
88306+ - $ref: '#/components/parameters/SloID'
88307+ - $ref: '#/components/parameters/FromTimestamp'
88308+ - $ref: '#/components/parameters/ToTimestamp'
88309+ - $ref: '#/components/parameters/DisableCorrections'
88310+ responses:
88311+ '200':
88312+ content:
88313+ application/json:
88314+ schema:
88315+ $ref: '#/components/schemas/SloStatusResponse'
88316+ description: OK
88317+ '400':
88318+ content:
88319+ application/json:
88320+ schema:
88321+ $ref: '#/components/schemas/JSONAPIErrorResponse'
88322+ description: Bad Request
88323+ '403':
88324+ content:
88325+ application/json:
88326+ schema:
88327+ $ref: '#/components/schemas/JSONAPIErrorResponse'
88328+ description: Forbidden
88329+ '404':
88330+ content:
88331+ application/json:
88332+ schema:
88333+ $ref: '#/components/schemas/JSONAPIErrorResponse'
88334+ description: Not Found
88335+ '429':
88336+ $ref: '#/components/responses/TooManyRequestsResponse'
88337+ security:
88338+ - apiKeyAuth: []
88339+ appKeyAuth: []
88340+ - AuthZ:
88341+ - slos_read
88342+ summary: Get SLO status
88343+ tags:
88344+ - Service Level Objectives
88345+ x-permission:
88346+ operator: OR
88347+ permissions:
88348+ - slos_read
88349+ x-unstable: '**Note**: This endpoint is in public beta and it''s subject to
88350+ change.
88351+
88352+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
8825988353 /api/v2/spa/recommendations/{service}:
8826088354 get:
8826188355 description: This endpoint is currently experimental and restricted to Datadog
0 commit comments