datadog_api_client 2.18.0 → 2.20.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.apigentools-info +4 -4
- data/.generator/conftest.py +1 -1
- data/.generator/poetry.lock +69 -69
- data/.generator/schemas/v1/openapi.yaml +286 -55
- data/.generator/schemas/v2/openapi.yaml +2021 -226
- data/.generator/src/generator/templates/api.j2 +5 -5
- data/.generator/src/generator/templates/model_generic.j2 +2 -2
- data/CHANGELOG.md +38 -0
- data/examples/v1/azure-integration/CreateAzureIntegration.rb +4 -4
- data/examples/v1/azure-integration/DeleteAzureIntegration.rb +2 -15
- data/examples/v1/azure-integration/UpdateAzureIntegration.rb +4 -4
- data/examples/v1/gcp-integration/CreateGCPIntegration.rb +4 -5
- data/examples/v1/gcp-integration/DeleteGCPIntegration.rb +2 -14
- data/examples/v1/gcp-integration/UpdateGCPIntegration.rb +4 -5
- data/examples/v1/logs-indexes/CreateLogsIndex.rb +5 -0
- data/examples/v1/logs-indexes/UpdateLogsIndex.rb +5 -0
- data/examples/v1/service-level-objectives/CreateSLO_3765703239.rb +46 -0
- data/examples/v1/synthetics/CreateSyntheticsAPITest.rb +1 -1
- data/examples/v1/synthetics/CreateSyntheticsBrowserTest.rb +1 -1
- data/examples/v1/synthetics/TriggerCITests.rb +1 -1
- data/examples/v1/synthetics/UpdateBrowserTest.rb +1 -1
- data/examples/v1/usage-metering/GetUsageLambda.rb +5 -2
- data/examples/v2/api-management/CreateOpenAPI.rb +11 -0
- data/examples/v2/api-management/DeleteOpenAPI.rb +11 -0
- data/examples/v2/api-management/GetOpenAPI.rb +11 -0
- data/examples/v2/api-management/UpdateOpenAPI.rb +14 -0
- data/examples/v2/ci-visibility-pipelines/CreateCIAppPipelineEvent.rb +0 -3
- data/examples/v2/ci-visibility-pipelines/CreateCIAppPipelineEvent_129899466.rb +0 -3
- data/examples/v2/cloud-cost-management/CreateCostAWSCURConfig.rb +18 -0
- data/examples/v2/cloud-cost-management/CreateCostAzureUCConfigs.rb +29 -0
- data/examples/v2/cloud-cost-management/DeleteCostAWSCURConfig.rb +5 -0
- data/examples/v2/cloud-cost-management/DeleteCostAzureUCConfig.rb +5 -0
- data/examples/v2/cloud-cost-management/GetCloudCostActivity.rb +5 -0
- data/examples/v2/cloud-cost-management/ListAWSRelatedAccounts.rb +5 -0
- data/examples/v2/cloud-cost-management/ListCostAWSCURConfigs.rb +5 -0
- data/examples/v2/cloud-cost-management/ListCostAzureUCConfigs.rb +5 -0
- data/examples/v2/cloud-cost-management/UpdateCostAWSCURConfig.rb +14 -0
- data/examples/v2/cloud-cost-management/UpdateCostAzureUCConfigs.rb +14 -0
- data/examples/v2/cloudflare-integration/CreateCloudflareAccount.rb +1 -1
- data/examples/v2/cloudflare-integration/UpdateCloudflareAccount.rb +4 -1
- data/examples/v2/downtimes/ListMonitorDowntimes_3316718253.rb +5 -0
- data/examples/v2/gcp-integration/CreateGCPSTSAccount_130557025.rb +16 -0
- data/examples/v2/gcp-integration/CreateGCPSTSAccount_2597004741.rb +16 -0
- data/examples/v2/gcp-integration/CreateGCPSTSAccount_4235664992.rb +17 -0
- data/examples/v2/gcp-integration/UpdateGCPSTSAccount_3205636354.rb +19 -0
- data/examples/v2/okta-integration/CreateOktaAccount.rb +1 -1
- data/examples/v2/security-monitoring/CreateSecurityMonitoringRule_3367706049.rb +46 -0
- data/examples/v2/security-monitoring/CreateSecurityMonitoringSuppression.rb +19 -0
- data/examples/v2/security-monitoring/DeleteSecurityMonitoringSuppression.rb +8 -0
- data/examples/v2/security-monitoring/GetSecurityMonitoringSuppression.rb +8 -0
- data/examples/v2/security-monitoring/ListSecurityMonitoringSuppressions.rb +5 -0
- data/examples/v2/security-monitoring/UpdateSecurityMonitoringSuppression.rb +17 -0
- data/examples/v2/sensitive-data-scanner/CreateScanningRule.rb +7 -0
- data/examples/v2/sensitive-data-scanner/UpdateScanningRule.rb +7 -10
- data/examples/v2/teams/CreateTeamMembership.rb +6 -0
- data/examples/v2/teams/GetTeamMemberships_3799131168.rb +8 -0
- data/examples/v2/usage-metering/GetUsageLambdaTracedInvocations.rb +1 -1
- data/lib/datadog_api_client/configuration.rb +4 -1
- data/lib/datadog_api_client/inflector.rb +74 -0
- data/lib/datadog_api_client/v1/api/downtimes_api.rb +28 -7
- data/lib/datadog_api_client/v1/api/monitors_api.rb +1 -1
- data/lib/datadog_api_client/v1/api/organizations_api.rb +1 -1
- data/lib/datadog_api_client/v1/api/usage_metering_api.rb +3 -3
- data/lib/datadog_api_client/v1/models/dashboard.rb +5 -1
- data/lib/datadog_api_client/v1/models/dashboard_summary_definition.rb +2 -0
- data/lib/datadog_api_client/v1/models/gcp_account.rb +22 -2
- data/lib/datadog_api_client/v1/models/log.rb +1 -1
- data/lib/datadog_api_client/v1/models/logs_daily_limit_reset.rb +90 -0
- data/lib/datadog_api_client/v1/models/logs_index.rb +36 -1
- data/lib/datadog_api_client/v1/models/logs_index_update_request.rb +36 -1
- data/lib/datadog_api_client/v1/models/metrics_payload.rb +1 -1
- data/lib/datadog_api_client/v1/models/metrics_query_metadata.rb +1 -1
- data/lib/datadog_api_client/v1/models/organization.rb +1 -1
- data/lib/datadog_api_client/v1/models/service_level_objective.rb +11 -1
- data/lib/datadog_api_client/v1/models/service_level_objective_request.rb +11 -1
- data/lib/datadog_api_client/v1/models/slo_correction_create_request_attributes.rb +1 -1
- data/lib/datadog_api_client/v1/models/slo_correction_response_attributes.rb +1 -1
- data/lib/datadog_api_client/v1/models/slo_correction_update_request_attributes.rb +1 -1
- data/lib/datadog_api_client/v1/models/slo_data_source_query_definition.rb +62 -0
- data/lib/datadog_api_client/v1/models/slo_formula.rb +98 -0
- data/lib/datadog_api_client/v1/models/slo_history_metrics.rb +2 -2
- data/lib/datadog_api_client/v1/models/slo_history_metrics_series.rb +1 -1
- data/lib/datadog_api_client/v1/models/slo_history_monitor.rb +1 -1
- data/lib/datadog_api_client/v1/models/slo_history_sli_data.rb +1 -1
- data/lib/datadog_api_client/v1/models/slo_response_data.rb +11 -1
- data/lib/datadog_api_client/v1/models/slo_sli_spec.rb +62 -0
- data/lib/datadog_api_client/v1/models/slo_time_slice_comparator.rb +29 -0
- data/lib/datadog_api_client/v1/models/slo_time_slice_condition.rb +141 -0
- data/lib/datadog_api_client/v1/models/slo_time_slice_query.rb +131 -0
- data/lib/datadog_api_client/v1/models/slo_time_slice_spec.rb +99 -0
- data/lib/datadog_api_client/v1/models/slo_type.rb +1 -0
- data/lib/datadog_api_client/v1/models/slo_type_numeric.rb +1 -0
- data/lib/datadog_api_client/v1/models/split_config.rb +6 -6
- data/lib/datadog_api_client/v1/models/synthetics_test_request.rb +11 -1
- data/lib/datadog_api_client/v1/models/usage_lambda_hour.rb +1 -1
- data/lib/datadog_api_client/v1/models/usage_lambda_response.rb +1 -1
- data/lib/datadog_api_client/v1/models/usage_summary_date.rb +11 -1
- data/lib/datadog_api_client/v1/models/usage_summary_date_org.rb +11 -1
- data/lib/datadog_api_client/v1/models/usage_summary_response.rb +11 -1
- data/lib/datadog_api_client/v2/api/api_management_api.rb +319 -0
- data/lib/datadog_api_client/v2/api/ci_visibility_pipelines_api.rb +0 -6
- data/lib/datadog_api_client/v2/api/cloud_cost_management_api.rb +680 -0
- data/lib/datadog_api_client/v2/api/downtimes_api.rb +25 -0
- data/lib/datadog_api_client/v2/api/metrics_api.rb +3 -2
- data/lib/datadog_api_client/v2/api/organizations_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/security_monitoring_api.rb +329 -0
- data/lib/datadog_api_client/v2/api/teams_api.rb +22 -0
- data/lib/datadog_api_client/v2/api/usage_metering_api.rb +3 -3
- data/lib/datadog_api_client/v2/models/aws_cur_config.rb +129 -0
- data/lib/datadog_api_client/v2/models/aws_cur_config_attributes.rb +305 -0
- data/lib/datadog_api_client/v2/models/aws_cur_config_patch_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/aws_cur_config_patch_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/aws_cur_config_patch_request_attributes.rb +98 -0
- data/lib/datadog_api_client/v2/models/aws_cur_config_patch_request_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/aws_cur_config_post_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/aws_cur_config_post_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/aws_cur_config_post_request_attributes.rb +202 -0
- data/lib/datadog_api_client/v2/models/aws_cur_config_post_request_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/aws_cur_config_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/aws_cur_config_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/aws_cur_configs_response.rb +82 -0
- data/lib/datadog_api_client/v2/models/aws_related_account.rb +129 -0
- data/lib/datadog_api_client/v2/models/aws_related_account_attributes.rb +90 -0
- data/lib/datadog_api_client/v2/models/aws_related_account_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/aws_related_accounts_response.rb +82 -0
- data/lib/datadog_api_client/v2/models/azure_uc_config.rb +378 -0
- data/lib/datadog_api_client/v2/models/azure_uc_config_pair.rb +129 -0
- data/lib/datadog_api_client/v2/models/azure_uc_config_pair_attributes.rb +110 -0
- data/lib/datadog_api_client/v2/models/azure_uc_config_pair_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/azure_uc_config_pairs_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/azure_uc_config_patch_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/azure_uc_config_patch_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/azure_uc_config_patch_request_attributes.rb +98 -0
- data/lib/datadog_api_client/v2/models/azure_uc_config_patch_request_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/azure_uc_config_post_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/azure_uc_config_post_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/azure_uc_config_post_request_attributes.rb +192 -0
- data/lib/datadog_api_client/v2/models/azure_uc_config_post_request_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/azure_uc_configs_response.rb +82 -0
- data/lib/datadog_api_client/v2/models/bill_config.rb +161 -0
- data/lib/datadog_api_client/v2/models/ci_app_git_info.rb +2 -2
- data/lib/datadog_api_client/v2/models/cloud_cost_activity.rb +119 -0
- data/lib/datadog_api_client/v2/models/cloud_cost_activity_attributes.rb +98 -0
- data/lib/datadog_api_client/v2/models/cloud_cost_activity_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/cloud_cost_activity_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/cloudflare_account_create_request_attributes.rb +28 -4
- data/lib/datadog_api_client/v2/models/cloudflare_account_response_attributes.rb +28 -4
- data/lib/datadog_api_client/v2/models/cloudflare_account_update_request_attributes.rb +28 -4
- data/lib/datadog_api_client/v2/models/create_open_api_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/create_open_api_response_attributes.rb +82 -0
- data/lib/datadog_api_client/v2/models/create_open_api_response_data.rb +90 -0
- data/lib/datadog_api_client/v2/models/dora_deployment_request_attributes.rb +11 -1
- data/lib/datadog_api_client/v2/models/dora_git_info.rb +2 -2
- data/lib/datadog_api_client/v2/models/dora_incident_request_attributes.rb +11 -1
- data/lib/datadog_api_client/v2/models/gcpsts_service_account_attributes.rb +25 -5
- data/lib/datadog_api_client/v2/models/metric_payload.rb +1 -1
- data/lib/datadog_api_client/v2/models/open_api_endpoint.rb +90 -0
- data/lib/datadog_api_client/v2/models/open_api_file.rb +80 -0
- data/lib/datadog_api_client/v2/models/relationship_to_user_team_team.rb +98 -0
- data/lib/datadog_api_client/v2/models/relationship_to_user_team_team_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_options.rb +14 -4
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_third_party_options.rb +114 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb +13 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_create_payload.rb +13 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_response.rb +13 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_suppression.rb +100 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_suppression_attributes.rb +198 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_suppression_create_attributes.rb +181 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_suppression_create_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_suppression_create_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_suppression_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_suppression_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_suppression_update_attributes.rb +166 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_suppression_update_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_suppression_update_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_suppressions_response.rb +82 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_third_party_root_query.rb +92 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_third_party_rule_case.rb +112 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_third_party_rule_case_create.rb +130 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_user.rb +98 -0
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_included_keyword_configuration.rb +134 -0
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_rule_attributes.rb +46 -1
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_standard_pattern_attributes.rb +33 -1
- data/lib/datadog_api_client/v2/models/update_open_api_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/update_open_api_response_attributes.rb +82 -0
- data/lib/datadog_api_client/v2/models/update_open_api_response_data.rb +90 -0
- data/lib/datadog_api_client/v2/models/user_team_attributes.rb +24 -1
- data/lib/datadog_api_client/v2/models/user_team_relationships.rb +11 -1
- data/lib/datadog_api_client/v2/models/user_team_team_type.rb +26 -0
- data/lib/datadog_api_client/version.rb +1 -1
- metadata +103 -3
- data/examples/v1/usage-metering/GetUsageLambda_3132428705.rb +0 -8
@@ -151,6 +151,13 @@ components:
|
|
151
151
|
required: true
|
152
152
|
schema:
|
153
153
|
type: string
|
154
|
+
CloudAccountID:
|
155
|
+
description: Cloud Account id.
|
156
|
+
in: path
|
157
|
+
name: cloud_account_id
|
158
|
+
required: true
|
159
|
+
schema:
|
160
|
+
type: string
|
154
161
|
CloudWorkloadSecurityAgentRuleID:
|
155
162
|
description: The ID of the Agent rule.
|
156
163
|
example: 3b5-v82-ns6
|
@@ -425,6 +432,13 @@ components:
|
|
425
432
|
required: true
|
426
433
|
schema:
|
427
434
|
type: string
|
435
|
+
SecurityMonitoringSuppressionID:
|
436
|
+
description: The ID of the suppression rule
|
437
|
+
in: path
|
438
|
+
name: suppression_id
|
439
|
+
required: true
|
440
|
+
schema:
|
441
|
+
type: string
|
428
442
|
SensitiveDataScannerGroupID:
|
429
443
|
description: The ID of a group of rules.
|
430
444
|
in: path
|
@@ -741,6 +755,49 @@ components:
|
|
741
755
|
type: string
|
742
756
|
x-enum-varnames:
|
743
757
|
- API_KEYS
|
758
|
+
AWSRelatedAccount:
|
759
|
+
description: AWS related account.
|
760
|
+
properties:
|
761
|
+
attributes:
|
762
|
+
$ref: '#/components/schemas/AWSRelatedAccountAttributes'
|
763
|
+
id:
|
764
|
+
description: The AWS account ID.
|
765
|
+
example: '123456789123'
|
766
|
+
type: string
|
767
|
+
type:
|
768
|
+
$ref: '#/components/schemas/AWSRelatedAccountType'
|
769
|
+
required:
|
770
|
+
- id
|
771
|
+
- type
|
772
|
+
type: object
|
773
|
+
AWSRelatedAccountAttributes:
|
774
|
+
description: Attributes for an AWS related account.
|
775
|
+
properties:
|
776
|
+
has_datadog_integration:
|
777
|
+
description: Whether or not the AWS account has a Datadog integration.
|
778
|
+
type: boolean
|
779
|
+
name:
|
780
|
+
description: The name of the AWS account.
|
781
|
+
type: string
|
782
|
+
type: object
|
783
|
+
AWSRelatedAccountType:
|
784
|
+
default: aws_account
|
785
|
+
description: Type of AWS related account.
|
786
|
+
enum:
|
787
|
+
- aws_account
|
788
|
+
example: aws_account
|
789
|
+
type: string
|
790
|
+
x-enum-varnames:
|
791
|
+
- AWS_ACCOUNT
|
792
|
+
AWSRelatedAccountsResponse:
|
793
|
+
description: List of AWS related accounts.
|
794
|
+
properties:
|
795
|
+
data:
|
796
|
+
description: An AWS related account.
|
797
|
+
items:
|
798
|
+
$ref: '#/components/schemas/AWSRelatedAccount'
|
799
|
+
type: array
|
800
|
+
type: object
|
744
801
|
ActiveBillingDimensionsAttributes:
|
745
802
|
description: List of active billing dimensions.
|
746
803
|
properties:
|
@@ -782,6 +839,11 @@ components:
|
|
782
839
|
type: string
|
783
840
|
x-enum-varnames:
|
784
841
|
- BILLING_DIMENSIONS
|
842
|
+
ApiID:
|
843
|
+
description: API identifier.
|
844
|
+
example: 90646597-5fdb-4a17-a240-647003f8c028
|
845
|
+
format: uuid
|
846
|
+
type: string
|
785
847
|
ApmRetentionFilterType:
|
786
848
|
default: apm_retention_filter
|
787
849
|
description: The type of the resource.
|
@@ -1369,6 +1431,459 @@ components:
|
|
1369
1431
|
type: string
|
1370
1432
|
x-enum-varnames:
|
1371
1433
|
- AUTHN_MAPPINGS
|
1434
|
+
AwsCURConfig:
|
1435
|
+
description: AWS CUR config.
|
1436
|
+
properties:
|
1437
|
+
attributes:
|
1438
|
+
$ref: '#/components/schemas/AwsCURConfigAttributes'
|
1439
|
+
id:
|
1440
|
+
description: The ID of the AWS CUR config.
|
1441
|
+
format: int64
|
1442
|
+
type: integer
|
1443
|
+
type:
|
1444
|
+
$ref: '#/components/schemas/AwsCURConfigType'
|
1445
|
+
required:
|
1446
|
+
- attributes
|
1447
|
+
- type
|
1448
|
+
type: object
|
1449
|
+
AwsCURConfigAttributes:
|
1450
|
+
description: Attributes for An AWS CUR config.
|
1451
|
+
properties:
|
1452
|
+
account_id:
|
1453
|
+
description: The AWS account ID.
|
1454
|
+
example: '123456789123'
|
1455
|
+
type: string
|
1456
|
+
bucket_name:
|
1457
|
+
description: The AWS bucket name used to store the Cost and Usage Report.
|
1458
|
+
example: dd-cost-bucket
|
1459
|
+
type: string
|
1460
|
+
bucket_region:
|
1461
|
+
description: The region the bucket is located in.
|
1462
|
+
example: us-east-1
|
1463
|
+
type: string
|
1464
|
+
created_at:
|
1465
|
+
description: The timestamp when the AWS CUR config was created.
|
1466
|
+
pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}$
|
1467
|
+
type: string
|
1468
|
+
error_messages:
|
1469
|
+
description: The error messages for the AWS CUR config.
|
1470
|
+
items:
|
1471
|
+
type: string
|
1472
|
+
type: array
|
1473
|
+
months:
|
1474
|
+
deprecated: true
|
1475
|
+
description: The number of months the report has been backfilled.
|
1476
|
+
format: int32
|
1477
|
+
maximum: 36
|
1478
|
+
type: integer
|
1479
|
+
report_name:
|
1480
|
+
description: The name of the Cost and Usage Report.
|
1481
|
+
example: dd-report-name
|
1482
|
+
type: string
|
1483
|
+
report_prefix:
|
1484
|
+
description: The report prefix used for the Cost and Usage Report.
|
1485
|
+
example: dd-report-prefix
|
1486
|
+
type: string
|
1487
|
+
status:
|
1488
|
+
description: The status of the AWS CUR.
|
1489
|
+
example: active
|
1490
|
+
type: string
|
1491
|
+
status_updated_at:
|
1492
|
+
description: The timestamp when the AWS CUR config status was updated.
|
1493
|
+
pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}$
|
1494
|
+
type: string
|
1495
|
+
updated_at:
|
1496
|
+
description: The timestamp when the AWS CUR config status was updated.
|
1497
|
+
pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}$
|
1498
|
+
type: string
|
1499
|
+
required:
|
1500
|
+
- account_id
|
1501
|
+
- bucket_name
|
1502
|
+
- bucket_region
|
1503
|
+
- report_name
|
1504
|
+
- report_prefix
|
1505
|
+
- status
|
1506
|
+
type: object
|
1507
|
+
AwsCURConfigPatchData:
|
1508
|
+
description: AWS CUR config Patch data.
|
1509
|
+
properties:
|
1510
|
+
attributes:
|
1511
|
+
$ref: '#/components/schemas/AwsCURConfigPatchRequestAttributes'
|
1512
|
+
type:
|
1513
|
+
$ref: '#/components/schemas/AwsCURConfigPatchRequestType'
|
1514
|
+
required:
|
1515
|
+
- attributes
|
1516
|
+
- type
|
1517
|
+
type: object
|
1518
|
+
AwsCURConfigPatchRequest:
|
1519
|
+
description: AWS CUR config Patch Request.
|
1520
|
+
properties:
|
1521
|
+
data:
|
1522
|
+
$ref: '#/components/schemas/AwsCURConfigPatchData'
|
1523
|
+
required:
|
1524
|
+
- data
|
1525
|
+
type: object
|
1526
|
+
AwsCURConfigPatchRequestAttributes:
|
1527
|
+
description: Attributes for AWS CUR config Patch Request.
|
1528
|
+
properties:
|
1529
|
+
is_enabled:
|
1530
|
+
description: Whether or not the Cloud Cost Management account is enabled.
|
1531
|
+
example: true
|
1532
|
+
type: boolean
|
1533
|
+
required:
|
1534
|
+
- is_enabled
|
1535
|
+
type: object
|
1536
|
+
AwsCURConfigPatchRequestType:
|
1537
|
+
default: aws_cur_config_patch_request
|
1538
|
+
description: Type of AWS CUR config Patch Request.
|
1539
|
+
enum:
|
1540
|
+
- aws_cur_config_patch_request
|
1541
|
+
example: aws_cur_config_patch_request
|
1542
|
+
type: string
|
1543
|
+
x-enum-varnames:
|
1544
|
+
- AWS_CUR_CONFIG_PATCH_REQUEST
|
1545
|
+
AwsCURConfigPostData:
|
1546
|
+
description: AWS CUR config Post data.
|
1547
|
+
properties:
|
1548
|
+
attributes:
|
1549
|
+
$ref: '#/components/schemas/AwsCURConfigPostRequestAttributes'
|
1550
|
+
type:
|
1551
|
+
$ref: '#/components/schemas/AwsCURConfigPostRequestType'
|
1552
|
+
required:
|
1553
|
+
- attributes
|
1554
|
+
- type
|
1555
|
+
type: object
|
1556
|
+
AwsCURConfigPostRequest:
|
1557
|
+
description: AWS CUR config Post Request.
|
1558
|
+
properties:
|
1559
|
+
data:
|
1560
|
+
$ref: '#/components/schemas/AwsCURConfigPostData'
|
1561
|
+
required:
|
1562
|
+
- data
|
1563
|
+
type: object
|
1564
|
+
AwsCURConfigPostRequestAttributes:
|
1565
|
+
description: Attributes for AWS CUR config Post Request.
|
1566
|
+
properties:
|
1567
|
+
account_id:
|
1568
|
+
description: The AWS account ID.
|
1569
|
+
example: '123456789123'
|
1570
|
+
type: string
|
1571
|
+
bucket_name:
|
1572
|
+
description: The AWS bucket name used to store the Cost and Usage Report.
|
1573
|
+
example: dd-cost-bucket
|
1574
|
+
type: string
|
1575
|
+
bucket_region:
|
1576
|
+
description: The region the bucket is located in.
|
1577
|
+
example: us-east-1
|
1578
|
+
type: string
|
1579
|
+
is_enabled:
|
1580
|
+
description: Whether or not the Cloud Cost Management account is enabled.
|
1581
|
+
type: boolean
|
1582
|
+
months:
|
1583
|
+
description: The month of the report.
|
1584
|
+
format: int32
|
1585
|
+
maximum: 36
|
1586
|
+
type: integer
|
1587
|
+
report_name:
|
1588
|
+
description: The name of the Cost and Usage Report.
|
1589
|
+
example: dd-report-name
|
1590
|
+
type: string
|
1591
|
+
report_prefix:
|
1592
|
+
description: The report prefix used for the Cost and Usage Report.
|
1593
|
+
example: dd-report-prefix
|
1594
|
+
type: string
|
1595
|
+
required:
|
1596
|
+
- account_id
|
1597
|
+
- bucket_name
|
1598
|
+
- report_name
|
1599
|
+
- report_prefix
|
1600
|
+
type: object
|
1601
|
+
AwsCURConfigPostRequestType:
|
1602
|
+
default: aws_cur_config_post_request
|
1603
|
+
description: Type of AWS CUR config Post Request.
|
1604
|
+
enum:
|
1605
|
+
- aws_cur_config_post_request
|
1606
|
+
example: aws_cur_config_post_request
|
1607
|
+
type: string
|
1608
|
+
x-enum-varnames:
|
1609
|
+
- AWS_CUR_CONFIG_POST_REQUEST
|
1610
|
+
AwsCURConfigResponse:
|
1611
|
+
description: Response of AWS CUR config.
|
1612
|
+
properties:
|
1613
|
+
data:
|
1614
|
+
$ref: '#/components/schemas/AwsCURConfig'
|
1615
|
+
type: object
|
1616
|
+
AwsCURConfigType:
|
1617
|
+
default: aws_cur_config
|
1618
|
+
description: Type of AWS CUR config.
|
1619
|
+
enum:
|
1620
|
+
- aws_cur_config
|
1621
|
+
example: aws_cur_config
|
1622
|
+
type: string
|
1623
|
+
x-enum-varnames:
|
1624
|
+
- AWS_CUR_CONFIG
|
1625
|
+
AwsCURConfigsResponse:
|
1626
|
+
description: List of AWS CUR configs.
|
1627
|
+
properties:
|
1628
|
+
data:
|
1629
|
+
description: An AWS CUR config.
|
1630
|
+
items:
|
1631
|
+
$ref: '#/components/schemas/AwsCURConfig'
|
1632
|
+
type: array
|
1633
|
+
type: object
|
1634
|
+
AzureUCConfig:
|
1635
|
+
description: Azure config.
|
1636
|
+
properties:
|
1637
|
+
account_id:
|
1638
|
+
description: The tenant ID of the azure account.
|
1639
|
+
example: 1234abcd-1234-abcd-1234-1234abcd1234
|
1640
|
+
type: string
|
1641
|
+
client_id:
|
1642
|
+
description: The client ID of the Azure account.
|
1643
|
+
example: 1234abcd-1234-abcd-1234-1234abcd1234
|
1644
|
+
type: string
|
1645
|
+
created_at:
|
1646
|
+
description: The timestamp when the Azure config was created.
|
1647
|
+
pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}$
|
1648
|
+
type: string
|
1649
|
+
dataset_type:
|
1650
|
+
description: The dataset type of the Azure config.
|
1651
|
+
example: actual
|
1652
|
+
type: string
|
1653
|
+
error_messages:
|
1654
|
+
description: The error messages for the Azure config.
|
1655
|
+
items:
|
1656
|
+
type: string
|
1657
|
+
type: array
|
1658
|
+
export_name:
|
1659
|
+
description: The name of the configured Azure Export.
|
1660
|
+
example: dd-actual-export
|
1661
|
+
type: string
|
1662
|
+
export_path:
|
1663
|
+
description: The path where the Azure Export is saved.
|
1664
|
+
example: dd-export-path
|
1665
|
+
type: string
|
1666
|
+
id:
|
1667
|
+
description: The ID of the Azure config.
|
1668
|
+
format: int64
|
1669
|
+
type: integer
|
1670
|
+
months:
|
1671
|
+
deprecated: true
|
1672
|
+
description: The number of months the report has been backfilled.
|
1673
|
+
format: int32
|
1674
|
+
maximum: 36
|
1675
|
+
type: integer
|
1676
|
+
scope:
|
1677
|
+
description: The scope of your observed subscription.
|
1678
|
+
example: subscriptions/1234abcd-1234-abcd-1234-1234abcd1234
|
1679
|
+
type: string
|
1680
|
+
status:
|
1681
|
+
description: The status of the Azure config.
|
1682
|
+
example: active
|
1683
|
+
type: string
|
1684
|
+
status_updated_at:
|
1685
|
+
description: The timestamp when the Azure config status was last updated.
|
1686
|
+
pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}$
|
1687
|
+
type: string
|
1688
|
+
storage_account:
|
1689
|
+
description: The name of the storage account where the Azure Export is saved.
|
1690
|
+
example: dd-storage-account
|
1691
|
+
type: string
|
1692
|
+
storage_container:
|
1693
|
+
description: The name of the storage container where the Azure Export is
|
1694
|
+
saved.
|
1695
|
+
example: dd-storage-container
|
1696
|
+
type: string
|
1697
|
+
updated_at:
|
1698
|
+
description: The timestamp when the Azure config was last updated.
|
1699
|
+
pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}$
|
1700
|
+
type: string
|
1701
|
+
required:
|
1702
|
+
- account_id
|
1703
|
+
- client_id
|
1704
|
+
- dataset_type
|
1705
|
+
- export_name
|
1706
|
+
- export_path
|
1707
|
+
- scope
|
1708
|
+
- status
|
1709
|
+
- storage_account
|
1710
|
+
- storage_container
|
1711
|
+
type: object
|
1712
|
+
AzureUCConfigPair:
|
1713
|
+
description: Azure config pair.
|
1714
|
+
properties:
|
1715
|
+
attributes:
|
1716
|
+
$ref: '#/components/schemas/AzureUCConfigPairAttributes'
|
1717
|
+
id:
|
1718
|
+
description: The ID of Cloud Cost Management account.
|
1719
|
+
format: int64
|
1720
|
+
type: integer
|
1721
|
+
type:
|
1722
|
+
$ref: '#/components/schemas/AzureUCConfigPairType'
|
1723
|
+
required:
|
1724
|
+
- attributes
|
1725
|
+
- type
|
1726
|
+
type: object
|
1727
|
+
AzureUCConfigPairAttributes:
|
1728
|
+
description: Attributes for Azure config pair.
|
1729
|
+
properties:
|
1730
|
+
configs:
|
1731
|
+
description: An Azure config.
|
1732
|
+
items:
|
1733
|
+
$ref: '#/components/schemas/AzureUCConfig'
|
1734
|
+
type: array
|
1735
|
+
id:
|
1736
|
+
description: The ID of the Azure config pair.
|
1737
|
+
format: int64
|
1738
|
+
type: integer
|
1739
|
+
required:
|
1740
|
+
- configs
|
1741
|
+
type: object
|
1742
|
+
AzureUCConfigPairType:
|
1743
|
+
default: azure_uc_configs
|
1744
|
+
description: Type of Azure config pair.
|
1745
|
+
enum:
|
1746
|
+
- azure_uc_configs
|
1747
|
+
example: azure_uc_configs
|
1748
|
+
type: string
|
1749
|
+
x-enum-varnames:
|
1750
|
+
- AZURE_UC_CONFIGS
|
1751
|
+
AzureUCConfigPairsResponse:
|
1752
|
+
description: Response of Azure config pair.
|
1753
|
+
properties:
|
1754
|
+
data:
|
1755
|
+
$ref: '#/components/schemas/AzureUCConfigPair'
|
1756
|
+
type: object
|
1757
|
+
AzureUCConfigPatchData:
|
1758
|
+
description: Azure config Patch data.
|
1759
|
+
properties:
|
1760
|
+
attributes:
|
1761
|
+
$ref: '#/components/schemas/AzureUCConfigPatchRequestAttributes'
|
1762
|
+
type:
|
1763
|
+
$ref: '#/components/schemas/AzureUCConfigPatchRequestType'
|
1764
|
+
required:
|
1765
|
+
- attributes
|
1766
|
+
- type
|
1767
|
+
type: object
|
1768
|
+
AzureUCConfigPatchRequest:
|
1769
|
+
description: Azure config Patch Request.
|
1770
|
+
properties:
|
1771
|
+
data:
|
1772
|
+
$ref: '#/components/schemas/AzureUCConfigPatchData'
|
1773
|
+
required:
|
1774
|
+
- data
|
1775
|
+
type: object
|
1776
|
+
AzureUCConfigPatchRequestAttributes:
|
1777
|
+
description: Attributes for Azure config Patch Request.
|
1778
|
+
properties:
|
1779
|
+
is_enabled:
|
1780
|
+
description: Whether or not the Cloud Cost Management account is enabled.
|
1781
|
+
example: true
|
1782
|
+
type: boolean
|
1783
|
+
required:
|
1784
|
+
- is_enabled
|
1785
|
+
type: object
|
1786
|
+
AzureUCConfigPatchRequestType:
|
1787
|
+
default: azure_uc_config_patch_request
|
1788
|
+
description: Type of Azure config Patch Request.
|
1789
|
+
enum:
|
1790
|
+
- azure_uc_config_patch_request
|
1791
|
+
example: azure_uc_config_patch_request
|
1792
|
+
type: string
|
1793
|
+
x-enum-varnames:
|
1794
|
+
- AZURE_UC_CONFIG_PATCH_REQUEST
|
1795
|
+
AzureUCConfigPostData:
|
1796
|
+
description: Azure config Post data.
|
1797
|
+
properties:
|
1798
|
+
attributes:
|
1799
|
+
$ref: '#/components/schemas/AzureUCConfigPostRequestAttributes'
|
1800
|
+
type:
|
1801
|
+
$ref: '#/components/schemas/AzureUCConfigPostRequestType'
|
1802
|
+
required:
|
1803
|
+
- attributes
|
1804
|
+
- type
|
1805
|
+
type: object
|
1806
|
+
AzureUCConfigPostRequest:
|
1807
|
+
description: Azure config Post Request.
|
1808
|
+
properties:
|
1809
|
+
data:
|
1810
|
+
$ref: '#/components/schemas/AzureUCConfigPostData'
|
1811
|
+
required:
|
1812
|
+
- data
|
1813
|
+
type: object
|
1814
|
+
AzureUCConfigPostRequestAttributes:
|
1815
|
+
description: Attributes for Azure config Post Request.
|
1816
|
+
properties:
|
1817
|
+
account_id:
|
1818
|
+
description: The tenant ID of the azure account.
|
1819
|
+
example: 1234abcd-1234-abcd-1234-1234abcd1234
|
1820
|
+
type: string
|
1821
|
+
actual_bill_config:
|
1822
|
+
$ref: '#/components/schemas/BillConfig'
|
1823
|
+
amortized_bill_config:
|
1824
|
+
$ref: '#/components/schemas/BillConfig'
|
1825
|
+
client_id:
|
1826
|
+
description: The client ID of the azure account.
|
1827
|
+
example: 1234abcd-1234-abcd-1234-1234abcd1234
|
1828
|
+
type: string
|
1829
|
+
is_enabled:
|
1830
|
+
description: Whether or not the Cloud Cost Management account is enabled.
|
1831
|
+
type: boolean
|
1832
|
+
scope:
|
1833
|
+
description: The scope of your observed subscription.
|
1834
|
+
example: subscriptions/1234abcd-1234-abcd-1234-1234abcd1234
|
1835
|
+
type: string
|
1836
|
+
required:
|
1837
|
+
- account_id
|
1838
|
+
- actual_bill_config
|
1839
|
+
- amortized_bill_config
|
1840
|
+
- client_id
|
1841
|
+
- scope
|
1842
|
+
type: object
|
1843
|
+
AzureUCConfigPostRequestType:
|
1844
|
+
default: azure_uc_config_post_request
|
1845
|
+
description: Type of Azure config Post Request.
|
1846
|
+
enum:
|
1847
|
+
- azure_uc_config_post_request
|
1848
|
+
example: azure_uc_config_post_request
|
1849
|
+
type: string
|
1850
|
+
x-enum-varnames:
|
1851
|
+
- AZURE_UC_CONFIG_POST_REQUEST
|
1852
|
+
AzureUCConfigsResponse:
|
1853
|
+
description: List of Azure accounts with configs.
|
1854
|
+
properties:
|
1855
|
+
data:
|
1856
|
+
description: An Azure config pair.
|
1857
|
+
items:
|
1858
|
+
$ref: '#/components/schemas/AzureUCConfigPair'
|
1859
|
+
type: array
|
1860
|
+
type: object
|
1861
|
+
BillConfig:
|
1862
|
+
description: Bill config.
|
1863
|
+
properties:
|
1864
|
+
export_name:
|
1865
|
+
description: The name of the configured Azure Export.
|
1866
|
+
example: dd-actual-export
|
1867
|
+
type: string
|
1868
|
+
export_path:
|
1869
|
+
description: The path where the Azure Export is saved.
|
1870
|
+
example: dd-export-path
|
1871
|
+
type: string
|
1872
|
+
storage_account:
|
1873
|
+
description: The name of the storage account where the Azure Export is saved.
|
1874
|
+
example: dd-storage-account
|
1875
|
+
type: string
|
1876
|
+
storage_container:
|
1877
|
+
description: The name of the storage container where the Azure Export is
|
1878
|
+
saved.
|
1879
|
+
example: dd-storage-container
|
1880
|
+
type: string
|
1881
|
+
required:
|
1882
|
+
- export_name
|
1883
|
+
- export_path
|
1884
|
+
- storage_account
|
1885
|
+
- storage_container
|
1886
|
+
type: object
|
1372
1887
|
BulkMuteFindingsRequest:
|
1373
1888
|
description: The new bulk mute finding request.
|
1374
1889
|
properties:
|
@@ -3005,11 +3520,47 @@ components:
|
|
3005
3520
|
type: string
|
3006
3521
|
x-enum-varnames:
|
3007
3522
|
- CLOUD_CONFIGURATION
|
3008
|
-
|
3009
|
-
description:
|
3523
|
+
CloudCostActivity:
|
3524
|
+
description: Cloud Cost Activity.
|
3010
3525
|
properties:
|
3011
|
-
|
3012
|
-
|
3526
|
+
attributes:
|
3527
|
+
$ref: '#/components/schemas/CloudCostActivityAttributes'
|
3528
|
+
type:
|
3529
|
+
$ref: '#/components/schemas/CloudCostActivityType'
|
3530
|
+
required:
|
3531
|
+
- attributes
|
3532
|
+
- type
|
3533
|
+
type: object
|
3534
|
+
CloudCostActivityAttributes:
|
3535
|
+
description: Attributes for Cloud Cost activity.
|
3536
|
+
properties:
|
3537
|
+
is_enabled:
|
3538
|
+
description: Whether or not the cloud account is enabled.
|
3539
|
+
example: true
|
3540
|
+
type: boolean
|
3541
|
+
required:
|
3542
|
+
- is_enabled
|
3543
|
+
type: object
|
3544
|
+
CloudCostActivityResponse:
|
3545
|
+
description: Response for Cloud Cost activity.
|
3546
|
+
properties:
|
3547
|
+
data:
|
3548
|
+
$ref: '#/components/schemas/CloudCostActivity'
|
3549
|
+
type: object
|
3550
|
+
CloudCostActivityType:
|
3551
|
+
default: cloud_cost_activity
|
3552
|
+
description: Type of Cloud Cost Activity.
|
3553
|
+
enum:
|
3554
|
+
- cloud_cost_activity
|
3555
|
+
example: cloud_cost_activity
|
3556
|
+
type: string
|
3557
|
+
x-enum-varnames:
|
3558
|
+
- CLOUD_COST_ACTIVITY
|
3559
|
+
CloudWorkloadSecurityAgentRuleAttributes:
|
3560
|
+
description: A Cloud Workload Security Agent rule returned by the API.
|
3561
|
+
properties:
|
3562
|
+
agentConstraint:
|
3563
|
+
description: The version of the agent.
|
3013
3564
|
type: string
|
3014
3565
|
category:
|
3015
3566
|
description: The category of the Agent rule.
|
@@ -3237,6 +3788,22 @@ components:
|
|
3237
3788
|
description: The name of the Cloudflare account.
|
3238
3789
|
example: test-name
|
3239
3790
|
type: string
|
3791
|
+
resources:
|
3792
|
+
description: An allowlist of resources to restrict pulling metrics for.
|
3793
|
+
example:
|
3794
|
+
- web
|
3795
|
+
- dns
|
3796
|
+
items:
|
3797
|
+
type: string
|
3798
|
+
type: array
|
3799
|
+
zones:
|
3800
|
+
description: An allowlist of zones to restrict pulling metrics for.
|
3801
|
+
example:
|
3802
|
+
- zone_id_1
|
3803
|
+
- zone_id_2
|
3804
|
+
items:
|
3805
|
+
type: string
|
3806
|
+
type: array
|
3240
3807
|
required:
|
3241
3808
|
- api_key
|
3242
3809
|
- name
|
@@ -3269,6 +3836,22 @@ components:
|
|
3269
3836
|
description: The name of the Cloudflare account.
|
3270
3837
|
example: test-name
|
3271
3838
|
type: string
|
3839
|
+
resources:
|
3840
|
+
description: An allowlist of resources to restrict pulling metrics for.
|
3841
|
+
example:
|
3842
|
+
- web
|
3843
|
+
- dns
|
3844
|
+
items:
|
3845
|
+
type: string
|
3846
|
+
type: array
|
3847
|
+
zones:
|
3848
|
+
description: An allowlist of zones to restrict pulling metrics for.
|
3849
|
+
example:
|
3850
|
+
- zone_id_1
|
3851
|
+
- zone_id_2
|
3852
|
+
items:
|
3853
|
+
type: string
|
3854
|
+
type: array
|
3272
3855
|
required:
|
3273
3856
|
- name
|
3274
3857
|
type: object
|
@@ -3317,6 +3900,22 @@ components:
|
|
3317
3900
|
key is provided (and not a token), this field is also required.
|
3318
3901
|
example: test-email@example.com
|
3319
3902
|
type: string
|
3903
|
+
resources:
|
3904
|
+
description: An allowlist of resources to restrict pulling metrics for.
|
3905
|
+
example:
|
3906
|
+
- web
|
3907
|
+
- dns
|
3908
|
+
items:
|
3909
|
+
type: string
|
3910
|
+
type: array
|
3911
|
+
zones:
|
3912
|
+
description: An allowlist of zones to restrict pulling metrics for.
|
3913
|
+
example:
|
3914
|
+
- zone_id_1
|
3915
|
+
- zone_id_2
|
3916
|
+
items:
|
3917
|
+
type: string
|
3918
|
+
type: array
|
3320
3919
|
required:
|
3321
3920
|
- api_key
|
3322
3921
|
type: object
|
@@ -4279,6 +4878,29 @@ components:
|
|
4279
4878
|
type: string
|
4280
4879
|
x-enum-varnames:
|
4281
4880
|
- COST_BY_ORG
|
4881
|
+
CreateOpenAPIResponse:
|
4882
|
+
description: Response for `CreateOpenAPI` operation.
|
4883
|
+
properties:
|
4884
|
+
data:
|
4885
|
+
$ref: '#/components/schemas/CreateOpenAPIResponseData'
|
4886
|
+
type: object
|
4887
|
+
CreateOpenAPIResponseAttributes:
|
4888
|
+
description: Attributes for `CreateOpenAPI`.
|
4889
|
+
properties:
|
4890
|
+
failed_endpoints:
|
4891
|
+
description: List of endpoints which couldn't be parsed.
|
4892
|
+
items:
|
4893
|
+
$ref: '#/components/schemas/OpenAPIEndpoint'
|
4894
|
+
type: array
|
4895
|
+
type: object
|
4896
|
+
CreateOpenAPIResponseData:
|
4897
|
+
description: Data envelope for `CreateOpenAPIResponse`.
|
4898
|
+
properties:
|
4899
|
+
attributes:
|
4900
|
+
$ref: '#/components/schemas/CreateOpenAPIResponseAttributes'
|
4901
|
+
id:
|
4902
|
+
$ref: '#/components/schemas/ApiID'
|
4903
|
+
type: object
|
4282
4904
|
CreateRuleRequest:
|
4283
4905
|
description: Scorecard create rule request.
|
4284
4906
|
properties:
|
@@ -4336,6 +4958,10 @@ components:
|
|
4336
4958
|
DORADeploymentRequestAttributes:
|
4337
4959
|
description: Attributes to create a DORA deployment event.
|
4338
4960
|
properties:
|
4961
|
+
env:
|
4962
|
+
description: Environment name to where the service was deployed.
|
4963
|
+
example: staging
|
4964
|
+
type: string
|
4339
4965
|
finished_at:
|
4340
4966
|
description: Unix timestamp in nanoseconds when the deployment finished.
|
4341
4967
|
It should not be older than 3 hours.
|
@@ -4424,6 +5050,10 @@ components:
|
|
4424
5050
|
DORAIncidentRequestAttributes:
|
4425
5051
|
description: Attributes to create a DORA incident event.
|
4426
5052
|
properties:
|
5053
|
+
env:
|
5054
|
+
description: Environment name that was impacted by the incident.
|
5055
|
+
example: staging
|
5056
|
+
type: string
|
4427
5057
|
finished_at:
|
4428
5058
|
description: Unix timestamp in nanoseconds when the incident finished. It
|
4429
5059
|
should not be older than 3 hours.
|
@@ -6393,8 +7023,19 @@ components:
|
|
6393
7023
|
type: string
|
6394
7024
|
type: array
|
6395
7025
|
is_cspm_enabled:
|
6396
|
-
description: When enabled, Datadog
|
6397
|
-
|
7026
|
+
description: 'When enabled, Datadog will activate the Cloud Security Monitoring
|
7027
|
+
product for this service account. Note: This requires resource_collection_enabled
|
7028
|
+
to be set to true.'
|
7029
|
+
type: boolean
|
7030
|
+
is_security_command_center_enabled:
|
7031
|
+
default: false
|
7032
|
+
description: 'When enabled, Datadog will attempt to collect Security Command
|
7033
|
+
Center Findings. Note: This requires additional permissions on the service
|
7034
|
+
account.'
|
7035
|
+
example: true
|
7036
|
+
type: boolean
|
7037
|
+
resource_collection_enabled:
|
7038
|
+
description: When enabled, Datadog scans for all resources in your GCP environment.
|
6398
7039
|
type: boolean
|
6399
7040
|
type: object
|
6400
7041
|
GCPSTSServiceAccountCreateRequest:
|
@@ -10442,7 +11083,7 @@ components:
|
|
10442
11083
|
description: The metrics' payload.
|
10443
11084
|
properties:
|
10444
11085
|
series:
|
10445
|
-
description: A list of
|
11086
|
+
description: A list of timeseries to submit to Datadog.
|
10446
11087
|
example:
|
10447
11088
|
- metric: system.load.1
|
10448
11089
|
points:
|
@@ -11466,6 +12107,24 @@ components:
|
|
11466
12107
|
type: string
|
11467
12108
|
x-enum-varnames:
|
11468
12109
|
- ON_DEMAND_CONCURRENCY_CAP
|
12110
|
+
OpenAPIEndpoint:
|
12111
|
+
description: Endpoint info extracted from an `OpenAPI` specification.
|
12112
|
+
properties:
|
12113
|
+
method:
|
12114
|
+
description: The endpoint method.
|
12115
|
+
type: string
|
12116
|
+
path:
|
12117
|
+
description: The endpoint path.
|
12118
|
+
type: string
|
12119
|
+
type: object
|
12120
|
+
OpenAPIFile:
|
12121
|
+
description: Object for API data in an `OpenAPI` format as a file.
|
12122
|
+
properties:
|
12123
|
+
openapi_spec_file:
|
12124
|
+
description: Binary `OpenAPI` spec file
|
12125
|
+
format: binary
|
12126
|
+
type: string
|
12127
|
+
type: object
|
11469
12128
|
OpsgenieServiceCreateAttributes:
|
11470
12129
|
description: The Opsgenie service attributes for a create request.
|
11471
12130
|
properties:
|
@@ -13628,6 +14287,27 @@ components:
|
|
13628
14287
|
- id
|
13629
14288
|
- type
|
13630
14289
|
type: object
|
14290
|
+
RelationshipToUserTeamTeam:
|
14291
|
+
description: Relationship between team membership and team
|
14292
|
+
properties:
|
14293
|
+
data:
|
14294
|
+
$ref: '#/components/schemas/RelationshipToUserTeamTeamData'
|
14295
|
+
required:
|
14296
|
+
- data
|
14297
|
+
type: object
|
14298
|
+
RelationshipToUserTeamTeamData:
|
14299
|
+
description: The team associated with the membership
|
14300
|
+
properties:
|
14301
|
+
id:
|
14302
|
+
description: The ID of the team associated with the membership
|
14303
|
+
example: d7e15d9d-d346-43da-81d8-3d9e71d9a5e9
|
14304
|
+
type: string
|
14305
|
+
type:
|
14306
|
+
$ref: '#/components/schemas/UserTeamTeamType'
|
14307
|
+
required:
|
14308
|
+
- id
|
14309
|
+
- type
|
14310
|
+
type: object
|
13631
14311
|
RelationshipToUserTeamUser:
|
13632
14312
|
description: Relationship between team membership and user
|
13633
14313
|
properties:
|
@@ -15045,6 +15725,8 @@ components:
|
|
15045
15725
|
$ref: '#/components/schemas/SecurityMonitoringRuleMaxSignalDuration'
|
15046
15726
|
newValueOptions:
|
15047
15727
|
$ref: '#/components/schemas/SecurityMonitoringRuleNewValueOptions'
|
15728
|
+
thirdPartyRuleOptions:
|
15729
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleThirdPartyOptions'
|
15048
15730
|
type: object
|
15049
15731
|
SecurityMonitoringRuleQuery:
|
15050
15732
|
description: Query for matching rule.
|
@@ -15093,6 +15775,30 @@ components:
|
|
15093
15775
|
- MEDIUM
|
15094
15776
|
- HIGH
|
15095
15777
|
- CRITICAL
|
15778
|
+
SecurityMonitoringRuleThirdPartyOptions:
|
15779
|
+
description: Options on third party rules.
|
15780
|
+
properties:
|
15781
|
+
defaultNotifications:
|
15782
|
+
description: Notification targets for the logs that do not correspond to
|
15783
|
+
any of the cases.
|
15784
|
+
items:
|
15785
|
+
description: Notification.
|
15786
|
+
type: string
|
15787
|
+
type: array
|
15788
|
+
defaultStatus:
|
15789
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleSeverity'
|
15790
|
+
rootQueries:
|
15791
|
+
description: Queries to be combined with third party case queries. Each
|
15792
|
+
of them can have different group by fields, to aggregate differently based
|
15793
|
+
on the type of alert.
|
15794
|
+
items:
|
15795
|
+
$ref: '#/components/schemas/SecurityMonitoringThirdPartyRootQuery'
|
15796
|
+
type: array
|
15797
|
+
signalTitleTemplate:
|
15798
|
+
description: A template for the signal title; if omitted, the title is generated
|
15799
|
+
based on the case name.
|
15800
|
+
type: string
|
15801
|
+
type: object
|
15096
15802
|
SecurityMonitoringRuleTypeCreate:
|
15097
15803
|
description: The rule type.
|
15098
15804
|
enum:
|
@@ -15162,6 +15868,13 @@ components:
|
|
15162
15868
|
description: Tag.
|
15163
15869
|
type: string
|
15164
15870
|
type: array
|
15871
|
+
thirdPartyCases:
|
15872
|
+
description: Cases for generating signals from third party rules. Only available
|
15873
|
+
for third party rules.
|
15874
|
+
example: []
|
15875
|
+
items:
|
15876
|
+
$ref: '#/components/schemas/SecurityMonitoringThirdPartyRuleCase'
|
15877
|
+
type: array
|
15165
15878
|
version:
|
15166
15879
|
description: The version of the rule being updated.
|
15167
15880
|
example: 1
|
@@ -15791,6 +16504,13 @@ components:
|
|
15791
16504
|
description: Tag.
|
15792
16505
|
type: string
|
15793
16506
|
type: array
|
16507
|
+
thirdPartyCases:
|
16508
|
+
description: Cases for generating signals from third party rules. Only available
|
16509
|
+
for third party rules.
|
16510
|
+
example: []
|
16511
|
+
items:
|
16512
|
+
$ref: '#/components/schemas/SecurityMonitoringThirdPartyRuleCaseCreate'
|
16513
|
+
type: array
|
15794
16514
|
type:
|
15795
16515
|
$ref: '#/components/schemas/SecurityMonitoringRuleTypeCreate'
|
15796
16516
|
required:
|
@@ -15912,6 +16632,13 @@ components:
|
|
15912
16632
|
description: Tag.
|
15913
16633
|
type: string
|
15914
16634
|
type: array
|
16635
|
+
thirdPartyCases:
|
16636
|
+
description: Cases for generating signals from third party rules. Only available
|
16637
|
+
for third party rules.
|
16638
|
+
example: []
|
16639
|
+
items:
|
16640
|
+
$ref: '#/components/schemas/SecurityMonitoringThirdPartyRuleCase'
|
16641
|
+
type: array
|
15915
16642
|
type:
|
15916
16643
|
$ref: '#/components/schemas/SecurityMonitoringRuleTypeRead'
|
15917
16644
|
updateAuthorId:
|
@@ -15922,98 +16649,376 @@ components:
|
|
15922
16649
|
description: The version of the rule.
|
15923
16650
|
format: int64
|
15924
16651
|
type: integer
|
15925
|
-
|
15926
|
-
description:
|
16652
|
+
SecurityMonitoringSuppression:
|
16653
|
+
description: The suppression rule's properties.
|
15927
16654
|
properties:
|
15928
|
-
|
15929
|
-
|
16655
|
+
attributes:
|
16656
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionAttributes'
|
16657
|
+
id:
|
16658
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionID'
|
16659
|
+
type:
|
16660
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionType'
|
16661
|
+
type: object
|
16662
|
+
SecurityMonitoringSuppressionAttributes:
|
16663
|
+
description: The attributes of the suppression rule.
|
16664
|
+
properties:
|
16665
|
+
creation_date:
|
16666
|
+
description: A Unix millisecond timestamp given the creation date of the
|
16667
|
+
suppression rule.
|
16668
|
+
format: int64
|
16669
|
+
type: integer
|
16670
|
+
creator:
|
16671
|
+
$ref: '#/components/schemas/SecurityMonitoringUser'
|
16672
|
+
description:
|
16673
|
+
description: A description for the suppression rule.
|
16674
|
+
example: This rule suppresses low-severity signals in staging environments.
|
15930
16675
|
type: string
|
15931
|
-
|
15932
|
-
description:
|
15933
|
-
example:
|
15934
|
-
|
16676
|
+
enabled:
|
16677
|
+
description: Whether the suppression rule is enabled.
|
16678
|
+
example: true
|
16679
|
+
type: boolean
|
16680
|
+
expiration_date:
|
16681
|
+
description: A Unix millisecond timestamp giving an expiration date for
|
16682
|
+
the suppression rule. After this date, it won't suppress signals anymore.
|
16683
|
+
example: 1703187336000
|
16684
|
+
format: int64
|
16685
|
+
type: integer
|
16686
|
+
name:
|
16687
|
+
description: The name of the suppression rule.
|
16688
|
+
example: Custom suppression
|
16689
|
+
type: string
|
16690
|
+
rule_query:
|
16691
|
+
description: The rule query of the suppression rule, with the same syntax
|
16692
|
+
as the search bar for detection rules.
|
16693
|
+
example: type:log_detection source:cloudtrail
|
16694
|
+
type: string
|
16695
|
+
suppression_query:
|
16696
|
+
description: The suppression query of the suppression rule. If a signal
|
16697
|
+
matches this query, it is suppressed and not triggered. Same syntax as
|
16698
|
+
the queries to search signals in the signal explorer.
|
16699
|
+
example: env:staging status:low
|
16700
|
+
type: string
|
16701
|
+
update_date:
|
16702
|
+
description: A Unix millisecond timestamp given the update date of the suppression
|
16703
|
+
rule.
|
16704
|
+
format: int64
|
16705
|
+
type: integer
|
16706
|
+
updater:
|
16707
|
+
$ref: '#/components/schemas/SecurityMonitoringUser'
|
16708
|
+
version:
|
16709
|
+
description: The version of the suppression rule; it starts at 1, and is
|
16710
|
+
incremented at each update.
|
16711
|
+
example: 42
|
16712
|
+
format: int32
|
16713
|
+
maximum: 2147483647
|
16714
|
+
type: integer
|
16715
|
+
type: object
|
16716
|
+
SecurityMonitoringSuppressionCreateAttributes:
|
16717
|
+
description: Object containing the attributes of the suppression rule to be
|
16718
|
+
created.
|
16719
|
+
properties:
|
16720
|
+
description:
|
16721
|
+
description: A description for the suppression rule.
|
16722
|
+
example: This rule suppresses low-severity signals in staging environments.
|
15935
16723
|
type: string
|
15936
|
-
|
15937
|
-
description:
|
16724
|
+
enabled:
|
16725
|
+
description: Whether the suppression rule is enabled.
|
16726
|
+
example: true
|
16727
|
+
type: boolean
|
16728
|
+
expiration_date:
|
16729
|
+
description: A Unix millisecond timestamp giving an expiration date for
|
16730
|
+
the suppression rule. After this date, it won't suppress signals anymore.
|
16731
|
+
example: 1703187336000
|
15938
16732
|
format: int64
|
15939
16733
|
type: integer
|
15940
16734
|
name:
|
15941
|
-
description: The name
|
15942
|
-
|
16735
|
+
description: The name of the suppression rule.
|
16736
|
+
example: Custom suppression
|
15943
16737
|
type: string
|
15944
|
-
|
15945
|
-
description:
|
15946
|
-
|
16738
|
+
rule_query:
|
16739
|
+
description: The rule query of the suppression rule, with the same syntax
|
16740
|
+
as the search bar for detection rules.
|
16741
|
+
example: type:log_detection source:cloudtrail
|
16742
|
+
type: string
|
16743
|
+
suppression_query:
|
16744
|
+
description: The suppression query of the suppression rule. If a signal
|
16745
|
+
matches this query, it is suppressed and is not triggered . Same syntax
|
16746
|
+
as the queries to search signals in the signal explorer.
|
16747
|
+
example: env:staging status:low
|
15947
16748
|
type: string
|
15948
16749
|
required:
|
15949
|
-
-
|
15950
|
-
|
15951
|
-
|
15952
|
-
|
15953
|
-
properties:
|
15954
|
-
data:
|
15955
|
-
$ref: '#/components/schemas/SensitiveDataScannerReorderConfig'
|
15956
|
-
meta:
|
15957
|
-
$ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly'
|
15958
|
-
required:
|
15959
|
-
- data
|
15960
|
-
- meta
|
16750
|
+
- name
|
16751
|
+
- enabled
|
16752
|
+
- rule_query
|
16753
|
+
- suppression_query
|
15961
16754
|
type: object
|
15962
|
-
|
15963
|
-
description:
|
16755
|
+
SecurityMonitoringSuppressionCreateData:
|
16756
|
+
description: Object for a single suppression rule.
|
15964
16757
|
properties:
|
15965
|
-
|
15966
|
-
|
15967
|
-
type: string
|
16758
|
+
attributes:
|
16759
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionCreateAttributes'
|
15968
16760
|
type:
|
15969
|
-
$ref: '#/components/schemas/
|
16761
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionType'
|
16762
|
+
required:
|
16763
|
+
- type
|
16764
|
+
- attributes
|
15970
16765
|
type: object
|
15971
|
-
|
15972
|
-
description:
|
16766
|
+
SecurityMonitoringSuppressionCreateRequest:
|
16767
|
+
description: Request object that includes the suppression rule that you would
|
16768
|
+
like to create.
|
15973
16769
|
properties:
|
15974
16770
|
data:
|
15975
|
-
$ref: '#/components/schemas/
|
16771
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionCreateData'
|
16772
|
+
required:
|
16773
|
+
- data
|
15976
16774
|
type: object
|
15977
|
-
|
15978
|
-
description:
|
16775
|
+
SecurityMonitoringSuppressionID:
|
16776
|
+
description: The ID of the suppression rule.
|
16777
|
+
example: 3dd-0uc-h1s
|
16778
|
+
type: string
|
16779
|
+
SecurityMonitoringSuppressionResponse:
|
16780
|
+
description: Response object containing a single suppression rule.
|
15979
16781
|
properties:
|
15980
|
-
|
15981
|
-
$ref: '#/components/schemas/
|
16782
|
+
data:
|
16783
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppression'
|
15982
16784
|
type: object
|
15983
|
-
|
15984
|
-
default:
|
15985
|
-
description:
|
16785
|
+
SecurityMonitoringSuppressionType:
|
16786
|
+
default: suppressions
|
16787
|
+
description: The type of the resource. The value should always be `suppressions`.
|
15986
16788
|
enum:
|
15987
|
-
-
|
15988
|
-
example:
|
16789
|
+
- suppressions
|
16790
|
+
example: suppressions
|
15989
16791
|
type: string
|
15990
16792
|
x-enum-varnames:
|
15991
|
-
-
|
15992
|
-
|
15993
|
-
description:
|
16793
|
+
- SUPPRESSIONS
|
16794
|
+
SecurityMonitoringSuppressionUpdateAttributes:
|
16795
|
+
description: The suppression rule properties to be updated.
|
16796
|
+
properties:
|
16797
|
+
description:
|
16798
|
+
description: A description for the suppression rule.
|
16799
|
+
example: This rule suppresses low-severity signals in staging environments.
|
16800
|
+
type: string
|
16801
|
+
enabled:
|
16802
|
+
description: Whether the suppression rule is enabled.
|
16803
|
+
example: true
|
16804
|
+
type: boolean
|
16805
|
+
expiration_date:
|
16806
|
+
description: A Unix millisecond timestamp giving an expiration date for
|
16807
|
+
the suppression rule. After this date, it won't suppress signals anymore.
|
16808
|
+
If unset, the expiration date of the suppression rule is left untouched.
|
16809
|
+
If set to `null`, the expiration date is removed.
|
16810
|
+
example: 1703187336000
|
16811
|
+
format: int64
|
16812
|
+
nullable: true
|
16813
|
+
type: integer
|
16814
|
+
name:
|
16815
|
+
description: The name of the suppression rule.
|
16816
|
+
example: Custom suppression
|
16817
|
+
type: string
|
16818
|
+
rule_query:
|
16819
|
+
description: The rule query of the suppression rule, with the same syntax
|
16820
|
+
as the search bar for detection rules.
|
16821
|
+
example: type:log_detection source:cloudtrail
|
16822
|
+
type: string
|
16823
|
+
suppression_query:
|
16824
|
+
description: The suppression query of the suppression rule. If a signal
|
16825
|
+
matches this query, it is suppressed and not triggered. Same syntax as
|
16826
|
+
the queries to search signals in the signal explorer.
|
16827
|
+
example: env:staging status:low
|
16828
|
+
type: string
|
16829
|
+
version:
|
16830
|
+
description: The current version of the suppression. This is optional, but
|
16831
|
+
it can help prevent concurrent modifications.
|
16832
|
+
format: int32
|
16833
|
+
maximum: 2147483647
|
16834
|
+
type: integer
|
16835
|
+
type: object
|
16836
|
+
SecurityMonitoringSuppressionUpdateData:
|
16837
|
+
description: The new suppression properties; partial updates are supported.
|
16838
|
+
properties:
|
16839
|
+
attributes:
|
16840
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionUpdateAttributes'
|
16841
|
+
type:
|
16842
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionType'
|
16843
|
+
required:
|
16844
|
+
- type
|
16845
|
+
- attributes
|
16846
|
+
type: object
|
16847
|
+
SecurityMonitoringSuppressionUpdateRequest:
|
16848
|
+
description: Request object containing the fields to update on the suppression
|
16849
|
+
rule.
|
15994
16850
|
properties:
|
15995
16851
|
data:
|
15996
|
-
$ref: '#/components/schemas/
|
15997
|
-
|
15998
|
-
|
16852
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionUpdateData'
|
16853
|
+
required:
|
16854
|
+
- data
|
15999
16855
|
type: object
|
16000
|
-
|
16001
|
-
description:
|
16856
|
+
SecurityMonitoringSuppressionsResponse:
|
16857
|
+
description: Response object containing the available suppression rules.
|
16002
16858
|
properties:
|
16003
16859
|
data:
|
16004
|
-
|
16005
|
-
|
16006
|
-
|
16860
|
+
description: A list of suppressions objects.
|
16861
|
+
items:
|
16862
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppression'
|
16863
|
+
type: array
|
16007
16864
|
type: object
|
16008
|
-
|
16009
|
-
description:
|
16865
|
+
SecurityMonitoringThirdPartyRootQuery:
|
16866
|
+
description: A query to be combined with the third party case query.
|
16010
16867
|
properties:
|
16868
|
+
groupByFields:
|
16869
|
+
description: Fields to group by.
|
16870
|
+
items:
|
16871
|
+
description: Field.
|
16872
|
+
type: string
|
16873
|
+
type: array
|
16011
16874
|
query:
|
16012
|
-
description: Query to
|
16875
|
+
description: Query to run on logs.
|
16876
|
+
example: source:cloudtrail
|
16013
16877
|
type: string
|
16014
16878
|
type: object
|
16015
|
-
|
16016
|
-
description:
|
16879
|
+
SecurityMonitoringThirdPartyRuleCase:
|
16880
|
+
description: Case when signal is generated by a third party rule.
|
16881
|
+
properties:
|
16882
|
+
name:
|
16883
|
+
description: Name of the case.
|
16884
|
+
type: string
|
16885
|
+
notifications:
|
16886
|
+
description: Notification targets for each rule case.
|
16887
|
+
items:
|
16888
|
+
description: Notification.
|
16889
|
+
type: string
|
16890
|
+
type: array
|
16891
|
+
query:
|
16892
|
+
description: A query to map a third party event to this case.
|
16893
|
+
type: string
|
16894
|
+
status:
|
16895
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleSeverity'
|
16896
|
+
type: object
|
16897
|
+
SecurityMonitoringThirdPartyRuleCaseCreate:
|
16898
|
+
description: Case when a signal is generated by a third party rule.
|
16899
|
+
properties:
|
16900
|
+
name:
|
16901
|
+
description: Name of the case.
|
16902
|
+
type: string
|
16903
|
+
notifications:
|
16904
|
+
description: Notification targets for each rule case.
|
16905
|
+
items:
|
16906
|
+
description: Notification.
|
16907
|
+
type: string
|
16908
|
+
type: array
|
16909
|
+
query:
|
16910
|
+
description: A query to map a third party event to this case.
|
16911
|
+
type: string
|
16912
|
+
status:
|
16913
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleSeverity'
|
16914
|
+
required:
|
16915
|
+
- status
|
16916
|
+
type: object
|
16917
|
+
SecurityMonitoringTriageUser:
|
16918
|
+
description: Object representing a given user entity.
|
16919
|
+
properties:
|
16920
|
+
handle:
|
16921
|
+
description: The handle for this user account.
|
16922
|
+
type: string
|
16923
|
+
icon:
|
16924
|
+
description: Gravatar icon associated to the user.
|
16925
|
+
example: /path/to/matching/gravatar/icon
|
16926
|
+
readOnly: true
|
16927
|
+
type: string
|
16928
|
+
id:
|
16929
|
+
description: Numerical ID assigned by Datadog to this user account.
|
16930
|
+
format: int64
|
16931
|
+
type: integer
|
16932
|
+
name:
|
16933
|
+
description: The name for this user account.
|
16934
|
+
nullable: true
|
16935
|
+
type: string
|
16936
|
+
uuid:
|
16937
|
+
description: UUID assigned by Datadog to this user account.
|
16938
|
+
example: 773b045d-ccf8-4808-bd3b-955ef6a8c940
|
16939
|
+
type: string
|
16940
|
+
required:
|
16941
|
+
- uuid
|
16942
|
+
type: object
|
16943
|
+
SecurityMonitoringUser:
|
16944
|
+
description: A user.
|
16945
|
+
properties:
|
16946
|
+
handle:
|
16947
|
+
description: The handle of the user.
|
16948
|
+
example: john.doe@datadoghq.com
|
16949
|
+
type: string
|
16950
|
+
name:
|
16951
|
+
description: The name of the user.
|
16952
|
+
example: John Doe
|
16953
|
+
nullable: true
|
16954
|
+
type: string
|
16955
|
+
type: object
|
16956
|
+
SensitiveDataScannerConfigRequest:
|
16957
|
+
description: Group reorder request.
|
16958
|
+
properties:
|
16959
|
+
data:
|
16960
|
+
$ref: '#/components/schemas/SensitiveDataScannerReorderConfig'
|
16961
|
+
meta:
|
16962
|
+
$ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly'
|
16963
|
+
required:
|
16964
|
+
- data
|
16965
|
+
- meta
|
16966
|
+
type: object
|
16967
|
+
SensitiveDataScannerConfiguration:
|
16968
|
+
description: A Sensitive Data Scanner configuration.
|
16969
|
+
properties:
|
16970
|
+
id:
|
16971
|
+
description: ID of the configuration.
|
16972
|
+
type: string
|
16973
|
+
type:
|
16974
|
+
$ref: '#/components/schemas/SensitiveDataScannerConfigurationType'
|
16975
|
+
type: object
|
16976
|
+
SensitiveDataScannerConfigurationData:
|
16977
|
+
description: A Sensitive Data Scanner configuration data.
|
16978
|
+
properties:
|
16979
|
+
data:
|
16980
|
+
$ref: '#/components/schemas/SensitiveDataScannerConfiguration'
|
16981
|
+
type: object
|
16982
|
+
SensitiveDataScannerConfigurationRelationships:
|
16983
|
+
description: Relationships of the configuration.
|
16984
|
+
properties:
|
16985
|
+
groups:
|
16986
|
+
$ref: '#/components/schemas/SensitiveDataScannerGroupList'
|
16987
|
+
type: object
|
16988
|
+
SensitiveDataScannerConfigurationType:
|
16989
|
+
default: sensitive_data_scanner_configuration
|
16990
|
+
description: Sensitive Data Scanner configuration type.
|
16991
|
+
enum:
|
16992
|
+
- sensitive_data_scanner_configuration
|
16993
|
+
example: sensitive_data_scanner_configuration
|
16994
|
+
type: string
|
16995
|
+
x-enum-varnames:
|
16996
|
+
- SENSITIVE_DATA_SCANNER_CONFIGURATIONS
|
16997
|
+
SensitiveDataScannerCreateGroupResponse:
|
16998
|
+
description: Create group response.
|
16999
|
+
properties:
|
17000
|
+
data:
|
17001
|
+
$ref: '#/components/schemas/SensitiveDataScannerGroupResponse'
|
17002
|
+
meta:
|
17003
|
+
$ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly'
|
17004
|
+
type: object
|
17005
|
+
SensitiveDataScannerCreateRuleResponse:
|
17006
|
+
description: Create rule response.
|
17007
|
+
properties:
|
17008
|
+
data:
|
17009
|
+
$ref: '#/components/schemas/SensitiveDataScannerRuleResponse'
|
17010
|
+
meta:
|
17011
|
+
$ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly'
|
17012
|
+
type: object
|
17013
|
+
SensitiveDataScannerFilter:
|
17014
|
+
description: Filter for the Scanning Group.
|
17015
|
+
properties:
|
17016
|
+
query:
|
17017
|
+
description: Query to filter the events.
|
17018
|
+
type: string
|
17019
|
+
type: object
|
17020
|
+
SensitiveDataScannerGetConfigIncludedArray:
|
17021
|
+
description: Included objects from relationships.
|
16017
17022
|
items:
|
16018
17023
|
$ref: '#/components/schemas/SensitiveDataScannerGetConfigIncludedItem'
|
16019
17024
|
type: array
|
@@ -16208,6 +17213,44 @@ components:
|
|
16208
17213
|
meta:
|
16209
17214
|
$ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly'
|
16210
17215
|
type: object
|
17216
|
+
SensitiveDataScannerIncludedKeywordConfiguration:
|
17217
|
+
description: 'Object defining a set of keywords and a number of characters that
|
17218
|
+
help reduce noise.
|
17219
|
+
|
17220
|
+
You can provide a list of keywords you would like to check within a defined
|
17221
|
+
proximity of the matching pattern.
|
17222
|
+
|
17223
|
+
If any of the keywords are found within the proximity check, the match is
|
17224
|
+
kept.
|
17225
|
+
|
17226
|
+
If none are found, the match is discarded.'
|
17227
|
+
properties:
|
17228
|
+
character_count:
|
17229
|
+
description: 'The number of characters behind a match detected by Sensitive
|
17230
|
+
Data Scanner to look for the keywords defined.
|
17231
|
+
|
17232
|
+
`character_count` should be greater than the maximum length of a keyword
|
17233
|
+
defined for a rule.'
|
17234
|
+
example: 30
|
17235
|
+
format: int64
|
17236
|
+
maximum: 50
|
17237
|
+
minimum: 1
|
17238
|
+
type: integer
|
17239
|
+
keywords:
|
17240
|
+
description: 'Keyword list that will be checked during scanning in order
|
17241
|
+
to validate a match.
|
17242
|
+
|
17243
|
+
The number of keywords in the list must be less than or equal to 30.'
|
17244
|
+
example:
|
17245
|
+
- credit card
|
17246
|
+
- cc
|
17247
|
+
items:
|
17248
|
+
type: string
|
17249
|
+
type: array
|
17250
|
+
required:
|
17251
|
+
- keywords
|
17252
|
+
- character_count
|
17253
|
+
type: object
|
16211
17254
|
SensitiveDataScannerMeta:
|
16212
17255
|
description: Meta response containing information about the API.
|
16213
17256
|
properties:
|
@@ -16301,6 +17344,8 @@ components:
|
|
16301
17344
|
items:
|
16302
17345
|
type: string
|
16303
17346
|
type: array
|
17347
|
+
included_keyword_configuration:
|
17348
|
+
$ref: '#/components/schemas/SensitiveDataScannerIncludedKeywordConfiguration'
|
16304
17349
|
is_enabled:
|
16305
17350
|
description: Whether or not the rule is enabled.
|
16306
17351
|
type: boolean
|
@@ -16320,6 +17365,12 @@ components:
|
|
16320
17365
|
pattern:
|
16321
17366
|
description: Not included if there is a relationship to a standard pattern.
|
16322
17367
|
type: string
|
17368
|
+
priority:
|
17369
|
+
description: Integer from 1 (high) to 5 (low) indicating rule issue severity.
|
17370
|
+
format: int64
|
17371
|
+
maximum: 5
|
17372
|
+
minimum: 1
|
17373
|
+
type: integer
|
16323
17374
|
tags:
|
16324
17375
|
description: List of tags.
|
16325
17376
|
items:
|
@@ -16475,6 +17526,13 @@ components:
|
|
16475
17526
|
pattern:
|
16476
17527
|
description: Regex to match.
|
16477
17528
|
type: string
|
17529
|
+
priority:
|
17530
|
+
description: Integer from 1 (high) to 5 (low) indicating standard pattern
|
17531
|
+
issue severity.
|
17532
|
+
format: int64
|
17533
|
+
maximum: 5
|
17534
|
+
minimum: 1
|
17535
|
+
type: integer
|
16478
17536
|
tags:
|
16479
17537
|
description: List of tags.
|
16480
17538
|
items:
|
@@ -19272,6 +20330,29 @@ components:
|
|
19272
20330
|
example: min
|
19273
20331
|
type: string
|
19274
20332
|
type: object
|
20333
|
+
UpdateOpenAPIResponse:
|
20334
|
+
description: Response for `UpdateOpenAPI`.
|
20335
|
+
properties:
|
20336
|
+
data:
|
20337
|
+
$ref: '#/components/schemas/UpdateOpenAPIResponseData'
|
20338
|
+
type: object
|
20339
|
+
UpdateOpenAPIResponseAttributes:
|
20340
|
+
description: Attributes for `UpdateOpenAPI`.
|
20341
|
+
properties:
|
20342
|
+
failed_endpoints:
|
20343
|
+
description: List of endpoints which couldn't be parsed.
|
20344
|
+
items:
|
20345
|
+
$ref: '#/components/schemas/OpenAPIEndpoint'
|
20346
|
+
type: array
|
20347
|
+
type: object
|
20348
|
+
UpdateOpenAPIResponseData:
|
20349
|
+
description: Data envelope for `UpdateOpenAPIResponse`.
|
20350
|
+
properties:
|
20351
|
+
attributes:
|
20352
|
+
$ref: '#/components/schemas/UpdateOpenAPIResponseAttributes'
|
20353
|
+
id:
|
20354
|
+
$ref: '#/components/schemas/ApiID'
|
20355
|
+
type: object
|
19275
20356
|
UsageApplicationSecurityMonitoringResponse:
|
19276
20357
|
description: Application Security Monitoring usage response.
|
19277
20358
|
properties:
|
@@ -19589,6 +20670,20 @@ components:
|
|
19589
20670
|
UserTeamAttributes:
|
19590
20671
|
description: Team membership attributes
|
19591
20672
|
properties:
|
20673
|
+
provisioned_by:
|
20674
|
+
description: 'The mechanism responsible for provisioning the team relationship.
|
20675
|
+
|
20676
|
+
Possible values: null for added by a user, "service_account" if added
|
20677
|
+
by a service account, and "saml_mapping" if provisioned via SAML mapping.'
|
20678
|
+
nullable: true
|
20679
|
+
readOnly: true
|
20680
|
+
type: string
|
20681
|
+
provisioned_by_id:
|
20682
|
+
description: UUID of the User or Service Account who provisioned this team
|
20683
|
+
membership, or null if provisioned via SAML mapping.
|
20684
|
+
nullable: true
|
20685
|
+
readOnly: true
|
20686
|
+
type: string
|
19592
20687
|
role:
|
19593
20688
|
$ref: '#/components/schemas/UserTeamRole'
|
19594
20689
|
type: object
|
@@ -19640,6 +20735,8 @@ components:
|
|
19640
20735
|
UserTeamRelationships:
|
19641
20736
|
description: Relationship between membership and a user
|
19642
20737
|
properties:
|
20738
|
+
team:
|
20739
|
+
$ref: '#/components/schemas/RelationshipToUserTeamTeam'
|
19643
20740
|
user:
|
19644
20741
|
$ref: '#/components/schemas/RelationshipToUserTeamUser'
|
19645
20742
|
type: object
|
@@ -19665,6 +20762,15 @@ components:
|
|
19665
20762
|
type: string
|
19666
20763
|
x-enum-varnames:
|
19667
20764
|
- ADMIN
|
20765
|
+
UserTeamTeamType:
|
20766
|
+
default: team
|
20767
|
+
description: User team team type
|
20768
|
+
enum:
|
20769
|
+
- team
|
20770
|
+
example: team
|
20771
|
+
type: string
|
20772
|
+
x-enum-varnames:
|
20773
|
+
- TEAM
|
19668
20774
|
UserTeamType:
|
19669
20775
|
default: team_memberships
|
19670
20776
|
description: Team membership type
|
@@ -20073,55 +21179,244 @@ paths:
|
|
20073
21179
|
tags:
|
20074
21180
|
- Key Management
|
20075
21181
|
x-codegen-request-body-name: body
|
20076
|
-
/api/v2/
|
20077
|
-
|
20078
|
-
description:
|
20079
|
-
operationId:
|
21182
|
+
/api/v2/apicatalog/api/{id}:
|
21183
|
+
delete:
|
21184
|
+
description: Delete a specific API by ID.
|
21185
|
+
operationId: DeleteOpenAPI
|
21186
|
+
parameters:
|
21187
|
+
- description: ID of the API to delete
|
21188
|
+
in: path
|
21189
|
+
name: id
|
21190
|
+
required: true
|
21191
|
+
schema:
|
21192
|
+
$ref: '#/components/schemas/ApiID'
|
20080
21193
|
responses:
|
20081
|
-
'
|
21194
|
+
'204':
|
21195
|
+
description: API deleted successfully
|
21196
|
+
'400':
|
20082
21197
|
content:
|
20083
21198
|
application/json:
|
20084
21199
|
schema:
|
20085
|
-
$ref: '#/components/schemas/
|
20086
|
-
description:
|
21200
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
21201
|
+
description: Bad request
|
20087
21202
|
'403':
|
20088
|
-
|
21203
|
+
content:
|
21204
|
+
application/json:
|
21205
|
+
schema:
|
21206
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
21207
|
+
description: Forbidden
|
21208
|
+
'404':
|
21209
|
+
content:
|
21210
|
+
application/json:
|
21211
|
+
schema:
|
21212
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
21213
|
+
description: API not found error
|
20089
21214
|
'429':
|
20090
21215
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
20091
|
-
summary:
|
21216
|
+
summary: Delete an API
|
20092
21217
|
tags:
|
20093
|
-
-
|
20094
|
-
|
20095
|
-
description: 'Create a metric based on your ingested spans in your organization.
|
21218
|
+
- API Management
|
21219
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
20096
21220
|
|
20097
|
-
|
20098
|
-
|
20099
|
-
|
20100
|
-
|
20101
|
-
|
20102
|
-
|
20103
|
-
|
20104
|
-
|
20105
|
-
|
21221
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
21222
|
+
/api/v2/apicatalog/api/{id}/openapi:
|
21223
|
+
get:
|
21224
|
+
description: Retrieve information about a specific API in [OpenAPI](https://spec.openapis.org/oas/latest.html)
|
21225
|
+
format file.
|
21226
|
+
operationId: GetOpenAPI
|
21227
|
+
parameters:
|
21228
|
+
- description: ID of the API to retrieve
|
21229
|
+
in: path
|
21230
|
+
name: id
|
20106
21231
|
required: true
|
21232
|
+
schema:
|
21233
|
+
$ref: '#/components/schemas/ApiID'
|
20107
21234
|
responses:
|
20108
21235
|
'200':
|
20109
21236
|
content:
|
20110
|
-
|
21237
|
+
multipart/form-data:
|
20111
21238
|
schema:
|
20112
|
-
|
21239
|
+
format: binary
|
21240
|
+
type: string
|
20113
21241
|
description: OK
|
20114
21242
|
'400':
|
20115
|
-
|
21243
|
+
content:
|
21244
|
+
application/json:
|
21245
|
+
schema:
|
21246
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
21247
|
+
description: Bad request
|
20116
21248
|
'403':
|
20117
|
-
|
20118
|
-
|
20119
|
-
|
21249
|
+
content:
|
21250
|
+
application/json:
|
21251
|
+
schema:
|
21252
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
21253
|
+
description: Forbidden
|
21254
|
+
'404':
|
21255
|
+
content:
|
21256
|
+
application/json:
|
21257
|
+
schema:
|
21258
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
21259
|
+
description: API not found error
|
20120
21260
|
'429':
|
20121
21261
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
20122
|
-
summary:
|
21262
|
+
summary: Get an API
|
20123
21263
|
tags:
|
20124
|
-
-
|
21264
|
+
- API Management
|
21265
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
21266
|
+
|
21267
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
21268
|
+
put:
|
21269
|
+
description: 'Update information about a specific API. The given content will
|
21270
|
+
replace all API content of the given ID.
|
21271
|
+
|
21272
|
+
The ID is returned by the create API, or can be found in the URL in the API
|
21273
|
+
catalog UI.
|
21274
|
+
|
21275
|
+
'
|
21276
|
+
operationId: UpdateOpenAPI
|
21277
|
+
parameters:
|
21278
|
+
- description: ID of the API to modify
|
21279
|
+
in: path
|
21280
|
+
name: id
|
21281
|
+
required: true
|
21282
|
+
schema:
|
21283
|
+
$ref: '#/components/schemas/ApiID'
|
21284
|
+
requestBody:
|
21285
|
+
content:
|
21286
|
+
multipart/form-data:
|
21287
|
+
schema:
|
21288
|
+
$ref: '#/components/schemas/OpenAPIFile'
|
21289
|
+
required: true
|
21290
|
+
responses:
|
21291
|
+
'200':
|
21292
|
+
content:
|
21293
|
+
application/json:
|
21294
|
+
schema:
|
21295
|
+
$ref: '#/components/schemas/UpdateOpenAPIResponse'
|
21296
|
+
description: API updated successfully
|
21297
|
+
'400':
|
21298
|
+
content:
|
21299
|
+
application/json:
|
21300
|
+
schema:
|
21301
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
21302
|
+
description: Bad request
|
21303
|
+
'403':
|
21304
|
+
content:
|
21305
|
+
application/json:
|
21306
|
+
schema:
|
21307
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
21308
|
+
description: Forbidden
|
21309
|
+
'404':
|
21310
|
+
content:
|
21311
|
+
application/json:
|
21312
|
+
schema:
|
21313
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
21314
|
+
description: API not found error
|
21315
|
+
'429':
|
21316
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
21317
|
+
summary: Update an API
|
21318
|
+
tags:
|
21319
|
+
- API Management
|
21320
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
21321
|
+
|
21322
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
21323
|
+
/api/v2/apicatalog/openapi:
|
21324
|
+
post:
|
21325
|
+
description: 'Create a new API from the [OpenAPI](https://spec.openapis.org/oas/latest.html)
|
21326
|
+
specification given.
|
21327
|
+
|
21328
|
+
It supports version `2.0`, `3.0` and `3.1` of the specification. A specific
|
21329
|
+
extension section, `x-datadog`,
|
21330
|
+
|
21331
|
+
let you specify the `teamHandle` for your team responsible for the API in
|
21332
|
+
Datadog.
|
21333
|
+
|
21334
|
+
It returns the created API ID.
|
21335
|
+
|
21336
|
+
'
|
21337
|
+
operationId: CreateOpenAPI
|
21338
|
+
requestBody:
|
21339
|
+
content:
|
21340
|
+
multipart/form-data:
|
21341
|
+
schema:
|
21342
|
+
$ref: '#/components/schemas/OpenAPIFile'
|
21343
|
+
required: true
|
21344
|
+
responses:
|
21345
|
+
'201':
|
21346
|
+
content:
|
21347
|
+
application/json:
|
21348
|
+
schema:
|
21349
|
+
$ref: '#/components/schemas/CreateOpenAPIResponse'
|
21350
|
+
description: API created successfully
|
21351
|
+
'400':
|
21352
|
+
content:
|
21353
|
+
application/json:
|
21354
|
+
schema:
|
21355
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
21356
|
+
description: Bad request
|
21357
|
+
'403':
|
21358
|
+
content:
|
21359
|
+
application/json:
|
21360
|
+
schema:
|
21361
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
21362
|
+
description: Forbidden
|
21363
|
+
'429':
|
21364
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
21365
|
+
summary: Create a new API
|
21366
|
+
tags:
|
21367
|
+
- API Management
|
21368
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
21369
|
+
|
21370
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
21371
|
+
/api/v2/apm/config/metrics:
|
21372
|
+
get:
|
21373
|
+
description: Get the list of configured span-based metrics with their definitions.
|
21374
|
+
operationId: ListSpansMetrics
|
21375
|
+
responses:
|
21376
|
+
'200':
|
21377
|
+
content:
|
21378
|
+
application/json:
|
21379
|
+
schema:
|
21380
|
+
$ref: '#/components/schemas/SpansMetricsResponse'
|
21381
|
+
description: OK
|
21382
|
+
'403':
|
21383
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
21384
|
+
'429':
|
21385
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
21386
|
+
summary: Get all span-based metrics
|
21387
|
+
tags:
|
21388
|
+
- Spans Metrics
|
21389
|
+
post:
|
21390
|
+
description: 'Create a metric based on your ingested spans in your organization.
|
21391
|
+
|
21392
|
+
Returns the span-based metric object from the request body when the request
|
21393
|
+
is successful.'
|
21394
|
+
operationId: CreateSpansMetric
|
21395
|
+
requestBody:
|
21396
|
+
content:
|
21397
|
+
application/json:
|
21398
|
+
schema:
|
21399
|
+
$ref: '#/components/schemas/SpansMetricCreateRequest'
|
21400
|
+
description: The definition of the new span-based metric.
|
21401
|
+
required: true
|
21402
|
+
responses:
|
21403
|
+
'200':
|
21404
|
+
content:
|
21405
|
+
application/json:
|
21406
|
+
schema:
|
21407
|
+
$ref: '#/components/schemas/SpansMetricResponse'
|
21408
|
+
description: OK
|
21409
|
+
'400':
|
21410
|
+
$ref: '#/components/responses/BadRequestResponse'
|
21411
|
+
'403':
|
21412
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
21413
|
+
'409':
|
21414
|
+
$ref: '#/components/responses/ConflictResponse'
|
21415
|
+
'429':
|
21416
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
21417
|
+
summary: Create a span-based metric
|
21418
|
+
tags:
|
21419
|
+
- Spans Metrics
|
20125
21420
|
x-codegen-request-body-name: body
|
20126
21421
|
/api/v2/apm/config/metrics/{metric_id}:
|
20127
21422
|
delete:
|
@@ -20899,9 +22194,6 @@ paths:
|
|
20899
22194
|
tags:
|
20900
22195
|
- CI Visibility Pipelines
|
20901
22196
|
x-codegen-request-body-name: body
|
20902
|
-
x-unstable: '**Note:** This endpoint is in public beta.
|
20903
|
-
|
20904
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
20905
22197
|
/api/v2/ci/pipelines/analytics/aggregate:
|
20906
22198
|
post:
|
20907
22199
|
description: Use this API endpoint to aggregate CI Visibility pipeline events
|
@@ -21271,7 +22563,388 @@ paths:
|
|
21271
22563
|
content:
|
21272
22564
|
application/json:
|
21273
22565
|
schema:
|
21274
|
-
$ref: '#/components/schemas/ContainerImagesResponse'
|
22566
|
+
$ref: '#/components/schemas/ContainerImagesResponse'
|
22567
|
+
description: OK
|
22568
|
+
'400':
|
22569
|
+
content:
|
22570
|
+
application/json:
|
22571
|
+
schema:
|
22572
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22573
|
+
description: Bad Request
|
22574
|
+
'403':
|
22575
|
+
content:
|
22576
|
+
application/json:
|
22577
|
+
schema:
|
22578
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22579
|
+
description: Authentication Error
|
22580
|
+
'429':
|
22581
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
22582
|
+
security:
|
22583
|
+
- apiKeyAuth: []
|
22584
|
+
appKeyAuth: []
|
22585
|
+
- AuthZ: []
|
22586
|
+
summary: Get all Container Images
|
22587
|
+
tags:
|
22588
|
+
- Container Images
|
22589
|
+
x-pagination:
|
22590
|
+
cursorParam: page[cursor]
|
22591
|
+
cursorPath: meta.pagination.next_cursor
|
22592
|
+
limitParam: page[size]
|
22593
|
+
resultsPath: data
|
22594
|
+
/api/v2/containers:
|
22595
|
+
get:
|
22596
|
+
description: Get all containers for your organization.
|
22597
|
+
operationId: ListContainers
|
22598
|
+
parameters:
|
22599
|
+
- description: Comma-separated list of tags to filter containers by.
|
22600
|
+
example: env:prod,short_image:cassandra
|
22601
|
+
in: query
|
22602
|
+
name: filter[tags]
|
22603
|
+
required: false
|
22604
|
+
schema:
|
22605
|
+
type: string
|
22606
|
+
- description: Comma-separated list of tags to group containers by.
|
22607
|
+
example: datacenter,cluster
|
22608
|
+
in: query
|
22609
|
+
name: group_by
|
22610
|
+
required: false
|
22611
|
+
schema:
|
22612
|
+
type: string
|
22613
|
+
- description: Attribute to sort containers by.
|
22614
|
+
example: started_at
|
22615
|
+
in: query
|
22616
|
+
name: sort
|
22617
|
+
required: false
|
22618
|
+
schema:
|
22619
|
+
type: string
|
22620
|
+
- description: Maximum number of results returned.
|
22621
|
+
in: query
|
22622
|
+
name: page[size]
|
22623
|
+
required: false
|
22624
|
+
schema:
|
22625
|
+
default: 1000
|
22626
|
+
format: int32
|
22627
|
+
maximum: 10000
|
22628
|
+
minimum: 1
|
22629
|
+
type: integer
|
22630
|
+
- description: 'String to query the next page of results.
|
22631
|
+
|
22632
|
+
This key is provided with each valid response from the API in `meta.pagination.next_cursor`.'
|
22633
|
+
in: query
|
22634
|
+
name: page[cursor]
|
22635
|
+
required: false
|
22636
|
+
schema:
|
22637
|
+
type: string
|
22638
|
+
responses:
|
22639
|
+
'200':
|
22640
|
+
content:
|
22641
|
+
application/json:
|
22642
|
+
schema:
|
22643
|
+
$ref: '#/components/schemas/ContainersResponse'
|
22644
|
+
description: OK
|
22645
|
+
'400':
|
22646
|
+
content:
|
22647
|
+
application/json:
|
22648
|
+
schema:
|
22649
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22650
|
+
description: Bad Request
|
22651
|
+
'403':
|
22652
|
+
content:
|
22653
|
+
application/json:
|
22654
|
+
schema:
|
22655
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22656
|
+
description: Authentication Error
|
22657
|
+
'429':
|
22658
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
22659
|
+
security:
|
22660
|
+
- apiKeyAuth: []
|
22661
|
+
appKeyAuth: []
|
22662
|
+
- AuthZ: []
|
22663
|
+
summary: Get All Containers
|
22664
|
+
tags:
|
22665
|
+
- Containers
|
22666
|
+
x-pagination:
|
22667
|
+
cursorParam: page[cursor]
|
22668
|
+
cursorPath: meta.pagination.next_cursor
|
22669
|
+
limitParam: page[size]
|
22670
|
+
resultsPath: data
|
22671
|
+
/api/v2/cost/aws_cur_config:
|
22672
|
+
get:
|
22673
|
+
description: List the AWS CUR configs.
|
22674
|
+
operationId: ListCostAWSCURConfigs
|
22675
|
+
responses:
|
22676
|
+
'200':
|
22677
|
+
content:
|
22678
|
+
application/json:
|
22679
|
+
schema:
|
22680
|
+
$ref: '#/components/schemas/AwsCURConfigsResponse'
|
22681
|
+
description: OK
|
22682
|
+
'403':
|
22683
|
+
content:
|
22684
|
+
application/json:
|
22685
|
+
schema:
|
22686
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22687
|
+
description: Forbidden
|
22688
|
+
'429':
|
22689
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
22690
|
+
summary: List Cloud Cost Management AWS CUR configs
|
22691
|
+
tags:
|
22692
|
+
- Cloud Cost Management
|
22693
|
+
x-permission:
|
22694
|
+
operator: OR
|
22695
|
+
permissions:
|
22696
|
+
- CLOUD_COST_MANAGEMENT_READ
|
22697
|
+
post:
|
22698
|
+
description: Create a Cloud Cost Management account for an AWS CUR config.
|
22699
|
+
operationId: CreateCostAWSCURConfig
|
22700
|
+
requestBody:
|
22701
|
+
content:
|
22702
|
+
application/json:
|
22703
|
+
schema:
|
22704
|
+
$ref: '#/components/schemas/AwsCURConfigPostRequest'
|
22705
|
+
required: true
|
22706
|
+
responses:
|
22707
|
+
'200':
|
22708
|
+
content:
|
22709
|
+
application/json:
|
22710
|
+
schema:
|
22711
|
+
$ref: '#/components/schemas/AwsCURConfigResponse'
|
22712
|
+
description: OK
|
22713
|
+
'400':
|
22714
|
+
content:
|
22715
|
+
application/json:
|
22716
|
+
schema:
|
22717
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22718
|
+
description: Bad Request
|
22719
|
+
'403':
|
22720
|
+
content:
|
22721
|
+
application/json:
|
22722
|
+
schema:
|
22723
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22724
|
+
description: Forbidden
|
22725
|
+
'429':
|
22726
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
22727
|
+
summary: Create Cloud Cost Management AWS CUR config
|
22728
|
+
tags:
|
22729
|
+
- Cloud Cost Management
|
22730
|
+
x-permission:
|
22731
|
+
operator: OR
|
22732
|
+
permissions:
|
22733
|
+
- CLOUD_COST_MANAGEMENT_WRITE
|
22734
|
+
/api/v2/cost/aws_cur_config/{cloud_account_id}:
|
22735
|
+
delete:
|
22736
|
+
description: Archive a Cloud Cost Management Account.
|
22737
|
+
operationId: DeleteCostAWSCURConfig
|
22738
|
+
parameters:
|
22739
|
+
- $ref: '#/components/parameters/CloudAccountID'
|
22740
|
+
responses:
|
22741
|
+
'204':
|
22742
|
+
description: No Content
|
22743
|
+
'400':
|
22744
|
+
content:
|
22745
|
+
application/json:
|
22746
|
+
schema:
|
22747
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22748
|
+
description: Bad Request
|
22749
|
+
'404':
|
22750
|
+
content:
|
22751
|
+
application/json:
|
22752
|
+
schema:
|
22753
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22754
|
+
description: Not Found
|
22755
|
+
'429':
|
22756
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
22757
|
+
summary: Delete Cloud Cost Management AWS CUR config
|
22758
|
+
tags:
|
22759
|
+
- Cloud Cost Management
|
22760
|
+
x-permission:
|
22761
|
+
operator: OR
|
22762
|
+
permissions:
|
22763
|
+
- CLOUD_COST_MANAGEMENT_WRITE
|
22764
|
+
patch:
|
22765
|
+
description: Update the status of an AWS CUR config (active/archived).
|
22766
|
+
operationId: UpdateCostAWSCURConfig
|
22767
|
+
parameters:
|
22768
|
+
- $ref: '#/components/parameters/CloudAccountID'
|
22769
|
+
requestBody:
|
22770
|
+
content:
|
22771
|
+
application/json:
|
22772
|
+
schema:
|
22773
|
+
$ref: '#/components/schemas/AwsCURConfigPatchRequest'
|
22774
|
+
required: true
|
22775
|
+
responses:
|
22776
|
+
'200':
|
22777
|
+
content:
|
22778
|
+
application/json:
|
22779
|
+
schema:
|
22780
|
+
$ref: '#/components/schemas/AwsCURConfigsResponse'
|
22781
|
+
description: OK
|
22782
|
+
'403':
|
22783
|
+
content:
|
22784
|
+
application/json:
|
22785
|
+
schema:
|
22786
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22787
|
+
description: Forbidden
|
22788
|
+
'429':
|
22789
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
22790
|
+
summary: Update Cloud Cost Management AWS CUR config
|
22791
|
+
tags:
|
22792
|
+
- Cloud Cost Management
|
22793
|
+
x-permission:
|
22794
|
+
operator: OR
|
22795
|
+
permissions:
|
22796
|
+
- CLOUD_COST_MANAGEMENT_WRITE
|
22797
|
+
/api/v2/cost/aws_related_accounts:
|
22798
|
+
get:
|
22799
|
+
description: List the AWS accounts in an organization by calling 'organizations:ListAccounts'
|
22800
|
+
from the specified management account.
|
22801
|
+
operationId: ListAWSRelatedAccounts
|
22802
|
+
parameters:
|
22803
|
+
- description: The ID of the management account to filter by.
|
22804
|
+
example: '123456789123'
|
22805
|
+
in: query
|
22806
|
+
name: filter[management_account_id]
|
22807
|
+
required: true
|
22808
|
+
schema:
|
22809
|
+
type: string
|
22810
|
+
responses:
|
22811
|
+
'200':
|
22812
|
+
content:
|
22813
|
+
application/json:
|
22814
|
+
schema:
|
22815
|
+
$ref: '#/components/schemas/AWSRelatedAccountsResponse'
|
22816
|
+
description: OK
|
22817
|
+
'400':
|
22818
|
+
content:
|
22819
|
+
application/json:
|
22820
|
+
schema:
|
22821
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22822
|
+
description: Bad Request
|
22823
|
+
'403':
|
22824
|
+
content:
|
22825
|
+
application/json:
|
22826
|
+
schema:
|
22827
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22828
|
+
description: Forbidden
|
22829
|
+
'429':
|
22830
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
22831
|
+
summary: List related AWS accounts
|
22832
|
+
tags:
|
22833
|
+
- Cloud Cost Management
|
22834
|
+
x-permission:
|
22835
|
+
operator: OR
|
22836
|
+
permissions:
|
22837
|
+
- CLOUD_COST_MANAGEMENT_READ
|
22838
|
+
/api/v2/cost/azure_uc_config:
|
22839
|
+
get:
|
22840
|
+
description: List the Azure configs.
|
22841
|
+
operationId: ListCostAzureUCConfigs
|
22842
|
+
responses:
|
22843
|
+
'200':
|
22844
|
+
content:
|
22845
|
+
application/json:
|
22846
|
+
schema:
|
22847
|
+
$ref: '#/components/schemas/AzureUCConfigsResponse'
|
22848
|
+
description: OK
|
22849
|
+
'403':
|
22850
|
+
content:
|
22851
|
+
application/json:
|
22852
|
+
schema:
|
22853
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22854
|
+
description: Forbidden
|
22855
|
+
'429':
|
22856
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
22857
|
+
summary: List Cloud Cost Management Azure configs
|
22858
|
+
tags:
|
22859
|
+
- Cloud Cost Management
|
22860
|
+
x-permission:
|
22861
|
+
operator: OR
|
22862
|
+
permissions:
|
22863
|
+
- CLOUD_COST_MANAGEMENT_READ
|
22864
|
+
post:
|
22865
|
+
description: Create a Cloud Cost Management account for an Azure config.
|
22866
|
+
operationId: CreateCostAzureUCConfigs
|
22867
|
+
requestBody:
|
22868
|
+
content:
|
22869
|
+
application/json:
|
22870
|
+
schema:
|
22871
|
+
$ref: '#/components/schemas/AzureUCConfigPostRequest'
|
22872
|
+
required: true
|
22873
|
+
responses:
|
22874
|
+
'200':
|
22875
|
+
content:
|
22876
|
+
application/json:
|
22877
|
+
schema:
|
22878
|
+
$ref: '#/components/schemas/AzureUCConfigPairsResponse'
|
22879
|
+
description: OK
|
22880
|
+
'400':
|
22881
|
+
content:
|
22882
|
+
application/json:
|
22883
|
+
schema:
|
22884
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22885
|
+
description: Bad Request
|
22886
|
+
'403':
|
22887
|
+
content:
|
22888
|
+
application/json:
|
22889
|
+
schema:
|
22890
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22891
|
+
description: Forbidden
|
22892
|
+
'429':
|
22893
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
22894
|
+
summary: Create Cloud Cost Management Azure configs
|
22895
|
+
tags:
|
22896
|
+
- Cloud Cost Management
|
22897
|
+
x-permission:
|
22898
|
+
operator: OR
|
22899
|
+
permissions:
|
22900
|
+
- CLOUD_COST_MANAGEMENT_WRITE
|
22901
|
+
/api/v2/cost/azure_uc_config/{cloud_account_id}:
|
22902
|
+
delete:
|
22903
|
+
description: Archive a Cloud Cost Management Account.
|
22904
|
+
operationId: DeleteCostAzureUCConfig
|
22905
|
+
parameters:
|
22906
|
+
- $ref: '#/components/parameters/CloudAccountID'
|
22907
|
+
responses:
|
22908
|
+
'204':
|
22909
|
+
description: No Content
|
22910
|
+
'400':
|
22911
|
+
content:
|
22912
|
+
application/json:
|
22913
|
+
schema:
|
22914
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22915
|
+
description: Bad Request
|
22916
|
+
'404':
|
22917
|
+
content:
|
22918
|
+
application/json:
|
22919
|
+
schema:
|
22920
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22921
|
+
description: Not Found
|
22922
|
+
'429':
|
22923
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
22924
|
+
summary: Delete Cloud Cost Management Azure config
|
22925
|
+
tags:
|
22926
|
+
- Cloud Cost Management
|
22927
|
+
x-permission:
|
22928
|
+
operator: OR
|
22929
|
+
permissions:
|
22930
|
+
- CLOUD_COST_MANAGEMENT_WRITE
|
22931
|
+
patch:
|
22932
|
+
description: Update the status of an Azure config (active/archived).
|
22933
|
+
operationId: UpdateCostAzureUCConfigs
|
22934
|
+
parameters:
|
22935
|
+
- $ref: '#/components/parameters/CloudAccountID'
|
22936
|
+
requestBody:
|
22937
|
+
content:
|
22938
|
+
application/json:
|
22939
|
+
schema:
|
22940
|
+
$ref: '#/components/schemas/AzureUCConfigPatchRequest'
|
22941
|
+
required: true
|
22942
|
+
responses:
|
22943
|
+
'200':
|
22944
|
+
content:
|
22945
|
+
application/json:
|
22946
|
+
schema:
|
22947
|
+
$ref: '#/components/schemas/AzureUCConfigPairsResponse'
|
21275
22948
|
description: OK
|
21276
22949
|
'400':
|
21277
22950
|
content:
|
@@ -21284,98 +22957,42 @@ paths:
|
|
21284
22957
|
application/json:
|
21285
22958
|
schema:
|
21286
22959
|
$ref: '#/components/schemas/APIErrorResponse'
|
21287
|
-
description:
|
22960
|
+
description: Forbidden
|
21288
22961
|
'429':
|
21289
22962
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
21290
|
-
|
21291
|
-
- apiKeyAuth: []
|
21292
|
-
appKeyAuth: []
|
21293
|
-
- AuthZ: []
|
21294
|
-
summary: Get all Container Images
|
22963
|
+
summary: Update Cloud Cost Management Azure config
|
21295
22964
|
tags:
|
21296
|
-
-
|
21297
|
-
x-
|
21298
|
-
|
21299
|
-
|
21300
|
-
|
21301
|
-
|
21302
|
-
/api/v2/containers:
|
22965
|
+
- Cloud Cost Management
|
22966
|
+
x-permission:
|
22967
|
+
operator: OR
|
22968
|
+
permissions:
|
22969
|
+
- CLOUD_COST_MANAGEMENT_WRITE
|
22970
|
+
/api/v2/cost/enabled:
|
21303
22971
|
get:
|
21304
|
-
description: Get
|
21305
|
-
operationId:
|
21306
|
-
parameters:
|
21307
|
-
- description: Comma-separated list of tags to filter containers by.
|
21308
|
-
example: env:prod,short_image:cassandra
|
21309
|
-
in: query
|
21310
|
-
name: filter[tags]
|
21311
|
-
required: false
|
21312
|
-
schema:
|
21313
|
-
type: string
|
21314
|
-
- description: Comma-separated list of tags to group containers by.
|
21315
|
-
example: datacenter,cluster
|
21316
|
-
in: query
|
21317
|
-
name: group_by
|
21318
|
-
required: false
|
21319
|
-
schema:
|
21320
|
-
type: string
|
21321
|
-
- description: Attribute to sort containers by.
|
21322
|
-
example: started_at
|
21323
|
-
in: query
|
21324
|
-
name: sort
|
21325
|
-
required: false
|
21326
|
-
schema:
|
21327
|
-
type: string
|
21328
|
-
- description: Maximum number of results returned.
|
21329
|
-
in: query
|
21330
|
-
name: page[size]
|
21331
|
-
required: false
|
21332
|
-
schema:
|
21333
|
-
default: 1000
|
21334
|
-
format: int32
|
21335
|
-
maximum: 10000
|
21336
|
-
minimum: 1
|
21337
|
-
type: integer
|
21338
|
-
- description: 'String to query the next page of results.
|
21339
|
-
|
21340
|
-
This key is provided with each valid response from the API in `meta.pagination.next_cursor`.'
|
21341
|
-
in: query
|
21342
|
-
name: page[cursor]
|
21343
|
-
required: false
|
21344
|
-
schema:
|
21345
|
-
type: string
|
22972
|
+
description: Get the Cloud Cost Management activity.
|
22973
|
+
operationId: GetCloudCostActivity
|
21346
22974
|
responses:
|
21347
22975
|
'200':
|
21348
22976
|
content:
|
21349
22977
|
application/json:
|
21350
22978
|
schema:
|
21351
|
-
$ref: '#/components/schemas/
|
22979
|
+
$ref: '#/components/schemas/CloudCostActivityResponse'
|
21352
22980
|
description: OK
|
21353
|
-
'400':
|
21354
|
-
content:
|
21355
|
-
application/json:
|
21356
|
-
schema:
|
21357
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
21358
|
-
description: Bad Request
|
21359
22981
|
'403':
|
21360
22982
|
content:
|
21361
22983
|
application/json:
|
21362
22984
|
schema:
|
21363
22985
|
$ref: '#/components/schemas/APIErrorResponse'
|
21364
|
-
description:
|
22986
|
+
description: Forbidden
|
21365
22987
|
'429':
|
21366
22988
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
21367
|
-
|
21368
|
-
- apiKeyAuth: []
|
21369
|
-
appKeyAuth: []
|
21370
|
-
- AuthZ: []
|
21371
|
-
summary: Get All Containers
|
22989
|
+
summary: Cloud Cost Enabled
|
21372
22990
|
tags:
|
21373
|
-
-
|
21374
|
-
x-
|
21375
|
-
|
21376
|
-
|
21377
|
-
|
21378
|
-
resultsPath: data
|
22991
|
+
- Cloud Cost Management
|
22992
|
+
x-permission:
|
22993
|
+
operator: OR
|
22994
|
+
permissions:
|
22995
|
+
- CLOUD_COST_MANAGEMENT_READ
|
21379
22996
|
/api/v2/cost_by_tag/active_billing_dimensions:
|
21380
22997
|
get:
|
21381
22998
|
description: Get active billing dimensions for cost attribution. Cost data for
|
@@ -21409,7 +23026,8 @@ paths:
|
|
21409
23026
|
security:
|
21410
23027
|
- apiKeyAuth: []
|
21411
23028
|
appKeyAuth: []
|
21412
|
-
- AuthZ:
|
23029
|
+
- AuthZ:
|
23030
|
+
- usage_read
|
21413
23031
|
summary: Get active billing dimensions for cost attribution
|
21414
23032
|
tags:
|
21415
23033
|
- Usage Metering
|
@@ -21530,7 +23148,8 @@ paths:
|
|
21530
23148
|
security:
|
21531
23149
|
- apiKeyAuth: []
|
21532
23150
|
appKeyAuth: []
|
21533
|
-
- AuthZ:
|
23151
|
+
- AuthZ:
|
23152
|
+
- usage_read
|
21534
23153
|
summary: Get Monthly Cost Attribution
|
21535
23154
|
tags:
|
21536
23155
|
- Usage Metering
|
@@ -21947,8 +23566,7 @@ paths:
|
|
21947
23566
|
tags:
|
21948
23567
|
- DORA Metrics
|
21949
23568
|
x-codegen-request-body-name: body
|
21950
|
-
x-unstable: '**Note**: This endpoint is in private beta
|
21951
|
-
customers.
|
23569
|
+
x-unstable: '**Note**: This endpoint is in private beta.
|
21952
23570
|
|
21953
23571
|
If you want to request access, complete the [form](https://forms.gle/Eqq6uXfGjYxmqpjDA).'
|
21954
23572
|
/api/v2/dora/incident:
|
@@ -21998,8 +23616,7 @@ paths:
|
|
21998
23616
|
tags:
|
21999
23617
|
- DORA Metrics
|
22000
23618
|
x-codegen-request-body-name: body
|
22001
|
-
x-unstable: '**Note**: This endpoint is in private beta
|
22002
|
-
customers.
|
23619
|
+
x-unstable: '**Note**: This endpoint is in private beta.
|
22003
23620
|
|
22004
23621
|
If you want to request access, complete the [form](https://forms.gle/Eqq6uXfGjYxmqpjDA).'
|
22005
23622
|
/api/v2/downtime:
|
@@ -25109,8 +26726,8 @@ paths:
|
|
25109
26726
|
required: false
|
25110
26727
|
schema:
|
25111
26728
|
type: boolean
|
25112
|
-
- description: 'Filter custom metrics that have or have not been queried
|
25113
|
-
the specified window[seconds].
|
26729
|
+
- description: '(Beta) Filter custom metrics that have or have not been queried
|
26730
|
+
in the specified window[seconds].
|
25114
26731
|
|
25115
26732
|
If no window is provided or the window is less than 2 hours, a default of
|
25116
26733
|
2 hours will be applied.'
|
@@ -25578,7 +27195,9 @@ paths:
|
|
25578
27195
|
queryable.
|
25579
27196
|
|
25580
27197
|
Can only be used with application keys from users with the `Manage Tags for
|
25581
|
-
Metrics` permission.
|
27198
|
+
Metrics` permission. This endpoint requires
|
27199
|
+
|
27200
|
+
a tag configuration to be created first.'
|
25582
27201
|
operationId: UpdateTagConfiguration
|
25583
27202
|
parameters:
|
25584
27203
|
- $ref: '#/components/parameters/MetricName'
|
@@ -25931,6 +27550,16 @@ paths:
|
|
25931
27550
|
schema:
|
25932
27551
|
format: int64
|
25933
27552
|
type: integer
|
27553
|
+
- $ref: '#/components/parameters/PageOffset'
|
27554
|
+
- description: Maximum number of downtimes in the response.
|
27555
|
+
example: 100
|
27556
|
+
in: query
|
27557
|
+
name: page[limit]
|
27558
|
+
required: false
|
27559
|
+
schema:
|
27560
|
+
default: 30
|
27561
|
+
format: int64
|
27562
|
+
type: integer
|
25934
27563
|
responses:
|
25935
27564
|
'200':
|
25936
27565
|
content:
|
@@ -25955,6 +27584,10 @@ paths:
|
|
25955
27584
|
tags:
|
25956
27585
|
- Downtimes
|
25957
27586
|
x-codegen-request-body-name: body
|
27587
|
+
x-pagination:
|
27588
|
+
limitParam: page[limit]
|
27589
|
+
pageOffsetParam: page[offset]
|
27590
|
+
resultsPath: data
|
25958
27591
|
/api/v2/permissions:
|
25959
27592
|
get:
|
25960
27593
|
description: Returns a list of all permissions, including name, description,
|
@@ -26544,10 +28177,9 @@ paths:
|
|
26544
28177
|
- Metrics
|
26545
28178
|
x-codegen-request-body-name: body
|
26546
28179
|
x-unstable: '**Note**: This endpoint is GA for Metrics, Real User Monitoring
|
26547
|
-
(RUM),
|
28180
|
+
(RUM), Cloud Cost Management, and Log Management data sources.
|
26548
28181
|
|
26549
|
-
|
26550
|
-
sources. If you have any
|
28182
|
+
We are gradually onboarding support for more sources. If you have any
|
26551
28183
|
|
26552
28184
|
feedback, contact [Datadog Support](https://docs.datadoghq.com/help/).'
|
26553
28185
|
/api/v2/query/timeseries:
|
@@ -26587,10 +28219,9 @@ paths:
|
|
26587
28219
|
- Metrics
|
26588
28220
|
x-codegen-request-body-name: body
|
26589
28221
|
x-unstable: '**Note**: This endpoint is GA for Metrics, Real User Monitoring
|
26590
|
-
(RUM),
|
28222
|
+
(RUM), Cloud Cost Management, and Log Management data sources.
|
26591
28223
|
|
26592
|
-
|
26593
|
-
sources. If you have any
|
28224
|
+
We are gradually onboarding support for more sources. If you have any
|
26594
28225
|
|
26595
28226
|
feedback, contact [Datadog Support](https://docs.datadoghq.com/help/).'
|
26596
28227
|
/api/v2/restriction_policy/{resource_id}:
|
@@ -27695,10 +29326,9 @@ paths:
|
|
27695
29326
|
tags:
|
27696
29327
|
- Service Scorecards
|
27697
29328
|
x-codegen-request-body-name: body
|
27698
|
-
x-unstable: '**Note**: This endpoint is in
|
27699
|
-
fill out this [sign-up form](https://forms.gle/CcEyp1uJmZpxRv8U8),
|
29329
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
27700
29330
|
|
27701
|
-
|
29331
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
27702
29332
|
/api/v2/scorecard/rules:
|
27703
29333
|
get:
|
27704
29334
|
description: Fetch all rules.
|
@@ -27823,10 +29453,9 @@ paths:
|
|
27823
29453
|
tags:
|
27824
29454
|
- Service Scorecards
|
27825
29455
|
x-codegen-request-body-name: body
|
27826
|
-
x-unstable: '**Note**: This endpoint is in
|
27827
|
-
fill out this [sign-up form](https://forms.gle/CcEyp1uJmZpxRv8U8),
|
29456
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
27828
29457
|
|
27829
|
-
|
29458
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
27830
29459
|
/api/v2/scorecard/rules/{rule_id}:
|
27831
29460
|
delete:
|
27832
29461
|
description: Deletes a single rule.
|
@@ -27852,10 +29481,9 @@ paths:
|
|
27852
29481
|
summary: Delete a rule
|
27853
29482
|
tags:
|
27854
29483
|
- Service Scorecards
|
27855
|
-
x-unstable: '**Note**: This endpoint is in
|
27856
|
-
fill out this [sign-up form](https://forms.gle/CcEyp1uJmZpxRv8U8),
|
29484
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
27857
29485
|
|
27858
|
-
|
29486
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
27859
29487
|
/api/v2/security/cloud_workload/policy/download:
|
27860
29488
|
get:
|
27861
29489
|
description: 'The download endpoint generates a Cloud Workload Security policy
|
@@ -28158,6 +29786,149 @@ paths:
|
|
28158
29786
|
tags:
|
28159
29787
|
- Security Monitoring
|
28160
29788
|
x-codegen-request-body-name: body
|
29789
|
+
/api/v2/security_monitoring/configuration/suppressions:
|
29790
|
+
get:
|
29791
|
+
description: Get the list of all suppression rules.
|
29792
|
+
operationId: ListSecurityMonitoringSuppressions
|
29793
|
+
responses:
|
29794
|
+
'200':
|
29795
|
+
content:
|
29796
|
+
application/json:
|
29797
|
+
schema:
|
29798
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionsResponse'
|
29799
|
+
description: OK
|
29800
|
+
'403':
|
29801
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
29802
|
+
'429':
|
29803
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
29804
|
+
security:
|
29805
|
+
- apiKeyAuth: []
|
29806
|
+
appKeyAuth: []
|
29807
|
+
- AuthZ:
|
29808
|
+
- security_monitoring_suppressions_read
|
29809
|
+
summary: Get all suppression rules
|
29810
|
+
tags:
|
29811
|
+
- Security Monitoring
|
29812
|
+
post:
|
29813
|
+
description: Create a new suppression rule.
|
29814
|
+
operationId: CreateSecurityMonitoringSuppression
|
29815
|
+
requestBody:
|
29816
|
+
content:
|
29817
|
+
application/json:
|
29818
|
+
schema:
|
29819
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionCreateRequest'
|
29820
|
+
description: The definition of the new suppression rule.
|
29821
|
+
required: true
|
29822
|
+
responses:
|
29823
|
+
'200':
|
29824
|
+
content:
|
29825
|
+
application/json:
|
29826
|
+
schema:
|
29827
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionResponse'
|
29828
|
+
description: OK
|
29829
|
+
'400':
|
29830
|
+
$ref: '#/components/responses/BadRequestResponse'
|
29831
|
+
'403':
|
29832
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
29833
|
+
'409':
|
29834
|
+
$ref: '#/components/responses/ConflictResponse'
|
29835
|
+
'429':
|
29836
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
29837
|
+
security:
|
29838
|
+
- apiKeyAuth: []
|
29839
|
+
appKeyAuth: []
|
29840
|
+
- AuthZ:
|
29841
|
+
- security_monitoring_suppressions_write
|
29842
|
+
summary: Create a suppression rule
|
29843
|
+
tags:
|
29844
|
+
- Security Monitoring
|
29845
|
+
x-codegen-request-body-name: body
|
29846
|
+
/api/v2/security_monitoring/configuration/suppressions/{suppression_id}:
|
29847
|
+
delete:
|
29848
|
+
description: Delete a specific suppression rule.
|
29849
|
+
operationId: DeleteSecurityMonitoringSuppression
|
29850
|
+
parameters:
|
29851
|
+
- $ref: '#/components/parameters/SecurityMonitoringSuppressionID'
|
29852
|
+
responses:
|
29853
|
+
'204':
|
29854
|
+
description: OK
|
29855
|
+
'403':
|
29856
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
29857
|
+
'404':
|
29858
|
+
$ref: '#/components/responses/NotFoundResponse'
|
29859
|
+
'429':
|
29860
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
29861
|
+
security:
|
29862
|
+
- apiKeyAuth: []
|
29863
|
+
appKeyAuth: []
|
29864
|
+
- AuthZ:
|
29865
|
+
- security_monitoring_suppressions_write
|
29866
|
+
summary: Delete a suppression rule
|
29867
|
+
tags:
|
29868
|
+
- Security Monitoring
|
29869
|
+
get:
|
29870
|
+
description: Get the details of a specific suppression rule.
|
29871
|
+
operationId: GetSecurityMonitoringSuppression
|
29872
|
+
parameters:
|
29873
|
+
- $ref: '#/components/parameters/SecurityMonitoringSuppressionID'
|
29874
|
+
responses:
|
29875
|
+
'200':
|
29876
|
+
content:
|
29877
|
+
application/json:
|
29878
|
+
schema:
|
29879
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionResponse'
|
29880
|
+
description: OK
|
29881
|
+
'403':
|
29882
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
29883
|
+
'404':
|
29884
|
+
$ref: '#/components/responses/NotFoundResponse'
|
29885
|
+
'429':
|
29886
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
29887
|
+
security:
|
29888
|
+
- apiKeyAuth: []
|
29889
|
+
appKeyAuth: []
|
29890
|
+
- AuthZ:
|
29891
|
+
- security_monitoring_suppressions_read
|
29892
|
+
summary: Get a suppression rule
|
29893
|
+
tags:
|
29894
|
+
- Security Monitoring
|
29895
|
+
patch:
|
29896
|
+
description: Update a specific suppression rule.
|
29897
|
+
operationId: UpdateSecurityMonitoringSuppression
|
29898
|
+
parameters:
|
29899
|
+
- $ref: '#/components/parameters/SecurityMonitoringSuppressionID'
|
29900
|
+
requestBody:
|
29901
|
+
content:
|
29902
|
+
application/json:
|
29903
|
+
schema:
|
29904
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionUpdateRequest'
|
29905
|
+
description: New definition of the suppression rule. Supports partial updates.
|
29906
|
+
required: true
|
29907
|
+
responses:
|
29908
|
+
'200':
|
29909
|
+
content:
|
29910
|
+
application/json:
|
29911
|
+
schema:
|
29912
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionResponse'
|
29913
|
+
description: OK
|
29914
|
+
'400':
|
29915
|
+
$ref: '#/components/responses/BadRequestResponse'
|
29916
|
+
'403':
|
29917
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
29918
|
+
'404':
|
29919
|
+
$ref: '#/components/responses/NotFoundResponse'
|
29920
|
+
'409':
|
29921
|
+
$ref: '#/components/responses/ConcurrentModificationResponse'
|
29922
|
+
'429':
|
29923
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
29924
|
+
security:
|
29925
|
+
- apiKeyAuth: []
|
29926
|
+
appKeyAuth: []
|
29927
|
+
- AuthZ:
|
29928
|
+
- security_monitoring_suppressions_write
|
29929
|
+
summary: Update a suppression rule
|
29930
|
+
tags:
|
29931
|
+
- Security Monitoring
|
28161
29932
|
/api/v2/security_monitoring/rules:
|
28162
29933
|
get:
|
28163
29934
|
description: List rules.
|
@@ -30220,6 +31991,10 @@ paths:
|
|
30220
31991
|
summary: Get team memberships
|
30221
31992
|
tags:
|
30222
31993
|
- Teams
|
31994
|
+
x-pagination:
|
31995
|
+
limitParam: page[size]
|
31996
|
+
pageParam: page[number]
|
31997
|
+
resultsPath: data
|
30223
31998
|
post:
|
30224
31999
|
description: Add a user to a team.
|
30225
32000
|
operationId: CreateTeamMembership
|
@@ -31024,7 +32799,7 @@ paths:
|
|
31024
32799
|
- Usage Metering
|
31025
32800
|
/api/v2/usage/lambda_traced_invocations:
|
31026
32801
|
get:
|
31027
|
-
description: 'Get hourly usage for
|
32802
|
+
description: 'Get hourly usage for Lambda traced invocations.
|
31028
32803
|
|
31029
32804
|
**Note:** hourly usage data for all products is now available in the [Get
|
31030
32805
|
hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)'
|
@@ -31078,7 +32853,7 @@ paths:
|
|
31078
32853
|
appKeyAuth: []
|
31079
32854
|
- AuthZ:
|
31080
32855
|
- usage_read
|
31081
|
-
summary: Get hourly usage for
|
32856
|
+
summary: Get hourly usage for Lambda traced invocations
|
31082
32857
|
tags:
|
31083
32858
|
- Usage Metering
|
31084
32859
|
/api/v2/usage/observability_pipelines:
|
@@ -31662,41 +33437,59 @@ servers:
|
|
31662
33437
|
default: api
|
31663
33438
|
description: The subdomain where the API is deployed.
|
31664
33439
|
tags:
|
33440
|
+
- description: Configure your API endpoints through the Datadog API.
|
33441
|
+
name: API Management
|
31665
33442
|
- description: Manage configuration of [APM retention filters](https://app.datadoghq.com/apm/traces/retention-filters)
|
31666
33443
|
for your organization. You need an API and application key with Admin rights to
|
31667
|
-
interact with this endpoint.
|
33444
|
+
interact with this endpoint. See [retention filters](https://docs.datadoghq.com/tracing/trace_pipeline/trace_retention/#retention-filters)
|
33445
|
+
on the Trace Retention page for more information.
|
31668
33446
|
externalDocs:
|
31669
33447
|
description: Find out more at
|
31670
33448
|
url: https://docs.datadoghq.com/tracing/trace_pipeline/trace_retention/
|
31671
33449
|
name: APM Retention Filters
|
31672
33450
|
- description: Search your Audit Logs events over HTTP.
|
31673
33451
|
name: Audit
|
31674
|
-
- description: '[AuthN Mappings API](https://docs.datadoghq.com/account_management/authn_mapping/?tab=example)
|
33452
|
+
- description: '[The AuthN Mappings API](https://docs.datadoghq.com/account_management/authn_mapping/?tab=example)
|
31675
33453
|
|
31676
|
-
is used to automatically map
|
33454
|
+
is used to automatically map groups of users to roles in Datadog using attributes
|
31677
33455
|
|
31678
|
-
sent from Identity Providers.'
|
33456
|
+
sent from Identity Providers. Use these endpoints to manage your AuthN Mappings.'
|
31679
33457
|
name: AuthN Mappings
|
31680
33458
|
- description: Search or aggregate your CI Visibility pipeline events and send them
|
31681
|
-
to your Datadog site over HTTP.
|
33459
|
+
to your Datadog site over HTTP. See the [CI Pipeline Visibility in Datadog page](https://docs.datadoghq.com/continuous_integration/pipelines/)
|
33460
|
+
for more information.
|
31682
33461
|
name: CI Visibility Pipelines
|
31683
|
-
- description: Search or aggregate your CI Visibility test events over HTTP.
|
33462
|
+
- description: Search or aggregate your CI Visibility test events over HTTP. See the
|
33463
|
+
[Test Visibility in Datadog page](https://docs.datadoghq.com/tests/) for more
|
33464
|
+
information.
|
31684
33465
|
name: CI Visibility Tests
|
33466
|
+
- description: The Cloud Cost Management API allows you to set up, edit, and delete
|
33467
|
+
Cloud Cost Management accounts for AWS and Azure. See the [Cloud Cost Management
|
33468
|
+
page](https://docs.datadoghq.com/cloud_cost_management/) for more information.
|
33469
|
+
name: Cloud Cost Management
|
31685
33470
|
- description: Workload activity security rules for generating events using the Datadog
|
31686
|
-
security Agent.
|
33471
|
+
security Agent. See the [Setting up CSM Workload Security page](https://docs.datadoghq.com/security/cloud_security_management/setup/csm_workload_security/)
|
33472
|
+
for more information.
|
31687
33473
|
name: Cloud Workload Security
|
31688
|
-
- description:
|
31689
|
-
|
33474
|
+
- description: Manage your Datadog Cloudflare integration directly through the Datadog
|
33475
|
+
API. See the [Cloudflare integration page](https://docs.datadoghq.com/integrations/cloudflare/)
|
33476
|
+
for more information.
|
31690
33477
|
name: Cloudflare Integration
|
31691
|
-
- description:
|
31692
|
-
the Datadog API.
|
33478
|
+
- description: Manage your Datadog Confluent Cloud integration accounts and account
|
33479
|
+
resources directly through the Datadog API. See the [Confluent Cloud page](https://docs.datadoghq.com/integrations/confluent_cloud/)
|
33480
|
+
for more information.
|
31693
33481
|
name: Confluent Cloud
|
31694
33482
|
- description: The Container Images API allows you to query Container Image data for
|
31695
|
-
your organization.
|
33483
|
+
your organization. See the [Container Images View page](https://docs.datadoghq.com/infrastructure/containers/container_images/)
|
33484
|
+
for more information.
|
31696
33485
|
name: Container Images
|
31697
33486
|
- description: The Containers API allows you to query container data for your organization.
|
33487
|
+
See the [Container Monitoring page](https://docs.datadoghq.com/containers/) for
|
33488
|
+
more information.
|
31698
33489
|
name: Containers
|
31699
33490
|
- description: Send events for DORA Metrics to measure and improve software delivery.
|
33491
|
+
See the [DORA Metrics page](https://docs.datadoghq.com/dora_metrics/) for more
|
33492
|
+
information.
|
31700
33493
|
name: DORA Metrics
|
31701
33494
|
- description: 'Interact with your dashboard lists through the API to
|
31702
33495
|
|
@@ -31716,18 +33509,15 @@ tags:
|
|
31716
33509
|
|
31717
33510
|
end times, prevent all alerting related to specified Datadog tags.'
|
31718
33511
|
name: Downtimes
|
31719
|
-
- description: 'The
|
31720
|
-
|
33512
|
+
- description: 'The Event Management API allows you to programmatically post events
|
33513
|
+
to the Events Explorer
|
31721
33514
|
|
31722
|
-
and fetch events from the
|
31723
|
-
|
31724
|
-
If an event is sent out with a message containing more than 4000 characters, only
|
31725
|
-
the
|
31726
|
-
|
31727
|
-
first 4000 characters are displayed.'
|
33515
|
+
and fetch events from the Events Explorer. See the [Event Management page](https://docs.datadoghq.com/service_management/events/)
|
33516
|
+
for more information.'
|
31728
33517
|
name: Events
|
31729
|
-
- description:
|
31730
|
-
API.
|
33518
|
+
- description: Manage your Datadog Fastly integration accounts and services directly
|
33519
|
+
through the Datadog API. See the [Fastly integration page](https://docs.datadoghq.com/integrations/fastly/)
|
33520
|
+
for more information.
|
31731
33521
|
name: Fastly Integration
|
31732
33522
|
- description: 'Configure your Datadog-Google Cloud Platform (GCP) integration directly
|
31733
33523
|
|
@@ -31747,12 +33537,15 @@ tags:
|
|
31747
33537
|
contacting Datadog support.'
|
31748
33538
|
name: IP Allowlist
|
31749
33539
|
- description: Create, update, delete, and retrieve services which can be associated
|
31750
|
-
with incidents.
|
33540
|
+
with incidents. See the [Incident Management page](https://docs.datadoghq.com/service_management/incident_management/)
|
33541
|
+
for more information.
|
31751
33542
|
name: Incident Services
|
31752
33543
|
- description: The Incident Teams endpoints are deprecated. See the [Teams API endpoints](https://docs.datadoghq.com/api/latest/teams/)
|
31753
33544
|
to create, update, delete, and retrieve teams which can be associated with incidents.
|
31754
33545
|
name: Incident Teams
|
31755
|
-
- description: Manage incident response
|
33546
|
+
- description: Manage incident response, as well as associated attachments, metadata,
|
33547
|
+
and todos. See the [Incident Management page](https://docs.datadoghq.com/service_management/incident_management/)
|
33548
|
+
for more information.
|
31756
33549
|
name: Incidents
|
31757
33550
|
- description: 'Manage your Datadog API and application keys. You need an API key
|
31758
33551
|
and
|
@@ -31918,7 +33711,9 @@ tags:
|
|
31918
33711
|
|
31919
33712
|
You can retrieve up to 24 hours of hourly usage data for multiple organizations,
|
31920
33713
|
|
31921
|
-
and up to two months of hourly usage data for a single organization in one request.
|
33714
|
+
and up to two months of hourly usage data for a single organization in one request.
|
33715
|
+
|
33716
|
+
Learn more on the [usage details documentation](https://docs.datadoghq.com/account_management/billing/usage_details/).'
|
31922
33717
|
externalDocs:
|
31923
33718
|
description: Find out more at
|
31924
33719
|
url: https://docs.datadoghq.com/account_management/billing/usage_details/
|