datadog_api_client 2.37.0 → 2.39.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.generated-info +4 -0
- data/.generator/schemas/v1/openapi.yaml +513 -14
- data/.generator/schemas/v2/openapi.yaml +2101 -107
- data/.github/workflows/approved_status.yml +1 -0
- data/.github/workflows/test.yml +1 -1
- data/CHANGELOG.md +36 -0
- data/examples/v1/dashboards/CreateDashboard_1751391372.rb +41 -0
- data/examples/v1/dashboards/CreatePublicDashboard_1668947073.rb +28 -0
- data/examples/v1/dashboards/UpdatePublicDashboard_1708268778.rb +27 -0
- data/examples/v1/logs-pipelines/CreateLogsPipeline_1248402480.rb +25 -0
- data/examples/v1/logs-pipelines/CreateLogsPipeline_1267211320.rb +27 -0
- data/examples/v1/logs-pipelines/CreateLogsPipeline_1271012410.rb +25 -0
- data/examples/v1/logs-pipelines/CreateLogsPipeline_3314493032.rb +26 -0
- data/examples/v1/logs-pipelines/CreateLogsPipeline_3934594739.rb +26 -0
- data/examples/v1/synthetics/SearchTests.rb +5 -0
- data/examples/v1/synthetics/SearchTests_195957771.rb +13 -0
- data/examples/v2/action-connection/GetAppKeyRegistration.rb +5 -0
- data/examples/v2/action-connection/ListAppKeyRegistrations.rb +5 -0
- data/examples/v2/action-connection/RegisterAppKey.rb +5 -0
- data/examples/v2/action-connection/UnregisterAppKey.rb +5 -0
- data/examples/v2/aws-integration/GetAWSIntegrationIAMPermissions.rb +5 -0
- data/examples/v2/cloud-cost-management/CreateCostGCPUsageCostConfig.rb +19 -0
- data/examples/v2/cloud-cost-management/DeleteCostGCPUsageCostConfig.rb +5 -0
- data/examples/v2/cloud-cost-management/ListCostGCPUsageCostConfigs.rb +5 -0
- data/examples/v2/cloud-cost-management/UpdateCostGCPUsageCostConfig.rb +14 -0
- data/examples/v2/datasets/CreateDataset.rb +27 -0
- data/examples/v2/datasets/DeleteDataset.rb +5 -0
- data/examples/v2/datasets/GetAllDatasets.rb +5 -0
- data/examples/v2/datasets/GetDataset.rb +5 -0
- data/examples/v2/events/CreateEvent.rb +4 -2
- data/examples/v2/monitors/CreateMonitorNotificationRule.rb +0 -3
- data/examples/v2/monitors/CreateMonitorUserTemplate.rb +37 -0
- data/examples/v2/monitors/DeleteMonitorNotificationRule.rb +0 -3
- data/examples/v2/monitors/DeleteMonitorUserTemplate.rb +8 -0
- data/examples/v2/monitors/GetMonitorNotificationRule.rb +0 -3
- data/examples/v2/monitors/GetMonitorNotificationRules.rb +0 -3
- data/examples/v2/monitors/GetMonitorUserTemplate.rb +11 -0
- data/examples/v2/monitors/ListMonitorUserTemplates.rb +8 -0
- data/examples/v2/monitors/UpdateMonitorNotificationRule.rb +0 -3
- data/examples/v2/monitors/UpdateMonitorUserTemplate.rb +41 -0
- data/examples/v2/monitors/ValidateExistingMonitorUserTemplate.rb +41 -0
- data/examples/v2/monitors/ValidateMonitorUserTemplate.rb +37 -0
- data/examples/v2/on-call/UpdateOnCallSchedule.rb +1 -1
- data/examples/v2/security-monitoring/ListAssetsSBOMs.rb +12 -0
- data/lib/datadog_api_client/configuration.rb +60 -5
- data/lib/datadog_api_client/inflector.rb +70 -0
- data/lib/datadog_api_client/v1/api/hosts_api.rb +1 -0
- data/lib/datadog_api_client/v1/api/synthetics_api.rb +72 -0
- data/lib/datadog_api_client/v1/api/usage_metering_api.rb +6 -6
- data/lib/datadog_api_client/v1/models/dashboard_template_variable.rb +14 -3
- data/lib/datadog_api_client/v1/models/hourly_usage_attribution_body.rb +1 -0
- data/lib/datadog_api_client/v1/models/hourly_usage_attribution_usage_type.rb +9 -1
- data/lib/datadog_api_client/v1/models/logs_array_processor.rb +168 -0
- data/lib/datadog_api_client/v1/models/logs_array_processor_operation.rb +64 -0
- data/lib/datadog_api_client/v1/models/logs_array_processor_operation_append.rb +175 -0
- data/lib/datadog_api_client/v1/models/logs_array_processor_operation_append_type.rb +26 -0
- data/lib/datadog_api_client/v1/models/logs_array_processor_operation_length.rb +165 -0
- data/lib/datadog_api_client/v1/models/logs_array_processor_operation_length_type.rb +26 -0
- data/lib/datadog_api_client/v1/models/logs_array_processor_operation_select.rb +207 -0
- data/lib/datadog_api_client/v1/models/logs_array_processor_operation_select_type.rb +26 -0
- data/lib/datadog_api_client/v1/models/logs_array_processor_type.rb +26 -0
- data/lib/datadog_api_client/v1/models/logs_processor.rb +2 -1
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_body.rb +1 -0
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_supported_metrics.rb +14 -0
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_values.rb +142 -1
- data/lib/datadog_api_client/v1/models/selectable_template_variable_items.rb +12 -1
- data/lib/datadog_api_client/v1/models/synthetics_mobile_test.rb +12 -1
- data/lib/datadog_api_client/v1/models/synthetics_step_type.rb +1 -0
- data/lib/datadog_api_client/v1/models/synthetics_test_request.rb +1 -1
- data/lib/datadog_api_client/v1/models/synthetics_test_request_dns_server_port.rb +63 -0
- data/lib/datadog_api_client/v1/models/usage_summary_date.rb +81 -1
- data/lib/datadog_api_client/v1/models/usage_summary_date_org.rb +81 -1
- data/lib/datadog_api_client/v1/models/usage_summary_response.rb +81 -1
- data/lib/datadog_api_client/v2/api/action_connection_api.rb +263 -4
- data/lib/datadog_api_client/v2/api/app_builder_api.rb +8 -8
- data/lib/datadog_api_client/v2/api/aws_integration_api.rb +60 -0
- data/lib/datadog_api_client/v2/api/cloud_cost_management_api.rb +264 -0
- data/lib/datadog_api_client/v2/api/datasets_api.rb +283 -0
- data/lib/datadog_api_client/v2/api/events_api.rb +10 -4
- data/lib/datadog_api_client/v2/api/monitors_api.rb +512 -30
- data/lib/datadog_api_client/v2/api/restriction_policies_api.rb +7 -3
- data/lib/datadog_api_client/v2/api/security_monitoring_api.rb +111 -0
- data/lib/datadog_api_client/v2/api/usage_metering_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/workflow_automation_api.rb +8 -8
- data/lib/datadog_api_client/v2/models/alert_event_custom_attributes.rb +145 -0
- data/lib/datadog_api_client/v2/models/alert_event_custom_attributes_links_items.rb +152 -0
- data/lib/datadog_api_client/v2/models/alert_event_custom_attributes_links_items_category.rb +28 -0
- data/lib/datadog_api_client/v2/models/alert_event_custom_attributes_priority.rb +30 -0
- data/lib/datadog_api_client/v2/models/alert_event_custom_attributes_status.rb +28 -0
- data/lib/datadog_api_client/v2/models/app_key_registration_data.rb +133 -0
- data/lib/datadog_api_client/v2/models/app_key_registration_data_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/asset_attributes.rb +13 -1
- data/lib/datadog_api_client/v2/models/aws_integration_iam_permissions_response.rb +123 -0
- data/lib/datadog_api_client/v2/models/aws_integration_iam_permissions_response_attributes.rb +125 -0
- data/lib/datadog_api_client/v2/models/aws_integration_iam_permissions_response_data.rb +125 -0
- data/lib/datadog_api_client/v2/models/aws_integration_iam_permissions_response_data_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/change_event_custom_attributes.rb +19 -33
- data/lib/datadog_api_client/v2/models/change_event_custom_attributes_author.rb +10 -31
- data/lib/datadog_api_client/v2/models/change_event_custom_attributes_changed_resource.rb +15 -32
- data/lib/datadog_api_client/v2/models/change_event_custom_attributes_changed_resource_type.rb +1 -1
- data/lib/datadog_api_client/v2/models/change_event_custom_attributes_impacted_resources_items.rb +15 -32
- data/lib/datadog_api_client/v2/models/change_event_custom_attributes_impacted_resources_items_type.rb +1 -1
- data/lib/datadog_api_client/v2/models/dataset.rb +154 -0
- data/lib/datadog_api_client/v2/models/dataset_attributes.rb +197 -0
- data/lib/datadog_api_client/v2/models/dataset_create_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/dataset_response_multi.rb +125 -0
- data/lib/datadog_api_client/v2/models/dataset_response_single.rb +123 -0
- data/lib/datadog_api_client/v2/models/event_category.rb +2 -1
- data/lib/datadog_api_client/v2/models/event_create_request.rb +32 -3
- data/lib/datadog_api_client/v2/models/event_create_request_payload.rb +20 -2
- data/lib/datadog_api_client/v2/models/event_create_response.rb +3 -3
- data/lib/datadog_api_client/v2/models/event_create_response_attributes.rb +2 -2
- data/lib/datadog_api_client/v2/models/event_create_response_attributes_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/event_create_response_attributes_attributes_evt.rb +14 -4
- data/lib/datadog_api_client/v2/models/event_create_response_payload.rb +15 -5
- data/lib/datadog_api_client/v2/models/event_create_response_payload_links.rb +105 -0
- data/lib/datadog_api_client/v2/models/event_payload.rb +48 -36
- data/lib/datadog_api_client/v2/models/event_payload_attributes.rb +3 -2
- data/lib/datadog_api_client/v2/models/event_payload_integration_id.rb +26 -0
- data/lib/datadog_api_client/v2/models/filters_per_product.rb +150 -0
- data/lib/datadog_api_client/v2/models/gcp_usage_cost_config.rb +154 -0
- data/lib/datadog_api_client/v2/models/gcp_usage_cost_config_attributes.rb +369 -0
- data/lib/datadog_api_client/v2/models/gcp_usage_cost_config_patch_data.rb +144 -0
- data/lib/datadog_api_client/v2/models/gcp_usage_cost_config_patch_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/gcp_usage_cost_config_patch_request_attributes.rb +123 -0
- data/lib/datadog_api_client/v2/models/gcp_usage_cost_config_patch_request_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/gcp_usage_cost_config_post_data.rb +144 -0
- data/lib/datadog_api_client/v2/models/gcp_usage_cost_config_post_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/gcp_usage_cost_config_post_request_attributes.rb +217 -0
- data/lib/datadog_api_client/v2/models/gcp_usage_cost_config_post_request_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/gcp_usage_cost_config_response.rb +105 -0
- data/lib/datadog_api_client/v2/models/gcp_usage_cost_config_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/gcp_usage_cost_configs_response.rb +107 -0
- data/lib/datadog_api_client/v2/models/get_app_key_registration_response.rb +105 -0
- data/lib/datadog_api_client/v2/models/incident_create_attributes.rb +11 -1
- data/lib/datadog_api_client/v2/models/incident_response_attributes.rb +11 -1
- data/lib/datadog_api_client/v2/models/job_definition_from_rule.rb +1 -26
- data/lib/datadog_api_client/v2/models/layer_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/layer_attributes_interval.rb +1 -1
- data/lib/datadog_api_client/v2/models/list_app_key_registrations_response.rb +117 -0
- data/lib/datadog_api_client/v2/models/list_app_key_registrations_response_meta.rb +115 -0
- data/lib/datadog_api_client/v2/models/list_assets_sbo_ms_response.rb +145 -0
- data/lib/datadog_api_client/v2/models/monitor_user_template.rb +200 -0
- data/lib/datadog_api_client/v2/models/monitor_user_template_create_data.rb +144 -0
- data/lib/datadog_api_client/v2/models/monitor_user_template_create_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/monitor_user_template_create_response.rb +105 -0
- data/lib/datadog_api_client/v2/models/monitor_user_template_list_response.rb +107 -0
- data/lib/datadog_api_client/v2/models/monitor_user_template_request_attributes.rb +172 -0
- data/lib/datadog_api_client/v2/models/monitor_user_template_resource_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/monitor_user_template_response.rb +105 -0
- data/lib/datadog_api_client/v2/models/monitor_user_template_response_attributes.rb +188 -0
- data/lib/datadog_api_client/v2/models/monitor_user_template_response_data.rb +125 -0
- data/lib/datadog_api_client/v2/models/monitor_user_template_response_data_with_versions.rb +125 -0
- data/lib/datadog_api_client/v2/models/monitor_user_template_template_variables_items.rb +132 -0
- data/lib/datadog_api_client/v2/models/monitor_user_template_update_data.rb +165 -0
- data/lib/datadog_api_client/v2/models/monitor_user_template_update_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/register_app_key_response.rb +105 -0
- data/lib/datadog_api_client/v2/models/sbom_attributes.rb +24 -1
- data/lib/datadog_api_client/v2/models/sbom_component.rb +46 -1
- data/lib/datadog_api_client/v2/models/sbom_component_dependency.rb +117 -0
- data/lib/datadog_api_client/v2/models/sbom_component_license.rb +123 -0
- data/lib/datadog_api_client/v2/models/sbom_component_license_license.rb +123 -0
- data/lib/datadog_api_client/v2/models/sbom_component_license_type.rb +33 -0
- data/lib/datadog_api_client/v2/models/sbom_component_property.rb +144 -0
- data/lib/datadog_api_client/v2/models/sbom_component_supplier.rb +123 -0
- data/lib/datadog_api_client/v2/models/sbom_metadata.rb +25 -3
- data/lib/datadog_api_client/v2/models/sbom_metadata_author.rb +105 -0
- data/lib/datadog_api_client/v2/models/schedule_create_request_data_attributes_layers_items.rb +1 -1
- data/lib/datadog_api_client/v2/models/schedule_update_request_data_attributes_layers_items.rb +1 -1
- data/lib/datadog_api_client/v2/models/simple_monitor_user_template.rb +188 -0
- data/lib/datadog_api_client/v2/models/vulnerability_attributes.rb +24 -1
- data/lib/datadog_api_client/version.rb +1 -1
- metadata +103 -2
- data/.apigentools-info +0 -16
@@ -127,6 +127,13 @@ components:
|
|
127
127
|
required: true
|
128
128
|
schema:
|
129
129
|
type: string
|
130
|
+
ApplicationKeyId:
|
131
|
+
description: The ID of the app key
|
132
|
+
in: path
|
133
|
+
name: app_key_id
|
134
|
+
required: true
|
135
|
+
schema:
|
136
|
+
type: string
|
130
137
|
ApplicationKeyIncludeParameter:
|
131
138
|
description: Resource path for related resources to include in the response.
|
132
139
|
Only `owned_by` is supported.
|
@@ -281,6 +288,14 @@ components:
|
|
281
288
|
required: true
|
282
289
|
schema:
|
283
290
|
type: string
|
291
|
+
DatasetID:
|
292
|
+
description: The ID of a defined dataset.
|
293
|
+
example: 0879ce27-29a1-481f-a12e-bc2a48ec9ae1
|
294
|
+
in: path
|
295
|
+
name: dataset_id
|
296
|
+
required: true
|
297
|
+
schema:
|
298
|
+
type: string
|
284
299
|
EntityID:
|
285
300
|
description: UUID or Entity Ref.
|
286
301
|
in: path
|
@@ -751,7 +766,8 @@ components:
|
|
751
766
|
description: 'Identifier, formatted as `type:id`. Supported types: `connection`,
|
752
767
|
`dashboard`, `integration-account`, `integration-service`, `integration-webhook`,
|
753
768
|
`notebook`, `reference-table`, `security-rule`, `slo`, `workflow`, `app-builder-app`,
|
754
|
-
`connection`, `connection-group`, `rum-application
|
769
|
+
`connection`, `connection-group`, `rum-application`, `cross-org-connection`,
|
770
|
+
`spreadsheet`.'
|
755
771
|
example: dashboard:abc-def-ghi
|
756
772
|
in: path
|
757
773
|
name: resource_id
|
@@ -1529,6 +1545,54 @@ components:
|
|
1529
1545
|
- type
|
1530
1546
|
- credentials
|
1531
1547
|
type: object
|
1548
|
+
AWSIntegrationIamPermissionsResponse:
|
1549
|
+
description: AWS Integration IAM Permissions response body.
|
1550
|
+
properties:
|
1551
|
+
data:
|
1552
|
+
$ref: '#/components/schemas/AWSIntegrationIamPermissionsResponseData'
|
1553
|
+
required:
|
1554
|
+
- data
|
1555
|
+
type: object
|
1556
|
+
AWSIntegrationIamPermissionsResponseAttributes:
|
1557
|
+
description: AWS Integration IAM Permissions response attributes.
|
1558
|
+
properties:
|
1559
|
+
permissions:
|
1560
|
+
description: List of AWS IAM permissions required for the integration.
|
1561
|
+
example:
|
1562
|
+
- account:GetContactInformation
|
1563
|
+
- amplify:ListApps
|
1564
|
+
- amplify:ListArtifacts
|
1565
|
+
- amplify:ListBackendEnvironments
|
1566
|
+
- amplify:ListBranches
|
1567
|
+
items:
|
1568
|
+
example: account:GetContactInformation
|
1569
|
+
type: string
|
1570
|
+
type: array
|
1571
|
+
required:
|
1572
|
+
- permissions
|
1573
|
+
type: object
|
1574
|
+
AWSIntegrationIamPermissionsResponseData:
|
1575
|
+
description: AWS Integration IAM Permissions response data.
|
1576
|
+
properties:
|
1577
|
+
attributes:
|
1578
|
+
$ref: '#/components/schemas/AWSIntegrationIamPermissionsResponseAttributes'
|
1579
|
+
id:
|
1580
|
+
default: permissions
|
1581
|
+
description: The `AWSIntegrationIamPermissionsResponseData` `id`.
|
1582
|
+
example: permissions
|
1583
|
+
type: string
|
1584
|
+
type:
|
1585
|
+
$ref: '#/components/schemas/AWSIntegrationIamPermissionsResponseDataType'
|
1586
|
+
type: object
|
1587
|
+
AWSIntegrationIamPermissionsResponseDataType:
|
1588
|
+
default: permissions
|
1589
|
+
description: The `AWSIntegrationIamPermissionsResponseData` `type`.
|
1590
|
+
enum:
|
1591
|
+
- permissions
|
1592
|
+
example: permissions
|
1593
|
+
type: string
|
1594
|
+
x-enum-varnames:
|
1595
|
+
- PERMISSIONS
|
1532
1596
|
AWSIntegrationType:
|
1533
1597
|
description: The definition of `AWSIntegrationType` object.
|
1534
1598
|
enum:
|
@@ -2227,6 +2291,97 @@ components:
|
|
2227
2291
|
- id
|
2228
2292
|
- base_severity
|
2229
2293
|
type: object
|
2294
|
+
AlertEventCustomAttributes:
|
2295
|
+
additionalProperties: false
|
2296
|
+
description: Alert event attributes.
|
2297
|
+
properties:
|
2298
|
+
custom:
|
2299
|
+
$ref: '#/components/schemas/AlertEventCustomAttributesCustom'
|
2300
|
+
links:
|
2301
|
+
$ref: '#/components/schemas/AlertEventCustomAttributesLinks'
|
2302
|
+
priority:
|
2303
|
+
$ref: '#/components/schemas/AlertEventCustomAttributesPriority'
|
2304
|
+
status:
|
2305
|
+
$ref: '#/components/schemas/AlertEventCustomAttributesStatus'
|
2306
|
+
required:
|
2307
|
+
- status
|
2308
|
+
type: object
|
2309
|
+
AlertEventCustomAttributesCustom:
|
2310
|
+
additionalProperties: {}
|
2311
|
+
description: Free form JSON object for arbitrary data. Supports up to 100 properties
|
2312
|
+
per object and a maximum nesting depth of 10 levels.
|
2313
|
+
example: {}
|
2314
|
+
type: object
|
2315
|
+
AlertEventCustomAttributesLinks:
|
2316
|
+
description: The links related to the event. Maximum of 20 links allowed.
|
2317
|
+
items:
|
2318
|
+
$ref: '#/components/schemas/AlertEventCustomAttributesLinksItems'
|
2319
|
+
maxItems: 20
|
2320
|
+
minItems: 1
|
2321
|
+
type: array
|
2322
|
+
AlertEventCustomAttributesLinksItems:
|
2323
|
+
additionalProperties: false
|
2324
|
+
description: A link.
|
2325
|
+
properties:
|
2326
|
+
category:
|
2327
|
+
$ref: '#/components/schemas/AlertEventCustomAttributesLinksItemsCategory'
|
2328
|
+
title:
|
2329
|
+
description: The display text of the link. Limited to 300 characters.
|
2330
|
+
example: Runbook Link
|
2331
|
+
maxLength: 300
|
2332
|
+
minLength: 1
|
2333
|
+
type: string
|
2334
|
+
url:
|
2335
|
+
description: The URL of the link. Limited to 2048 characters.
|
2336
|
+
example: https://app.datadoghq.com/runbook
|
2337
|
+
maxLength: 2048
|
2338
|
+
minLength: 1
|
2339
|
+
type: string
|
2340
|
+
required:
|
2341
|
+
- url
|
2342
|
+
- category
|
2343
|
+
type: object
|
2344
|
+
AlertEventCustomAttributesLinksItemsCategory:
|
2345
|
+
description: The category of the link.
|
2346
|
+
enum:
|
2347
|
+
- runbook
|
2348
|
+
- documentation
|
2349
|
+
- dashboard
|
2350
|
+
example: runbook
|
2351
|
+
type: string
|
2352
|
+
x-enum-varnames:
|
2353
|
+
- RUNBOOK
|
2354
|
+
- DOCUMENTATION
|
2355
|
+
- DASHBOARD
|
2356
|
+
AlertEventCustomAttributesPriority:
|
2357
|
+
default: '5'
|
2358
|
+
description: The priority of the alert.
|
2359
|
+
enum:
|
2360
|
+
- '1'
|
2361
|
+
- '2'
|
2362
|
+
- '3'
|
2363
|
+
- '4'
|
2364
|
+
- '5'
|
2365
|
+
example: '5'
|
2366
|
+
type: string
|
2367
|
+
x-enum-varnames:
|
2368
|
+
- PRIORITY_ONE
|
2369
|
+
- PRIORITY_TWO
|
2370
|
+
- PRIORITY_THREE
|
2371
|
+
- PRIORITY_FOUR
|
2372
|
+
- PRIORITY_FIVE
|
2373
|
+
AlertEventCustomAttributesStatus:
|
2374
|
+
description: The status of the alert.
|
2375
|
+
enum:
|
2376
|
+
- warn
|
2377
|
+
- error
|
2378
|
+
- ok
|
2379
|
+
example: warn
|
2380
|
+
type: string
|
2381
|
+
x-enum-varnames:
|
2382
|
+
- WARN
|
2383
|
+
- ERROR
|
2384
|
+
- OK
|
2230
2385
|
Annotation:
|
2231
2386
|
description: A list of annotations used in the workflow. These are like sticky
|
2232
2387
|
notes for your workflow!
|
@@ -2367,6 +2522,27 @@ components:
|
|
2367
2522
|
type: string
|
2368
2523
|
x-enum-varnames:
|
2369
2524
|
- DEPLOYMENT
|
2525
|
+
AppKeyRegistrationData:
|
2526
|
+
description: Data related to the app key registration.
|
2527
|
+
properties:
|
2528
|
+
id:
|
2529
|
+
description: The app key registration identifier
|
2530
|
+
format: uuid
|
2531
|
+
readOnly: true
|
2532
|
+
type: string
|
2533
|
+
type:
|
2534
|
+
$ref: '#/components/schemas/AppKeyRegistrationDataType'
|
2535
|
+
required:
|
2536
|
+
- type
|
2537
|
+
type: object
|
2538
|
+
AppKeyRegistrationDataType:
|
2539
|
+
description: The definition of `AppKeyRegistrationDataType` object.
|
2540
|
+
enum:
|
2541
|
+
- app_key_registration
|
2542
|
+
example: app_key_registration
|
2543
|
+
type: string
|
2544
|
+
x-enum-varnames:
|
2545
|
+
- APP_KEY_REGISTRATION
|
2370
2546
|
AppMeta:
|
2371
2547
|
description: Metadata of an app.
|
2372
2548
|
properties:
|
@@ -3407,6 +3583,14 @@ components:
|
|
3407
3583
|
$ref: '#/components/schemas/AssetOperatingSystem'
|
3408
3584
|
risks:
|
3409
3585
|
$ref: '#/components/schemas/AssetRisks'
|
3586
|
+
teams:
|
3587
|
+
description: List of teams that own the asset.
|
3588
|
+
example:
|
3589
|
+
- compute
|
3590
|
+
items:
|
3591
|
+
example: compute
|
3592
|
+
type: string
|
3593
|
+
type: array
|
3410
3594
|
type:
|
3411
3595
|
$ref: '#/components/schemas/AssetType'
|
3412
3596
|
version:
|
@@ -6919,14 +7103,16 @@ components:
|
|
6919
7103
|
type: integer
|
6920
7104
|
type: object
|
6921
7105
|
ChangeEventCustomAttributes:
|
6922
|
-
|
7106
|
+
additionalProperties: false
|
7107
|
+
description: Change event attributes.
|
6923
7108
|
properties:
|
6924
7109
|
author:
|
6925
7110
|
$ref: '#/components/schemas/ChangeEventCustomAttributesAuthor'
|
6926
7111
|
change_metadata:
|
6927
7112
|
additionalProperties: {}
|
6928
|
-
description: Free form object with information related to the `change`
|
6929
|
-
|
7113
|
+
description: Free form JSON object with information related to the `change`
|
7114
|
+
event. Supports up to 100 properties per object and a maximum nesting
|
7115
|
+
depth of 10 levels.
|
6930
7116
|
example:
|
6931
7117
|
dd:
|
6932
7118
|
team: datadog_team
|
@@ -6941,17 +7127,19 @@ components:
|
|
6941
7127
|
description: 'A list of resources impacted by this change. It is recommended
|
6942
7128
|
to provide an impacted resource to display
|
6943
7129
|
|
6944
|
-
the change event at the
|
6945
|
-
are supported.'
|
7130
|
+
the change event at the correct location. Only resources of type `service`
|
7131
|
+
are supported. Maximum of 100 impacted resources allowed.'
|
6946
7132
|
example:
|
6947
7133
|
- name: payments_api
|
6948
7134
|
type: service
|
6949
7135
|
items:
|
6950
7136
|
$ref: '#/components/schemas/ChangeEventCustomAttributesImpactedResourcesItems'
|
7137
|
+
maxItems: 100
|
6951
7138
|
type: array
|
6952
7139
|
new_value:
|
6953
7140
|
additionalProperties: {}
|
6954
|
-
description: Free form object
|
7141
|
+
description: Free form JSON object representing the new state of the changed
|
7142
|
+
resource.
|
6955
7143
|
example:
|
6956
7144
|
enabled: true
|
6957
7145
|
percentage: 50%
|
@@ -6960,7 +7148,8 @@ components:
|
|
6960
7148
|
type: object
|
6961
7149
|
prev_value:
|
6962
7150
|
additionalProperties: {}
|
6963
|
-
description: Free form object
|
7151
|
+
description: Free form JSON object representing the previous state of the
|
7152
|
+
changed resource.
|
6964
7153
|
example:
|
6965
7154
|
enabled: true
|
6966
7155
|
percentage: 10%
|
@@ -6971,13 +7160,16 @@ components:
|
|
6971
7160
|
- changed_resource
|
6972
7161
|
type: object
|
6973
7162
|
ChangeEventCustomAttributesAuthor:
|
6974
|
-
|
6975
|
-
|
7163
|
+
additionalProperties: false
|
7164
|
+
description: The entity that made the change. Optional, if provided it must
|
7165
|
+
include `type` and `name`.
|
6976
7166
|
properties:
|
6977
7167
|
name:
|
6978
|
-
description:
|
6979
|
-
|
7168
|
+
description: The name of the user or system that made the change. Limited
|
7169
|
+
to 128 characters.
|
7170
|
+
example: example@datadog.com
|
6980
7171
|
maxLength: 128
|
7172
|
+
minLength: 1
|
6981
7173
|
type: string
|
6982
7174
|
type:
|
6983
7175
|
$ref: '#/components/schemas/ChangeEventCustomAttributesAuthorType'
|
@@ -7000,11 +7192,14 @@ components:
|
|
7000
7192
|
- API
|
7001
7193
|
- AUTOMATION
|
7002
7194
|
ChangeEventCustomAttributesChangedResource:
|
7003
|
-
|
7195
|
+
additionalProperties: false
|
7196
|
+
description: A uniquely identified resource.
|
7004
7197
|
properties:
|
7005
7198
|
name:
|
7006
|
-
description:
|
7199
|
+
description: The name of the resource that was changed. Limited to 128 characters.
|
7007
7200
|
example: fallback_payments_test
|
7201
|
+
maxLength: 128
|
7202
|
+
minLength: 1
|
7008
7203
|
type: string
|
7009
7204
|
type:
|
7010
7205
|
$ref: '#/components/schemas/ChangeEventCustomAttributesChangedResourceType'
|
@@ -7013,7 +7208,7 @@ components:
|
|
7013
7208
|
- name
|
7014
7209
|
type: object
|
7015
7210
|
ChangeEventCustomAttributesChangedResourceType:
|
7016
|
-
description:
|
7211
|
+
description: The type of the resource that was changed.
|
7017
7212
|
enum:
|
7018
7213
|
- feature_flag
|
7019
7214
|
- configuration
|
@@ -7023,12 +7218,14 @@ components:
|
|
7023
7218
|
- FEATURE_FLAG
|
7024
7219
|
- CONFIGURATION
|
7025
7220
|
ChangeEventCustomAttributesImpactedResourcesItems:
|
7026
|
-
|
7027
|
-
|
7221
|
+
additionalProperties: false
|
7222
|
+
description: Object representing a uniquely identified resource.
|
7028
7223
|
properties:
|
7029
7224
|
name:
|
7030
|
-
description:
|
7225
|
+
description: The name of the impacted resource. Limited to 128 characters.
|
7031
7226
|
example: payments_api
|
7227
|
+
maxLength: 128
|
7228
|
+
minLength: 1
|
7032
7229
|
type: string
|
7033
7230
|
type:
|
7034
7231
|
$ref: '#/components/schemas/ChangeEventCustomAttributesImpactedResourcesItemsType'
|
@@ -7037,7 +7234,7 @@ components:
|
|
7037
7234
|
- name
|
7038
7235
|
type: object
|
7039
7236
|
ChangeEventCustomAttributesImpactedResourcesItemsType:
|
7040
|
-
description:
|
7237
|
+
description: The type of the impacted resource.
|
7041
7238
|
enum:
|
7042
7239
|
- service
|
7043
7240
|
example: service
|
@@ -11989,6 +12186,85 @@ components:
|
|
11989
12186
|
required:
|
11990
12187
|
- databaseMonitoringTrigger
|
11991
12188
|
type: object
|
12189
|
+
Dataset:
|
12190
|
+
description: Dataset object.
|
12191
|
+
properties:
|
12192
|
+
attributes:
|
12193
|
+
$ref: '#/components/schemas/DatasetAttributes'
|
12194
|
+
id:
|
12195
|
+
description: Unique identifier for the dataset.
|
12196
|
+
example: 123e4567-e89b-12d3-a456-426614174000
|
12197
|
+
type: string
|
12198
|
+
type:
|
12199
|
+
description: Resource type, always "dataset".
|
12200
|
+
example: dataset
|
12201
|
+
type: string
|
12202
|
+
required:
|
12203
|
+
- type
|
12204
|
+
- attributes
|
12205
|
+
type: object
|
12206
|
+
DatasetAttributes:
|
12207
|
+
description: Dataset metadata and configuration(s).
|
12208
|
+
properties:
|
12209
|
+
created_at:
|
12210
|
+
description: Timestamp when the dataset was created.
|
12211
|
+
format: date-time
|
12212
|
+
nullable: true
|
12213
|
+
type: string
|
12214
|
+
created_by:
|
12215
|
+
description: Unique ID of the user who created the dataset.
|
12216
|
+
format: uuid
|
12217
|
+
type: string
|
12218
|
+
name:
|
12219
|
+
description: Name of the dataset.
|
12220
|
+
example: Security Audit Dataset
|
12221
|
+
type: string
|
12222
|
+
principals:
|
12223
|
+
description: List of access principals, formatted as `principal_type:id`.
|
12224
|
+
Principal can be 'team' or 'role'.
|
12225
|
+
example:
|
12226
|
+
- role:86245fce-0a4e-11f0-92bd-da7ad0900002
|
12227
|
+
items:
|
12228
|
+
example: role:86245fce-0a4e-11f0-92bd-da7ad0900002
|
12229
|
+
type: string
|
12230
|
+
type: array
|
12231
|
+
product_filters:
|
12232
|
+
description: List of product-specific filters.
|
12233
|
+
items:
|
12234
|
+
$ref: '#/components/schemas/FiltersPerProduct'
|
12235
|
+
type: array
|
12236
|
+
required:
|
12237
|
+
- name
|
12238
|
+
- product_filters
|
12239
|
+
- principals
|
12240
|
+
type: object
|
12241
|
+
DatasetCreateRequest:
|
12242
|
+
description: Create request for a dataset.
|
12243
|
+
properties:
|
12244
|
+
data:
|
12245
|
+
$ref: '#/components/schemas/Dataset'
|
12246
|
+
required:
|
12247
|
+
- data
|
12248
|
+
type: object
|
12249
|
+
DatasetResponseMulti:
|
12250
|
+
description: Response containing a list of datasets.
|
12251
|
+
properties:
|
12252
|
+
data:
|
12253
|
+
description: The list of datasets returned in response.
|
12254
|
+
items:
|
12255
|
+
$ref: '#/components/schemas/Dataset'
|
12256
|
+
type: array
|
12257
|
+
required:
|
12258
|
+
- data
|
12259
|
+
type: object
|
12260
|
+
DatasetResponseSingle:
|
12261
|
+
description: Response containing a single dataset object.
|
12262
|
+
properties:
|
12263
|
+
data:
|
12264
|
+
$ref: '#/components/schemas/Dataset'
|
12265
|
+
required:
|
12266
|
+
- data
|
12267
|
+
type: object
|
11992
12268
|
Date:
|
11993
12269
|
description: Date as Unix timestamp in milliseconds.
|
11994
12270
|
example: 1722439510282
|
@@ -14679,28 +14955,33 @@ components:
|
|
14679
14955
|
type: string
|
14680
14956
|
type: object
|
14681
14957
|
EventCategory:
|
14682
|
-
description: Event category
|
14683
|
-
is supported. Support for other categories are coming. please reach out to
|
14684
|
-
datadog support if you're interested.
|
14958
|
+
description: Event category identifying the type of event.
|
14685
14959
|
enum:
|
14686
14960
|
- change
|
14961
|
+
- alert
|
14687
14962
|
example: change
|
14688
14963
|
type: string
|
14689
14964
|
x-enum-varnames:
|
14690
14965
|
- CHANGE
|
14966
|
+
- ALERT
|
14691
14967
|
EventCreateRequest:
|
14692
|
-
description:
|
14968
|
+
description: An event object.
|
14693
14969
|
properties:
|
14694
14970
|
attributes:
|
14695
14971
|
$ref: '#/components/schemas/EventPayload'
|
14696
14972
|
type:
|
14697
14973
|
$ref: '#/components/schemas/EventCreateRequestType'
|
14974
|
+
required:
|
14975
|
+
- type
|
14976
|
+
- attributes
|
14698
14977
|
type: object
|
14699
14978
|
EventCreateRequestPayload:
|
14700
14979
|
description: Payload for creating an event.
|
14701
14980
|
properties:
|
14702
14981
|
data:
|
14703
14982
|
$ref: '#/components/schemas/EventCreateRequest'
|
14983
|
+
required:
|
14984
|
+
- data
|
14704
14985
|
type: object
|
14705
14986
|
EventCreateRequestType:
|
14706
14987
|
description: Entity type.
|
@@ -14711,24 +14992,23 @@ components:
|
|
14711
14992
|
x-enum-varnames:
|
14712
14993
|
- EVENT
|
14713
14994
|
EventCreateResponse:
|
14714
|
-
description:
|
14995
|
+
description: Event object.
|
14715
14996
|
properties:
|
14716
14997
|
attributes:
|
14717
14998
|
$ref: '#/components/schemas/EventCreateResponseAttributes'
|
14718
14999
|
type:
|
14719
|
-
description:
|
15000
|
+
description: Entity type.
|
14720
15001
|
example: event
|
14721
15002
|
type: string
|
14722
15003
|
type: object
|
14723
15004
|
EventCreateResponseAttributes:
|
14724
|
-
description:
|
14725
|
-
values.
|
15005
|
+
description: Event attributes.
|
14726
15006
|
properties:
|
14727
15007
|
attributes:
|
14728
15008
|
$ref: '#/components/schemas/EventCreateResponseAttributesAttributes'
|
14729
15009
|
type: object
|
14730
15010
|
EventCreateResponseAttributesAttributes:
|
14731
|
-
description: JSON object
|
15011
|
+
description: JSON object for category-specific attributes.
|
14732
15012
|
properties:
|
14733
15013
|
evt:
|
14734
15014
|
$ref: '#/components/schemas/EventCreateResponseAttributesAttributesEvt'
|
@@ -14737,41 +15017,71 @@ components:
|
|
14737
15017
|
description: JSON object of event system attributes.
|
14738
15018
|
properties:
|
14739
15019
|
id:
|
14740
|
-
|
15020
|
+
deprecated: true
|
15021
|
+
description: Event identifier. This field is deprecated and will be removed
|
15022
|
+
in a future version. Use the `uid` field instead.
|
15023
|
+
type: string
|
15024
|
+
uid:
|
15025
|
+
description: A unique identifier for the event. You can use this identifier
|
15026
|
+
to query or reference the event.
|
14741
15027
|
type: string
|
14742
15028
|
type: object
|
14743
15029
|
EventCreateResponsePayload:
|
14744
|
-
description:
|
15030
|
+
description: Event creation response.
|
14745
15031
|
properties:
|
14746
15032
|
data:
|
14747
15033
|
$ref: '#/components/schemas/EventCreateResponse'
|
15034
|
+
links:
|
15035
|
+
$ref: '#/components/schemas/EventCreateResponsePayloadLinks'
|
15036
|
+
type: object
|
15037
|
+
EventCreateResponsePayloadLinks:
|
15038
|
+
description: Links to the event.
|
15039
|
+
properties:
|
15040
|
+
self:
|
15041
|
+
description: The URL of the event. This link is only functional when using
|
15042
|
+
the default subdomain.
|
15043
|
+
type: string
|
14748
15044
|
type: object
|
14749
15045
|
EventPayload:
|
15046
|
+
additionalProperties: false
|
14750
15047
|
description: Event attributes.
|
14751
15048
|
properties:
|
14752
15049
|
aggregation_key:
|
14753
|
-
description:
|
14754
|
-
events.
|
15050
|
+
description: A string used for aggregation when [correlating](https://docs.datadoghq.com/service_management/events/correlation/)
|
15051
|
+
events. If you specify a key, events are deduplicated to alerts based
|
15052
|
+
on this key. Limited to 100 characters.
|
15053
|
+
example: aggregation_key_123
|
14755
15054
|
maxLength: 100
|
15055
|
+
minLength: 1
|
14756
15056
|
type: string
|
14757
15057
|
attributes:
|
14758
15058
|
$ref: '#/components/schemas/EventPayloadAttributes'
|
14759
15059
|
category:
|
14760
15060
|
$ref: '#/components/schemas/EventCategory'
|
15061
|
+
integration_id:
|
15062
|
+
$ref: '#/components/schemas/EventPayloadIntegrationId'
|
14761
15063
|
message:
|
14762
|
-
description:
|
15064
|
+
description: Free formed text associated with the event. It's suggested
|
15065
|
+
to use `data.attributes.attributes.custom` for well-structured attributes.
|
15066
|
+
Limited to 4000 characters.
|
14763
15067
|
example: payment_processed feature flag has been enabled
|
14764
15068
|
maxLength: 4000
|
15069
|
+
minLength: 1
|
14765
15070
|
type: string
|
14766
15071
|
tags:
|
14767
|
-
description: 'A list of tags
|
15072
|
+
description: 'A list of tags associated with the event. Maximum of 100 tags
|
15073
|
+
allowed.
|
14768
15074
|
|
14769
15075
|
Refer to [Tags docs](https://docs.datadoghq.com/getting_started/tagging/).'
|
14770
15076
|
example:
|
14771
|
-
- env:
|
15077
|
+
- env:api_client_test
|
14772
15078
|
items:
|
14773
15079
|
description: A tag.
|
15080
|
+
maxLength: 200
|
15081
|
+
minLength: 1
|
14774
15082
|
type: string
|
15083
|
+
maxItems: 100
|
15084
|
+
minItems: 1
|
14775
15085
|
type: array
|
14776
15086
|
timestamp:
|
14777
15087
|
description: 'Timestamp when the event occurred. Must follow [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)
|
@@ -14783,9 +15093,10 @@ components:
|
|
14783
15093
|
18 hours.'
|
14784
15094
|
type: string
|
14785
15095
|
title:
|
14786
|
-
description: The event
|
15096
|
+
description: The title of the event. Limited to 500 characters.
|
14787
15097
|
example: payment_processed feature flag updated
|
14788
15098
|
maxLength: 500
|
15099
|
+
minLength: 1
|
14789
15100
|
type: string
|
14790
15101
|
required:
|
14791
15102
|
- title
|
@@ -14793,10 +15104,19 @@ components:
|
|
14793
15104
|
- attributes
|
14794
15105
|
type: object
|
14795
15106
|
EventPayloadAttributes:
|
14796
|
-
description: JSON object for
|
14797
|
-
event category.
|
15107
|
+
description: JSON object for category-specific attributes. Schema is different
|
15108
|
+
per event category.
|
14798
15109
|
oneOf:
|
14799
15110
|
- $ref: '#/components/schemas/ChangeEventCustomAttributes'
|
15111
|
+
- $ref: '#/components/schemas/AlertEventCustomAttributes'
|
15112
|
+
EventPayloadIntegrationId:
|
15113
|
+
description: Integration ID sourced from integration manifests.
|
15114
|
+
enum:
|
15115
|
+
- custom-events
|
15116
|
+
example: custom-events
|
15117
|
+
type: string
|
15118
|
+
x-enum-varnames:
|
15119
|
+
- CUSTOM_EVENTS
|
14800
15120
|
EventPriority:
|
14801
15121
|
description: The priority of the event's monitor. For example, `normal` or `low`.
|
14802
15122
|
enum:
|
@@ -15403,6 +15723,38 @@ components:
|
|
15403
15723
|
$ref: '#/components/schemas/FastlyServiceData'
|
15404
15724
|
type: array
|
15405
15725
|
type: object
|
15726
|
+
FiltersPerProduct:
|
15727
|
+
description: Product-specific filters for the dataset.
|
15728
|
+
properties:
|
15729
|
+
filters:
|
15730
|
+
description: 'Defines the list of tag-based filters used to restrict access
|
15731
|
+
to telemetry data for a specific product.
|
15732
|
+
|
15733
|
+
These filters act as access control rules. Each filter must follow the
|
15734
|
+
tag query syntax used by
|
15735
|
+
|
15736
|
+
Datadog (such as `@tag.key:value`), and only one tag or attribute may
|
15737
|
+
be used to define the access strategy
|
15738
|
+
|
15739
|
+
per telemetry type.'
|
15740
|
+
example:
|
15741
|
+
- '@application.id:ABCD'
|
15742
|
+
items:
|
15743
|
+
example: '@application.id:ABCD'
|
15744
|
+
type: string
|
15745
|
+
type: array
|
15746
|
+
product:
|
15747
|
+
description: 'Name of the product the dataset is for. Possible values are
|
15748
|
+
''apm'', ''rum'', ''synthetics'',
|
15749
|
+
|
15750
|
+
''metrics'', ''logs'', ''sd_repoinfo'', ''error_tracking'', ''cloud_cost'',
|
15751
|
+
and ''ml_obs''.'
|
15752
|
+
example: logs
|
15753
|
+
type: string
|
15754
|
+
required:
|
15755
|
+
- product
|
15756
|
+
- filters
|
15757
|
+
type: object
|
15406
15758
|
Finding:
|
15407
15759
|
description: A single finding without the message and resource configuration.
|
15408
15760
|
properties:
|
@@ -15986,12 +16338,224 @@ components:
|
|
15986
16338
|
type: string
|
15987
16339
|
x-enum-varnames:
|
15988
16340
|
- GCP_SERVICE_ACCOUNT
|
16341
|
+
GCPUsageCostConfig:
|
16342
|
+
description: GCP Usage Cost config.
|
16343
|
+
properties:
|
16344
|
+
attributes:
|
16345
|
+
$ref: '#/components/schemas/GCPUsageCostConfigAttributes'
|
16346
|
+
id:
|
16347
|
+
description: The ID of the GCP Usage Cost config.
|
16348
|
+
type: string
|
16349
|
+
type:
|
16350
|
+
$ref: '#/components/schemas/GCPUsageCostConfigType'
|
16351
|
+
required:
|
16352
|
+
- attributes
|
16353
|
+
- type
|
16354
|
+
type: object
|
16355
|
+
GCPUsageCostConfigAttributes:
|
16356
|
+
description: Attributes for a GCP Usage Cost config.
|
16357
|
+
properties:
|
16358
|
+
account_id:
|
16359
|
+
description: The GCP account ID.
|
16360
|
+
example: 123456_A123BC_12AB34
|
16361
|
+
type: string
|
16362
|
+
bucket_name:
|
16363
|
+
description: The GCP bucket name used to store the Usage Cost export.
|
16364
|
+
example: dd-cost-bucket
|
16365
|
+
type: string
|
16366
|
+
created_at:
|
16367
|
+
description: The timestamp when the GCP Usage Cost config was created.
|
16368
|
+
pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}$
|
16369
|
+
type: string
|
16370
|
+
dataset:
|
16371
|
+
description: The export dataset name used for the GCP Usage Cost Report.
|
16372
|
+
example: billing
|
16373
|
+
type: string
|
16374
|
+
error_messages:
|
16375
|
+
description: The error messages for the GCP Usage Cost config.
|
16376
|
+
items:
|
16377
|
+
type: string
|
16378
|
+
nullable: true
|
16379
|
+
type: array
|
16380
|
+
export_prefix:
|
16381
|
+
description: The export prefix used for the GCP Usage Cost Report.
|
16382
|
+
example: datadog_cloud_cost_usage_export
|
16383
|
+
type: string
|
16384
|
+
export_project_name:
|
16385
|
+
description: The name of the GCP Usage Cost Report.
|
16386
|
+
example: dd-cloud-cost-report
|
16387
|
+
type: string
|
16388
|
+
months:
|
16389
|
+
deprecated: true
|
16390
|
+
description: The number of months the report has been backfilled.
|
16391
|
+
format: int32
|
16392
|
+
maximum: 36
|
16393
|
+
type: integer
|
16394
|
+
project_id:
|
16395
|
+
description: The `project_id` of the GCP Usage Cost report.
|
16396
|
+
example: my-project-123
|
16397
|
+
type: string
|
16398
|
+
service_account:
|
16399
|
+
description: The unique GCP service account email.
|
16400
|
+
example: dd-ccm-gcp-integration@my-environment.iam.gserviceaccount.com
|
16401
|
+
type: string
|
16402
|
+
status:
|
16403
|
+
description: The status of the GCP Usage Cost config.
|
16404
|
+
example: active
|
16405
|
+
type: string
|
16406
|
+
status_updated_at:
|
16407
|
+
description: The timestamp when the GCP Usage Cost config status was updated.
|
16408
|
+
pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}$
|
16409
|
+
type: string
|
16410
|
+
updated_at:
|
16411
|
+
description: The timestamp when the GCP Usage Cost config status was updated.
|
16412
|
+
pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}$
|
16413
|
+
type: string
|
16414
|
+
required:
|
16415
|
+
- account_id
|
16416
|
+
- bucket_name
|
16417
|
+
- dataset
|
16418
|
+
- export_prefix
|
16419
|
+
- export_project_name
|
16420
|
+
- service_account
|
16421
|
+
- status
|
16422
|
+
type: object
|
16423
|
+
GCPUsageCostConfigPatchData:
|
16424
|
+
description: GCP Usage Cost config patch data.
|
16425
|
+
properties:
|
16426
|
+
attributes:
|
16427
|
+
$ref: '#/components/schemas/GCPUsageCostConfigPatchRequestAttributes'
|
16428
|
+
type:
|
16429
|
+
$ref: '#/components/schemas/GCPUsageCostConfigPatchRequestType'
|
16430
|
+
required:
|
16431
|
+
- attributes
|
16432
|
+
- type
|
16433
|
+
type: object
|
16434
|
+
GCPUsageCostConfigPatchRequest:
|
16435
|
+
description: GCP Usage Cost config patch request.
|
16436
|
+
properties:
|
16437
|
+
data:
|
16438
|
+
$ref: '#/components/schemas/GCPUsageCostConfigPatchData'
|
16439
|
+
required:
|
16440
|
+
- data
|
16441
|
+
type: object
|
16442
|
+
GCPUsageCostConfigPatchRequestAttributes:
|
16443
|
+
description: Attributes for GCP Usage Cost config patch request.
|
16444
|
+
properties:
|
16445
|
+
is_enabled:
|
16446
|
+
description: Whether or not the Cloud Cost Management account is enabled.
|
16447
|
+
example: true
|
16448
|
+
type: boolean
|
16449
|
+
required:
|
16450
|
+
- is_enabled
|
16451
|
+
type: object
|
16452
|
+
GCPUsageCostConfigPatchRequestType:
|
16453
|
+
default: gcp_uc_config_patch_request
|
16454
|
+
description: Type of GCP Usage Cost config patch request.
|
16455
|
+
enum:
|
16456
|
+
- gcp_uc_config_patch_request
|
16457
|
+
example: gcp_uc_config_patch_request
|
16458
|
+
type: string
|
16459
|
+
x-enum-varnames:
|
16460
|
+
- GCP_USAGE_COST_CONFIG_PATCH_REQUEST
|
16461
|
+
GCPUsageCostConfigPostData:
|
16462
|
+
description: GCP Usage Cost config post data.
|
16463
|
+
properties:
|
16464
|
+
attributes:
|
16465
|
+
$ref: '#/components/schemas/GCPUsageCostConfigPostRequestAttributes'
|
16466
|
+
type:
|
16467
|
+
$ref: '#/components/schemas/GCPUsageCostConfigPostRequestType'
|
16468
|
+
required:
|
16469
|
+
- attributes
|
16470
|
+
- type
|
16471
|
+
type: object
|
16472
|
+
GCPUsageCostConfigPostRequest:
|
16473
|
+
description: GCP Usage Cost config post request.
|
16474
|
+
properties:
|
16475
|
+
data:
|
16476
|
+
$ref: '#/components/schemas/GCPUsageCostConfigPostData'
|
16477
|
+
required:
|
16478
|
+
- data
|
16479
|
+
type: object
|
16480
|
+
GCPUsageCostConfigPostRequestAttributes:
|
16481
|
+
description: Attributes for GCP Usage Cost config post request.
|
16482
|
+
properties:
|
16483
|
+
billing_account_id:
|
16484
|
+
description: The GCP account ID.
|
16485
|
+
example: 123456_A123BC_12AB34
|
16486
|
+
type: string
|
16487
|
+
bucket_name:
|
16488
|
+
description: The GCP bucket name used to store the Usage Cost export.
|
16489
|
+
example: dd-cost-bucket
|
16490
|
+
type: string
|
16491
|
+
export_dataset_name:
|
16492
|
+
description: The export dataset name used for the GCP Usage Cost report.
|
16493
|
+
example: billing
|
16494
|
+
type: string
|
16495
|
+
export_prefix:
|
16496
|
+
description: The export prefix used for the GCP Usage Cost report.
|
16497
|
+
example: datadog_cloud_cost_usage_export
|
16498
|
+
type: string
|
16499
|
+
export_project_name:
|
16500
|
+
description: The name of the GCP Usage Cost report.
|
16501
|
+
example: dd-cloud-cost-report
|
16502
|
+
type: string
|
16503
|
+
service_account:
|
16504
|
+
description: The unique GCP service account email.
|
16505
|
+
example: dd-ccm-gcp-integration@my-environment.iam.gserviceaccount.com
|
16506
|
+
type: string
|
16507
|
+
required:
|
16508
|
+
- billing_account_id
|
16509
|
+
- bucket_name
|
16510
|
+
- export_project_name
|
16511
|
+
- export_dataset_name
|
16512
|
+
- service_account
|
16513
|
+
type: object
|
16514
|
+
GCPUsageCostConfigPostRequestType:
|
16515
|
+
default: gcp_uc_config_post_request
|
16516
|
+
description: Type of GCP Usage Cost config post request.
|
16517
|
+
enum:
|
16518
|
+
- gcp_uc_config_post_request
|
16519
|
+
example: gcp_usage_cost_config_post_request
|
16520
|
+
type: string
|
16521
|
+
x-enum-varnames:
|
16522
|
+
- GCP_USAGE_COST_CONFIG_POST_REQUEST
|
16523
|
+
GCPUsageCostConfigResponse:
|
16524
|
+
description: Response of GCP Usage Cost config.
|
16525
|
+
properties:
|
16526
|
+
data:
|
16527
|
+
$ref: '#/components/schemas/GCPUsageCostConfig'
|
16528
|
+
type: object
|
16529
|
+
GCPUsageCostConfigType:
|
16530
|
+
default: gcp_uc_config
|
16531
|
+
description: Type of GCP Usage Cost config.
|
16532
|
+
enum:
|
16533
|
+
- gcp_uc_config
|
16534
|
+
example: gcp_uc_config
|
16535
|
+
type: string
|
16536
|
+
x-enum-varnames:
|
16537
|
+
- GCP_UC_CONFIG
|
16538
|
+
GCPUsageCostConfigsResponse:
|
16539
|
+
description: List of GCP Usage Cost configs.
|
16540
|
+
properties:
|
16541
|
+
data:
|
16542
|
+
description: A GCP Usage Cost config.
|
16543
|
+
items:
|
16544
|
+
$ref: '#/components/schemas/GCPUsageCostConfig'
|
16545
|
+
type: array
|
16546
|
+
type: object
|
15989
16547
|
GetActionConnectionResponse:
|
15990
16548
|
description: The response for found connection
|
15991
16549
|
properties:
|
15992
16550
|
data:
|
15993
16551
|
$ref: '#/components/schemas/ActionConnectionData'
|
15994
16552
|
type: object
|
16553
|
+
GetAppKeyRegistrationResponse:
|
16554
|
+
description: The response object after getting an app key registration.
|
16555
|
+
properties:
|
16556
|
+
data:
|
16557
|
+
$ref: '#/components/schemas/AppKeyRegistrationData'
|
16558
|
+
type: object
|
15995
16559
|
GetAppResponse:
|
15996
16560
|
description: The full app definition response object.
|
15997
16561
|
properties:
|
@@ -17271,6 +17835,10 @@ components:
|
|
17271
17835
|
items:
|
17272
17836
|
$ref: '#/components/schemas/IncidentTimelineCellCreateAttributes'
|
17273
17837
|
type: array
|
17838
|
+
is_test:
|
17839
|
+
description: A flag indicating whether the incident is a test incident.
|
17840
|
+
example: false
|
17841
|
+
type: boolean
|
17274
17842
|
notification_handles:
|
17275
17843
|
description: Notification handles that will be notified of the incident
|
17276
17844
|
at creation.
|
@@ -17676,6 +18244,10 @@ components:
|
|
17676
18244
|
description: A unique identifier that represents an incident type.
|
17677
18245
|
example: 00000000-0000-0000-0000-000000000000
|
17678
18246
|
type: string
|
18247
|
+
is_test:
|
18248
|
+
description: A flag indicating whether the incident is a test incident.
|
18249
|
+
example: false
|
18250
|
+
type: boolean
|
17679
18251
|
modified:
|
17680
18252
|
description: Timestamp when the incident was last modified.
|
17681
18253
|
format: date-time
|
@@ -19402,12 +19974,6 @@ components:
|
|
19402
19974
|
JobDefinitionFromRule:
|
19403
19975
|
description: Definition of a historical job based on a security monitoring rule.
|
19404
19976
|
properties:
|
19405
|
-
caseIndex:
|
19406
|
-
description: Index of the rule case applied by the job.
|
19407
|
-
example: 0
|
19408
|
-
format: int32
|
19409
|
-
maximum: 9
|
19410
|
-
type: integer
|
19411
19977
|
from:
|
19412
19978
|
description: Starting time of data analyzed by the job.
|
19413
19979
|
example: 1729843470000
|
@@ -19438,7 +20004,6 @@ components:
|
|
19438
20004
|
- from
|
19439
20005
|
- to
|
19440
20006
|
- index
|
19441
|
-
- caseIndex
|
19442
20007
|
type: object
|
19443
20008
|
KindAttributes:
|
19444
20009
|
description: Kind attributes.
|
@@ -19571,7 +20136,7 @@ components:
|
|
19571
20136
|
type: object
|
19572
20137
|
LayerAttributesInterval:
|
19573
20138
|
description: Defines how often the rotation repeats, using a combination of
|
19574
|
-
days and optional seconds.
|
20139
|
+
days and optional seconds. Should be at least 1 hour.
|
19575
20140
|
properties:
|
19576
20141
|
days:
|
19577
20142
|
description: The number of days in each rotation cycle.
|
@@ -19770,6 +20335,32 @@ components:
|
|
19770
20335
|
format: int64
|
19771
20336
|
type: integer
|
19772
20337
|
type: object
|
20338
|
+
ListAppKeyRegistrationsResponse:
|
20339
|
+
description: A paginated list of app key registrations.
|
20340
|
+
properties:
|
20341
|
+
data:
|
20342
|
+
description: An array of app key registrations.
|
20343
|
+
items:
|
20344
|
+
$ref: '#/components/schemas/AppKeyRegistrationData'
|
20345
|
+
type: array
|
20346
|
+
meta:
|
20347
|
+
$ref: '#/components/schemas/ListAppKeyRegistrationsResponseMeta'
|
20348
|
+
type: object
|
20349
|
+
ListAppKeyRegistrationsResponseMeta:
|
20350
|
+
description: The definition of `ListAppKeyRegistrationsResponseMeta` object.
|
20351
|
+
properties:
|
20352
|
+
total:
|
20353
|
+
description: The total number of app key registrations.
|
20354
|
+
example: 1
|
20355
|
+
format: int64
|
20356
|
+
type: integer
|
20357
|
+
total_filtered:
|
20358
|
+
description: The total number of app key registrations that match the specified
|
20359
|
+
filters.
|
20360
|
+
example: 1
|
20361
|
+
format: int64
|
20362
|
+
type: integer
|
20363
|
+
type: object
|
19773
20364
|
ListApplicationKeysResponse:
|
19774
20365
|
description: Response for a list of application keys.
|
19775
20366
|
properties:
|
@@ -19876,6 +20467,21 @@ components:
|
|
19876
20467
|
format: int64
|
19877
20468
|
type: integer
|
19878
20469
|
type: object
|
20470
|
+
ListAssetsSBOMsResponse:
|
20471
|
+
description: The expected response schema when listing assets SBOMs.
|
20472
|
+
properties:
|
20473
|
+
data:
|
20474
|
+
description: List of assets SBOMs.
|
20475
|
+
items:
|
20476
|
+
$ref: '#/components/schemas/SBOM'
|
20477
|
+
type: array
|
20478
|
+
links:
|
20479
|
+
$ref: '#/components/schemas/Links'
|
20480
|
+
meta:
|
20481
|
+
$ref: '#/components/schemas/Metadata'
|
20482
|
+
required:
|
20483
|
+
- data
|
20484
|
+
type: object
|
19879
20485
|
ListDevicesResponse:
|
19880
20486
|
description: List devices response.
|
19881
20487
|
properties:
|
@@ -23664,6 +24270,278 @@ components:
|
|
23664
24270
|
description: The monitor type.
|
23665
24271
|
type: string
|
23666
24272
|
type: object
|
24273
|
+
MonitorUserTemplate:
|
24274
|
+
additionalProperties: {}
|
24275
|
+
description: A monitor user template object.
|
24276
|
+
properties:
|
24277
|
+
created:
|
24278
|
+
$ref: '#/components/schemas/MonitorUserTemplateCreated'
|
24279
|
+
description:
|
24280
|
+
$ref: '#/components/schemas/MonitorUserTemplateDescription'
|
24281
|
+
modified:
|
24282
|
+
$ref: '#/components/schemas/MonitorUserTemplateModified'
|
24283
|
+
monitor_definition:
|
24284
|
+
additionalProperties: {}
|
24285
|
+
description: A valid monitor definition in the same format as the [V1 Monitor
|
24286
|
+
API](https://docs.datadoghq.com/api/latest/monitors/#create-a-monitor).
|
24287
|
+
example:
|
24288
|
+
message: You may need to add web hosts if this is consistently high.
|
24289
|
+
name: Bytes received on host0
|
24290
|
+
query: avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100
|
24291
|
+
type: query alert
|
24292
|
+
type: object
|
24293
|
+
tags:
|
24294
|
+
$ref: '#/components/schemas/MonitorUserTemplateTags'
|
24295
|
+
template_variables:
|
24296
|
+
$ref: '#/components/schemas/MonitorUserTemplateTemplateVariables'
|
24297
|
+
title:
|
24298
|
+
$ref: '#/components/schemas/MonitorUserTemplateTitle'
|
24299
|
+
version:
|
24300
|
+
$ref: '#/components/schemas/MonitorUserTemplateVersion'
|
24301
|
+
versions:
|
24302
|
+
description: All versions of the monitor user template.
|
24303
|
+
items:
|
24304
|
+
$ref: '#/components/schemas/SimpleMonitorUserTemplate'
|
24305
|
+
type: array
|
24306
|
+
type: object
|
24307
|
+
MonitorUserTemplateCreateData:
|
24308
|
+
description: Monitor user template data.
|
24309
|
+
properties:
|
24310
|
+
attributes:
|
24311
|
+
$ref: '#/components/schemas/MonitorUserTemplateRequestAttributes'
|
24312
|
+
type:
|
24313
|
+
$ref: '#/components/schemas/MonitorUserTemplateResourceType'
|
24314
|
+
required:
|
24315
|
+
- type
|
24316
|
+
- attributes
|
24317
|
+
type: object
|
24318
|
+
MonitorUserTemplateCreateRequest:
|
24319
|
+
description: Request for creating a monitor user template.
|
24320
|
+
properties:
|
24321
|
+
data:
|
24322
|
+
$ref: '#/components/schemas/MonitorUserTemplateCreateData'
|
24323
|
+
required:
|
24324
|
+
- data
|
24325
|
+
type: object
|
24326
|
+
MonitorUserTemplateCreateResponse:
|
24327
|
+
description: Response for creating a monitor user template.
|
24328
|
+
properties:
|
24329
|
+
data:
|
24330
|
+
$ref: '#/components/schemas/MonitorUserTemplateResponseData'
|
24331
|
+
type: object
|
24332
|
+
MonitorUserTemplateCreated:
|
24333
|
+
description: The created timestamp of the template.
|
24334
|
+
example: '2024-01-02T03:04:23.274966+00:00'
|
24335
|
+
format: date-time
|
24336
|
+
readOnly: true
|
24337
|
+
type: string
|
24338
|
+
MonitorUserTemplateDescription:
|
24339
|
+
description: A brief description of the monitor user template.
|
24340
|
+
example: This is a template for monitoring user activity.
|
24341
|
+
nullable: true
|
24342
|
+
type: string
|
24343
|
+
MonitorUserTemplateId:
|
24344
|
+
description: The unique identifier.
|
24345
|
+
example: 00000000-0000-1234-0000-000000000000
|
24346
|
+
type: string
|
24347
|
+
MonitorUserTemplateListResponse:
|
24348
|
+
description: Response for retrieving all monitor user templates.
|
24349
|
+
properties:
|
24350
|
+
data:
|
24351
|
+
description: An array of monitor user templates.
|
24352
|
+
items:
|
24353
|
+
$ref: '#/components/schemas/MonitorUserTemplateResponseData'
|
24354
|
+
type: array
|
24355
|
+
type: object
|
24356
|
+
MonitorUserTemplateModified:
|
24357
|
+
description: The last modified timestamp. When the template version was created.
|
24358
|
+
example: '2024-02-02T03:04:23.274966+00:00'
|
24359
|
+
format: date-time
|
24360
|
+
readOnly: true
|
24361
|
+
type: string
|
24362
|
+
MonitorUserTemplateRequestAttributes:
|
24363
|
+
additionalProperties: false
|
24364
|
+
description: Attributes for a monitor user template.
|
24365
|
+
properties:
|
24366
|
+
description:
|
24367
|
+
$ref: '#/components/schemas/MonitorUserTemplateDescription'
|
24368
|
+
monitor_definition:
|
24369
|
+
additionalProperties: {}
|
24370
|
+
description: A valid monitor definition in the same format as the [V1 Monitor
|
24371
|
+
API](https://docs.datadoghq.com/api/latest/monitors/#create-a-monitor).
|
24372
|
+
example:
|
24373
|
+
message: You may need to add web hosts if this is consistently high.
|
24374
|
+
name: Bytes received on host0
|
24375
|
+
query: avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100
|
24376
|
+
type: query alert
|
24377
|
+
type: object
|
24378
|
+
tags:
|
24379
|
+
$ref: '#/components/schemas/MonitorUserTemplateTags'
|
24380
|
+
template_variables:
|
24381
|
+
$ref: '#/components/schemas/MonitorUserTemplateTemplateVariables'
|
24382
|
+
title:
|
24383
|
+
$ref: '#/components/schemas/MonitorUserTemplateTitle'
|
24384
|
+
required:
|
24385
|
+
- title
|
24386
|
+
- monitor_definition
|
24387
|
+
- tags
|
24388
|
+
type: object
|
24389
|
+
MonitorUserTemplateResourceType:
|
24390
|
+
default: monitor-user-template
|
24391
|
+
description: Monitor user template resource type.
|
24392
|
+
enum:
|
24393
|
+
- monitor-user-template
|
24394
|
+
example: monitor-user-template
|
24395
|
+
type: string
|
24396
|
+
x-enum-varnames:
|
24397
|
+
- MONITOR_USER_TEMPLATE
|
24398
|
+
MonitorUserTemplateResponse:
|
24399
|
+
description: Response for retrieving a monitor user template.
|
24400
|
+
properties:
|
24401
|
+
data:
|
24402
|
+
$ref: '#/components/schemas/MonitorUserTemplateResponseDataWithVersions'
|
24403
|
+
type: object
|
24404
|
+
MonitorUserTemplateResponseAttributes:
|
24405
|
+
additionalProperties: {}
|
24406
|
+
description: Attributes for a monitor user template.
|
24407
|
+
properties:
|
24408
|
+
created:
|
24409
|
+
$ref: '#/components/schemas/MonitorUserTemplateCreated'
|
24410
|
+
description:
|
24411
|
+
$ref: '#/components/schemas/MonitorUserTemplateDescription'
|
24412
|
+
modified:
|
24413
|
+
$ref: '#/components/schemas/MonitorUserTemplateModified'
|
24414
|
+
monitor_definition:
|
24415
|
+
additionalProperties: {}
|
24416
|
+
description: A valid monitor definition in the same format as the [V1 Monitor
|
24417
|
+
API](https://docs.datadoghq.com/api/latest/monitors/#create-a-monitor).
|
24418
|
+
example:
|
24419
|
+
message: You may need to add web hosts if this is consistently high.
|
24420
|
+
name: Bytes received on host0
|
24421
|
+
query: avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100
|
24422
|
+
type: query alert
|
24423
|
+
type: object
|
24424
|
+
tags:
|
24425
|
+
$ref: '#/components/schemas/MonitorUserTemplateTags'
|
24426
|
+
template_variables:
|
24427
|
+
$ref: '#/components/schemas/MonitorUserTemplateTemplateVariables'
|
24428
|
+
title:
|
24429
|
+
$ref: '#/components/schemas/MonitorUserTemplateTitle'
|
24430
|
+
version:
|
24431
|
+
$ref: '#/components/schemas/MonitorUserTemplateVersion'
|
24432
|
+
type: object
|
24433
|
+
MonitorUserTemplateResponseData:
|
24434
|
+
description: Monitor user template list response data.
|
24435
|
+
properties:
|
24436
|
+
attributes:
|
24437
|
+
$ref: '#/components/schemas/MonitorUserTemplateResponseAttributes'
|
24438
|
+
id:
|
24439
|
+
$ref: '#/components/schemas/MonitorUserTemplateId'
|
24440
|
+
type:
|
24441
|
+
$ref: '#/components/schemas/MonitorUserTemplateResourceType'
|
24442
|
+
type: object
|
24443
|
+
MonitorUserTemplateResponseDataWithVersions:
|
24444
|
+
description: Monitor user template data.
|
24445
|
+
properties:
|
24446
|
+
attributes:
|
24447
|
+
$ref: '#/components/schemas/MonitorUserTemplate'
|
24448
|
+
id:
|
24449
|
+
$ref: '#/components/schemas/MonitorUserTemplateId'
|
24450
|
+
type:
|
24451
|
+
$ref: '#/components/schemas/MonitorUserTemplateResourceType'
|
24452
|
+
type: object
|
24453
|
+
MonitorUserTemplateTags:
|
24454
|
+
description: The definition of `MonitorUserTemplateTags` object.
|
24455
|
+
example:
|
24456
|
+
- product:Our Custom App
|
24457
|
+
- integration:Azure
|
24458
|
+
items:
|
24459
|
+
description: 'Tags associated with the monitor user template. Must be key
|
24460
|
+
value. Only ''product'' and ''integration'' keys are
|
24461
|
+
|
24462
|
+
allowed. The value is the name of the category to display the template under.
|
24463
|
+
Integrations can be filtered out in the UI.
|
24464
|
+
|
24465
|
+
(Review note: This modeling of ''categories'' is subject to change.)'
|
24466
|
+
example: us-east1
|
24467
|
+
minLength: 1
|
24468
|
+
type: string
|
24469
|
+
uniqueItems: true
|
24470
|
+
type: array
|
24471
|
+
MonitorUserTemplateTemplateVariables:
|
24472
|
+
description: The definition of `MonitorUserTemplateTemplateVariables` object.
|
24473
|
+
items:
|
24474
|
+
$ref: '#/components/schemas/MonitorUserTemplateTemplateVariablesItems'
|
24475
|
+
type: array
|
24476
|
+
MonitorUserTemplateTemplateVariablesItems:
|
24477
|
+
additionalProperties: false
|
24478
|
+
description: List of objects representing template variables on the monitor
|
24479
|
+
which can have selectable values.
|
24480
|
+
properties:
|
24481
|
+
available_values:
|
24482
|
+
description: Available values for the variable.
|
24483
|
+
example:
|
24484
|
+
- value1
|
24485
|
+
- value2
|
24486
|
+
items:
|
24487
|
+
minLength: 1
|
24488
|
+
type: string
|
24489
|
+
uniqueItems: true
|
24490
|
+
type: array
|
24491
|
+
defaults:
|
24492
|
+
description: Default values of the template variable.
|
24493
|
+
example:
|
24494
|
+
- defaultValue
|
24495
|
+
items:
|
24496
|
+
minLength: 0
|
24497
|
+
type: string
|
24498
|
+
uniqueItems: true
|
24499
|
+
type: array
|
24500
|
+
name:
|
24501
|
+
description: The name of the template variable.
|
24502
|
+
example: regionName
|
24503
|
+
type: string
|
24504
|
+
tag_key:
|
24505
|
+
description: The tag key associated with the variable. This works the same
|
24506
|
+
as dashboard template variables.
|
24507
|
+
example: datacenter
|
24508
|
+
type: string
|
24509
|
+
required:
|
24510
|
+
- name
|
24511
|
+
type: object
|
24512
|
+
MonitorUserTemplateTitle:
|
24513
|
+
description: The title of the monitor user template.
|
24514
|
+
example: Postgres CPU Monitor
|
24515
|
+
type: string
|
24516
|
+
MonitorUserTemplateUpdateData:
|
24517
|
+
description: Monitor user template data.
|
24518
|
+
properties:
|
24519
|
+
attributes:
|
24520
|
+
$ref: '#/components/schemas/MonitorUserTemplateRequestAttributes'
|
24521
|
+
id:
|
24522
|
+
$ref: '#/components/schemas/MonitorUserTemplateId'
|
24523
|
+
type:
|
24524
|
+
$ref: '#/components/schemas/MonitorUserTemplateResourceType'
|
24525
|
+
required:
|
24526
|
+
- id
|
24527
|
+
- type
|
24528
|
+
- attributes
|
24529
|
+
type: object
|
24530
|
+
MonitorUserTemplateUpdateRequest:
|
24531
|
+
description: Request for creating a new monitor user template version.
|
24532
|
+
properties:
|
24533
|
+
data:
|
24534
|
+
$ref: '#/components/schemas/MonitorUserTemplateUpdateData'
|
24535
|
+
required:
|
24536
|
+
- data
|
24537
|
+
type: object
|
24538
|
+
MonitorUserTemplateVersion:
|
24539
|
+
description: The version of the monitor user template.
|
24540
|
+
example: 0
|
24541
|
+
format: int64
|
24542
|
+
nullable: true
|
24543
|
+
readOnly: true
|
24544
|
+
type: integer
|
23667
24545
|
MonthlyCostAttributionAttributes:
|
23668
24546
|
description: Cost Attribution by Tag for a given organization.
|
23669
24547
|
properties:
|
@@ -29407,6 +30285,12 @@ components:
|
|
29407
30285
|
x-enum-varnames:
|
29408
30286
|
- ANY
|
29409
30287
|
- ALL
|
30288
|
+
RegisterAppKeyResponse:
|
30289
|
+
description: The response object after creating an app key registration.
|
30290
|
+
properties:
|
30291
|
+
data:
|
30292
|
+
$ref: '#/components/schemas/AppKeyRegistrationData'
|
30293
|
+
type: object
|
29410
30294
|
RelationAttributes:
|
29411
30295
|
description: Relation attributes.
|
29412
30296
|
properties:
|
@@ -31653,6 +32537,11 @@ components:
|
|
31653
32537
|
items:
|
31654
32538
|
$ref: '#/components/schemas/SBOMComponent'
|
31655
32539
|
type: array
|
32540
|
+
dependencies:
|
32541
|
+
description: List of dependencies between components of the SBOM.
|
32542
|
+
items:
|
32543
|
+
$ref: '#/components/schemas/SBOMComponentDependency'
|
32544
|
+
type: array
|
31656
32545
|
metadata:
|
31657
32546
|
$ref: '#/components/schemas/SBOMMetadata'
|
31658
32547
|
serialNumber:
|
@@ -31676,6 +32565,7 @@ components:
|
|
31676
32565
|
- metadata
|
31677
32566
|
- serialNumber
|
31678
32567
|
- version
|
32568
|
+
- dependencies
|
31679
32569
|
type: object
|
31680
32570
|
SBOMComponent:
|
31681
32571
|
description: Software or hardware component.
|
@@ -31685,16 +32575,28 @@ components:
|
|
31685
32575
|
elsewhere in the BOM.
|
31686
32576
|
example: pkg:golang/google.golang.org/grpc@1.68.1
|
31687
32577
|
type: string
|
32578
|
+
licenses:
|
32579
|
+
description: The software licenses of the SBOM component.
|
32580
|
+
items:
|
32581
|
+
$ref: '#/components/schemas/SBOMComponentLicense'
|
32582
|
+
type: array
|
31688
32583
|
name:
|
31689
32584
|
description: The name of the component. This will often be a shortened,
|
31690
32585
|
single name of the component.
|
31691
32586
|
example: google.golang.org/grpc
|
31692
32587
|
type: string
|
32588
|
+
properties:
|
32589
|
+
description: The custom properties of the component of the SBOM.
|
32590
|
+
items:
|
32591
|
+
$ref: '#/components/schemas/SBOMComponentProperty'
|
32592
|
+
type: array
|
31693
32593
|
purl:
|
31694
32594
|
description: Specifies the package-url (purl). The purl, if specified, MUST
|
31695
32595
|
be valid and conform to the [specification](https://github.com/package-url/purl-spec).
|
31696
32596
|
example: pkg:golang/google.golang.org/grpc@1.68.1
|
31697
32597
|
type: string
|
32598
|
+
supplier:
|
32599
|
+
$ref: '#/components/schemas/SBOMComponentSupplier'
|
31698
32600
|
type:
|
31699
32601
|
$ref: '#/components/schemas/SBOMComponentType'
|
31700
32602
|
version:
|
@@ -31705,6 +32607,89 @@ components:
|
|
31705
32607
|
- type
|
31706
32608
|
- name
|
31707
32609
|
- version
|
32610
|
+
- supplier
|
32611
|
+
type: object
|
32612
|
+
SBOMComponentDependency:
|
32613
|
+
description: The dependencies of a component of the SBOM.
|
32614
|
+
properties:
|
32615
|
+
dependsOn:
|
32616
|
+
description: The components that are dependencies of the ref component.
|
32617
|
+
items:
|
32618
|
+
example: pkg:golang/google.golang.org/grpc@1.68.1
|
32619
|
+
type: string
|
32620
|
+
required:
|
32621
|
+
- ref
|
32622
|
+
- dependsOn
|
32623
|
+
type: array
|
32624
|
+
ref:
|
32625
|
+
description: The identifier for the related component.
|
32626
|
+
example: Repository|github.com/datadog/datadog-agent
|
32627
|
+
type: string
|
32628
|
+
type: object
|
32629
|
+
SBOMComponentLicense:
|
32630
|
+
description: The software license of the component of the SBOM.
|
32631
|
+
properties:
|
32632
|
+
license:
|
32633
|
+
$ref: '#/components/schemas/SBOMComponentLicenseLicense'
|
32634
|
+
required:
|
32635
|
+
- license
|
32636
|
+
type: object
|
32637
|
+
SBOMComponentLicenseLicense:
|
32638
|
+
description: The software license of the component of the SBOM.
|
32639
|
+
properties:
|
32640
|
+
name:
|
32641
|
+
description: The name of the software license of the component of the SBOM.
|
32642
|
+
example: MIT
|
32643
|
+
type: string
|
32644
|
+
required:
|
32645
|
+
- name
|
32646
|
+
type: object
|
32647
|
+
SBOMComponentLicenseType:
|
32648
|
+
description: The SBOM component license type.
|
32649
|
+
enum:
|
32650
|
+
- network_strong_copyleft
|
32651
|
+
- non_standard_copyleft
|
32652
|
+
- other_non_free
|
32653
|
+
- other_non_standard
|
32654
|
+
- permissive
|
32655
|
+
- public_domain
|
32656
|
+
- strong_copyleft
|
32657
|
+
- weak_copyleft
|
32658
|
+
example: application
|
32659
|
+
type: string
|
32660
|
+
x-enum-varnames:
|
32661
|
+
- NETWORK_STRONG_COPYLEFT
|
32662
|
+
- NON_STANDARD_COPYLEFT
|
32663
|
+
- OTHER_NON_FREE
|
32664
|
+
- OTHER_NON_STANDARD
|
32665
|
+
- PERMISSIVE
|
32666
|
+
- PUBLIC_DOMAIN
|
32667
|
+
- STRONG_COPYLEFT
|
32668
|
+
- WEAK_COPYLEFT
|
32669
|
+
SBOMComponentProperty:
|
32670
|
+
description: The custom property of the component of the SBOM.
|
32671
|
+
properties:
|
32672
|
+
name:
|
32673
|
+
description: The name of the custom property of the component of the SBOM.
|
32674
|
+
example: license_type
|
32675
|
+
type: string
|
32676
|
+
value:
|
32677
|
+
description: The value of the custom property of the component of the SBOM.
|
32678
|
+
example: permissive
|
32679
|
+
type: string
|
32680
|
+
required:
|
32681
|
+
- name
|
32682
|
+
- value
|
32683
|
+
type: object
|
32684
|
+
SBOMComponentSupplier:
|
32685
|
+
description: The supplier of the component.
|
32686
|
+
properties:
|
32687
|
+
name:
|
32688
|
+
description: Identifier of the supplier of the component.
|
32689
|
+
example: https://go.dev
|
32690
|
+
type: string
|
32691
|
+
required:
|
32692
|
+
- name
|
31708
32693
|
type: object
|
31709
32694
|
SBOMComponentType:
|
31710
32695
|
description: The SBOM component type
|
@@ -31739,8 +32724,25 @@ components:
|
|
31739
32724
|
SBOMMetadata:
|
31740
32725
|
description: Provides additional information about a BOM.
|
31741
32726
|
properties:
|
32727
|
+
authors:
|
32728
|
+
description: List of authors of the SBOM.
|
32729
|
+
items:
|
32730
|
+
$ref: '#/components/schemas/SBOMMetadataAuthor'
|
32731
|
+
type: array
|
31742
32732
|
component:
|
31743
32733
|
$ref: '#/components/schemas/SBOMMetadataComponent'
|
32734
|
+
timestamp:
|
32735
|
+
description: The timestamp of the SBOM creation.
|
32736
|
+
example: '2025-07-08T07:24:53Z'
|
32737
|
+
type: string
|
32738
|
+
type: object
|
32739
|
+
SBOMMetadataAuthor:
|
32740
|
+
description: Author of the SBOM.
|
32741
|
+
properties:
|
32742
|
+
name:
|
32743
|
+
description: The identifier of the Author of the SBOM.
|
32744
|
+
example: Datadog, Inc.
|
32745
|
+
type: string
|
31744
32746
|
type: object
|
31745
32747
|
SBOMMetadataComponent:
|
31746
32748
|
description: The component that the BOM describes.
|
@@ -32402,7 +33404,7 @@ components:
|
|
32402
33404
|
- effective_date: '2025-02-03T05:00:00Z'
|
32403
33405
|
end_date: '2025-12-31T00:00:00Z'
|
32404
33406
|
interval:
|
32405
|
-
seconds:
|
33407
|
+
seconds: 3600
|
32406
33408
|
members:
|
32407
33409
|
- user:
|
32408
33410
|
id: 00000000-aba1-0000-0000-000000000000
|
@@ -36839,6 +37841,37 @@ components:
|
|
36839
37841
|
description: The definition of `ShiftIncluded` object.
|
36840
37842
|
oneOf:
|
36841
37843
|
- $ref: '#/components/schemas/ScheduleUser'
|
37844
|
+
SimpleMonitorUserTemplate:
|
37845
|
+
description: A simplified version of a monitor user template.
|
37846
|
+
properties:
|
37847
|
+
created:
|
37848
|
+
$ref: '#/components/schemas/MonitorUserTemplateCreated'
|
37849
|
+
description:
|
37850
|
+
$ref: '#/components/schemas/MonitorUserTemplateDescription'
|
37851
|
+
id:
|
37852
|
+
description: The unique identifier. The initial version will match the template
|
37853
|
+
ID.
|
37854
|
+
example: 00000000-0000-1234-0000-000000000000
|
37855
|
+
type: string
|
37856
|
+
monitor_definition:
|
37857
|
+
additionalProperties: {}
|
37858
|
+
description: A valid monitor definition in the same format as the [V1 Monitor
|
37859
|
+
API](https://docs.datadoghq.com/api/latest/monitors/#create-a-monitor).
|
37860
|
+
example:
|
37861
|
+
message: You may need to add web hosts if this is consistently high.
|
37862
|
+
name: Bytes received on host0
|
37863
|
+
query: avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100
|
37864
|
+
type: query alert
|
37865
|
+
type: object
|
37866
|
+
tags:
|
37867
|
+
$ref: '#/components/schemas/MonitorUserTemplateTags'
|
37868
|
+
template_variables:
|
37869
|
+
$ref: '#/components/schemas/MonitorUserTemplateTemplateVariables'
|
37870
|
+
title:
|
37871
|
+
$ref: '#/components/schemas/MonitorUserTemplateTitle'
|
37872
|
+
version:
|
37873
|
+
$ref: '#/components/schemas/MonitorUserTemplateVersion'
|
37874
|
+
type: object
|
36842
37875
|
SingleAggregatedConnectionResponseArray:
|
36843
37876
|
description: List of aggregated connections.
|
36844
37877
|
example:
|
@@ -40665,6 +41698,14 @@ components:
|
|
40665
41698
|
type: string
|
40666
41699
|
library:
|
40667
41700
|
$ref: '#/components/schemas/Library'
|
41701
|
+
origin:
|
41702
|
+
description: Vulnerability origin.
|
41703
|
+
example:
|
41704
|
+
- agentless-scanner
|
41705
|
+
items:
|
41706
|
+
example: agentless-scanner
|
41707
|
+
type: string
|
41708
|
+
type: array
|
40668
41709
|
remediations:
|
40669
41710
|
description: List of remediations.
|
40670
41711
|
items:
|
@@ -40704,6 +41745,7 @@ components:
|
|
40704
41745
|
- exposure_time
|
40705
41746
|
- remediations
|
40706
41747
|
- fix_available
|
41748
|
+
- origin
|
40707
41749
|
type: object
|
40708
41750
|
VulnerabilityCvss:
|
40709
41751
|
description: Vulnerability severities.
|
@@ -41440,9 +42482,185 @@ info:
|
|
41440
42482
|
version: '1.0'
|
41441
42483
|
openapi: 3.0.0
|
41442
42484
|
paths:
|
42485
|
+
/api/v2/actions/app_key_registrations:
|
42486
|
+
get:
|
42487
|
+
description: List App Key Registrations
|
42488
|
+
operationId: ListAppKeyRegistrations
|
42489
|
+
parameters:
|
42490
|
+
- description: The number of App Key Registrations to return per page.
|
42491
|
+
in: query
|
42492
|
+
name: page[size]
|
42493
|
+
required: false
|
42494
|
+
schema:
|
42495
|
+
format: int64
|
42496
|
+
type: integer
|
42497
|
+
- description: The page number to return.
|
42498
|
+
in: query
|
42499
|
+
name: page[number]
|
42500
|
+
required: false
|
42501
|
+
schema:
|
42502
|
+
format: int64
|
42503
|
+
type: integer
|
42504
|
+
responses:
|
42505
|
+
'200':
|
42506
|
+
content:
|
42507
|
+
application/json:
|
42508
|
+
schema:
|
42509
|
+
$ref: '#/components/schemas/ListAppKeyRegistrationsResponse'
|
42510
|
+
description: OK
|
42511
|
+
'400':
|
42512
|
+
content:
|
42513
|
+
application/json:
|
42514
|
+
schema:
|
42515
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
42516
|
+
description: Bad request
|
42517
|
+
'403':
|
42518
|
+
content:
|
42519
|
+
application/json:
|
42520
|
+
schema:
|
42521
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
42522
|
+
description: Forbidden
|
42523
|
+
'429':
|
42524
|
+
content:
|
42525
|
+
application/json:
|
42526
|
+
schema:
|
42527
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
42528
|
+
description: Too many requests
|
42529
|
+
summary: List App Key Registrations
|
42530
|
+
tags:
|
42531
|
+
- Action Connection
|
42532
|
+
x-permission:
|
42533
|
+
operator: OR
|
42534
|
+
permissions:
|
42535
|
+
- org_app_keys_read
|
42536
|
+
/api/v2/actions/app_key_registrations/{app_key_id}:
|
42537
|
+
delete:
|
42538
|
+
description: Unregister an App Key
|
42539
|
+
operationId: UnregisterAppKey
|
42540
|
+
parameters:
|
42541
|
+
- $ref: '#/components/parameters/ApplicationKeyId'
|
42542
|
+
responses:
|
42543
|
+
'204':
|
42544
|
+
description: No Content
|
42545
|
+
'400':
|
42546
|
+
content:
|
42547
|
+
application/json:
|
42548
|
+
schema:
|
42549
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
42550
|
+
description: Bad request
|
42551
|
+
'403':
|
42552
|
+
content:
|
42553
|
+
application/json:
|
42554
|
+
schema:
|
42555
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
42556
|
+
description: Forbidden
|
42557
|
+
'404':
|
42558
|
+
content:
|
42559
|
+
application/json:
|
42560
|
+
schema:
|
42561
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
42562
|
+
description: Not found
|
42563
|
+
'429':
|
42564
|
+
content:
|
42565
|
+
application/json:
|
42566
|
+
schema:
|
42567
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
42568
|
+
description: Too many requests
|
42569
|
+
summary: Unregister an App Key
|
42570
|
+
tags:
|
42571
|
+
- Action Connection
|
42572
|
+
x-permission:
|
42573
|
+
operator: OR
|
42574
|
+
permissions:
|
42575
|
+
- user_access_manage
|
42576
|
+
- user_app_keys
|
42577
|
+
- service_account_write
|
42578
|
+
get:
|
42579
|
+
description: Get an existing App Key Registration
|
42580
|
+
operationId: GetAppKeyRegistration
|
42581
|
+
parameters:
|
42582
|
+
- $ref: '#/components/parameters/ApplicationKeyId'
|
42583
|
+
responses:
|
42584
|
+
'200':
|
42585
|
+
content:
|
42586
|
+
application/json:
|
42587
|
+
schema:
|
42588
|
+
$ref: '#/components/schemas/GetAppKeyRegistrationResponse'
|
42589
|
+
description: OK
|
42590
|
+
'400':
|
42591
|
+
content:
|
42592
|
+
application/json:
|
42593
|
+
schema:
|
42594
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
42595
|
+
description: Bad request
|
42596
|
+
'403':
|
42597
|
+
content:
|
42598
|
+
application/json:
|
42599
|
+
schema:
|
42600
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
42601
|
+
description: Forbidden
|
42602
|
+
'404':
|
42603
|
+
content:
|
42604
|
+
application/json:
|
42605
|
+
schema:
|
42606
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
42607
|
+
description: Not found
|
42608
|
+
'429':
|
42609
|
+
content:
|
42610
|
+
application/json:
|
42611
|
+
schema:
|
42612
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
42613
|
+
description: Too many requests
|
42614
|
+
summary: Get an existing App Key Registration
|
42615
|
+
tags:
|
42616
|
+
- Action Connection
|
42617
|
+
x-permission:
|
42618
|
+
operator: OR
|
42619
|
+
permissions:
|
42620
|
+
- org_app_keys_read
|
42621
|
+
put:
|
42622
|
+
description: Register a new App Key
|
42623
|
+
operationId: RegisterAppKey
|
42624
|
+
parameters:
|
42625
|
+
- $ref: '#/components/parameters/ApplicationKeyId'
|
42626
|
+
responses:
|
42627
|
+
'201':
|
42628
|
+
content:
|
42629
|
+
application/json:
|
42630
|
+
schema:
|
42631
|
+
$ref: '#/components/schemas/RegisterAppKeyResponse'
|
42632
|
+
description: Created
|
42633
|
+
'400':
|
42634
|
+
content:
|
42635
|
+
application/json:
|
42636
|
+
schema:
|
42637
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
42638
|
+
description: Bad request
|
42639
|
+
'403':
|
42640
|
+
content:
|
42641
|
+
application/json:
|
42642
|
+
schema:
|
42643
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
42644
|
+
description: Forbidden
|
42645
|
+
'429':
|
42646
|
+
content:
|
42647
|
+
application/json:
|
42648
|
+
schema:
|
42649
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
42650
|
+
description: Too many requests
|
42651
|
+
summary: Register a new App Key
|
42652
|
+
tags:
|
42653
|
+
- Action Connection
|
42654
|
+
x-permission:
|
42655
|
+
operator: OR
|
42656
|
+
permissions:
|
42657
|
+
- user_access_manage
|
42658
|
+
- user_app_keys
|
42659
|
+
- service_account_write
|
41443
42660
|
/api/v2/actions/connections:
|
41444
42661
|
post:
|
41445
|
-
description: Create a new Action Connection
|
42662
|
+
description: Create a new Action Connection. This API requires a [registered
|
42663
|
+
application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
41446
42664
|
operationId: CreateActionConnection
|
41447
42665
|
requestBody:
|
41448
42666
|
content:
|
@@ -41480,7 +42698,8 @@ paths:
|
|
41480
42698
|
- Action Connection
|
41481
42699
|
/api/v2/actions/connections/{connection_id}:
|
41482
42700
|
delete:
|
41483
|
-
description: Delete an existing Action Connection
|
42701
|
+
description: Delete an existing Action Connection. This API requires a [registered
|
42702
|
+
application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
41484
42703
|
operationId: DeleteActionConnection
|
41485
42704
|
parameters:
|
41486
42705
|
- $ref: '#/components/parameters/ConnectionId'
|
@@ -41513,7 +42732,8 @@ paths:
|
|
41513
42732
|
permissions:
|
41514
42733
|
- connection_write
|
41515
42734
|
get:
|
41516
|
-
description: Get an existing Action Connection
|
42735
|
+
description: Get an existing Action Connection. This API requires a [registered
|
42736
|
+
application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
41517
42737
|
operationId: GetActionConnection
|
41518
42738
|
parameters:
|
41519
42739
|
- $ref: '#/components/parameters/ConnectionId'
|
@@ -41552,7 +42772,8 @@ paths:
|
|
41552
42772
|
tags:
|
41553
42773
|
- Action Connection
|
41554
42774
|
patch:
|
41555
|
-
description: Update an existing Action Connection
|
42775
|
+
description: Update an existing Action Connection. This API requires a [registered
|
42776
|
+
application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
41556
42777
|
operationId: UpdateActionConnection
|
41557
42778
|
parameters:
|
41558
42779
|
- $ref: '#/components/parameters/ConnectionId'
|
@@ -42582,6 +43803,7 @@ paths:
|
|
42582
43803
|
/api/v2/app-builder/apps:
|
42583
43804
|
delete:
|
42584
43805
|
description: Delete multiple apps in a single request from a list of app IDs.
|
43806
|
+
This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
42585
43807
|
operationId: DeleteApps
|
42586
43808
|
requestBody:
|
42587
43809
|
content:
|
@@ -42626,7 +43848,8 @@ paths:
|
|
42626
43848
|
get:
|
42627
43849
|
description: List all apps, with optional filters and sorting. This endpoint
|
42628
43850
|
is paginated. Only basic app information such as the app ID, name, and description
|
42629
|
-
is returned by this endpoint.
|
43851
|
+
is returned by this endpoint. This API requires a [registered application
|
43852
|
+
key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
42630
43853
|
operationId: ListApps
|
42631
43854
|
parameters:
|
42632
43855
|
- description: The number of apps to return per page.
|
@@ -42732,7 +43955,8 @@ paths:
|
|
42732
43955
|
permissions:
|
42733
43956
|
- apps_run
|
42734
43957
|
post:
|
42735
|
-
description: Create a new app, returning the app ID.
|
43958
|
+
description: Create a new app, returning the app ID. This API requires a [registered
|
43959
|
+
application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
42736
43960
|
operationId: CreateApp
|
42737
43961
|
requestBody:
|
42738
43962
|
content:
|
@@ -42772,7 +43996,8 @@ paths:
|
|
42772
43996
|
- workflows_run
|
42773
43997
|
/api/v2/app-builder/apps/{app_id}:
|
42774
43998
|
delete:
|
42775
|
-
description: Delete a single app.
|
43999
|
+
description: Delete a single app. This API requires a [registered application
|
44000
|
+
key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
42776
44001
|
operationId: DeleteApp
|
42777
44002
|
parameters:
|
42778
44003
|
- description: The ID of the app to delete.
|
@@ -42824,7 +44049,8 @@ paths:
|
|
42824
44049
|
permissions:
|
42825
44050
|
- apps_write
|
42826
44051
|
get:
|
42827
|
-
description: Get the full definition of an app.
|
44052
|
+
description: Get the full definition of an app. This API requires a [registered
|
44053
|
+
application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
42828
44054
|
operationId: GetApp
|
42829
44055
|
parameters:
|
42830
44056
|
- description: The ID of the app to retrieve.
|
@@ -42887,6 +44113,7 @@ paths:
|
|
42887
44113
|
- connections_read
|
42888
44114
|
patch:
|
42889
44115
|
description: Update an existing app. This creates a new version of the app.
|
44116
|
+
This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
42890
44117
|
operationId: UpdateApp
|
42891
44118
|
parameters:
|
42892
44119
|
- description: The ID of the app to update.
|
@@ -42938,7 +44165,8 @@ paths:
|
|
42938
44165
|
description: Unpublish an app, removing the live version of the app. Unpublishing
|
42939
44166
|
creates a new instance of a `deployment` object on the app, with a nil `app_version_id`
|
42940
44167
|
(`00000000-0000-0000-0000-000000000000`). The app can still be updated and
|
42941
|
-
published again in the future.
|
44168
|
+
published again in the future. This API requires a [registered application
|
44169
|
+
key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
42942
44170
|
operationId: UnpublishApp
|
42943
44171
|
parameters:
|
42944
44172
|
- description: The ID of the app to unpublish.
|
@@ -42986,7 +44214,8 @@ paths:
|
|
42986
44214
|
post:
|
42987
44215
|
description: Publish an app for use by other users. To ensure the app is accessible
|
42988
44216
|
to the correct users, you also need to set a [Restriction Policy](https://docs.datadoghq.com/api/latest/restriction-policies/)
|
42989
|
-
on the app if a policy does not yet exist.
|
44217
|
+
on the app if a policy does not yet exist. This API requires a [registered
|
44218
|
+
application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
42990
44219
|
operationId: PublishApp
|
42991
44220
|
parameters:
|
42992
44221
|
- description: The ID of the app to publish.
|
@@ -45549,6 +46778,164 @@ paths:
|
|
45549
46778
|
summary: Get Custom Costs file
|
45550
46779
|
tags:
|
45551
46780
|
- Cloud Cost Management
|
46781
|
+
/api/v2/cost/gcp_uc_config:
|
46782
|
+
get:
|
46783
|
+
description: List the GCP Usage Cost configs.
|
46784
|
+
operationId: ListCostGCPUsageCostConfigs
|
46785
|
+
responses:
|
46786
|
+
'200':
|
46787
|
+
content:
|
46788
|
+
application/json:
|
46789
|
+
schema:
|
46790
|
+
$ref: '#/components/schemas/GCPUsageCostConfigsResponse'
|
46791
|
+
description: OK
|
46792
|
+
'403':
|
46793
|
+
content:
|
46794
|
+
application/json:
|
46795
|
+
schema:
|
46796
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
46797
|
+
description: Forbidden
|
46798
|
+
'429':
|
46799
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
46800
|
+
security:
|
46801
|
+
- apiKeyAuth: []
|
46802
|
+
appKeyAuth: []
|
46803
|
+
- AuthZ:
|
46804
|
+
- cloud_cost_management_read
|
46805
|
+
summary: List Cloud Cost Management GCP Usage Cost configs
|
46806
|
+
tags:
|
46807
|
+
- Cloud Cost Management
|
46808
|
+
x-permission:
|
46809
|
+
operator: OR
|
46810
|
+
permissions:
|
46811
|
+
- cloud_cost_management_read
|
46812
|
+
post:
|
46813
|
+
description: Create a Cloud Cost Management account for an GCP Usage Cost config.
|
46814
|
+
operationId: CreateCostGCPUsageCostConfig
|
46815
|
+
requestBody:
|
46816
|
+
content:
|
46817
|
+
application/json:
|
46818
|
+
schema:
|
46819
|
+
$ref: '#/components/schemas/GCPUsageCostConfigPostRequest'
|
46820
|
+
required: true
|
46821
|
+
responses:
|
46822
|
+
'200':
|
46823
|
+
content:
|
46824
|
+
application/json:
|
46825
|
+
schema:
|
46826
|
+
$ref: '#/components/schemas/GCPUsageCostConfigResponse'
|
46827
|
+
description: OK
|
46828
|
+
'400':
|
46829
|
+
content:
|
46830
|
+
application/json:
|
46831
|
+
schema:
|
46832
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
46833
|
+
description: Bad Request
|
46834
|
+
'403':
|
46835
|
+
content:
|
46836
|
+
application/json:
|
46837
|
+
schema:
|
46838
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
46839
|
+
description: Forbidden
|
46840
|
+
'429':
|
46841
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
46842
|
+
security:
|
46843
|
+
- apiKeyAuth: []
|
46844
|
+
appKeyAuth: []
|
46845
|
+
- AuthZ:
|
46846
|
+
- cloud_cost_management_write
|
46847
|
+
summary: Create Cloud Cost Management GCP Usage Cost config
|
46848
|
+
tags:
|
46849
|
+
- Cloud Cost Management
|
46850
|
+
x-permission:
|
46851
|
+
operator: OR
|
46852
|
+
permissions:
|
46853
|
+
- cloud_cost_management_write
|
46854
|
+
/api/v2/cost/gcp_uc_config/{cloud_account_id}:
|
46855
|
+
delete:
|
46856
|
+
description: Archive a Cloud Cost Management account.
|
46857
|
+
operationId: DeleteCostGCPUsageCostConfig
|
46858
|
+
parameters:
|
46859
|
+
- $ref: '#/components/parameters/CloudAccountID'
|
46860
|
+
responses:
|
46861
|
+
'204':
|
46862
|
+
description: No Content
|
46863
|
+
'400':
|
46864
|
+
content:
|
46865
|
+
application/json:
|
46866
|
+
schema:
|
46867
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
46868
|
+
description: Bad Request
|
46869
|
+
'404':
|
46870
|
+
content:
|
46871
|
+
application/json:
|
46872
|
+
schema:
|
46873
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
46874
|
+
description: Not Found
|
46875
|
+
'429':
|
46876
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
46877
|
+
security:
|
46878
|
+
- apiKeyAuth: []
|
46879
|
+
appKeyAuth: []
|
46880
|
+
- AuthZ:
|
46881
|
+
- cloud_cost_management_write
|
46882
|
+
summary: Delete Cloud Cost Management GCP Usage Cost config
|
46883
|
+
tags:
|
46884
|
+
- Cloud Cost Management
|
46885
|
+
x-permission:
|
46886
|
+
operator: OR
|
46887
|
+
permissions:
|
46888
|
+
- cloud_cost_management_write
|
46889
|
+
patch:
|
46890
|
+
description: Update the status of an GCP Usage Cost config (active/archived).
|
46891
|
+
operationId: UpdateCostGCPUsageCostConfig
|
46892
|
+
parameters:
|
46893
|
+
- $ref: '#/components/parameters/CloudAccountID'
|
46894
|
+
requestBody:
|
46895
|
+
content:
|
46896
|
+
application/json:
|
46897
|
+
schema:
|
46898
|
+
$ref: '#/components/schemas/GCPUsageCostConfigPatchRequest'
|
46899
|
+
required: true
|
46900
|
+
responses:
|
46901
|
+
'200':
|
46902
|
+
content:
|
46903
|
+
application/json:
|
46904
|
+
schema:
|
46905
|
+
$ref: '#/components/schemas/GCPUsageCostConfigResponse'
|
46906
|
+
description: OK
|
46907
|
+
'400':
|
46908
|
+
content:
|
46909
|
+
application/json:
|
46910
|
+
schema:
|
46911
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
46912
|
+
description: Bad Request
|
46913
|
+
'403':
|
46914
|
+
content:
|
46915
|
+
application/json:
|
46916
|
+
schema:
|
46917
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
46918
|
+
description: Forbidden
|
46919
|
+
'404':
|
46920
|
+
content:
|
46921
|
+
application/json:
|
46922
|
+
schema:
|
46923
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
46924
|
+
description: Not Found
|
46925
|
+
'429':
|
46926
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
46927
|
+
security:
|
46928
|
+
- apiKeyAuth: []
|
46929
|
+
appKeyAuth: []
|
46930
|
+
- AuthZ:
|
46931
|
+
- cloud_cost_management_write
|
46932
|
+
summary: Update Cloud Cost Management GCP Usage Cost config
|
46933
|
+
tags:
|
46934
|
+
- Cloud Cost Management
|
46935
|
+
x-permission:
|
46936
|
+
operator: OR
|
46937
|
+
permissions:
|
46938
|
+
- cloud_cost_management_write
|
45552
46939
|
/api/v2/cost_by_tag/active_billing_dimensions:
|
45553
46940
|
get:
|
45554
46941
|
description: Get active billing dimensions for cost attribution. Cost data for
|
@@ -46276,6 +47663,135 @@ paths:
|
|
46276
47663
|
tags:
|
46277
47664
|
- Dashboard Lists
|
46278
47665
|
x-codegen-request-body-name: body
|
47666
|
+
/api/v2/datasets:
|
47667
|
+
get:
|
47668
|
+
description: Get all datasets that have been configured for an organization.
|
47669
|
+
operationId: GetAllDatasets
|
47670
|
+
responses:
|
47671
|
+
'200':
|
47672
|
+
content:
|
47673
|
+
application/json:
|
47674
|
+
schema:
|
47675
|
+
$ref: '#/components/schemas/DatasetResponseMulti'
|
47676
|
+
description: OK
|
47677
|
+
'403':
|
47678
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
47679
|
+
'429':
|
47680
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
47681
|
+
security:
|
47682
|
+
- apiKeyAuth: []
|
47683
|
+
appKeyAuth: []
|
47684
|
+
- AuthZ: []
|
47685
|
+
summary: Get all datasets
|
47686
|
+
tags:
|
47687
|
+
- Datasets
|
47688
|
+
x-permission:
|
47689
|
+
operator: OPEN
|
47690
|
+
permissions: []
|
47691
|
+
post:
|
47692
|
+
description: Create a dataset with the configurations in the request.
|
47693
|
+
operationId: CreateDataset
|
47694
|
+
requestBody:
|
47695
|
+
content:
|
47696
|
+
application/json:
|
47697
|
+
example:
|
47698
|
+
data:
|
47699
|
+
attributes:
|
47700
|
+
name: Test RUM Dataset
|
47701
|
+
principals:
|
47702
|
+
- role:23bacb30-1c59-11f0-a596-da7ad0900002
|
47703
|
+
product_filters:
|
47704
|
+
- filters:
|
47705
|
+
- '@application.id:application_123'
|
47706
|
+
product: rum
|
47707
|
+
type: dataset
|
47708
|
+
schema:
|
47709
|
+
$ref: '#/components/schemas/DatasetCreateRequest'
|
47710
|
+
description: Dataset payload
|
47711
|
+
required: true
|
47712
|
+
responses:
|
47713
|
+
'200':
|
47714
|
+
content:
|
47715
|
+
application/json:
|
47716
|
+
schema:
|
47717
|
+
$ref: '#/components/schemas/DatasetResponseSingle'
|
47718
|
+
description: OK
|
47719
|
+
'400':
|
47720
|
+
$ref: '#/components/responses/BadRequestResponse'
|
47721
|
+
'403':
|
47722
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
47723
|
+
'409':
|
47724
|
+
$ref: '#/components/responses/ConflictResponse'
|
47725
|
+
'429':
|
47726
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
47727
|
+
security:
|
47728
|
+
- apiKeyAuth: []
|
47729
|
+
appKeyAuth: []
|
47730
|
+
- AuthZ: []
|
47731
|
+
summary: Create a dataset
|
47732
|
+
tags:
|
47733
|
+
- Datasets
|
47734
|
+
x-codegen-request-body-name: body
|
47735
|
+
x-permission:
|
47736
|
+
operator: OPEN
|
47737
|
+
permissions: []
|
47738
|
+
/api/v2/datasets/{dataset_id}:
|
47739
|
+
delete:
|
47740
|
+
description: Deletes the dataset associated with the ID.
|
47741
|
+
operationId: DeleteDataset
|
47742
|
+
parameters:
|
47743
|
+
- $ref: '#/components/parameters/DatasetID'
|
47744
|
+
responses:
|
47745
|
+
'204':
|
47746
|
+
description: No Content
|
47747
|
+
'400':
|
47748
|
+
$ref: '#/components/responses/BadRequestResponse'
|
47749
|
+
'403':
|
47750
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
47751
|
+
'404':
|
47752
|
+
$ref: '#/components/responses/NotFoundResponse'
|
47753
|
+
'429':
|
47754
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
47755
|
+
security:
|
47756
|
+
- apiKeyAuth: []
|
47757
|
+
appKeyAuth: []
|
47758
|
+
- AuthZ: []
|
47759
|
+
summary: Delete a dataset
|
47760
|
+
tags:
|
47761
|
+
- Datasets
|
47762
|
+
x-permission:
|
47763
|
+
operator: OPEN
|
47764
|
+
permissions: []
|
47765
|
+
get:
|
47766
|
+
description: Retrieves the dataset associated with the ID.
|
47767
|
+
operationId: GetDataset
|
47768
|
+
parameters:
|
47769
|
+
- $ref: '#/components/parameters/DatasetID'
|
47770
|
+
responses:
|
47771
|
+
'200':
|
47772
|
+
content:
|
47773
|
+
application/json:
|
47774
|
+
schema:
|
47775
|
+
$ref: '#/components/schemas/DatasetResponseSingle'
|
47776
|
+
description: OK
|
47777
|
+
'400':
|
47778
|
+
$ref: '#/components/responses/BadRequestResponse'
|
47779
|
+
'403':
|
47780
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
47781
|
+
'404':
|
47782
|
+
$ref: '#/components/responses/NotFoundResponse'
|
47783
|
+
'429':
|
47784
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
47785
|
+
security:
|
47786
|
+
- apiKeyAuth: []
|
47787
|
+
appKeyAuth: []
|
47788
|
+
- AuthZ: []
|
47789
|
+
summary: Get a single dataset by ID
|
47790
|
+
tags:
|
47791
|
+
- Datasets
|
47792
|
+
x-permission:
|
47793
|
+
operator: OPEN
|
47794
|
+
permissions: []
|
46279
47795
|
/api/v2/deletion/data/{product}:
|
46280
47796
|
post:
|
46281
47797
|
description: Creates a data deletion request by providing a query and a timeframe
|
@@ -47159,10 +48675,17 @@ paths:
|
|
47159
48675
|
permissions:
|
47160
48676
|
- events_read
|
47161
48677
|
post:
|
47162
|
-
description: "This endpoint allows you to
|
47163
|
-
with
|
48678
|
+
description: "This endpoint allows you to publish events.\n\n**Note:** To utilize
|
48679
|
+
this endpoint with our client libraries, please ensure you are using the latest
|
48680
|
+
version released on or after July 1, 2025. Earlier versions do not support
|
48681
|
+
this functionality.\n\n\u2705 **Only events with the `change` or `alert` category**
|
48682
|
+
are in General Availability. For change events, see [Change Tracking](https://docs.datadoghq.com/change_tracking)
|
47164
48683
|
for more details.\n\n\u274C For use cases involving other event categories,
|
47165
|
-
|
48684
|
+
use the V1 endpoint or reach out to [support](https://www.datadoghq.com/support/).\n\n\u274C
|
48685
|
+
Notifications are not yet supported for events sent to this endpoint. Use
|
48686
|
+
the V1 endpoint for notification functionality.\n\n\u274C This endpoint is
|
48687
|
+
not available for the Government (US1-FED) site. Contact your account representative
|
48688
|
+
for more information."
|
47166
48689
|
operationId: CreateEvent
|
47167
48690
|
requestBody:
|
47168
48691
|
content:
|
@@ -47172,9 +48695,10 @@ paths:
|
|
47172
48695
|
value:
|
47173
48696
|
data:
|
47174
48697
|
attributes:
|
48698
|
+
aggregation_key: aggregation_key_123
|
47175
48699
|
attributes:
|
47176
48700
|
author:
|
47177
|
-
name:
|
48701
|
+
name: example@datadog.com
|
47178
48702
|
type: user
|
47179
48703
|
change_metadata:
|
47180
48704
|
dd:
|
@@ -47200,17 +48724,19 @@ paths:
|
|
47200
48724
|
rule:
|
47201
48725
|
datacenter: devcycle.us1.prod
|
47202
48726
|
category: change
|
48727
|
+
integration_id: custom-events
|
47203
48728
|
message: payment_processed feature flag has been enabled
|
47204
48729
|
tags:
|
47205
|
-
- env:
|
48730
|
+
- env:api_client_test
|
48731
|
+
timestamp: '2020-01-01T01:30:15.010000Z'
|
47206
48732
|
title: payment_processed feature flag updated
|
47207
48733
|
type: event
|
47208
48734
|
schema:
|
47209
48735
|
$ref: '#/components/schemas/EventCreateRequestPayload'
|
47210
|
-
description: Event request
|
48736
|
+
description: Event creation request payload.
|
47211
48737
|
required: true
|
47212
48738
|
responses:
|
47213
|
-
'
|
48739
|
+
'202':
|
47214
48740
|
content:
|
47215
48741
|
application/json:
|
47216
48742
|
schema:
|
@@ -47233,6 +48759,38 @@ paths:
|
|
47233
48759
|
security:
|
47234
48760
|
- apiKeyAuth: []
|
47235
48761
|
appKeyAuth: []
|
48762
|
+
servers:
|
48763
|
+
- url: https://{subdomain}.{site}
|
48764
|
+
variables:
|
48765
|
+
site:
|
48766
|
+
default: datadoghq.com
|
48767
|
+
description: The regional site for customers.
|
48768
|
+
enum:
|
48769
|
+
- datadoghq.com
|
48770
|
+
- us3.datadoghq.com
|
48771
|
+
- us5.datadoghq.com
|
48772
|
+
- ap1.datadoghq.com
|
48773
|
+
- datadoghq.eu
|
48774
|
+
- ddog-gov.com
|
48775
|
+
subdomain:
|
48776
|
+
default: event-management-intake
|
48777
|
+
description: The subdomain where the API is deployed.
|
48778
|
+
- url: '{protocol}://{name}'
|
48779
|
+
variables:
|
48780
|
+
name:
|
48781
|
+
default: event-management-intake.datadoghq.com
|
48782
|
+
description: Full site DNS name.
|
48783
|
+
protocol:
|
48784
|
+
default: https
|
48785
|
+
description: The protocol for accessing the API.
|
48786
|
+
- url: https://{subdomain}.{site}
|
48787
|
+
variables:
|
48788
|
+
site:
|
48789
|
+
default: datadoghq.com
|
48790
|
+
description: Any Datadog deployment.
|
48791
|
+
subdomain:
|
48792
|
+
default: event-management-intake
|
48793
|
+
description: The subdomain where the API is deployed.
|
47236
48794
|
summary: Post an event
|
47237
48795
|
tags:
|
47238
48796
|
- Events
|
@@ -48410,6 +49968,22 @@ paths:
|
|
48410
49968
|
x-unstable: '**Note: This endpoint is in Preview. If you have any feedback,
|
48411
49969
|
|
48412
49970
|
contact [Datadog support](https://docs.datadoghq.com/help/).**'
|
49971
|
+
/api/v2/integration/aws/iam_permissions:
|
49972
|
+
get:
|
49973
|
+
description: Get all AWS IAM permissions required for the AWS integration.
|
49974
|
+
operationId: GetAWSIntegrationIAMPermissions
|
49975
|
+
responses:
|
49976
|
+
'200':
|
49977
|
+
content:
|
49978
|
+
application/json:
|
49979
|
+
schema:
|
49980
|
+
$ref: '#/components/schemas/AWSIntegrationIamPermissionsResponse'
|
49981
|
+
description: AWS IAM Permissions object
|
49982
|
+
'429':
|
49983
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
49984
|
+
summary: Get AWS integration IAM permissions
|
49985
|
+
tags:
|
49986
|
+
- AWS Integration
|
48413
49987
|
/api/v2/integration/aws/logs/services:
|
48414
49988
|
get:
|
48415
49989
|
description: Get a list of AWS services that can send logs to Datadog.
|
@@ -51967,9 +53541,6 @@ paths:
|
|
51967
53541
|
operator: OR
|
51968
53542
|
permissions:
|
51969
53543
|
- monitors_read
|
51970
|
-
x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback,
|
51971
|
-
|
51972
|
-
contact [Datadog support](https://docs.datadoghq.com/help/).'
|
51973
53544
|
post:
|
51974
53545
|
description: Creates a monitor notification rule.
|
51975
53546
|
operationId: CreateMonitorNotificationRule
|
@@ -52013,9 +53584,6 @@ paths:
|
|
52013
53584
|
operator: OR
|
52014
53585
|
permissions:
|
52015
53586
|
- monitor_config_policy_write
|
52016
|
-
x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback,
|
52017
|
-
|
52018
|
-
contact [Datadog support](https://docs.datadoghq.com/help/).'
|
52019
53587
|
/api/v2/monitor/notification_rule/{rule_id}:
|
52020
53588
|
delete:
|
52021
53589
|
description: Deletes a monitor notification rule by `rule_id`.
|
@@ -52056,9 +53624,6 @@ paths:
|
|
52056
53624
|
operator: OR
|
52057
53625
|
permissions:
|
52058
53626
|
- monitor_config_policy_write
|
52059
|
-
x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback,
|
52060
|
-
|
52061
|
-
contact [Datadog support](https://docs.datadoghq.com/help/).'
|
52062
53627
|
get:
|
52063
53628
|
description: Returns a monitor notification rule by `rule_id`.
|
52064
53629
|
operationId: GetMonitorNotificationRule
|
@@ -52112,9 +53677,6 @@ paths:
|
|
52112
53677
|
operator: OR
|
52113
53678
|
permissions:
|
52114
53679
|
- monitors_read
|
52115
|
-
x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback,
|
52116
|
-
|
52117
|
-
contact [Datadog support](https://docs.datadoghq.com/help/).'
|
52118
53680
|
patch:
|
52119
53681
|
description: Updates a monitor notification rule by `rule_id`.
|
52120
53682
|
operationId: UpdateMonitorNotificationRule
|
@@ -52172,9 +53734,6 @@ paths:
|
|
52172
53734
|
operator: OR
|
52173
53735
|
permissions:
|
52174
53736
|
- monitor_config_policy_write
|
52175
|
-
x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback,
|
52176
|
-
|
52177
|
-
contact [Datadog support](https://docs.datadoghq.com/help/).'
|
52178
53737
|
/api/v2/monitor/policy:
|
52179
53738
|
get:
|
52180
53739
|
description: Get all monitor configuration policies.
|
@@ -52384,6 +53943,270 @@ paths:
|
|
52384
53943
|
operator: OR
|
52385
53944
|
permissions:
|
52386
53945
|
- monitor_config_policy_write
|
53946
|
+
/api/v2/monitor/template:
|
53947
|
+
get:
|
53948
|
+
description: Retrieve all monitor user templates.
|
53949
|
+
operationId: ListMonitorUserTemplates
|
53950
|
+
responses:
|
53951
|
+
'200':
|
53952
|
+
content:
|
53953
|
+
application/json:
|
53954
|
+
schema:
|
53955
|
+
$ref: '#/components/schemas/MonitorUserTemplateListResponse'
|
53956
|
+
description: OK
|
53957
|
+
'429':
|
53958
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
53959
|
+
security:
|
53960
|
+
- apiKeyAuth: []
|
53961
|
+
appKeyAuth: []
|
53962
|
+
- AuthZ:
|
53963
|
+
- monitors_read
|
53964
|
+
summary: Get all monitor user templates
|
53965
|
+
tags:
|
53966
|
+
- Monitors
|
53967
|
+
x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback,
|
53968
|
+
|
53969
|
+
contact [Datadog support](https://docs.datadoghq.com/help/).'
|
53970
|
+
post:
|
53971
|
+
description: Create a new monitor user template.
|
53972
|
+
operationId: CreateMonitorUserTemplate
|
53973
|
+
requestBody:
|
53974
|
+
content:
|
53975
|
+
application/json:
|
53976
|
+
schema:
|
53977
|
+
$ref: '#/components/schemas/MonitorUserTemplateCreateRequest'
|
53978
|
+
required: true
|
53979
|
+
responses:
|
53980
|
+
'200':
|
53981
|
+
content:
|
53982
|
+
application/json:
|
53983
|
+
schema:
|
53984
|
+
$ref: '#/components/schemas/MonitorUserTemplateCreateResponse'
|
53985
|
+
description: OK
|
53986
|
+
'400':
|
53987
|
+
content:
|
53988
|
+
application/json:
|
53989
|
+
schema:
|
53990
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
53991
|
+
description: Bad Request
|
53992
|
+
'429':
|
53993
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
53994
|
+
security:
|
53995
|
+
- apiKeyAuth: []
|
53996
|
+
appKeyAuth: []
|
53997
|
+
- AuthZ:
|
53998
|
+
- monitor_config_policy_write
|
53999
|
+
summary: Create a monitor user template
|
54000
|
+
tags:
|
54001
|
+
- Monitors
|
54002
|
+
x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback,
|
54003
|
+
|
54004
|
+
contact [Datadog support](https://docs.datadoghq.com/help/).'
|
54005
|
+
/api/v2/monitor/template/validate:
|
54006
|
+
post:
|
54007
|
+
description: Validate the structure and content of a monitor user template.
|
54008
|
+
operationId: ValidateMonitorUserTemplate
|
54009
|
+
requestBody:
|
54010
|
+
content:
|
54011
|
+
application/json:
|
54012
|
+
schema:
|
54013
|
+
$ref: '#/components/schemas/MonitorUserTemplateCreateRequest'
|
54014
|
+
required: true
|
54015
|
+
responses:
|
54016
|
+
'204':
|
54017
|
+
description: OK
|
54018
|
+
'400':
|
54019
|
+
content:
|
54020
|
+
application/json:
|
54021
|
+
schema:
|
54022
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
54023
|
+
description: Bad Request
|
54024
|
+
'429':
|
54025
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
54026
|
+
security:
|
54027
|
+
- apiKeyAuth: []
|
54028
|
+
appKeyAuth: []
|
54029
|
+
- AuthZ:
|
54030
|
+
- monitor_config_policy_write
|
54031
|
+
summary: Validate a monitor user template
|
54032
|
+
tags:
|
54033
|
+
- Monitors
|
54034
|
+
x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback,
|
54035
|
+
|
54036
|
+
contact [Datadog support](https://docs.datadoghq.com/help/).'
|
54037
|
+
/api/v2/monitor/template/{template_id}:
|
54038
|
+
delete:
|
54039
|
+
description: Delete an existing monitor user template by its ID.
|
54040
|
+
operationId: DeleteMonitorUserTemplate
|
54041
|
+
parameters:
|
54042
|
+
- description: ID of the monitor user template.
|
54043
|
+
in: path
|
54044
|
+
name: template_id
|
54045
|
+
required: true
|
54046
|
+
schema:
|
54047
|
+
type: string
|
54048
|
+
responses:
|
54049
|
+
'204':
|
54050
|
+
description: OK
|
54051
|
+
'404':
|
54052
|
+
content:
|
54053
|
+
application/json:
|
54054
|
+
schema:
|
54055
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
54056
|
+
description: Not Found
|
54057
|
+
'429':
|
54058
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
54059
|
+
security:
|
54060
|
+
- apiKeyAuth: []
|
54061
|
+
appKeyAuth: []
|
54062
|
+
- AuthZ:
|
54063
|
+
- monitor_config_policy_write
|
54064
|
+
summary: Delete a monitor user template
|
54065
|
+
tags:
|
54066
|
+
- Monitors
|
54067
|
+
x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback,
|
54068
|
+
|
54069
|
+
contact [Datadog support](https://docs.datadoghq.com/help/).'
|
54070
|
+
get:
|
54071
|
+
description: Retrieve a monitor user template by its ID.
|
54072
|
+
operationId: GetMonitorUserTemplate
|
54073
|
+
parameters:
|
54074
|
+
- description: ID of the monitor user template.
|
54075
|
+
in: path
|
54076
|
+
name: template_id
|
54077
|
+
required: true
|
54078
|
+
schema:
|
54079
|
+
example: 00000000-0000-1234-0000-000000000000
|
54080
|
+
type: string
|
54081
|
+
- description: Whether to include all versions of the template in the response
|
54082
|
+
in the versions field.
|
54083
|
+
example: false
|
54084
|
+
in: query
|
54085
|
+
name: with_all_versions
|
54086
|
+
required: false
|
54087
|
+
schema:
|
54088
|
+
type: boolean
|
54089
|
+
responses:
|
54090
|
+
'200':
|
54091
|
+
content:
|
54092
|
+
application/json:
|
54093
|
+
schema:
|
54094
|
+
$ref: '#/components/schemas/MonitorUserTemplateResponse'
|
54095
|
+
description: OK
|
54096
|
+
'404':
|
54097
|
+
content:
|
54098
|
+
application/json:
|
54099
|
+
schema:
|
54100
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
54101
|
+
description: Not Found
|
54102
|
+
'429':
|
54103
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
54104
|
+
security:
|
54105
|
+
- apiKeyAuth: []
|
54106
|
+
appKeyAuth: []
|
54107
|
+
- AuthZ:
|
54108
|
+
- monitors_read
|
54109
|
+
summary: Get a monitor user template
|
54110
|
+
tags:
|
54111
|
+
- Monitors
|
54112
|
+
x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback,
|
54113
|
+
|
54114
|
+
contact [Datadog support](https://docs.datadoghq.com/help/).'
|
54115
|
+
put:
|
54116
|
+
description: Creates a new version of an existing monitor user template.
|
54117
|
+
operationId: UpdateMonitorUserTemplate
|
54118
|
+
parameters:
|
54119
|
+
- description: ID of the monitor user template.
|
54120
|
+
in: path
|
54121
|
+
name: template_id
|
54122
|
+
required: true
|
54123
|
+
schema:
|
54124
|
+
type: string
|
54125
|
+
requestBody:
|
54126
|
+
content:
|
54127
|
+
application/json:
|
54128
|
+
schema:
|
54129
|
+
$ref: '#/components/schemas/MonitorUserTemplateUpdateRequest'
|
54130
|
+
required: true
|
54131
|
+
responses:
|
54132
|
+
'200':
|
54133
|
+
content:
|
54134
|
+
application/json:
|
54135
|
+
schema:
|
54136
|
+
$ref: '#/components/schemas/MonitorUserTemplateResponse'
|
54137
|
+
description: OK
|
54138
|
+
'400':
|
54139
|
+
content:
|
54140
|
+
application/json:
|
54141
|
+
schema:
|
54142
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
54143
|
+
description: Bad Request
|
54144
|
+
'404':
|
54145
|
+
content:
|
54146
|
+
application/json:
|
54147
|
+
schema:
|
54148
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
54149
|
+
description: Not Found
|
54150
|
+
'429':
|
54151
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
54152
|
+
security:
|
54153
|
+
- apiKeyAuth: []
|
54154
|
+
appKeyAuth: []
|
54155
|
+
- AuthZ:
|
54156
|
+
- monitor_config_policy_write
|
54157
|
+
summary: Update a monitor user template to a new version
|
54158
|
+
tags:
|
54159
|
+
- Monitors
|
54160
|
+
x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback,
|
54161
|
+
|
54162
|
+
contact [Datadog support](https://docs.datadoghq.com/help/).'
|
54163
|
+
/api/v2/monitor/template/{template_id}/validate:
|
54164
|
+
post:
|
54165
|
+
description: Validate the structure and content of an existing monitor user
|
54166
|
+
template being updated to a new version.
|
54167
|
+
operationId: ValidateExistingMonitorUserTemplate
|
54168
|
+
parameters:
|
54169
|
+
- description: ID of the monitor user template.
|
54170
|
+
in: path
|
54171
|
+
name: template_id
|
54172
|
+
required: true
|
54173
|
+
schema:
|
54174
|
+
example: 00000000-0000-1234-0000-000000000000
|
54175
|
+
type: string
|
54176
|
+
requestBody:
|
54177
|
+
content:
|
54178
|
+
application/json:
|
54179
|
+
schema:
|
54180
|
+
$ref: '#/components/schemas/MonitorUserTemplateUpdateRequest'
|
54181
|
+
required: true
|
54182
|
+
responses:
|
54183
|
+
'204':
|
54184
|
+
description: OK
|
54185
|
+
'400':
|
54186
|
+
content:
|
54187
|
+
application/json:
|
54188
|
+
schema:
|
54189
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
54190
|
+
description: Bad Request
|
54191
|
+
'404':
|
54192
|
+
content:
|
54193
|
+
application/json:
|
54194
|
+
schema:
|
54195
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
54196
|
+
description: Not Found
|
54197
|
+
'429':
|
54198
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
54199
|
+
security:
|
54200
|
+
- apiKeyAuth: []
|
54201
|
+
appKeyAuth: []
|
54202
|
+
- AuthZ:
|
54203
|
+
- monitor_config_policy_write
|
54204
|
+
summary: Validate an existing monitor user template
|
54205
|
+
tags:
|
54206
|
+
- Monitors
|
54207
|
+
x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback,
|
54208
|
+
|
54209
|
+
contact [Datadog support](https://docs.datadoghq.com/help/).'
|
52387
54210
|
/api/v2/monitor/{monitor_id}/downtime_matches:
|
52388
54211
|
get:
|
52389
54212
|
description: Get all active downtimes for the specified monitor.
|
@@ -54798,7 +56621,8 @@ paths:
|
|
54798
56621
|
operator: OR
|
54799
56622
|
permissions:
|
54800
56623
|
- observability_pipelines_read
|
54801
|
-
x-unstable: '**Note**: This endpoint is in Preview.
|
56624
|
+
x-unstable: '**Note**: This endpoint is in Preview. Fill out this [form](https://www.datadoghq.com/product-preview/observability-pipelines-api-and-terraform-support/)
|
56625
|
+
to request access.'
|
54802
56626
|
post:
|
54803
56627
|
description: Create a new pipeline.
|
54804
56628
|
operationId: CreatePipeline
|
@@ -54830,7 +56654,8 @@ paths:
|
|
54830
56654
|
operator: OR
|
54831
56655
|
permissions:
|
54832
56656
|
- observability_pipelines_deploy
|
54833
|
-
x-unstable: '**Note**: This endpoint is in Preview.
|
56657
|
+
x-unstable: '**Note**: This endpoint is in Preview. Fill out this [form](https://www.datadoghq.com/product-preview/observability-pipelines-api-and-terraform-support/)
|
56658
|
+
to request access.'
|
54834
56659
|
/api/v2/remote_config/products/obs_pipelines/pipelines/validate:
|
54835
56660
|
post:
|
54836
56661
|
description: 'Validates a pipeline configuration without creating or updating
|
@@ -54866,7 +56691,8 @@ paths:
|
|
54866
56691
|
operator: OR
|
54867
56692
|
permissions:
|
54868
56693
|
- observability_pipelines_read
|
54869
|
-
x-unstable: '**Note**: This endpoint is in Preview.
|
56694
|
+
x-unstable: '**Note**: This endpoint is in Preview. Fill out this [form](https://www.datadoghq.com/product-preview/observability-pipelines-api-and-terraform-support/)
|
56695
|
+
to request access.'
|
54870
56696
|
/api/v2/remote_config/products/obs_pipelines/pipelines/{pipeline_id}:
|
54871
56697
|
delete:
|
54872
56698
|
description: Delete a pipeline.
|
@@ -54908,7 +56734,8 @@ paths:
|
|
54908
56734
|
operator: OR
|
54909
56735
|
permissions:
|
54910
56736
|
- observability_pipelines_delete
|
54911
|
-
x-unstable: '**Note**: This endpoint is in Preview.
|
56737
|
+
x-unstable: '**Note**: This endpoint is in Preview. Fill out this [form](https://www.datadoghq.com/product-preview/observability-pipelines-api-and-terraform-support/)
|
56738
|
+
to request access.'
|
54912
56739
|
get:
|
54913
56740
|
description: Get a specific pipeline by its ID.
|
54914
56741
|
operationId: GetPipeline
|
@@ -54941,7 +56768,8 @@ paths:
|
|
54941
56768
|
operator: OR
|
54942
56769
|
permissions:
|
54943
56770
|
- observability_pipelines_read
|
54944
|
-
x-unstable: '**Note**: This endpoint is in Preview.
|
56771
|
+
x-unstable: '**Note**: This endpoint is in Preview. Fill out this [form](https://www.datadoghq.com/product-preview/observability-pipelines-api-and-terraform-support/)
|
56772
|
+
to request access.'
|
54945
56773
|
put:
|
54946
56774
|
description: Update a pipeline.
|
54947
56775
|
operationId: UpdatePipeline
|
@@ -54982,7 +56810,8 @@ paths:
|
|
54982
56810
|
operator: OR
|
54983
56811
|
permissions:
|
54984
56812
|
- observability_pipelines_deploy
|
54985
|
-
x-unstable: '**Note**: This endpoint is in Preview.
|
56813
|
+
x-unstable: '**Note**: This endpoint is in Preview. Fill out this [form](https://www.datadoghq.com/product-preview/observability-pipelines-api-and-terraform-support/)
|
56814
|
+
to request access.'
|
54986
56815
|
/api/v2/restriction_policy/{resource_id}:
|
54987
56816
|
delete:
|
54988
56817
|
description: Deletes the restriction policy associated with a specified resource.
|
@@ -55080,6 +56909,10 @@ paths:
|
|
55080
56909
|
|
55081
56910
|
- RUM Applications: `rum-application`
|
55082
56911
|
|
56912
|
+
- Cross Org Connections: `cross-org-connection`
|
56913
|
+
|
56914
|
+
- Spreadsheets: `spreadsheet`
|
56915
|
+
|
55083
56916
|
|
55084
56917
|
#### Supported relations for resources
|
55085
56918
|
|
@@ -55121,7 +56954,11 @@ paths:
|
|
55121
56954
|
|
55122
56955
|
Connection Groups | `viewer`, `editor`
|
55123
56956
|
|
55124
|
-
RUM Application | `viewer`, `editor`
|
56957
|
+
RUM Application | `viewer`, `editor`
|
56958
|
+
|
56959
|
+
Cross Org Connections | `viewer`, `editor`
|
56960
|
+
|
56961
|
+
Spreadsheets | `viewer`, `editor`'
|
55125
56962
|
operationId: UpdateRestrictionPolicy
|
55126
56963
|
parameters:
|
55127
56964
|
- $ref: '#/components/parameters/ResourceID'
|
@@ -56826,6 +58663,13 @@ paths:
|
|
56826
58663
|
required: false
|
56827
58664
|
schema:
|
56828
58665
|
type: string
|
58666
|
+
- description: Filter by teams.
|
58667
|
+
example: compute
|
58668
|
+
in: query
|
58669
|
+
name: filter[teams]
|
58670
|
+
required: false
|
58671
|
+
schema:
|
58672
|
+
type: string
|
56829
58673
|
- description: Filter by architecture.
|
56830
58674
|
example: arm64
|
56831
58675
|
in: query
|
@@ -56919,6 +58763,133 @@ paths:
|
|
56919
58763
|
operator: OR
|
56920
58764
|
permissions:
|
56921
58765
|
- security_monitoring_cws_agent_rules_read
|
58766
|
+
/api/v2/security/sboms:
|
58767
|
+
get:
|
58768
|
+
description: 'Get a list of assets SBOMs for an organization.
|
58769
|
+
|
58770
|
+
|
58771
|
+
### Pagination
|
58772
|
+
|
58773
|
+
|
58774
|
+
Please review the [Pagination section](#pagination) for the "List Vulnerabilities"
|
58775
|
+
endpoint.
|
58776
|
+
|
58777
|
+
|
58778
|
+
### Filtering
|
58779
|
+
|
58780
|
+
|
58781
|
+
Please review the [Filtering section](#filtering) for the "List Vulnerabilities"
|
58782
|
+
endpoint.
|
58783
|
+
|
58784
|
+
|
58785
|
+
### Metadata
|
58786
|
+
|
58787
|
+
|
58788
|
+
Please review the [Metadata section](#metadata) for the "List Vulnerabilities"
|
58789
|
+
endpoint.'
|
58790
|
+
operationId: ListAssetsSBOMs
|
58791
|
+
parameters:
|
58792
|
+
- description: Its value must come from the `links` section of the response
|
58793
|
+
of the first request. Do not manually edit it.
|
58794
|
+
example: b82cef018aab81ed1d4bb4xb35xxfc065da7efa685fbcecdbd338f3015e3afabbbfa3a911b4984_721ee28a-zecb-4e45-9960-c42065b574f4
|
58795
|
+
in: query
|
58796
|
+
name: page[token]
|
58797
|
+
required: false
|
58798
|
+
schema:
|
58799
|
+
type: string
|
58800
|
+
- description: The page number to be retrieved. It should be equal to or greater
|
58801
|
+
than 1.
|
58802
|
+
example: 1
|
58803
|
+
in: query
|
58804
|
+
name: page[number]
|
58805
|
+
required: false
|
58806
|
+
schema:
|
58807
|
+
format: int64
|
58808
|
+
minimum: 1
|
58809
|
+
type: integer
|
58810
|
+
- description: The type of the assets for the SBOM request.
|
58811
|
+
example: Repository
|
58812
|
+
in: query
|
58813
|
+
name: filter[asset_type]
|
58814
|
+
required: false
|
58815
|
+
schema:
|
58816
|
+
$ref: '#/components/schemas/AssetType'
|
58817
|
+
- description: The name of the asset for the SBOM request.
|
58818
|
+
example: github.com/datadog/datadog-agent
|
58819
|
+
in: query
|
58820
|
+
name: filter[asset_name]
|
58821
|
+
required: false
|
58822
|
+
schema:
|
58823
|
+
type: string
|
58824
|
+
- description: The name of the component that is a dependency of an asset.
|
58825
|
+
example: opentelemetry-api
|
58826
|
+
in: query
|
58827
|
+
name: filter[package_name]
|
58828
|
+
required: false
|
58829
|
+
schema:
|
58830
|
+
type: string
|
58831
|
+
- description: The version of the component that is a dependency of an asset.
|
58832
|
+
example: 1.33.1
|
58833
|
+
in: query
|
58834
|
+
name: filter[package_version]
|
58835
|
+
required: false
|
58836
|
+
schema:
|
58837
|
+
type: string
|
58838
|
+
- description: The software license name of the component that is a dependency
|
58839
|
+
of an asset.
|
58840
|
+
example: Apache-2.0
|
58841
|
+
in: query
|
58842
|
+
name: filter[license_name]
|
58843
|
+
required: false
|
58844
|
+
schema:
|
58845
|
+
type: string
|
58846
|
+
- description: The software license type of the component that is a dependency
|
58847
|
+
of an asset.
|
58848
|
+
example: network_strong_copyleft
|
58849
|
+
in: query
|
58850
|
+
name: filter[license_type]
|
58851
|
+
required: false
|
58852
|
+
schema:
|
58853
|
+
$ref: '#/components/schemas/SBOMComponentLicenseType'
|
58854
|
+
responses:
|
58855
|
+
'200':
|
58856
|
+
content:
|
58857
|
+
application/json:
|
58858
|
+
schema:
|
58859
|
+
$ref: '#/components/schemas/ListAssetsSBOMsResponse'
|
58860
|
+
description: OK
|
58861
|
+
'400':
|
58862
|
+
content:
|
58863
|
+
application/json:
|
58864
|
+
schema:
|
58865
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
58866
|
+
description: 'Bad request: The server cannot process the request due to
|
58867
|
+
invalid syntax in the request.'
|
58868
|
+
'403':
|
58869
|
+
content:
|
58870
|
+
application/json:
|
58871
|
+
schema:
|
58872
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
58873
|
+
description: 'Forbidden: Access denied'
|
58874
|
+
'404':
|
58875
|
+
content:
|
58876
|
+
application/json:
|
58877
|
+
schema:
|
58878
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
58879
|
+
description: 'Not found: asset not found'
|
58880
|
+
'429':
|
58881
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
58882
|
+
security:
|
58883
|
+
- apiKeyAuth: []
|
58884
|
+
appKeyAuth: []
|
58885
|
+
- AuthZ:
|
58886
|
+
- appsec_vm_read
|
58887
|
+
summary: List assets SBOMs
|
58888
|
+
tags:
|
58889
|
+
- Security Monitoring
|
58890
|
+
x-unstable: '**Note**: This endpoint is a private preview.
|
58891
|
+
|
58892
|
+
If you are interested in accessing this API, [fill out this form](https://forms.gle/kMYC1sDr6WDUBDsx9).'
|
56922
58893
|
/api/v2/security/sboms/{asset_type}:
|
56923
58894
|
get:
|
56924
58895
|
description: 'Get a single SBOM related to an asset by its type and name.
|
@@ -57410,6 +59381,13 @@ paths:
|
|
57410
59381
|
required: false
|
57411
59382
|
schema:
|
57412
59383
|
type: string
|
59384
|
+
- description: Filter by origin.
|
59385
|
+
example: agentless-scanner
|
59386
|
+
in: query
|
59387
|
+
name: filter[origin]
|
59388
|
+
required: false
|
59389
|
+
schema:
|
59390
|
+
type: string
|
57413
59391
|
- description: Filter by asset name.
|
57414
59392
|
example: datadog-agent
|
57415
59393
|
in: query
|
@@ -57489,6 +59467,13 @@ paths:
|
|
57489
59467
|
required: false
|
57490
59468
|
schema:
|
57491
59469
|
type: string
|
59470
|
+
- description: Filter by asset teams.
|
59471
|
+
example: compute
|
59472
|
+
in: query
|
59473
|
+
name: filter[asset.teams]
|
59474
|
+
required: false
|
59475
|
+
schema:
|
59476
|
+
type: string
|
57492
59477
|
- description: Filter by asset architecture.
|
57493
59478
|
example: arm64
|
57494
59479
|
in: query
|
@@ -62091,15 +64076,16 @@ paths:
|
|
62091
64076
|
`fargate`, `infra_hosts`, `incident_management`, `indexed_logs`, `indexed_spans`,
|
62092
64077
|
`ingested_spans`, `iot`,
|
62093
64078
|
|
62094
|
-
`lambda_traced_invocations`, `
|
62095
|
-
`
|
64079
|
+
`lambda_traced_invocations`, `llm_observability`, `logs`, `network_flows`,
|
64080
|
+
`network_hosts`, `network_monitoring`,
|
62096
64081
|
|
62097
|
-
`
|
62098
|
-
`
|
64082
|
+
`observability_pipelines`, `online_archive`, `profiling`, `product_analytics`,
|
64083
|
+
`rum`, `rum_browser_sessions`,
|
62099
64084
|
|
62100
|
-
`
|
62101
|
-
`
|
64085
|
+
`rum_mobile_sessions`, `sds`, `snmp`, `software_delivery`, `synthetics_api`,
|
64086
|
+
`synthetics_browser`,
|
62102
64087
|
|
64088
|
+
`synthetics_mobile`, `synthetics_parallel_testing`, `timeseries`, `vuln_management`
|
62103
64089
|
and `workflow_executions`.
|
62104
64090
|
|
62105
64091
|
The following product family has been **deprecated**: `audit_logs`.'
|
@@ -62873,7 +64859,7 @@ paths:
|
|
62873
64859
|
/api/v2/workflows:
|
62874
64860
|
post:
|
62875
64861
|
description: Create a new workflow, returning the workflow ID. This API requires
|
62876
|
-
|
64862
|
+
a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
62877
64863
|
operationId: CreateWorkflow
|
62878
64864
|
requestBody:
|
62879
64865
|
content:
|
@@ -62915,8 +64901,8 @@ paths:
|
|
62915
64901
|
- workflows_write
|
62916
64902
|
/api/v2/workflows/{workflow_id}:
|
62917
64903
|
delete:
|
62918
|
-
description: Delete a workflow by ID. This API requires
|
62919
|
-
|
64904
|
+
description: Delete a workflow by ID. This API requires a [registered application
|
64905
|
+
key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
62920
64906
|
operationId: DeleteWorkflow
|
62921
64907
|
parameters:
|
62922
64908
|
- $ref: '#/components/parameters/WorkflowId'
|
@@ -62949,8 +64935,8 @@ paths:
|
|
62949
64935
|
permissions:
|
62950
64936
|
- workflows_write
|
62951
64937
|
get:
|
62952
|
-
description: Get a workflow by ID.
|
62953
|
-
|
64938
|
+
description: Get a workflow by ID. This API requires a [registered application
|
64939
|
+
key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
62954
64940
|
operationId: GetWorkflow
|
62955
64941
|
parameters:
|
62956
64942
|
- $ref: '#/components/parameters/WorkflowId'
|
@@ -62993,8 +64979,8 @@ paths:
|
|
62993
64979
|
permissions:
|
62994
64980
|
- workflows_read
|
62995
64981
|
patch:
|
62996
|
-
description: Update a workflow by ID. This API requires
|
62997
|
-
|
64982
|
+
description: Update a workflow by ID. This API requires a [registered application
|
64983
|
+
key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
62998
64984
|
operationId: UpdateWorkflow
|
62999
64985
|
parameters:
|
63000
64986
|
- $ref: '#/components/parameters/WorkflowId'
|
@@ -63044,8 +65030,8 @@ paths:
|
|
63044
65030
|
- workflows_write
|
63045
65031
|
/api/v2/workflows/{workflow_id}/instances:
|
63046
65032
|
get:
|
63047
|
-
description: List all instances of a given workflow. This API requires
|
63048
|
-
key
|
65033
|
+
description: List all instances of a given workflow. This API requires a [registered
|
65034
|
+
application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
63049
65035
|
operationId: ListWorkflowInstances
|
63050
65036
|
parameters:
|
63051
65037
|
- $ref: '#/components/parameters/WorkflowId'
|
@@ -63077,8 +65063,8 @@ paths:
|
|
63077
65063
|
permissions:
|
63078
65064
|
- workflows_read
|
63079
65065
|
post:
|
63080
|
-
description: Execute the given workflow. This API requires
|
63081
|
-
|
65066
|
+
description: Execute the given workflow. This API requires a [registered application
|
65067
|
+
key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
63082
65068
|
operationId: CreateWorkflowInstance
|
63083
65069
|
parameters:
|
63084
65070
|
- $ref: '#/components/parameters/WorkflowId'
|
@@ -63117,7 +65103,7 @@ paths:
|
|
63117
65103
|
/api/v2/workflows/{workflow_id}/instances/{instance_id}:
|
63118
65104
|
get:
|
63119
65105
|
description: Get a specific execution of a given workflow. This API requires
|
63120
|
-
|
65106
|
+
a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
63121
65107
|
operationId: GetWorkflowInstance
|
63122
65108
|
parameters:
|
63123
65109
|
- $ref: '#/components/parameters/WorkflowId'
|
@@ -63152,7 +65138,7 @@ paths:
|
|
63152
65138
|
/api/v2/workflows/{workflow_id}/instances/{instance_id}/cancel:
|
63153
65139
|
put:
|
63154
65140
|
description: Cancels a specific execution of a given workflow. This API requires
|
63155
|
-
|
65141
|
+
a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
63156
65142
|
operationId: CancelWorkflowInstance
|
63157
65143
|
parameters:
|
63158
65144
|
- $ref: '#/components/parameters/WorkflowId'
|
@@ -63324,8 +65310,8 @@ tags:
|
|
63324
65310
|
for more information.
|
63325
65311
|
name: Case Management
|
63326
65312
|
- description: The Cloud Cost Management API allows you to set up, edit, and delete
|
63327
|
-
Cloud Cost Management accounts for AWS and
|
63328
|
-
by using the [Metrics endpoint](https://docs.datadoghq.com/api/latest/metrics/#query-timeseries-data-across-multiple-products)
|
65313
|
+
Cloud Cost Management accounts for AWS, Azure, and GCP. You can query your cost
|
65314
|
+
data by using the [Metrics endpoint](https://docs.datadoghq.com/api/latest/metrics/#query-timeseries-data-across-multiple-products)
|
63329
65315
|
and the `cloud_cost` data source. For more information, see the [Cloud Cost Management
|
63330
65316
|
documentation](https://docs.datadoghq.com/cloud_cost_management/).
|
63331
65317
|
name: Cloud Cost Management
|
@@ -63366,6 +65352,14 @@ tags:
|
|
63366
65352
|
the allowed products. It's currently enabled for Logs and RUM and depends on `logs_delete_data`
|
63367
65353
|
and `rum_delete_data` permissions respectively.
|
63368
65354
|
name: Data Deletion
|
65355
|
+
- description: 'Data Access Controls in Datadog is a feature that allows administrators
|
65356
|
+
and access managers to regulate
|
65357
|
+
|
65358
|
+
access to sensitive data. By defining Restricted Datasets, you can ensure that
|
65359
|
+
only specific teams or roles can
|
65360
|
+
|
65361
|
+
view certain types of telemetry (for example, logs, traces, metrics, and RUM data).'
|
65362
|
+
name: Datasets
|
63369
65363
|
- description: 'Configure your Datadog Email Domain Allowlist directly through the
|
63370
65364
|
Datadog API.
|
63371
65365
|
|