.generator/schemas/v2/openapi.yaml in datadog_api_client-2.21.0 vs .generator/schemas/v2/openapi.yaml in datadog_api_client-2.22.0
- old
+ new
@@ -409,10 +409,17 @@
in: path
name: project_id
required: true
schema:
type: string
+ ReportID:
+ description: The ID of the report job.
+ in: path
+ name: report_id
+ required: true
+ schema:
+ type: string
ResourceID:
description: 'Identifier, formatted as `type:id`. Supported types: `connection`,
`dashboard`, `notebook`, `security-rule`, `slo`.'
example: dashboard:abc-def-ghi
in: path
@@ -1323,15 +1330,14 @@
$ref: '#/components/schemas/AuthNMappingsType'
required:
- type
type: object
AuthNMappingCreateRelationships:
- description: Relationship of AuthN Mapping create object to Role.
- properties:
- role:
- $ref: '#/components/schemas/RelationshipToRole'
- type: object
+ description: Relationship of AuthN Mapping create object to a Role or Team.
+ oneOf:
+ - $ref: '#/components/schemas/AuthNMappingRelationshipToRole'
+ - $ref: '#/components/schemas/AuthNMappingRelationshipToTeam'
AuthNMappingCreateRequest:
description: Request for creating an AuthN Mapping.
properties:
data:
$ref: '#/components/schemas/AuthNMappingCreateData'
@@ -1341,17 +1347,36 @@
AuthNMappingIncluded:
description: Included data in the AuthN Mapping response.
oneOf:
- $ref: '#/components/schemas/SAMLAssertionAttribute'
- $ref: '#/components/schemas/Role'
+ - $ref: '#/components/schemas/AuthNMappingTeam'
+ AuthNMappingRelationshipToRole:
+ description: Relationship of AuthN Mapping to a Role.
+ properties:
+ role:
+ $ref: '#/components/schemas/RelationshipToRole'
+ required:
+ - role
+ type: object
+ AuthNMappingRelationshipToTeam:
+ description: Relationship of AuthN Mapping to a Team.
+ properties:
+ team:
+ $ref: '#/components/schemas/RelationshipToTeam'
+ required:
+ - team
+ type: object
AuthNMappingRelationships:
description: All relationships associated with AuthN Mapping.
properties:
role:
$ref: '#/components/schemas/RelationshipToRole'
saml_assertion_attribute:
$ref: '#/components/schemas/RelationshipToSAMLAssertionAttribute'
+ team:
+ $ref: '#/components/schemas/RelationshipToTeam'
type: object
AuthNMappingResponse:
description: AuthN Mapping response from the API.
properties:
data:
@@ -1360,10 +1385,64 @@
description: Included data in the AuthN Mapping response.
items:
$ref: '#/components/schemas/AuthNMappingIncluded'
type: array
type: object
+ AuthNMappingTeam:
+ description: Team.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/AuthNMappingTeamAttributes'
+ id:
+ description: The ID of the Team.
+ example: f9bb8444-af7f-11ec-ac2c-da7ad0900001
+ type: string
+ type:
+ $ref: '#/components/schemas/TeamType'
+ type: object
+ AuthNMappingTeamAttributes:
+ description: Team attributes.
+ properties:
+ avatar:
+ description: Unicode representation of the avatar for the team, limited
+ to a single grapheme
+ example: "\U0001F951"
+ nullable: true
+ type: string
+ banner:
+ description: Banner selection for the team
+ format: int64
+ nullable: true
+ type: integer
+ handle:
+ description: The team's identifier
+ example: example-team
+ maxLength: 195
+ type: string
+ link_count:
+ description: The number of links belonging to the team
+ format: int32
+ maximum: 2147483647
+ readOnly: true
+ type: integer
+ name:
+ description: The name of the team
+ example: Example Team
+ maxLength: 200
+ type: string
+ summary:
+ description: A brief summary of the team, derived from the `description`
+ maxLength: 120
+ nullable: true
+ type: string
+ user_count:
+ description: The number of users belonging to the team
+ format: int32
+ maximum: 2147483647
+ readOnly: true
+ type: integer
+ type: object
AuthNMappingUpdateAttributes:
description: Key/Value pair of attributes used for update request.
properties:
attribute_key:
description: Key portion of a key/value pair of the attribute sent from
@@ -1392,15 +1471,14 @@
required:
- id
- type
type: object
AuthNMappingUpdateRelationships:
- description: Relationship of AuthN Mapping update object to Role.
- properties:
- role:
- $ref: '#/components/schemas/RelationshipToRole'
- type: object
+ description: Relationship of AuthN Mapping update object to a Role or Team.
+ oneOf:
+ - $ref: '#/components/schemas/AuthNMappingRelationshipToRole'
+ - $ref: '#/components/schemas/AuthNMappingRelationshipToTeam'
AuthNMappingUpdateRequest:
description: Request to update an AuthN Mapping.
properties:
data:
$ref: '#/components/schemas/AuthNMappingUpdateData'
@@ -5883,11 +5961,11 @@
enum:
- custom_destination
example: custom_destination
type: string
x-enum-varnames:
- - custom_destination
+ - CUSTOM_DESTINATION
CustomDestinationUpdateRequest:
description: The custom destination.
properties:
data:
$ref: '#/components/schemas/CustomDestinationUpdateRequestDefinition'
@@ -5978,11 +6056,11 @@
description: Environment name to where the service was deployed.
example: staging
type: string
finished_at:
description: Unix timestamp in nanoseconds when the deployment finished.
- It should not be older than 3 hours.
+ It should not be older than 1 hour.
example: 1693491984000000000
format: int64
type: integer
git:
$ref: '#/components/schemas/DORAGitInfo'
@@ -12442,11 +12520,11 @@
See [Datadog metrics](https://docs.datadoghq.com/developers/metrics/#custom-metrics-properties).'
properties:
interval:
description: If the type of the metric is rate or count, define the corresponding
- interval.
+ interval in seconds.
example: 20
format: int64
type: integer
metadata:
$ref: '#/components/schemas/MetricMetadata'
@@ -15665,10 +15743,26 @@
$ref: '#/components/schemas/SAMLAssertionAttributesType'
required:
- id
- type
type: object
+ RelationshipToTeam:
+ description: Relationship to team.
+ properties:
+ data:
+ $ref: '#/components/schemas/RelationshipToTeamData'
+ type: object
+ RelationshipToTeamData:
+ description: Relationship to Team object.
+ properties:
+ id:
+ description: The unique identifier of the team.
+ example: f9bb8444-af7f-11ec-ac2c-da7ad0900001
+ type: string
+ type:
+ $ref: '#/components/schemas/TeamType'
+ type: object
RelationshipToTeamLinkData:
description: Relationship between a link and a team
properties:
id:
description: The team link's identifier
@@ -15976,10 +16070,11 @@
description: The type of retention filter.
enum:
- spans-sampling-processor
- spans-errors-sampling-processor
- spans-appsec-sampling-processor
+ example: spans-sampling-processor
type: string
x-enum-varnames:
- SPANS_SAMPLING_PROCESSOR
- SPANS_ERRORS_SAMPLING_PROCESSOR
- SPANS_APPSEC_SAMPLING_PROCESSOR
@@ -16092,15 +16187,46 @@
- spans-sampling-processor
example: spans-sampling-processor
type: string
x-enum-varnames:
- SPANS_SAMPLING_PROCESSOR
+ RetentionFilterUpdateAttributes:
+ description: The object describing the configuration of the retention filter
+ to create/update.
+ properties:
+ enabled:
+ description: Enable/Disable the retention filter.
+ example: true
+ type: boolean
+ filter:
+ $ref: '#/components/schemas/SpansFilterCreate'
+ filter_type:
+ $ref: '#/components/schemas/RetentionFilterAllType'
+ name:
+ description: The name of the retention filter.
+ example: my retention filter
+ type: string
+ rate:
+ description: 'Sample rate to apply to spans going through this retention
+ filter,
+
+ a value of 1.0 keeps all spans matching the query.'
+ example: 1.0
+ format: double
+ type: number
+ required:
+ - name
+ - filter
+ - enabled
+ - filter_type
+ - rate
+ type: object
RetentionFilterUpdateData:
description: The body of the retention filter to be updated.
properties:
attributes:
- $ref: '#/components/schemas/RetentionFilterCreateAttributes'
+ $ref: '#/components/schemas/RetentionFilterUpdateAttributes'
id:
description: The ID of the retention filter.
example: retention-filter-id
type: string
type:
@@ -16485,10 +16611,78 @@
- saml_assertion_attributes
example: saml_assertion_attributes
type: string
x-enum-varnames:
- SAML_ASSERTION_ATTRIBUTES
+ SLOReportInterval:
+ description: The frequency at which report data is to be generated.
+ enum:
+ - weekly
+ - monthly
+ example: weekly
+ type: string
+ x-enum-varnames:
+ - WEEKLY
+ - MONTHLY
+ SLOReportPostResponse:
+ description: The SLO report response.
+ properties:
+ data:
+ $ref: '#/components/schemas/SLOReportPostResponseData'
+ type: object
+ SLOReportPostResponseData:
+ description: The data portion of the SLO report response.
+ properties:
+ id:
+ description: The ID of the report job.
+ example: dc8d92aa-e0af-11ee-af21-1feeaccaa3a3
+ type: string
+ type:
+ description: The type of ID.
+ example: report_id
+ type: string
+ type: object
+ SLOReportStatus:
+ description: The status of the SLO report job.
+ enum:
+ - in_progress
+ - completed
+ - completed_with_errors
+ - failed
+ example: completed
+ type: string
+ x-enum-varnames:
+ - IN_PROGRESS
+ - COMPLETED
+ - COMPLETED_WITH_ERRORS
+ - FAILED
+ SLOReportStatusGetResponse:
+ description: The SLO report status response.
+ properties:
+ data:
+ $ref: '#/components/schemas/SLOReportStatusGetResponseData'
+ type: object
+ SLOReportStatusGetResponseAttributes:
+ description: The attributes portion of the SLO report status response.
+ properties:
+ status:
+ $ref: '#/components/schemas/SLOReportStatus'
+ type: object
+ SLOReportStatusGetResponseData:
+ description: The data portion of the SLO report status response.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/SLOReportStatusGetResponseAttributes'
+ id:
+ description: The ID of the report job.
+ example: dc8d92aa-e0af-11ee-af21-1feeaccaa3a3
+ type: string
+ type:
+ description: The type of ID.
+ example: report_id
+ type: string
+ type: object
ScalarColumn:
description: A single column in a scalar query response.
oneOf:
- $ref: '#/components/schemas/GroupScalarColumn'
- $ref: '#/components/schemas/DataScalarColumn'
@@ -17281,11 +17475,12 @@
type: array
complianceSignalOptions:
$ref: '#/components/schemas/CloudConfigurationRuleComplianceSignalOptions'
filters:
description: Additional queries to filter matched events before they are
- processed.
+ processed. This field is deprecated for log detection, signal correlation,
+ and workload security rules.
items:
$ref: '#/components/schemas/SecurityMonitoringFilter'
type: array
hasExtendedTitle:
description: Whether the notifications include the triggering group-by values
@@ -17529,11 +17724,12 @@
items:
$ref: '#/components/schemas/SecurityMonitoringRuleCaseCreate'
type: array
filters:
description: Additional queries to filter matched events before they are
- processed.
+ processed. This field is deprecated for log detection, signal correlation,
+ and workload security rules.
items:
$ref: '#/components/schemas/SecurityMonitoringFilter'
type: array
hasExtendedTitle:
description: Whether the notifications include the triggering group-by values
@@ -17631,11 +17827,12 @@
description: When the rule will be deprecated, timestamp in milliseconds.
format: int64
type: integer
filters:
description: Additional queries to filter matched events before they are
- processed.
+ processed. This field is deprecated for log detection, signal correlation,
+ and workload security rules.
items:
$ref: '#/components/schemas/SecurityMonitoringFilter'
type: array
hasExtendedTitle:
description: Whether the notifications include the triggering group-by values
@@ -17910,11 +18107,12 @@
items:
$ref: '#/components/schemas/SecurityMonitoringRuleCaseCreate'
type: array
filters:
description: Additional queries to filter matched events before they are
- processed.
+ processed. This field is deprecated for log detection, signal correlation,
+ and workload security rules.
items:
$ref: '#/components/schemas/SecurityMonitoringFilter'
type: array
hasExtendedTitle:
description: Whether the notifications include the triggering group-by values
@@ -18037,11 +18235,12 @@
description: When the rule will be deprecated, timestamp in milliseconds.
format: int64
type: integer
filters:
description: Additional queries to filter matched events before they are
- processed.
+ processed. This field is deprecated for log detection, signal correlation,
+ and workload security rules.
items:
$ref: '#/components/schemas/SecurityMonitoringFilter'
type: array
hasExtendedTitle:
description: Whether the notifications include the triggering group-by values
@@ -18113,10 +18312,17 @@
suppression rule.
format: int64
type: integer
creator:
$ref: '#/components/schemas/SecurityMonitoringUser'
+ data_exclusion_query:
+ description: An exclusion query on the input data of the security rules,
+ which could be logs, Agent events, or other types of data based on the
+ security rule. Events matching this query are ignored by any detection
+ rules referenced in the suppression rule.
+ example: source:cloudtrail account_id:12345
+ type: string
description:
description: A description for the suppression rule.
example: This rule suppresses low-severity signals in staging environments.
type: string
enabled:
@@ -18161,10 +18367,17 @@
type: object
SecurityMonitoringSuppressionCreateAttributes:
description: Object containing the attributes of the suppression rule to be
created.
properties:
+ data_exclusion_query:
+ description: An exclusion query on the input data of the security rules,
+ which could be logs, Agent events, or other types of data based on the
+ security rule. Events matching this query are ignored by any detection
+ rules referenced in the suppression rule.
+ example: source:cloudtrail account_id:12345
+ type: string
description:
description: A description for the suppression rule.
example: This rule suppresses low-severity signals in staging environments.
type: string
enabled:
@@ -18186,19 +18399,18 @@
as the search bar for detection rules.
example: type:log_detection source:cloudtrail
type: string
suppression_query:
description: The suppression query of the suppression rule. If a signal
- matches this query, it is suppressed and is not triggered . Same syntax
- as the queries to search signals in the signal explorer.
+ matches this query, it is suppressed and is not triggered. It uses the
+ same syntax as the queries to search signals in the Signals Explorer.
example: env:staging status:low
type: string
required:
- name
- enabled
- rule_query
- - suppression_query
type: object
SecurityMonitoringSuppressionCreateData:
description: Object for a single suppression rule.
properties:
attributes:
@@ -18238,10 +18450,17 @@
x-enum-varnames:
- SUPPRESSIONS
SecurityMonitoringSuppressionUpdateAttributes:
description: The suppression rule properties to be updated.
properties:
+ data_exclusion_query:
+ description: An exclusion query on the input data of the security rules,
+ which could be logs, Agent events, or other types of data based on the
+ security rule. Events matching this query are ignored by any detection
+ rules referenced in the suppression rule.
+ example: source:cloudtrail account_id:12345
+ type: string
description:
description: A description for the suppression rule.
example: This rule suppresses low-severity signals in staging environments.
type: string
enabled:
@@ -19681,10 +19900,18 @@
application:
description: Identifier for a group of related services serving a product
feature, which the service is a part of.
example: my-app
type: string
+ ci-pipeline-fingerprints:
+ description: A set of CI fingerprints.
+ example:
+ - j88xdEy0J5lc
+ - eZ7LMljCk8vo
+ items:
+ type: string
+ type: array
contacts:
description: A list of contacts related to the services.
items:
$ref: '#/components/schemas/ServiceDefinitionV2Dot2Contact'
type: array
@@ -20114,10 +20341,57 @@
required:
- channel_id
- channel_name
- redirect_url
type: object
+ SloReportCreateRequest:
+ description: The SLO report request body.
+ properties:
+ data:
+ $ref: '#/components/schemas/SloReportCreateRequestData'
+ required:
+ - data
+ type: object
+ SloReportCreateRequestAttributes:
+ description: The attributes portion of the SLO report request.
+ properties:
+ from_ts:
+ description: The `from` timestamp for the report in epoch seconds.
+ example: 1690901870
+ format: int64
+ type: integer
+ interval:
+ $ref: '#/components/schemas/SLOReportInterval'
+ query:
+ description: The query string used to filter SLO results. Some examples
+ of queries include `service:<service-name>` and `slo-name`.
+ example: slo_type:metric
+ type: string
+ timezone:
+ description: The timezone used to determine the start and end of each interval.
+ For example, weekly intervals start at 12am on Sunday in the specified
+ timezone.
+ example: America/New_York
+ type: string
+ to_ts:
+ description: The `to` timestamp for the report in epoch seconds.
+ example: 1706803070
+ format: int64
+ type: integer
+ required:
+ - query
+ - from_ts
+ - to_ts
+ type: object
+ SloReportCreateRequestData:
+ description: The data portion of the SLO report request.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/SloReportCreateRequestAttributes'
+ required:
+ - attributes
+ type: object
SortDirection:
default: desc
description: The direction to sort by.
enum:
- desc
@@ -21732,10 +22006,11 @@
`bytes per second`).
If the second element is not present, the API returns null.'
items:
$ref: '#/components/schemas/Unit'
+ nullable: true
type: array
type: object
TimeseriesResponseSeriesList:
description: Array of response series. The index here corresponds to the index
in the `formulas` or `queries` array from the request.
@@ -22310,10 +22585,15 @@
data:
description: Team memberships response data
items:
$ref: '#/components/schemas/UserTeam'
type: array
+ included:
+ description: Resources related to the team memberships
+ items:
+ $ref: '#/components/schemas/UserTeamIncluded'
+ type: array
links:
$ref: '#/components/schemas/TeamsResponseLinks'
meta:
$ref: '#/components/schemas/TeamsResponseMeta'
type: object
@@ -23021,11 +23301,15 @@
tags:
- APM Retention Filters
post:
description: 'Create a retention filter to index spans in your organization.
- Returns the retention filter definition when the request is successful.'
+ Returns the retention filter definition when the request is successful.
+
+
+ Default filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor
+ cannot be created.'
operationId: CreateApmRetentionFilter
requestBody:
content:
application/json:
schema:
@@ -23075,11 +23359,15 @@
tags:
- APM Retention Filters
x-codegen-request-body-name: body
/api/v2/apm/config/retention-filters/{filter_id}:
delete:
- description: Delete a specific retention filter from your organization.
+ description: 'Delete a specific retention filter from your organization.
+
+
+ Default filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor
+ cannot be deleted.'
operationId: DeleteApmRetentionFilter
parameters:
- $ref: '#/components/parameters/RetentionFilterIdParam'
responses:
'200':
@@ -23113,11 +23401,15 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get a given APM retention filter
tags:
- APM Retention Filters
put:
- description: Update a retention filter from your organization.
+ description: 'Update a retention filter from your organization.
+
+
+ Default filters (filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor)
+ cannot be renamed or removed.'
operationId: UpdateApmRetentionFilter
parameters:
- $ref: '#/components/parameters/RetentionFilterIdParam'
requestBody:
content:
@@ -29014,12 +29306,12 @@
tags:
- Metrics
x-codegen-request-body-name: body
/api/v2/metrics/{metric_name}/active-configurations:
get:
- description: List tags and aggregations that are actively queried on dashboards
- and monitors for a given metric name.
+ description: List tags and aggregations that are actively queried on dashboards,
+ notebooks, monitors, and the Metrics Explorer for a given metric name.
operationId: ListActiveMetricConfigurations
parameters:
- $ref: '#/components/parameters/MetricName'
- description: 'The number of seconds of look back (from now).
@@ -32272,10 +32564,38 @@
- security_monitoring_rules_write
summary: Create a detection rule
tags:
- Security Monitoring
x-codegen-request-body-name: body
+ /api/v2/security_monitoring/rules/validation:
+ post:
+ description: Validate a detection rule.
+ operationId: ValidateSecurityMonitoringRule
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/SecurityMonitoringRuleCreatePayload'
+ required: true
+ responses:
+ '204':
+ description: OK
+ '400':
+ $ref: '#/components/responses/BadRequestResponse'
+ '403':
+ $ref: '#/components/responses/NotAuthorizedResponse'
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ - AuthZ:
+ - security_monitoring_rules_write
+ summary: Validate a detection rule
+ tags:
+ - Security Monitoring
+ x-codegen-request-body-name: body
/api/v2/security_monitoring/rules/{rule_id}:
delete:
description: Delete an existing rule. Default rules cannot be deleted.
operationId: DeleteSecurityMonitoringRule
parameters:
@@ -33579,10 +33899,153 @@
summary: Update an existing incident service
tags:
- Incident Services
x-codegen-request-body-name: body
x-unstable: '**Note**: This endpoint is deprecated.'
+ /api/v2/slo/report:
+ post:
+ description: 'Create a job to generate an SLO report. The report job is processed
+ asynchronously and eventually results in a CSV report being available for
+ download.
+
+
+ Check the status of the job and download the CSV report using the returned
+ `report_id`.'
+ operationId: CreateSLOReportJob
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/SloReportCreateRequest'
+ description: Create SLO report job request body.
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/SLOReportPostResponse'
+ description: OK
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/APIErrorResponse'
+ description: Bad Request
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/APIErrorResponse'
+ description: Forbidden
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ - AuthZ:
+ - slos_read
+ summary: Create a new SLO report
+ tags:
+ - Service Level Objectives
+ x-codegen-request-body-name: body
+ x-unstable: '**Note**: This feature is in private beta. To request access, use
+ the request access form in the [Service Level Objectives](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-csv-export)
+ docs.'
+ /api/v2/slo/report/{report_id}/download:
+ get:
+ description: 'Download an SLO report. This can only be performed after the report
+ job has completed.
+
+
+ Reports are not guaranteed to exist indefinitely. Datadog recommends that
+ you download the report as soon as it is available.'
+ operationId: GetSLOReport
+ parameters:
+ - $ref: '#/components/parameters/ReportID'
+ responses:
+ '200':
+ content:
+ text/csv:
+ schema:
+ type: string
+ description: OK
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/APIErrorResponse'
+ description: Bad Request
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/APIErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/APIErrorResponse'
+ description: Not Found
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ - AuthZ:
+ - slos_read
+ summary: Get SLO report
+ tags:
+ - Service Level Objectives
+ x-unstable: '**Note**: This feature is in private beta. To request access, use
+ the request access form in the [Service Level Objectives](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-csv-export)
+ docs.'
+ /api/v2/slo/report/{report_id}/status:
+ get:
+ description: Get the status of the SLO report job.
+ operationId: GetSLOReportJobStatus
+ parameters:
+ - $ref: '#/components/parameters/ReportID'
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/SLOReportStatusGetResponse'
+ description: OK
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/APIErrorResponse'
+ description: Bad Request
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/APIErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/APIErrorResponse'
+ description: Not Found
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ - AuthZ:
+ - slos_read
+ summary: Get SLO report status
+ tags:
+ - Service Level Objectives
+ x-unstable: '**Note**: This feature is in private beta. To request access, use
+ the request access form in the [Service Level Objectives](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-csv-export)
+ docs.'
/api/v2/spans/analytics/aggregate:
post:
description: 'The API endpoint to aggregate spans into buckets and compute metrics
and timeseries.
@@ -34679,14 +35142,15 @@
- Incident Teams
x-codegen-request-body-name: body
x-unstable: '**Note**: This endpoint is deprecated. See the [Teams API endpoints](https://docs.datadoghq.com/api/latest/teams/).'
/api/v2/usage/application_security:
get:
+ deprecated: true
description: 'Get hourly usage for application security .
- **Note:** hourly usage data for all products is now available in the [Get
- hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)'
+ **Note:** This endpoint has been deprecated. Hourly usage data for all products
+ is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)'
operationId: GetUsageApplicationSecurityMonitoring
parameters:
- description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
for usage beginning at this hour.'
in: query
@@ -35080,14 +35544,15 @@
summary: Get hourly usage by product family
tags:
- Usage Metering
/api/v2/usage/lambda_traced_invocations:
get:
+ deprecated: true
description: 'Get hourly usage for Lambda traced invocations.
- **Note:** hourly usage data for all products is now available in the [Get
- hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)'
+ **Note:** This endpoint has been deprecated.. Hourly usage data for all products
+ is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)'
operationId: GetUsageLambdaTracedInvocations
parameters:
- description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
for usage beginning at this hour.'
in: query
@@ -35139,14 +35604,15 @@
summary: Get hourly usage for Lambda traced invocations
tags:
- Usage Metering
/api/v2/usage/observability_pipelines:
get:
+ deprecated: true
description: 'Get hourly usage for observability pipelines.
- **Note:** hourly usage data for all products is now available in the [Get
- hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)'
+ **Note:** This endpoint has been deprecated. Hourly usage data for all products
+ is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)'
operationId: GetUsageObservabilityPipelines
parameters:
- description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
for usage beginning at this hour.'
in: query
@@ -35866,10 +36332,14 @@
url: https://docs.datadoghq.com/logs/archives/
name: Logs Archives
- description: 'Custom Destinations forward all the logs ingested to an external destination.
+ **Note**: Log forwarding is not available for the Government (US1-FED) site. Contact
+ your account representative for more information.
+
+
See the [Custom Destinations Page](https://app.datadoghq.com/logs/pipelines/log-forwarding/custom-destinations)
for a list of the custom destinations currently configured in web UI.'
externalDocs:
description: Find out more at
@@ -35986,9 +36456,21 @@
name: Service Accounts
- description: API to create, update, retrieve and delete service definitions.
externalDocs:
url: https://docs.datadoghq.com/tracing/service_catalog/
name: Service Definition
+- description: '[Service Level Objectives](https://docs.datadoghq.com/monitors/service_level_objectives/#configuration)
+
+ (SLOs) are a key part of the site reliability engineering toolkit.
+
+ SLOs provide a framework for defining clear targets around application performance,
+
+ which ultimately help teams provide a consistent customer experience,
+
+ balance feature development with platform stability,
+
+ and improve communication with internal and external users.'
+ name: Service Level Objectives
- description: 'API to create, update scorecard rules and outcomes. See [Service Scorecards](https://docs.datadoghq.com/service_catalog/scorecards)
for more information.
This feature is currently in BETA. If you have any feedback, contact [Datadog