.generator/schemas/v2/openapi.yaml in datadog_api_client-2.18.0 vs .generator/schemas/v2/openapi.yaml in datadog_api_client-2.19.0
- old
+ new
@@ -149,10 +149,17 @@
in: path
name: authn_mapping_id
required: true
schema:
type: string
+ CloudAccountID:
+ description: Cloud Account id.
+ in: path
+ name: cloud_account_id
+ required: true
+ schema:
+ type: string
CloudWorkloadSecurityAgentRuleID:
description: The ID of the Agent rule.
example: 3b5-v82-ns6
in: path
name: agent_rule_id
@@ -739,10 +746,53 @@
- api_keys
example: api_keys
type: string
x-enum-varnames:
- API_KEYS
+ AWSRelatedAccount:
+ description: AWS related account.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/AWSRelatedAccountAttributes'
+ id:
+ description: The AWS account ID.
+ example: '123456789123'
+ type: string
+ type:
+ $ref: '#/components/schemas/AWSRelatedAccountType'
+ required:
+ - id
+ - type
+ type: object
+ AWSRelatedAccountAttributes:
+ description: Attributes for an AWS related account.
+ properties:
+ has_datadog_integration:
+ description: Whether or not the AWS account has a Datadog integration.
+ type: boolean
+ name:
+ description: The name of the AWS account.
+ type: string
+ type: object
+ AWSRelatedAccountType:
+ default: aws_account
+ description: Type of AWS related account.
+ enum:
+ - aws_account
+ example: aws_account
+ type: string
+ x-enum-varnames:
+ - AWS_ACCOUNT
+ AWSRelatedAccountsResponse:
+ description: List of AWS related accounts.
+ properties:
+ data:
+ description: An AWS related account.
+ items:
+ $ref: '#/components/schemas/AWSRelatedAccount'
+ type: array
+ type: object
ActiveBillingDimensionsAttributes:
description: List of active billing dimensions.
properties:
month:
description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`.'
@@ -1367,10 +1417,463 @@
- authn_mappings
example: authn_mappings
type: string
x-enum-varnames:
- AUTHN_MAPPINGS
+ AwsCURConfig:
+ description: AWS CUR config.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/AwsCURConfigAttributes'
+ id:
+ description: The ID of the AWS CUR config.
+ format: int64
+ type: integer
+ type:
+ $ref: '#/components/schemas/AwsCURConfigType'
+ required:
+ - attributes
+ - type
+ type: object
+ AwsCURConfigAttributes:
+ description: Attributes for An AWS CUR config.
+ properties:
+ account_id:
+ description: The AWS account ID.
+ example: '123456789123'
+ type: string
+ bucket_name:
+ description: The AWS bucket name used to store the Cost and Usage Report.
+ example: dd-cost-bucket
+ type: string
+ bucket_region:
+ description: The region the bucket is located in.
+ example: us-east-1
+ type: string
+ created_at:
+ description: The timestamp when the AWS CUR config was created.
+ pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}$
+ type: string
+ error_messages:
+ description: The error messages for the AWS CUR config.
+ items:
+ type: string
+ type: array
+ months:
+ deprecated: true
+ description: The number of months the report has been backfilled.
+ format: int32
+ maximum: 36
+ type: integer
+ report_name:
+ description: The name of the Cost and Usage Report.
+ example: dd-report-name
+ type: string
+ report_prefix:
+ description: The report prefix used for the Cost and Usage Report.
+ example: dd-report-prefix
+ type: string
+ status:
+ description: The status of the AWS CUR.
+ example: active
+ type: string
+ status_updated_at:
+ description: The timestamp when the AWS CUR config status was updated.
+ pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}$
+ type: string
+ updated_at:
+ description: The timestamp when the AWS CUR config status was updated.
+ pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}$
+ type: string
+ required:
+ - account_id
+ - bucket_name
+ - bucket_region
+ - report_name
+ - report_prefix
+ - status
+ type: object
+ AwsCURConfigPatchData:
+ description: AWS CUR config Patch data.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/AwsCURConfigPatchRequestAttributes'
+ type:
+ $ref: '#/components/schemas/AwsCURConfigPatchRequestType'
+ required:
+ - attributes
+ - type
+ type: object
+ AwsCURConfigPatchRequest:
+ description: AWS CUR config Patch Request.
+ properties:
+ data:
+ $ref: '#/components/schemas/AwsCURConfigPatchData'
+ required:
+ - data
+ type: object
+ AwsCURConfigPatchRequestAttributes:
+ description: Attributes for AWS CUR config Patch Request.
+ properties:
+ is_enabled:
+ description: Whether or not the Cloud Cost Management account is enabled.
+ example: true
+ type: boolean
+ required:
+ - is_enabled
+ type: object
+ AwsCURConfigPatchRequestType:
+ default: aws_cur_config_patch_request
+ description: Type of AWS CUR config Patch Request.
+ enum:
+ - aws_cur_config_patch_request
+ example: aws_cur_config_patch_request
+ type: string
+ x-enum-varnames:
+ - AWS_CUR_CONFIG_PATCH_REQUEST
+ AwsCURConfigPostData:
+ description: AWS CUR config Post data.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/AwsCURConfigPostRequestAttributes'
+ type:
+ $ref: '#/components/schemas/AwsCURConfigPostRequestType'
+ required:
+ - attributes
+ - type
+ type: object
+ AwsCURConfigPostRequest:
+ description: AWS CUR config Post Request.
+ properties:
+ data:
+ $ref: '#/components/schemas/AwsCURConfigPostData'
+ required:
+ - data
+ type: object
+ AwsCURConfigPostRequestAttributes:
+ description: Attributes for AWS CUR config Post Request.
+ properties:
+ account_id:
+ description: The AWS account ID.
+ example: '123456789123'
+ type: string
+ bucket_name:
+ description: The AWS bucket name used to store the Cost and Usage Report.
+ example: dd-cost-bucket
+ type: string
+ bucket_region:
+ description: The region the bucket is located in.
+ example: us-east-1
+ type: string
+ is_enabled:
+ description: Whether or not the Cloud Cost Management account is enabled.
+ type: boolean
+ months:
+ description: The month of the report.
+ format: int32
+ maximum: 36
+ type: integer
+ report_name:
+ description: The name of the Cost and Usage Report.
+ example: dd-report-name
+ type: string
+ report_prefix:
+ description: The report prefix used for the Cost and Usage Report.
+ example: dd-report-prefix
+ type: string
+ required:
+ - account_id
+ - bucket_name
+ - report_name
+ - report_prefix
+ type: object
+ AwsCURConfigPostRequestType:
+ default: aws_cur_config_post_request
+ description: Type of AWS CUR config Post Request.
+ enum:
+ - aws_cur_config_post_request
+ example: aws_cur_config_post_request
+ type: string
+ x-enum-varnames:
+ - AWS_CUR_CONFIG_POST_REQUEST
+ AwsCURConfigResponse:
+ description: Response of AWS CUR config.
+ properties:
+ data:
+ $ref: '#/components/schemas/AwsCURConfig'
+ type: object
+ AwsCURConfigType:
+ default: aws_cur_config
+ description: Type of AWS CUR config.
+ enum:
+ - aws_cur_config
+ example: aws_cur_config
+ type: string
+ x-enum-varnames:
+ - AWS_CUR_CONFIG
+ AwsCURConfigsResponse:
+ description: List of AWS CUR configs.
+ properties:
+ data:
+ description: An AWS CUR config.
+ items:
+ $ref: '#/components/schemas/AwsCURConfig'
+ type: array
+ type: object
+ AzureUCConfig:
+ description: Azure config.
+ properties:
+ account_id:
+ description: The tenant ID of the azure account.
+ example: 1234abcd-1234-abcd-1234-1234abcd1234
+ type: string
+ client_id:
+ description: The client ID of the Azure account.
+ example: 1234abcd-1234-abcd-1234-1234abcd1234
+ type: string
+ created_at:
+ description: The timestamp when the Azure config was created.
+ pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}$
+ type: string
+ dataset_type:
+ description: The dataset type of the Azure config.
+ example: actual
+ type: string
+ error_messages:
+ description: The error messages for the Azure config.
+ items:
+ type: string
+ type: array
+ export_name:
+ description: The name of the configured Azure Export.
+ example: dd-actual-export
+ type: string
+ export_path:
+ description: The path where the Azure Export is saved.
+ example: dd-export-path
+ type: string
+ id:
+ description: The ID of the Azure config.
+ format: int64
+ type: integer
+ months:
+ deprecated: true
+ description: The number of months the report has been backfilled.
+ format: int32
+ maximum: 36
+ type: integer
+ scope:
+ description: The scope of your observed subscription.
+ example: subscriptions/1234abcd-1234-abcd-1234-1234abcd1234
+ type: string
+ status:
+ description: The status of the Azure config.
+ example: active
+ type: string
+ status_updated_at:
+ description: The timestamp when the Azure config status was last updated.
+ pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}$
+ type: string
+ storage_account:
+ description: The name of the storage account where the Azure Export is saved.
+ example: dd-storage-account
+ type: string
+ storage_container:
+ description: The name of the storage container where the Azure Export is
+ saved.
+ example: dd-storage-container
+ type: string
+ updated_at:
+ description: The timestamp when the Azure config was last updated.
+ pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}$
+ type: string
+ required:
+ - account_id
+ - client_id
+ - dataset_type
+ - export_name
+ - export_path
+ - scope
+ - status
+ - storage_account
+ - storage_container
+ type: object
+ AzureUCConfigPair:
+ description: Azure config pair.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/AzureUCConfigPairAttributes'
+ id:
+ description: The ID of Cloud Cost Management account.
+ format: int64
+ type: integer
+ type:
+ $ref: '#/components/schemas/AzureUCConfigPairType'
+ required:
+ - attributes
+ - type
+ type: object
+ AzureUCConfigPairAttributes:
+ description: Attributes for Azure config pair.
+ properties:
+ configs:
+ description: An Azure config.
+ items:
+ $ref: '#/components/schemas/AzureUCConfig'
+ type: array
+ id:
+ description: The ID of the Azure config pair.
+ format: int64
+ type: integer
+ required:
+ - configs
+ type: object
+ AzureUCConfigPairType:
+ default: azure_uc_configs
+ description: Type of Azure config pair.
+ enum:
+ - azure_uc_configs
+ example: azure_uc_configs
+ type: string
+ x-enum-varnames:
+ - AZURE_UC_CONFIGS
+ AzureUCConfigPairsResponse:
+ description: Response of Azure config pair.
+ properties:
+ data:
+ $ref: '#/components/schemas/AzureUCConfigPair'
+ type: object
+ AzureUCConfigPatchData:
+ description: Azure config Patch data.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/AzureUCConfigPatchRequestAttributes'
+ type:
+ $ref: '#/components/schemas/AzureUCConfigPatchRequestType'
+ required:
+ - attributes
+ - type
+ type: object
+ AzureUCConfigPatchRequest:
+ description: Azure config Patch Request.
+ properties:
+ data:
+ $ref: '#/components/schemas/AzureUCConfigPatchData'
+ required:
+ - data
+ type: object
+ AzureUCConfigPatchRequestAttributes:
+ description: Attributes for Azure config Patch Request.
+ properties:
+ is_enabled:
+ description: Whether or not the Cloud Cost Management account is enabled.
+ example: true
+ type: boolean
+ required:
+ - is_enabled
+ type: object
+ AzureUCConfigPatchRequestType:
+ default: azure_uc_config_patch_request
+ description: Type of Azure config Patch Request.
+ enum:
+ - azure_uc_config_patch_request
+ example: azure_uc_config_patch_request
+ type: string
+ x-enum-varnames:
+ - AZURE_UC_CONFIG_PATCH_REQUEST
+ AzureUCConfigPostData:
+ description: Azure config Post data.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/AzureUCConfigPostRequestAttributes'
+ type:
+ $ref: '#/components/schemas/AzureUCConfigPostRequestType'
+ required:
+ - attributes
+ - type
+ type: object
+ AzureUCConfigPostRequest:
+ description: Azure config Post Request.
+ properties:
+ data:
+ $ref: '#/components/schemas/AzureUCConfigPostData'
+ required:
+ - data
+ type: object
+ AzureUCConfigPostRequestAttributes:
+ description: Attributes for Azure config Post Request.
+ properties:
+ account_id:
+ description: The tenant ID of the azure account.
+ example: 1234abcd-1234-abcd-1234-1234abcd1234
+ type: string
+ actual_bill_config:
+ $ref: '#/components/schemas/BillConfig'
+ amortized_bill_config:
+ $ref: '#/components/schemas/BillConfig'
+ client_id:
+ description: The client ID of the azure account.
+ example: 1234abcd-1234-abcd-1234-1234abcd1234
+ type: string
+ is_enabled:
+ description: Whether or not the Cloud Cost Management account is enabled.
+ type: boolean
+ scope:
+ description: The scope of your observed subscription.
+ example: subscriptions/1234abcd-1234-abcd-1234-1234abcd1234
+ type: string
+ required:
+ - account_id
+ - actual_bill_config
+ - amortized_bill_config
+ - client_id
+ - scope
+ type: object
+ AzureUCConfigPostRequestType:
+ default: azure_uc_config_post_request
+ description: Type of Azure config Post Request.
+ enum:
+ - azure_uc_config_post_request
+ example: azure_uc_config_post_request
+ type: string
+ x-enum-varnames:
+ - AZURE_UC_CONFIG_POST_REQUEST
+ AzureUCConfigsResponse:
+ description: List of Azure accounts with configs.
+ properties:
+ data:
+ description: An Azure config pair.
+ items:
+ $ref: '#/components/schemas/AzureUCConfigPair'
+ type: array
+ type: object
+ BillConfig:
+ description: Bill config.
+ properties:
+ export_name:
+ description: The name of the configured Azure Export.
+ example: dd-actual-export
+ type: string
+ export_path:
+ description: The path where the Azure Export is saved.
+ example: dd-export-path
+ type: string
+ storage_account:
+ description: The name of the storage account where the Azure Export is saved.
+ example: dd-storage-account
+ type: string
+ storage_container:
+ description: The name of the storage container where the Azure Export is
+ saved.
+ example: dd-storage-container
+ type: string
+ required:
+ - export_name
+ - export_path
+ - storage_account
+ - storage_container
+ type: object
BulkMuteFindingsRequest:
description: The new bulk mute finding request.
properties:
data:
$ref: '#/components/schemas/BulkMuteFindingsRequestData'
@@ -3003,10 +3506,46 @@
enum:
- cloud_configuration
type: string
x-enum-varnames:
- CLOUD_CONFIGURATION
+ CloudCostActivity:
+ description: Cloud Cost Activity.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/CloudCostActivityAttributes'
+ type:
+ $ref: '#/components/schemas/CloudCostActivityType'
+ required:
+ - attributes
+ - type
+ type: object
+ CloudCostActivityAttributes:
+ description: Attributes for Cloud Cost activity.
+ properties:
+ is_enabled:
+ description: Whether or not the cloud account is enabled.
+ example: true
+ type: boolean
+ required:
+ - is_enabled
+ type: object
+ CloudCostActivityResponse:
+ description: Response for Cloud Cost activity.
+ properties:
+ data:
+ $ref: '#/components/schemas/CloudCostActivity'
+ type: object
+ CloudCostActivityType:
+ default: cloud_cost_activity
+ description: Type of Cloud Cost Activity.
+ enum:
+ - cloud_cost_activity
+ example: cloud_cost_activity
+ type: string
+ x-enum-varnames:
+ - CLOUD_COST_ACTIVITY
CloudWorkloadSecurityAgentRuleAttributes:
description: A Cloud Workload Security Agent rule returned by the API.
properties:
agentConstraint:
description: The version of the agent.
@@ -3235,10 +3774,26 @@
type: string
name:
description: The name of the Cloudflare account.
example: test-name
type: string
+ resources:
+ description: An allowlist of resources to restrict pulling metrics for.
+ example:
+ - web
+ - dns
+ items:
+ type: string
+ type: array
+ zones:
+ description: An allowlist of zones to restrict pulling metrics for.
+ example:
+ - zone_id_1
+ - zone_id_2
+ items:
+ type: string
+ type: array
required:
- api_key
- name
type: object
CloudflareAccountCreateRequestData:
@@ -3267,10 +3822,26 @@
type: string
name:
description: The name of the Cloudflare account.
example: test-name
type: string
+ resources:
+ description: An allowlist of resources to restrict pulling metrics for.
+ example:
+ - web
+ - dns
+ items:
+ type: string
+ type: array
+ zones:
+ description: An allowlist of zones to restrict pulling metrics for.
+ example:
+ - zone_id_1
+ - zone_id_2
+ items:
+ type: string
+ type: array
required:
- name
type: object
CloudflareAccountResponseData:
description: Data object of a Cloudflare account.
@@ -3315,10 +3886,26 @@
email:
description: The email associated with the Cloudflare account. If an API
key is provided (and not a token), this field is also required.
example: test-email@example.com
type: string
+ resources:
+ description: An allowlist of resources to restrict pulling metrics for.
+ example:
+ - web
+ - dns
+ items:
+ type: string
+ type: array
+ zones:
+ description: An allowlist of zones to restrict pulling metrics for.
+ example:
+ - zone_id_1
+ - zone_id_2
+ items:
+ type: string
+ type: array
required:
- api_key
type: object
CloudflareAccountUpdateRequestData:
description: Data object for updating a Cloudflare account.
@@ -6391,13 +6978,24 @@
items:
description: Host Filters
type: string
type: array
is_cspm_enabled:
- description: When enabled, Datadog performs configuration checks across
- your Google Cloud environment by continuously scanning every resource.
+ description: 'When enabled, Datadog will activate the Cloud Security Monitoring
+ product for this service account. Note: This requires resource_collection_enabled
+ to be set to true.'
type: boolean
+ is_security_command_center_enabled:
+ default: false
+ description: 'When enabled, Datadog will attempt to collect Security Command
+ Center Findings. Note: This requires additional permissions on the service
+ account.'
+ example: true
+ type: boolean
+ resource_collection_enabled:
+ description: When enabled, Datadog scans for all resources in your GCP environment.
+ type: boolean
type: object
GCPSTSServiceAccountCreateRequest:
description: Data on your newly generated service account.
properties:
data:
@@ -13626,10 +14224,31 @@
$ref: '#/components/schemas/UserTeamPermissionType'
required:
- id
- type
type: object
+ RelationshipToUserTeamTeam:
+ description: Relationship between team membership and team
+ properties:
+ data:
+ $ref: '#/components/schemas/RelationshipToUserTeamTeamData'
+ required:
+ - data
+ type: object
+ RelationshipToUserTeamTeamData:
+ description: The team associated with the membership
+ properties:
+ id:
+ description: The ID of the team associated with the membership
+ example: d7e15d9d-d346-43da-81d8-3d9e71d9a5e9
+ type: string
+ type:
+ $ref: '#/components/schemas/UserTeamTeamType'
+ required:
+ - id
+ - type
+ type: object
RelationshipToUserTeamUser:
description: Relationship between team membership and user
properties:
data:
$ref: '#/components/schemas/RelationshipToUserTeamUserData'
@@ -15043,10 +15662,12 @@
$ref: '#/components/schemas/SecurityMonitoringRuleKeepAlive'
maxSignalDuration:
$ref: '#/components/schemas/SecurityMonitoringRuleMaxSignalDuration'
newValueOptions:
$ref: '#/components/schemas/SecurityMonitoringRuleNewValueOptions'
+ thirdPartyRuleOptions:
+ $ref: '#/components/schemas/SecurityMonitoringRuleThirdPartyOptions'
type: object
SecurityMonitoringRuleQuery:
description: Query for matching rule.
oneOf:
- $ref: '#/components/schemas/SecurityMonitoringStandardRuleQuery'
@@ -15091,10 +15712,34 @@
- INFO
- LOW
- MEDIUM
- HIGH
- CRITICAL
+ SecurityMonitoringRuleThirdPartyOptions:
+ description: Options on third party rules.
+ properties:
+ defaultNotifications:
+ description: Notification targets for the logs that do not correspond to
+ any of the cases.
+ items:
+ description: Notification.
+ type: string
+ type: array
+ defaultStatus:
+ $ref: '#/components/schemas/SecurityMonitoringRuleSeverity'
+ rootQueries:
+ description: Queries to be combined with third party case queries. Each
+ of them can have different group by fields, to aggregate differently based
+ on the type of alert.
+ items:
+ $ref: '#/components/schemas/SecurityMonitoringThirdPartyRootQuery'
+ type: array
+ signalTitleTemplate:
+ description: A template for the signal title; if omitted, the title is generated
+ based on the case name.
+ type: string
+ type: object
SecurityMonitoringRuleTypeCreate:
description: The rule type.
enum:
- application_security
- log_detection
@@ -15160,10 +15805,17 @@
description: Tags for generated signals.
items:
description: Tag.
type: string
type: array
+ thirdPartyCases:
+ description: Cases for generating signals from third party rules. Only available
+ for third party rules.
+ example: []
+ items:
+ $ref: '#/components/schemas/SecurityMonitoringThirdPartyRuleCase'
+ type: array
version:
description: The version of the rule being updated.
example: 1
format: int32
maximum: 2147483647
@@ -15789,10 +16441,17 @@
- team:security
items:
description: Tag.
type: string
type: array
+ thirdPartyCases:
+ description: Cases for generating signals from third party rules. Only available
+ for third party rules.
+ example: []
+ items:
+ $ref: '#/components/schemas/SecurityMonitoringThirdPartyRuleCaseCreate'
+ type: array
type:
$ref: '#/components/schemas/SecurityMonitoringRuleTypeCreate'
required:
- name
- isEnabled
@@ -15910,20 +16569,79 @@
description: Tags for generated signals.
items:
description: Tag.
type: string
type: array
+ thirdPartyCases:
+ description: Cases for generating signals from third party rules. Only available
+ for third party rules.
+ example: []
+ items:
+ $ref: '#/components/schemas/SecurityMonitoringThirdPartyRuleCase'
+ type: array
type:
$ref: '#/components/schemas/SecurityMonitoringRuleTypeRead'
updateAuthorId:
description: User ID of the user who updated the rule.
format: int64
type: integer
version:
description: The version of the rule.
format: int64
type: integer
+ SecurityMonitoringThirdPartyRootQuery:
+ description: A query to be combined with the third party case query.
+ properties:
+ groupByFields:
+ description: Fields to group by.
+ items:
+ description: Field.
+ type: string
+ type: array
+ query:
+ description: Query to run on logs.
+ example: source:cloudtrail
+ type: string
+ type: object
+ SecurityMonitoringThirdPartyRuleCase:
+ description: Case when signal is generated by a third party rule.
+ properties:
+ name:
+ description: Name of the case.
+ type: string
+ notifications:
+ description: Notification targets for each rule case.
+ items:
+ description: Notification.
+ type: string
+ type: array
+ query:
+ description: A query to map a third party event to this case.
+ type: string
+ status:
+ $ref: '#/components/schemas/SecurityMonitoringRuleSeverity'
+ type: object
+ SecurityMonitoringThirdPartyRuleCaseCreate:
+ description: Case when a signal is generated by a third party rule.
+ properties:
+ name:
+ description: Name of the case.
+ type: string
+ notifications:
+ description: Notification targets for each rule case.
+ items:
+ description: Notification.
+ type: string
+ type: array
+ query:
+ description: A query to map a third party event to this case.
+ type: string
+ status:
+ $ref: '#/components/schemas/SecurityMonitoringRuleSeverity'
+ required:
+ - status
+ type: object
SecurityMonitoringTriageUser:
description: Object representing a given user entity.
properties:
handle:
description: The handle for this user account.
@@ -16206,10 +16924,48 @@
description: Update group response.
properties:
meta:
$ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly'
type: object
+ SensitiveDataScannerIncludedKeywordConfiguration:
+ description: 'Object defining a set of keywords and a number of characters that
+ help reduce noise.
+
+ You can provide a list of keywords you would like to check within a defined
+ proximity of the matching pattern.
+
+ If any of the keywords are found within the proximity check, the match is
+ kept.
+
+ If none are found, the match is discarded.'
+ properties:
+ character_count:
+ description: 'The number of characters behind a match detected by Sensitive
+ Data Scanner to look for the keywords defined.
+
+ `character_count` should be greater than the maximum length of a keyword
+ defined for a rule.'
+ example: 30
+ format: int64
+ maximum: 50
+ minimum: 1
+ 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.'
+ example:
+ - credit card
+ - cc
+ items:
+ type: string
+ type: array
+ required:
+ - keywords
+ - character_count
+ type: object
SensitiveDataScannerMeta:
description: Meta response containing information about the API.
properties:
count_limit:
description: Maximum number of scanning rules allowed for the org.
@@ -16299,10 +17055,12 @@
example:
- admin.name
items:
type: string
type: array
+ included_keyword_configuration:
+ $ref: '#/components/schemas/SensitiveDataScannerIncludedKeywordConfiguration'
is_enabled:
description: Whether or not the rule is enabled.
type: boolean
name:
description: Name of the rule.
@@ -16318,10 +17076,16 @@
type: string
type: array
pattern:
description: Not included if there is a relationship to a standard pattern.
type: string
+ priority:
+ description: Integer from 1 (high) to 5 (low) indicating rule issue severity.
+ format: int64
+ maximum: 5
+ minimum: 1
+ type: integer
tags:
description: List of tags.
items:
type: string
type: array
@@ -16473,10 +17237,17 @@
description: Name of the standard pattern.
type: string
pattern:
description: Regex to match.
type: string
+ priority:
+ description: Integer from 1 (high) to 5 (low) indicating standard pattern
+ issue severity.
+ format: int64
+ maximum: 5
+ minimum: 1
+ type: integer
tags:
description: List of tags.
items:
type: string
type: array
@@ -19587,10 +20358,24 @@
- type
type: object
UserTeamAttributes:
description: Team membership attributes
properties:
+ provisioned_by:
+ description: 'The mechanism responsible for provisioning the team relationship.
+
+ Possible values: null for added by a user, "service_account" if added
+ by a service account, and "saml_mapping" if provisioned via SAML mapping.'
+ nullable: true
+ readOnly: true
+ type: string
+ provisioned_by_id:
+ description: UUID of the User or Service Account who provisioned this team
+ membership, or null if provisioned via SAML mapping.
+ nullable: true
+ readOnly: true
+ type: string
role:
$ref: '#/components/schemas/UserTeamRole'
type: object
UserTeamCreate:
description: A user's relationship with a team
@@ -19638,10 +20423,12 @@
x-enum-varnames:
- USER_TEAM_PERMISSIONS
UserTeamRelationships:
description: Relationship between membership and a user
properties:
+ team:
+ $ref: '#/components/schemas/RelationshipToUserTeamTeam'
user:
$ref: '#/components/schemas/RelationshipToUserTeamUser'
type: object
UserTeamRequest:
description: Team membership request
@@ -19663,10 +20450,19 @@
- admin
nullable: true
type: string
x-enum-varnames:
- ADMIN
+ UserTeamTeamType:
+ default: team
+ description: User team team type
+ enum:
+ - team
+ example: team
+ type: string
+ x-enum-varnames:
+ - TEAM
UserTeamType:
default: team_memberships
description: Team membership type
enum:
- team_memberships
@@ -20897,13 +21693,10 @@
- apiKeyAuth: []
summary: Send pipeline event
tags:
- CI Visibility Pipelines
x-codegen-request-body-name: body
- x-unstable: '**Note:** This endpoint is in public beta.
-
- If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
/api/v2/ci/pipelines/analytics/aggregate:
post:
description: Use this API endpoint to aggregate CI Visibility pipeline events
into buckets of computed metrics and timeseries.
operationId: AggregateCIAppPipelineEvents
@@ -21374,10 +22167,335 @@
x-pagination:
cursorParam: page[cursor]
cursorPath: meta.pagination.next_cursor
limitParam: page[size]
resultsPath: data
+ /api/v2/cost/aws_cur_config:
+ get:
+ description: List the AWS CUR configs.
+ operationId: ListCostAWSCURConfigs
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AwsCURConfigsResponse'
+ description: OK
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/APIErrorResponse'
+ description: Forbidden
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ summary: List Cloud Cost Management AWS CUR configs
+ tags:
+ - Cloud Cost Management
+ x-permission:
+ operator: OR
+ permissions:
+ - CLOUD_COST_MANAGEMENT_READ
+ post:
+ description: Create a Cloud Cost Management account for an AWS CUR config.
+ operationId: CreateCostAWSCURConfig
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AwsCURConfigPostRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AwsCURConfigResponse'
+ 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'
+ summary: Create Cloud Cost Management AWS CUR config
+ tags:
+ - Cloud Cost Management
+ x-permission:
+ operator: OR
+ permissions:
+ - CLOUD_COST_MANAGEMENT_WRITE
+ /api/v2/cost/aws_cur_config/{cloud_account_id}:
+ delete:
+ description: Archive a Cloud Cost Management Account.
+ operationId: DeleteCostAWSCURConfig
+ parameters:
+ - $ref: '#/components/parameters/CloudAccountID'
+ responses:
+ '204':
+ description: No Content
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/APIErrorResponse'
+ description: Bad Request
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/APIErrorResponse'
+ description: Not Found
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ summary: Delete Cloud Cost Management AWS CUR config
+ tags:
+ - Cloud Cost Management
+ x-permission:
+ operator: OR
+ permissions:
+ - CLOUD_COST_MANAGEMENT_WRITE
+ patch:
+ description: Update the status of an AWS CUR config (active/archived).
+ operationId: UpdateCostAWSCURConfig
+ parameters:
+ - $ref: '#/components/parameters/CloudAccountID'
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AwsCURConfigPatchRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AwsCURConfigsResponse'
+ description: OK
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/APIErrorResponse'
+ description: Forbidden
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ summary: Update Cloud Cost Management AWS CUR config
+ tags:
+ - Cloud Cost Management
+ x-permission:
+ operator: OR
+ permissions:
+ - CLOUD_COST_MANAGEMENT_WRITE
+ /api/v2/cost/aws_related_accounts:
+ get:
+ description: List the AWS accounts in an organization by calling 'organizations:ListAccounts'
+ from the specified management account.
+ operationId: ListAWSRelatedAccounts
+ parameters:
+ - description: The ID of the management account to filter by.
+ example: '123456789123'
+ in: query
+ name: filter[management_account_id]
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AWSRelatedAccountsResponse'
+ 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'
+ summary: List related AWS accounts
+ tags:
+ - Cloud Cost Management
+ x-permission:
+ operator: OR
+ permissions:
+ - CLOUD_COST_MANAGEMENT_READ
+ /api/v2/cost/azure_uc_config:
+ get:
+ description: List the Azure configs.
+ operationId: ListCostAzureUCConfigs
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AzureUCConfigsResponse'
+ description: OK
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/APIErrorResponse'
+ description: Forbidden
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ summary: List Cloud Cost Management Azure configs
+ tags:
+ - Cloud Cost Management
+ x-permission:
+ operator: OR
+ permissions:
+ - CLOUD_COST_MANAGEMENT_READ
+ post:
+ description: Create a Cloud Cost Management account for an Azure config.
+ operationId: CreateCostAzureUCConfigs
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AzureUCConfigPostRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AzureUCConfigPairsResponse'
+ 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'
+ summary: Create Cloud Cost Management Azure configs
+ tags:
+ - Cloud Cost Management
+ x-permission:
+ operator: OR
+ permissions:
+ - CLOUD_COST_MANAGEMENT_WRITE
+ /api/v2/cost/azure_uc_config/{cloud_account_id}:
+ delete:
+ description: Archive a Cloud Cost Management Account.
+ operationId: DeleteCostAzureUCConfig
+ parameters:
+ - $ref: '#/components/parameters/CloudAccountID'
+ responses:
+ '204':
+ description: No Content
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/APIErrorResponse'
+ description: Bad Request
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/APIErrorResponse'
+ description: Not Found
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ summary: Delete Cloud Cost Management Azure config
+ tags:
+ - Cloud Cost Management
+ x-permission:
+ operator: OR
+ permissions:
+ - CLOUD_COST_MANAGEMENT_WRITE
+ patch:
+ description: Update the status of an Azure config (active/archived).
+ operationId: UpdateCostAzureUCConfigs
+ parameters:
+ - $ref: '#/components/parameters/CloudAccountID'
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AzureUCConfigPatchRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AzureUCConfigPairsResponse'
+ 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'
+ summary: Update Cloud Cost Management Azure config
+ tags:
+ - Cloud Cost Management
+ x-permission:
+ operator: OR
+ permissions:
+ - CLOUD_COST_MANAGEMENT_WRITE
+ /api/v2/cost/enabled:
+ get:
+ description: Get the Cloud Cost Management activity.
+ operationId: GetCloudCostActivity
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CloudCostActivityResponse'
+ description: OK
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/APIErrorResponse'
+ description: Forbidden
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ summary: Cloud Cost Enabled
+ tags:
+ - Cloud Cost Management
+ x-permission:
+ operator: OR
+ permissions:
+ - CLOUD_COST_MANAGEMENT_READ
/api/v2/cost_by_tag/active_billing_dimensions:
get:
description: Get active billing dimensions for cost attribution. Cost data for
a given month becomes available no later than the 17th of the following month.
operationId: GetActiveBillingDimensions
@@ -21945,12 +23063,11 @@
- apiKeyAuth: []
summary: Send a deployment event for DORA Metrics
tags:
- DORA Metrics
x-codegen-request-body-name: body
- x-unstable: '**Note**: This endpoint is in private beta for CI Pipeline Visibility
- customers.
+ x-unstable: '**Note**: This endpoint is in private beta.
If you want to request access, complete the [form](https://forms.gle/Eqq6uXfGjYxmqpjDA).'
/api/v2/dora/incident:
post:
description: 'Use this API endpoint to provide data about incidents for DORA
@@ -21996,12 +23113,11 @@
- apiKeyAuth: []
summary: Send an incident event for DORA Metrics
tags:
- DORA Metrics
x-codegen-request-body-name: body
- x-unstable: '**Note**: This endpoint is in private beta for CI Pipeline Visibility
- customers.
+ x-unstable: '**Note**: This endpoint is in private beta.
If you want to request access, complete the [form](https://forms.gle/Eqq6uXfGjYxmqpjDA).'
/api/v2/downtime:
get:
description: Get all scheduled downtimes.
@@ -25107,12 +26223,12 @@
in: query
name: filter[include_percentiles]
required: false
schema:
type: boolean
- - description: 'Filter custom metrics that have or have not been queried in
- the specified window[seconds].
+ - description: '(Beta) Filter custom metrics that have or have not been queried
+ in the specified window[seconds].
If no window is provided or the window is less than 2 hours, a default of
2 hours will be applied.'
example: true
in: query
@@ -25576,11 +26692,13 @@
from an allow-list to a deny-list, and tags in the defined list will not be
queryable.
Can only be used with application keys from users with the `Manage Tags for
- Metrics` permission.'
+ Metrics` permission. This endpoint requires
+
+ a tag configuration to be created first.'
operationId: UpdateTagConfiguration
parameters:
- $ref: '#/components/parameters/MetricName'
requestBody:
content:
@@ -25929,10 +27047,20 @@
name: monitor_id
required: true
schema:
format: int64
type: integer
+ - $ref: '#/components/parameters/PageOffset'
+ - description: Maximum number of downtimes in the response.
+ example: 100
+ in: query
+ name: page[limit]
+ required: false
+ schema:
+ default: 30
+ format: int64
+ type: integer
responses:
'200':
content:
application/json:
schema:
@@ -25953,10 +27081,14 @@
- monitors_downtime
summary: Get active downtimes for a monitor
tags:
- Downtimes
x-codegen-request-body-name: body
+ x-pagination:
+ limitParam: page[limit]
+ pageOffsetParam: page[offset]
+ resultsPath: data
/api/v2/permissions:
get:
description: Returns a list of all permissions, including name, description,
and ID.
operationId: ListPermissions
@@ -26542,14 +27674,13 @@
summary: Query scalar data across multiple products
tags:
- Metrics
x-codegen-request-body-name: body
x-unstable: '**Note**: This endpoint is GA for Metrics, Real User Monitoring
- (RUM), and Cloud Cost Management data sources.
+ (RUM), Cloud Cost Management, and Log Management data sources.
- Support for logs is in beta. We are gradually onboarding support for more
- sources. If you have any
+ We are gradually onboarding support for more sources. If you have any
feedback, contact [Datadog Support](https://docs.datadoghq.com/help/).'
/api/v2/query/timeseries:
post:
description: 'Query timeseries data across various data sources and
@@ -26585,14 +27716,13 @@
summary: Query timeseries data across multiple products
tags:
- Metrics
x-codegen-request-body-name: body
x-unstable: '**Note**: This endpoint is GA for Metrics, Real User Monitoring
- (RUM), and Cloud Cost Management data sources.
+ (RUM), Cloud Cost Management, and Log Management data sources.
- Support for logs is in beta. We are gradually onboarding support for more
- sources. If you have any
+ We are gradually onboarding support for more sources. If you have any
feedback, contact [Datadog Support](https://docs.datadoghq.com/help/).'
/api/v2/restriction_policy/{resource_id}:
delete:
description: Deletes the restriction policy associated with a specified resource.
@@ -31680,9 +32810,12 @@
- description: Search or aggregate your CI Visibility pipeline events and send them
to your Datadog site over HTTP.
name: CI Visibility Pipelines
- description: Search or aggregate your CI Visibility test events over HTTP.
name: CI Visibility Tests
+- description: The Cloud Cost Management API allows you to setup, edit and delete
+ cloud cost management accounts for AWS & Azure.
+ name: Cloud Cost Management
- description: Workload activity security rules for generating events using the Datadog
security Agent.
name: Cloud Workload Security
- description: Configure your Datadog Cloudflare integration directly through the
Datadog API.