.generator/schemas/v2/openapi.yaml in datadog_api_client-2.19.0 vs .generator/schemas/v2/openapi.yaml in datadog_api_client-2.20.0
- old
+ new
@@ -430,10 +430,17 @@
in: path
name: rule_id
required: true
schema:
type: string
+ SecurityMonitoringSuppressionID:
+ description: The ID of the suppression rule
+ in: path
+ name: suppression_id
+ required: true
+ schema:
+ type: string
SensitiveDataScannerGroupID:
description: The ID of a group of rules.
in: path
name: group_id
required: true
@@ -830,10 +837,15 @@
enum:
- billing_dimensions
type: string
x-enum-varnames:
- BILLING_DIMENSIONS
+ ApiID:
+ description: API identifier.
+ example: 90646597-5fdb-4a17-a240-647003f8c028
+ format: uuid
+ type: string
ApmRetentionFilterType:
default: apm_retention_filter
description: The type of the resource.
enum:
- apm_retention_filter
@@ -4864,10 +4876,33 @@
- cost_by_org
example: cost_by_org
type: string
x-enum-varnames:
- COST_BY_ORG
+ CreateOpenAPIResponse:
+ description: Response for `CreateOpenAPI` operation.
+ properties:
+ data:
+ $ref: '#/components/schemas/CreateOpenAPIResponseData'
+ type: object
+ CreateOpenAPIResponseAttributes:
+ description: Attributes for `CreateOpenAPI`.
+ properties:
+ failed_endpoints:
+ description: List of endpoints which couldn't be parsed.
+ items:
+ $ref: '#/components/schemas/OpenAPIEndpoint'
+ type: array
+ type: object
+ CreateOpenAPIResponseData:
+ description: Data envelope for `CreateOpenAPIResponse`.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/CreateOpenAPIResponseAttributes'
+ id:
+ $ref: '#/components/schemas/ApiID'
+ type: object
CreateRuleRequest:
description: Scorecard create rule request.
properties:
data:
$ref: '#/components/schemas/CreateRuleRequestData'
@@ -4921,10 +4956,14 @@
- data
type: object
DORADeploymentRequestAttributes:
description: Attributes to create a DORA deployment event.
properties:
+ env:
+ 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.
example: 1693491984000000000
format: int64
@@ -5009,10 +5048,14 @@
- data
type: object
DORAIncidentRequestAttributes:
description: Attributes to create a DORA incident event.
properties:
+ env:
+ description: Environment name that was impacted by the incident.
+ example: staging
+ type: string
finished_at:
description: Unix timestamp in nanoseconds when the incident finished. It
should not be older than 3 hours.
example: 1693491984000000000
format: int64
@@ -11038,11 +11081,11 @@
type: object
MetricPayload:
description: The metrics' payload.
properties:
series:
- description: A list of time series to submit to Datadog.
+ description: A list of timeseries to submit to Datadog.
example:
- metric: system.load.1
points:
- timestamp: 1475317847
value: 0.7
@@ -12062,10 +12105,28 @@
enum:
- on_demand_concurrency_cap
type: string
x-enum-varnames:
- ON_DEMAND_CONCURRENCY_CAP
+ OpenAPIEndpoint:
+ description: Endpoint info extracted from an `OpenAPI` specification.
+ properties:
+ method:
+ description: The endpoint method.
+ type: string
+ path:
+ description: The endpoint path.
+ type: string
+ type: object
+ OpenAPIFile:
+ description: Object for API data in an `OpenAPI` format as a file.
+ properties:
+ openapi_spec_file:
+ description: Binary `OpenAPI` spec file
+ format: binary
+ type: string
+ type: object
OpsgenieServiceCreateAttributes:
description: The Opsgenie service attributes for a create request.
properties:
custom_url:
description: The custom URL for a custom region.
@@ -16586,10 +16647,223 @@
type: integer
version:
description: The version of the rule.
format: int64
type: integer
+ SecurityMonitoringSuppression:
+ description: The suppression rule's properties.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionAttributes'
+ id:
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionID'
+ type:
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionType'
+ type: object
+ SecurityMonitoringSuppressionAttributes:
+ description: The attributes of the suppression rule.
+ properties:
+ creation_date:
+ description: A Unix millisecond timestamp given the creation date of the
+ suppression rule.
+ format: int64
+ type: integer
+ creator:
+ $ref: '#/components/schemas/SecurityMonitoringUser'
+ description:
+ description: A description for the suppression rule.
+ example: This rule suppresses low-severity signals in staging environments.
+ type: string
+ enabled:
+ description: Whether the suppression rule is enabled.
+ example: true
+ type: boolean
+ expiration_date:
+ description: A Unix millisecond timestamp giving an expiration date for
+ the suppression rule. After this date, it won't suppress signals anymore.
+ example: 1703187336000
+ format: int64
+ type: integer
+ name:
+ description: The name of the suppression rule.
+ example: Custom suppression
+ type: string
+ rule_query:
+ description: The rule query of the suppression rule, with the same syntax
+ 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 not triggered. Same syntax as
+ the queries to search signals in the signal explorer.
+ example: env:staging status:low
+ type: string
+ update_date:
+ description: A Unix millisecond timestamp given the update date of the suppression
+ rule.
+ format: int64
+ type: integer
+ updater:
+ $ref: '#/components/schemas/SecurityMonitoringUser'
+ version:
+ description: The version of the suppression rule; it starts at 1, and is
+ incremented at each update.
+ example: 42
+ format: int32
+ maximum: 2147483647
+ type: integer
+ type: object
+ SecurityMonitoringSuppressionCreateAttributes:
+ description: Object containing the attributes of the suppression rule to be
+ created.
+ properties:
+ description:
+ description: A description for the suppression rule.
+ example: This rule suppresses low-severity signals in staging environments.
+ type: string
+ enabled:
+ description: Whether the suppression rule is enabled.
+ example: true
+ type: boolean
+ expiration_date:
+ description: A Unix millisecond timestamp giving an expiration date for
+ the suppression rule. After this date, it won't suppress signals anymore.
+ example: 1703187336000
+ format: int64
+ type: integer
+ name:
+ description: The name of the suppression rule.
+ example: Custom suppression
+ type: string
+ rule_query:
+ description: The rule query of the suppression rule, with the same syntax
+ 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.
+ 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:
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionCreateAttributes'
+ type:
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionType'
+ required:
+ - type
+ - attributes
+ type: object
+ SecurityMonitoringSuppressionCreateRequest:
+ description: Request object that includes the suppression rule that you would
+ like to create.
+ properties:
+ data:
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionCreateData'
+ required:
+ - data
+ type: object
+ SecurityMonitoringSuppressionID:
+ description: The ID of the suppression rule.
+ example: 3dd-0uc-h1s
+ type: string
+ SecurityMonitoringSuppressionResponse:
+ description: Response object containing a single suppression rule.
+ properties:
+ data:
+ $ref: '#/components/schemas/SecurityMonitoringSuppression'
+ type: object
+ SecurityMonitoringSuppressionType:
+ default: suppressions
+ description: The type of the resource. The value should always be `suppressions`.
+ enum:
+ - suppressions
+ example: suppressions
+ type: string
+ x-enum-varnames:
+ - SUPPRESSIONS
+ SecurityMonitoringSuppressionUpdateAttributes:
+ description: The suppression rule properties to be updated.
+ properties:
+ description:
+ description: A description for the suppression rule.
+ example: This rule suppresses low-severity signals in staging environments.
+ type: string
+ enabled:
+ description: Whether the suppression rule is enabled.
+ example: true
+ type: boolean
+ expiration_date:
+ description: A Unix millisecond timestamp giving an expiration date for
+ the suppression rule. After this date, it won't suppress signals anymore.
+ If unset, the expiration date of the suppression rule is left untouched.
+ If set to `null`, the expiration date is removed.
+ example: 1703187336000
+ format: int64
+ nullable: true
+ type: integer
+ name:
+ description: The name of the suppression rule.
+ example: Custom suppression
+ type: string
+ rule_query:
+ description: The rule query of the suppression rule, with the same syntax
+ 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 not triggered. Same syntax as
+ the queries to search signals in the signal explorer.
+ example: env:staging status:low
+ type: string
+ version:
+ description: The current version of the suppression. This is optional, but
+ it can help prevent concurrent modifications.
+ format: int32
+ maximum: 2147483647
+ type: integer
+ type: object
+ SecurityMonitoringSuppressionUpdateData:
+ description: The new suppression properties; partial updates are supported.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionUpdateAttributes'
+ type:
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionType'
+ required:
+ - type
+ - attributes
+ type: object
+ SecurityMonitoringSuppressionUpdateRequest:
+ description: Request object containing the fields to update on the suppression
+ rule.
+ properties:
+ data:
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionUpdateData'
+ required:
+ - data
+ type: object
+ SecurityMonitoringSuppressionsResponse:
+ description: Response object containing the available suppression rules.
+ properties:
+ data:
+ description: A list of suppressions objects.
+ items:
+ $ref: '#/components/schemas/SecurityMonitoringSuppression'
+ type: array
+ type: object
SecurityMonitoringThirdPartyRootQuery:
description: A query to be combined with the third party case query.
properties:
groupByFields:
description: Fields to group by.
@@ -16664,10 +16938,23 @@
example: 773b045d-ccf8-4808-bd3b-955ef6a8c940
type: string
required:
- uuid
type: object
+ SecurityMonitoringUser:
+ description: A user.
+ properties:
+ handle:
+ description: The handle of the user.
+ example: john.doe@datadoghq.com
+ type: string
+ name:
+ description: The name of the user.
+ example: John Doe
+ nullable: true
+ type: string
+ type: object
SensitiveDataScannerConfigRequest:
description: Group reorder request.
properties:
data:
$ref: '#/components/schemas/SensitiveDataScannerReorderConfig'
@@ -16951,11 +17238,11 @@
type: integer
keywords:
description: 'Keyword list that will be checked during scanning in order
to validate a match.
- The number of keywords in the list must be less than or equal to 20.'
+ The number of keywords in the list must be less than or equal to 30.'
example:
- credit card
- cc
items:
type: string
@@ -20041,10 +20328,33 @@
short_name:
description: Abbreviation of the unit.
example: min
type: string
type: object
+ UpdateOpenAPIResponse:
+ description: Response for `UpdateOpenAPI`.
+ properties:
+ data:
+ $ref: '#/components/schemas/UpdateOpenAPIResponseData'
+ type: object
+ UpdateOpenAPIResponseAttributes:
+ description: Attributes for `UpdateOpenAPI`.
+ properties:
+ failed_endpoints:
+ description: List of endpoints which couldn't be parsed.
+ items:
+ $ref: '#/components/schemas/OpenAPIEndpoint'
+ type: array
+ type: object
+ UpdateOpenAPIResponseData:
+ description: Data envelope for `UpdateOpenAPIResponse`.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/UpdateOpenAPIResponseAttributes'
+ id:
+ $ref: '#/components/schemas/ApiID'
+ type: object
UsageApplicationSecurityMonitoringResponse:
description: Application Security Monitoring usage response.
properties:
data:
description: Response containing Application Security Monitoring usage.
@@ -20867,10 +21177,199 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Edit an API key
tags:
- Key Management
x-codegen-request-body-name: body
+ /api/v2/apicatalog/api/{id}:
+ delete:
+ description: Delete a specific API by ID.
+ operationId: DeleteOpenAPI
+ parameters:
+ - description: ID of the API to delete
+ in: path
+ name: id
+ required: true
+ schema:
+ $ref: '#/components/schemas/ApiID'
+ responses:
+ '204':
+ description: API deleted successfully
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
+ description: Bad request
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
+ description: API not found error
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ summary: Delete an API
+ tags:
+ - API Management
+ x-unstable: '**Note**: This endpoint is in public beta.
+
+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
+ /api/v2/apicatalog/api/{id}/openapi:
+ get:
+ description: Retrieve information about a specific API in [OpenAPI](https://spec.openapis.org/oas/latest.html)
+ format file.
+ operationId: GetOpenAPI
+ parameters:
+ - description: ID of the API to retrieve
+ in: path
+ name: id
+ required: true
+ schema:
+ $ref: '#/components/schemas/ApiID'
+ responses:
+ '200':
+ content:
+ multipart/form-data:
+ schema:
+ format: binary
+ type: string
+ description: OK
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
+ description: Bad request
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
+ description: API not found error
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ summary: Get an API
+ tags:
+ - API Management
+ x-unstable: '**Note**: This endpoint is in public beta.
+
+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
+ put:
+ description: 'Update information about a specific API. The given content will
+ replace all API content of the given ID.
+
+ The ID is returned by the create API, or can be found in the URL in the API
+ catalog UI.
+
+ '
+ operationId: UpdateOpenAPI
+ parameters:
+ - description: ID of the API to modify
+ in: path
+ name: id
+ required: true
+ schema:
+ $ref: '#/components/schemas/ApiID'
+ requestBody:
+ content:
+ multipart/form-data:
+ schema:
+ $ref: '#/components/schemas/OpenAPIFile'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UpdateOpenAPIResponse'
+ description: API updated successfully
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
+ description: Bad request
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
+ description: API not found error
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ summary: Update an API
+ tags:
+ - API Management
+ x-unstable: '**Note**: This endpoint is in public beta.
+
+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
+ /api/v2/apicatalog/openapi:
+ post:
+ description: 'Create a new API from the [OpenAPI](https://spec.openapis.org/oas/latest.html)
+ specification given.
+
+ It supports version `2.0`, `3.0` and `3.1` of the specification. A specific
+ extension section, `x-datadog`,
+
+ let you specify the `teamHandle` for your team responsible for the API in
+ Datadog.
+
+ It returns the created API ID.
+
+ '
+ operationId: CreateOpenAPI
+ requestBody:
+ content:
+ multipart/form-data:
+ schema:
+ $ref: '#/components/schemas/OpenAPIFile'
+ required: true
+ responses:
+ '201':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CreateOpenAPIResponse'
+ description: API created successfully
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
+ description: Bad request
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
+ description: Forbidden
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ summary: Create a new API
+ tags:
+ - API Management
+ x-unstable: '**Note**: This endpoint is in public beta.
+
+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
/api/v2/apm/config/metrics:
get:
description: Get the list of configured span-based metrics with their definitions.
operationId: ListSpansMetrics
responses:
@@ -22525,11 +23024,12 @@
$ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
appKeyAuth: []
- - AuthZ: []
+ - AuthZ:
+ - usage_read
summary: Get active billing dimensions for cost attribution
tags:
- Usage Metering
x-unstable: '**Note**: This endpoint is in public beta.
@@ -22646,11 +23146,12 @@
$ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
appKeyAuth: []
- - AuthZ: []
+ - AuthZ:
+ - usage_read
summary: Get Monthly Cost Attribution
tags:
- Usage Metering
x-unstable: '**Note**: This endpoint is in public beta.
@@ -28823,14 +29324,13 @@
- apm_service_catalog_write
summary: Create outcomes batch
tags:
- Service Scorecards
x-codegen-request-body-name: body
- x-unstable: '**Note**: This endpoint is in private beta. To request access,
- fill out this [sign-up form](https://forms.gle/CcEyp1uJmZpxRv8U8),
+ x-unstable: '**Note**: This endpoint is in public beta.
- and we will be in touch. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
/api/v2/scorecard/rules:
get:
description: Fetch all rules.
operationId: ListScorecardRules
parameters:
@@ -28951,14 +29451,13 @@
- apm_service_catalog_write
summary: Create a new rule
tags:
- Service Scorecards
x-codegen-request-body-name: body
- x-unstable: '**Note**: This endpoint is in private beta. To request access,
- fill out this [sign-up form](https://forms.gle/CcEyp1uJmZpxRv8U8),
+ x-unstable: '**Note**: This endpoint is in public beta.
- and we will be in touch. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
/api/v2/scorecard/rules/{rule_id}:
delete:
description: Deletes a single rule.
operationId: DeleteScorecardRule
parameters:
@@ -28980,14 +29479,13 @@
- AuthZ:
- apm_service_catalog_write
summary: Delete a rule
tags:
- Service Scorecards
- x-unstable: '**Note**: This endpoint is in private beta. To request access,
- fill out this [sign-up form](https://forms.gle/CcEyp1uJmZpxRv8U8),
+ x-unstable: '**Note**: This endpoint is in public beta.
- and we will be in touch. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
/api/v2/security/cloud_workload/policy/download:
get:
description: 'The download endpoint generates a Cloud Workload Security policy
file from your currently active
@@ -29286,10 +29784,153 @@
- security_monitoring_filters_write
summary: Update a security filter
tags:
- Security Monitoring
x-codegen-request-body-name: body
+ /api/v2/security_monitoring/configuration/suppressions:
+ get:
+ description: Get the list of all suppression rules.
+ operationId: ListSecurityMonitoringSuppressions
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionsResponse'
+ description: OK
+ '403':
+ $ref: '#/components/responses/NotAuthorizedResponse'
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ - AuthZ:
+ - security_monitoring_suppressions_read
+ summary: Get all suppression rules
+ tags:
+ - Security Monitoring
+ post:
+ description: Create a new suppression rule.
+ operationId: CreateSecurityMonitoringSuppression
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionCreateRequest'
+ description: The definition of the new suppression rule.
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionResponse'
+ description: OK
+ '400':
+ $ref: '#/components/responses/BadRequestResponse'
+ '403':
+ $ref: '#/components/responses/NotAuthorizedResponse'
+ '409':
+ $ref: '#/components/responses/ConflictResponse'
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ - AuthZ:
+ - security_monitoring_suppressions_write
+ summary: Create a suppression rule
+ tags:
+ - Security Monitoring
+ x-codegen-request-body-name: body
+ /api/v2/security_monitoring/configuration/suppressions/{suppression_id}:
+ delete:
+ description: Delete a specific suppression rule.
+ operationId: DeleteSecurityMonitoringSuppression
+ parameters:
+ - $ref: '#/components/parameters/SecurityMonitoringSuppressionID'
+ responses:
+ '204':
+ description: OK
+ '403':
+ $ref: '#/components/responses/NotAuthorizedResponse'
+ '404':
+ $ref: '#/components/responses/NotFoundResponse'
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ - AuthZ:
+ - security_monitoring_suppressions_write
+ summary: Delete a suppression rule
+ tags:
+ - Security Monitoring
+ get:
+ description: Get the details of a specific suppression rule.
+ operationId: GetSecurityMonitoringSuppression
+ parameters:
+ - $ref: '#/components/parameters/SecurityMonitoringSuppressionID'
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionResponse'
+ description: OK
+ '403':
+ $ref: '#/components/responses/NotAuthorizedResponse'
+ '404':
+ $ref: '#/components/responses/NotFoundResponse'
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ - AuthZ:
+ - security_monitoring_suppressions_read
+ summary: Get a suppression rule
+ tags:
+ - Security Monitoring
+ patch:
+ description: Update a specific suppression rule.
+ operationId: UpdateSecurityMonitoringSuppression
+ parameters:
+ - $ref: '#/components/parameters/SecurityMonitoringSuppressionID'
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionUpdateRequest'
+ description: New definition of the suppression rule. Supports partial updates.
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionResponse'
+ description: OK
+ '400':
+ $ref: '#/components/responses/BadRequestResponse'
+ '403':
+ $ref: '#/components/responses/NotAuthorizedResponse'
+ '404':
+ $ref: '#/components/responses/NotFoundResponse'
+ '409':
+ $ref: '#/components/responses/ConcurrentModificationResponse'
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ - AuthZ:
+ - security_monitoring_suppressions_write
+ summary: Update a suppression rule
+ tags:
+ - Security Monitoring
/api/v2/security_monitoring/rules:
get:
description: List rules.
operationId: ListSecurityMonitoringRules
parameters:
@@ -31348,10 +31989,14 @@
- AuthZ:
- teams_read
summary: Get team memberships
tags:
- Teams
+ x-pagination:
+ limitParam: page[size]
+ pageParam: page[number]
+ resultsPath: data
post:
description: Add a user to a team.
operationId: CreateTeamMembership
parameters:
- description: None
@@ -32152,11 +32797,11 @@
summary: Get hourly usage by product family
tags:
- Usage Metering
/api/v2/usage/lambda_traced_invocations:
get:
- description: 'Get hourly usage for lambda traced invocations.
+ 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)'
operationId: GetUsageLambdaTracedInvocations
parameters:
@@ -32206,11 +32851,11 @@
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- usage_read
- summary: Get hourly usage for lambda traced invocations
+ summary: Get hourly usage for Lambda traced invocations
tags:
- Usage Metering
/api/v2/usage/observability_pipelines:
get:
description: 'Get hourly usage for observability pipelines.
@@ -32790,48 +33435,63 @@
description: Any Datadog deployment.
subdomain:
default: api
description: The subdomain where the API is deployed.
tags:
+- description: Configure your API endpoints through the Datadog API.
+ name: API Management
- description: Manage configuration of [APM retention filters](https://app.datadoghq.com/apm/traces/retention-filters)
for your organization. You need an API and application key with Admin rights to
- interact with this endpoint.
+ interact with this endpoint. See [retention filters](https://docs.datadoghq.com/tracing/trace_pipeline/trace_retention/#retention-filters)
+ on the Trace Retention page for more information.
externalDocs:
description: Find out more at
url: https://docs.datadoghq.com/tracing/trace_pipeline/trace_retention/
name: APM Retention Filters
- description: Search your Audit Logs events over HTTP.
name: Audit
-- description: '[AuthN Mappings API](https://docs.datadoghq.com/account_management/authn_mapping/?tab=example)
+- description: '[The AuthN Mappings API](https://docs.datadoghq.com/account_management/authn_mapping/?tab=example)
- is used to automatically map group of users to roles in Datadog using attributes
+ is used to automatically map groups of users to roles in Datadog using attributes
- sent from Identity Providers.'
+ sent from Identity Providers. Use these endpoints to manage your AuthN Mappings.'
name: AuthN Mappings
- description: Search or aggregate your CI Visibility pipeline events and send them
- to your Datadog site over HTTP.
+ to your Datadog site over HTTP. See the [CI Pipeline Visibility in Datadog page](https://docs.datadoghq.com/continuous_integration/pipelines/)
+ for more information.
name: CI Visibility Pipelines
-- description: Search or aggregate your CI Visibility test events over HTTP.
+- description: Search or aggregate your CI Visibility test events over HTTP. See the
+ [Test Visibility in Datadog page](https://docs.datadoghq.com/tests/) for more
+ information.
name: CI Visibility Tests
-- description: The Cloud Cost Management API allows you to setup, edit and delete
- cloud cost management accounts for AWS & Azure.
+- description: The Cloud Cost Management API allows you to set up, edit, and delete
+ Cloud Cost Management accounts for AWS and Azure. See the [Cloud Cost Management
+ page](https://docs.datadoghq.com/cloud_cost_management/) for more information.
name: Cloud Cost Management
- description: Workload activity security rules for generating events using the Datadog
- security Agent.
+ security Agent. See the [Setting up CSM Workload Security page](https://docs.datadoghq.com/security/cloud_security_management/setup/csm_workload_security/)
+ for more information.
name: Cloud Workload Security
-- description: Configure your Datadog Cloudflare integration directly through the
- Datadog API.
+- description: Manage your Datadog Cloudflare integration directly through the Datadog
+ API. See the [Cloudflare integration page](https://docs.datadoghq.com/integrations/cloudflare/)
+ for more information.
name: Cloudflare Integration
-- description: Configure your Datadog Confluent Cloud integration directly through
- the Datadog API.
+- description: Manage your Datadog Confluent Cloud integration accounts and account
+ resources directly through the Datadog API. See the [Confluent Cloud page](https://docs.datadoghq.com/integrations/confluent_cloud/)
+ for more information.
name: Confluent Cloud
- description: The Container Images API allows you to query Container Image data for
- your organization.
+ your organization. See the [Container Images View page](https://docs.datadoghq.com/infrastructure/containers/container_images/)
+ for more information.
name: Container Images
- description: The Containers API allows you to query container data for your organization.
+ See the [Container Monitoring page](https://docs.datadoghq.com/containers/) for
+ more information.
name: Containers
- description: Send events for DORA Metrics to measure and improve software delivery.
+ See the [DORA Metrics page](https://docs.datadoghq.com/dora_metrics/) for more
+ information.
name: DORA Metrics
- description: 'Interact with your dashboard lists through the API to
organize, find, and share all of your dashboards with your team and
@@ -32847,22 +33507,19 @@
scopes from alerting. Downtime settings, which can be scheduled with start and
end times, prevent all alerting related to specified Datadog tags.'
name: Downtimes
-- description: 'The events service allows you to programmatically post events to the
- event stream
+- description: 'The Event Management API allows you to programmatically post events
+ to the Events Explorer
- and fetch events from the event stream. Events are limited to 4000 characters.
-
- If an event is sent out with a message containing more than 4000 characters, only
- the
-
- first 4000 characters are displayed.'
+ and fetch events from the Events Explorer. See the [Event Management page](https://docs.datadoghq.com/service_management/events/)
+ for more information.'
name: Events
-- description: Configure your Datadog Fastly integration directly through the Datadog
- API.
+- description: Manage your Datadog Fastly integration accounts and services directly
+ through the Datadog API. See the [Fastly integration page](https://docs.datadoghq.com/integrations/fastly/)
+ for more information.
name: Fastly Integration
- description: 'Configure your Datadog-Google Cloud Platform (GCP) integration directly
through the Datadog API. Read more about the [Datadog-Google Cloud Platform integration](https://docs.datadoghq.com/integrations/google_cloud_platform).'
externalDocs:
@@ -32878,16 +33535,19 @@
This is an enterprise-only feature. Request access by
contacting Datadog support.'
name: IP Allowlist
- description: Create, update, delete, and retrieve services which can be associated
- with incidents.
+ with incidents. See the [Incident Management page](https://docs.datadoghq.com/service_management/incident_management/)
+ for more information.
name: Incident Services
- description: The Incident Teams endpoints are deprecated. See the [Teams API endpoints](https://docs.datadoghq.com/api/latest/teams/)
to create, update, delete, and retrieve teams which can be associated with incidents.
name: Incident Teams
-- description: Manage incident response.
+- description: Manage incident response, as well as associated attachments, metadata,
+ and todos. See the [Incident Management page](https://docs.datadoghq.com/service_management/incident_management/)
+ for more information.
name: Incidents
- description: 'Manage your Datadog API and application keys. You need an API key
and
an application key for a user with the required permissions to interact
@@ -33049,10 +33709,12 @@
It is retained for 15 months.
You can retrieve up to 24 hours of hourly usage data for multiple organizations,
- and up to two months of hourly usage data for a single organization in one request.'
+ and up to two months of hourly usage data for a single organization in one request.
+
+ Learn more on the [usage details documentation](https://docs.datadoghq.com/account_management/billing/usage_details/).'
externalDocs:
description: Find out more at
url: https://docs.datadoghq.com/account_management/billing/usage_details/
name: Usage Metering
- description: Create, edit, and disable users.