datadog_api_client 2.34.0 → 2.36.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/.apigentools-info +4 -4
- data/.generator/schemas/v1/openapi.yaml +59 -6
- data/.generator/schemas/v2/openapi.yaml +1093 -69
- data/.generator/src/generator/formatter.py +2 -2
- data/.generator/src/generator/openapi.py +1 -1
- data/.github/workflows/release.yml +1 -1
- data/CHANGELOG.md +36 -0
- data/Gemfile +1 -0
- data/examples/v1/monitors/CreateMonitor_1539578087.rb +1 -0
- data/examples/v1/monitors/CreateMonitor_440013737.rb +1 -0
- data/examples/v1/synthetics/CreateSyntheticsAPITest_1279271422.rb +142 -0
- data/examples/v2/csm-threats/CreateCSMThreatsAgentRule_1295653933.rb +35 -0
- data/examples/v2/dora-metrics/CreateDORADeployment.rb +0 -3
- data/examples/v2/dora-metrics/CreateDORAFailure.rb +30 -0
- data/examples/v2/dora-metrics/CreateDORAIncident.rb +11 -9
- data/examples/v2/dora-metrics/CreateDORAIncident_1768887482.rb +25 -0
- data/examples/v2/logs-custom-destinations/CreateLogsCustomDestination_1735989579.rb +30 -0
- data/examples/v2/microsoft-teams-integration/CreateWorkflowsWebhookHandle_1716851881.rb +1 -1
- data/examples/v2/on-call/GetTeamOnCallUsers.rb +11 -0
- data/examples/v2/security-monitoring/ListFindings_2932019633.rb +11 -0
- data/examples/v2/software-catalog/DeleteCatalogKind.rb +5 -0
- data/examples/v2/software-catalog/ListCatalogKind.rb +5 -0
- data/examples/v2/software-catalog/ListCatalogKind_3806205775.rb +5 -0
- data/examples/v2/software-catalog/UpsertCatalogKind.rb +9 -0
- data/examples/v2/teams/AddMemberTeam.rb +15 -0
- data/examples/v2/teams/ListMemberTeams.rb +8 -0
- data/examples/v2/teams/ListMemberTeams_1662850354.rb +8 -0
- data/examples/v2/teams/RemoveMemberTeam.rb +8 -0
- data/lib/datadog_api_client/configuration.rb +3 -2
- data/lib/datadog_api_client/inflector.rb +42 -6
- data/lib/datadog_api_client/v1/api/snapshots_api.rb +2 -1
- data/lib/datadog_api_client/v1/models/monitor.rb +17 -1
- data/lib/datadog_api_client/v1/models/monitor_draft_status.rb +32 -0
- data/lib/datadog_api_client/v1/models/monitor_options.rb +1 -1
- data/lib/datadog_api_client/v1/models/monitor_update_request.rb +17 -1
- data/lib/datadog_api_client/v1/models/synthetics_api_test_step_subtype.rb +6 -0
- data/lib/datadog_api_client/v1/models/synthetics_basic_auth_web.rb +2 -31
- data/lib/datadog_api_client/v1/models/synthetics_test_request.rb +32 -2
- data/lib/datadog_api_client/v2/api/dora_metrics_api.rb +79 -15
- data/lib/datadog_api_client/v2/api/on_call_api.rb +67 -0
- data/lib/datadog_api_client/v2/api/restriction_policies_api.rb +5 -3
- data/lib/datadog_api_client/v2/api/security_monitoring_api.rb +13 -0
- data/lib/datadog_api_client/v2/api/software_catalog_api.rb +221 -0
- data/lib/datadog_api_client/v2/api/teams_api.rb +254 -0
- data/lib/datadog_api_client/v2/models/action_query_spec_inputs.rb +1 -1
- data/lib/datadog_api_client/v2/models/{dora_incident_response.rb → add_member_team_request.rb} +5 -5
- data/lib/datadog_api_client/v2/models/change_event_custom_attributes_author_type.rb +2 -0
- data/lib/datadog_api_client/v2/models/cloud_configuration_rule_payload.rb +21 -1
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_action.rb +33 -3
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_action_metadata.rb +125 -0
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_action_set.rb +165 -0
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_attributes.rb +37 -1
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_create_attributes.rb +57 -1
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_update_attributes.rb +57 -1
- data/lib/datadog_api_client/v2/models/custom_destination_forward_destination.rb +2 -1
- data/lib/datadog_api_client/v2/models/custom_destination_forward_destination_microsoft_sentinel.rb +228 -0
- data/lib/datadog_api_client/v2/models/custom_destination_forward_destination_microsoft_sentinel_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/custom_destination_response_forward_destination.rb +2 -1
- data/lib/datadog_api_client/v2/models/custom_destination_response_forward_destination_microsoft_sentinel.rb +228 -0
- data/lib/datadog_api_client/v2/models/custom_destination_response_forward_destination_microsoft_sentinel_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/dora_deployment_request_attributes.rb +21 -1
- data/lib/datadog_api_client/v2/models/{dora_incident_request.rb → dora_failure_request.rb} +4 -4
- data/lib/datadog_api_client/v2/models/{dora_incident_request_attributes.rb → dora_failure_request_attributes.rb} +31 -11
- data/lib/datadog_api_client/v2/models/{dora_incident_request_data.rb → dora_failure_request_data.rb} +4 -4
- data/lib/datadog_api_client/v2/models/dora_failure_response.rb +123 -0
- data/lib/datadog_api_client/v2/models/{dora_incident_response_data.rb → dora_failure_response_data.rb} +6 -6
- data/lib/datadog_api_client/v2/models/{dora_incident_type.rb → dora_failure_type.rb} +3 -3
- data/lib/datadog_api_client/v2/models/escalation.rb +143 -0
- data/lib/datadog_api_client/v2/models/escalation_relationships.rb +105 -0
- data/lib/datadog_api_client/v2/models/escalation_relationships_responders.rb +107 -0
- data/lib/datadog_api_client/v2/models/escalation_relationships_responders_data_items.rb +144 -0
- data/lib/datadog_api_client/v2/models/escalation_relationships_responders_data_items_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/escalation_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/finding_attributes.rb +31 -1
- data/lib/datadog_api_client/v2/models/kind_attributes.rb +143 -0
- data/lib/datadog_api_client/v2/models/kind_data.rb +153 -0
- data/lib/datadog_api_client/v2/models/kind_metadata.rb +115 -0
- data/lib/datadog_api_client/v2/models/kind_obj.rb +143 -0
- data/lib/datadog_api_client/v2/models/kind_response_meta.rb +105 -0
- data/lib/datadog_api_client/v2/models/list_kind_catalog_response.rb +117 -0
- data/lib/datadog_api_client/v2/models/member_team.rb +144 -0
- data/lib/datadog_api_client/v2/models/member_team_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_case.rb +11 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_type_create.rb +1 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_type_read.rb +1 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb +21 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_rule_payload.rb +21 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_rule_response.rb +21 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_payload.rb +21 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_query.rb +11 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_response.rb +21 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_third_party_rule_case.rb +11 -1
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_group_attributes.rb +15 -3
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_samplings.rb +137 -0
- data/lib/datadog_api_client/v2/models/team_on_call_responders.rb +117 -0
- data/lib/datadog_api_client/v2/models/team_on_call_responders_data.rb +143 -0
- data/lib/datadog_api_client/v2/models/team_on_call_responders_data_relationships.rb +115 -0
- data/lib/datadog_api_client/v2/models/team_on_call_responders_data_relationships_escalations.rb +107 -0
- data/lib/datadog_api_client/v2/models/team_on_call_responders_data_relationships_escalations_data_items.rb +144 -0
- data/lib/datadog_api_client/v2/models/team_on_call_responders_data_relationships_escalations_data_items_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/team_on_call_responders_data_relationships_responders.rb +107 -0
- data/lib/datadog_api_client/v2/models/team_on_call_responders_data_relationships_responders_data_items.rb +144 -0
- data/lib/datadog_api_client/v2/models/team_on_call_responders_data_relationships_responders_data_items_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/team_on_call_responders_data_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/team_on_call_responders_included.rb +63 -0
- data/lib/datadog_api_client/v2/models/upsert_catalog_kind_request.rb +63 -0
- data/lib/datadog_api_client/v2/models/upsert_catalog_kind_response.rb +117 -0
- data/lib/datadog_api_client/version.rb +1 -1
- data/repository.datadog.yaml +8 -0
- metadata +57 -7
@@ -563,6 +563,14 @@ components:
|
|
563
563
|
required: true
|
564
564
|
schema:
|
565
565
|
type: string
|
566
|
+
KindID:
|
567
|
+
description: Entity kind.
|
568
|
+
in: path
|
569
|
+
name: kind_id
|
570
|
+
required: true
|
571
|
+
schema:
|
572
|
+
example: my-job
|
573
|
+
type: string
|
566
574
|
MetricID:
|
567
575
|
description: The name of the log-based metric.
|
568
576
|
in: path
|
@@ -743,7 +751,7 @@ components:
|
|
743
751
|
description: 'Identifier, formatted as `type:id`. Supported types: `connection`,
|
744
752
|
`dashboard`, `integration-account`, `integration-service`, `integration-webhook`,
|
745
753
|
`notebook`, `reference-table`, `security-rule`, `slo`, `workflow`, `app-builder-app`,
|
746
|
-
`connection`, `connection-group`.'
|
754
|
+
`connection`, `connection-group`, `rum-application`.'
|
747
755
|
example: dashboard:abc-def-ghi
|
748
756
|
in: path
|
749
757
|
name: resource_id
|
@@ -2192,6 +2200,14 @@ components:
|
|
2192
2200
|
type: string
|
2193
2201
|
x-enum-varnames:
|
2194
2202
|
- BILLING_DIMENSIONS
|
2203
|
+
AddMemberTeamRequest:
|
2204
|
+
description: Request to add a member team to super team's hierarchy
|
2205
|
+
properties:
|
2206
|
+
data:
|
2207
|
+
$ref: '#/components/schemas/MemberTeam'
|
2208
|
+
required:
|
2209
|
+
- data
|
2210
|
+
type: object
|
2195
2211
|
Advisory:
|
2196
2212
|
description: Advisory.
|
2197
2213
|
properties:
|
@@ -6974,11 +6990,15 @@ components:
|
|
6974
6990
|
enum:
|
6975
6991
|
- user
|
6976
6992
|
- system
|
6993
|
+
- api
|
6994
|
+
- automation
|
6977
6995
|
example: user
|
6978
6996
|
type: string
|
6979
6997
|
x-enum-varnames:
|
6980
6998
|
- USER
|
6981
6999
|
- SYSTEM
|
7000
|
+
- API
|
7001
|
+
- AUTOMATION
|
6982
7002
|
ChangeEventCustomAttributesChangedResource:
|
6983
7003
|
description: Object representing a uniquely identified resource.
|
6984
7004
|
properties:
|
@@ -7230,6 +7250,14 @@ components:
|
|
7230
7250
|
type: array
|
7231
7251
|
complianceSignalOptions:
|
7232
7252
|
$ref: '#/components/schemas/CloudConfigurationRuleComplianceSignalOptions'
|
7253
|
+
customMessage:
|
7254
|
+
description: Custom/Overridden message for generated signals (used in case
|
7255
|
+
of Default rule update).
|
7256
|
+
type: string
|
7257
|
+
customName:
|
7258
|
+
description: Custom/Overridden name of the rule (used in case of Default
|
7259
|
+
rule update).
|
7260
|
+
type: string
|
7233
7261
|
filters:
|
7234
7262
|
description: Additional queries to filter matched events before they are
|
7235
7263
|
processed.
|
@@ -7524,8 +7552,58 @@ components:
|
|
7524
7552
|
description: SECL expression used to target the container to apply the action
|
7525
7553
|
on
|
7526
7554
|
type: string
|
7555
|
+
hash:
|
7556
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActionHash'
|
7527
7557
|
kill:
|
7528
7558
|
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleKill'
|
7559
|
+
metadata:
|
7560
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActionMetadata'
|
7561
|
+
set:
|
7562
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActionSet'
|
7563
|
+
type: object
|
7564
|
+
CloudWorkloadSecurityAgentRuleActionHash:
|
7565
|
+
additionalProperties: {}
|
7566
|
+
description: An empty object indicating the hash action
|
7567
|
+
type: object
|
7568
|
+
CloudWorkloadSecurityAgentRuleActionMetadata:
|
7569
|
+
description: The metadata action applied on the scope matching the rule
|
7570
|
+
properties:
|
7571
|
+
image_tag:
|
7572
|
+
description: The image tag of the metadata action
|
7573
|
+
type: string
|
7574
|
+
service:
|
7575
|
+
description: The service of the metadata action
|
7576
|
+
type: string
|
7577
|
+
short_image:
|
7578
|
+
description: The short image of the metadata action
|
7579
|
+
type: string
|
7580
|
+
type: object
|
7581
|
+
CloudWorkloadSecurityAgentRuleActionSet:
|
7582
|
+
description: The set action applied on the scope matching the rule
|
7583
|
+
properties:
|
7584
|
+
append:
|
7585
|
+
description: Whether the value should be appended to the field
|
7586
|
+
type: boolean
|
7587
|
+
field:
|
7588
|
+
description: The field of the set action
|
7589
|
+
type: string
|
7590
|
+
name:
|
7591
|
+
description: The name of the set action
|
7592
|
+
type: string
|
7593
|
+
scope:
|
7594
|
+
description: The scope of the set action
|
7595
|
+
type: string
|
7596
|
+
size:
|
7597
|
+
description: The size of the set action
|
7598
|
+
format: int64
|
7599
|
+
type: integer
|
7600
|
+
ttl:
|
7601
|
+
description: The time to live of the set action
|
7602
|
+
format: int64
|
7603
|
+
type: integer
|
7604
|
+
value:
|
7605
|
+
description: The value of the set action
|
7606
|
+
type: string
|
7529
7607
|
type: object
|
7530
7608
|
CloudWorkloadSecurityAgentRuleActions:
|
7531
7609
|
description: The array of actions the rule can perform if triggered
|
@@ -7541,6 +7619,11 @@ components:
|
|
7541
7619
|
agentConstraint:
|
7542
7620
|
description: The version of the Agent
|
7543
7621
|
type: string
|
7622
|
+
blocking:
|
7623
|
+
description: The blocking policies that the rule belongs to
|
7624
|
+
items:
|
7625
|
+
type: string
|
7626
|
+
type: array
|
7544
7627
|
category:
|
7545
7628
|
description: The category of the Agent rule
|
7546
7629
|
example: Process Activity
|
@@ -7564,6 +7647,11 @@ components:
|
|
7564
7647
|
description: The description of the Agent rule
|
7565
7648
|
example: My Agent rule
|
7566
7649
|
type: string
|
7650
|
+
disabled:
|
7651
|
+
description: The disabled policies that the rule belongs to
|
7652
|
+
items:
|
7653
|
+
type: string
|
7654
|
+
type: array
|
7567
7655
|
enabled:
|
7568
7656
|
description: Whether the Agent rule is enabled
|
7569
7657
|
example: true
|
@@ -7577,6 +7665,11 @@ components:
|
|
7577
7665
|
items:
|
7578
7666
|
type: string
|
7579
7667
|
type: array
|
7668
|
+
monitoring:
|
7669
|
+
description: The monitoring policies that the rule belongs to
|
7670
|
+
items:
|
7671
|
+
type: string
|
7672
|
+
type: array
|
7580
7673
|
name:
|
7581
7674
|
description: The name of the Agent rule
|
7582
7675
|
example: my_agent_rule
|
@@ -7611,10 +7704,22 @@ components:
|
|
7611
7704
|
CloudWorkloadSecurityAgentRuleCreateAttributes:
|
7612
7705
|
description: Create a new Cloud Workload Security Agent rule.
|
7613
7706
|
properties:
|
7707
|
+
actions:
|
7708
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActions'
|
7709
|
+
blocking:
|
7710
|
+
description: The blocking policies that the rule belongs to
|
7711
|
+
items:
|
7712
|
+
type: string
|
7713
|
+
type: array
|
7614
7714
|
description:
|
7615
7715
|
description: The description of the Agent rule.
|
7616
7716
|
example: My Agent rule
|
7617
7717
|
type: string
|
7718
|
+
disabled:
|
7719
|
+
description: The disabled policies that the rule belongs to
|
7720
|
+
items:
|
7721
|
+
type: string
|
7722
|
+
type: array
|
7618
7723
|
enabled:
|
7619
7724
|
description: Whether the Agent rule is enabled
|
7620
7725
|
example: true
|
@@ -7628,6 +7733,11 @@ components:
|
|
7628
7733
|
items:
|
7629
7734
|
type: string
|
7630
7735
|
type: array
|
7736
|
+
monitoring:
|
7737
|
+
description: The monitoring policies that the rule belongs to
|
7738
|
+
items:
|
7739
|
+
type: string
|
7740
|
+
type: array
|
7631
7741
|
name:
|
7632
7742
|
description: The name of the Agent rule.
|
7633
7743
|
example: my_agent_rule
|
@@ -7718,10 +7828,22 @@ components:
|
|
7718
7828
|
CloudWorkloadSecurityAgentRuleUpdateAttributes:
|
7719
7829
|
description: Update an existing Cloud Workload Security Agent rule
|
7720
7830
|
properties:
|
7831
|
+
actions:
|
7832
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActions'
|
7833
|
+
blocking:
|
7834
|
+
description: The blocking policies that the rule belongs to
|
7835
|
+
items:
|
7836
|
+
type: string
|
7837
|
+
type: array
|
7721
7838
|
description:
|
7722
7839
|
description: The description of the Agent rule
|
7723
7840
|
example: My Agent rule
|
7724
7841
|
type: string
|
7842
|
+
disabled:
|
7843
|
+
description: The disabled policies that the rule belongs to
|
7844
|
+
items:
|
7845
|
+
type: string
|
7846
|
+
type: array
|
7725
7847
|
enabled:
|
7726
7848
|
description: Whether the Agent rule is enabled
|
7727
7849
|
example: true
|
@@ -7730,6 +7852,11 @@ components:
|
|
7730
7852
|
description: The SECL expression of the Agent rule
|
7731
7853
|
example: exec.file.name == "sh"
|
7732
7854
|
type: string
|
7855
|
+
monitoring:
|
7856
|
+
description: The monitoring policies that the rule belongs to
|
7857
|
+
items:
|
7858
|
+
type: string
|
7859
|
+
type: array
|
7733
7860
|
policy_id:
|
7734
7861
|
description: The ID of the policy where the Agent rule is saved
|
7735
7862
|
example: a8c8e364-6556-434d-b798-a4c23de29c0b
|
@@ -10359,6 +10486,7 @@ components:
|
|
10359
10486
|
- $ref: '#/components/schemas/CustomDestinationForwardDestinationHttp'
|
10360
10487
|
- $ref: '#/components/schemas/CustomDestinationForwardDestinationSplunk'
|
10361
10488
|
- $ref: '#/components/schemas/CustomDestinationForwardDestinationElasticsearch'
|
10489
|
+
- $ref: '#/components/schemas/CustomDestinationForwardDestinationMicrosoftSentinel'
|
10362
10490
|
CustomDestinationForwardDestinationElasticsearch:
|
10363
10491
|
description: The Elasticsearch destination.
|
10364
10492
|
properties:
|
@@ -10443,6 +10571,49 @@ components:
|
|
10443
10571
|
type: string
|
10444
10572
|
x-enum-varnames:
|
10445
10573
|
- HTTP
|
10574
|
+
CustomDestinationForwardDestinationMicrosoftSentinel:
|
10575
|
+
description: The Microsoft Sentinel destination.
|
10576
|
+
properties:
|
10577
|
+
client_id:
|
10578
|
+
description: Client ID from the Datadog Azure integration.
|
10579
|
+
example: 9a2f4d83-2b5e-429e-a35a-2b3c4182db71
|
10580
|
+
type: string
|
10581
|
+
data_collection_endpoint:
|
10582
|
+
description: Azure data collection endpoint.
|
10583
|
+
example: https://my-dce-5kyl.eastus-1.ingest.monitor.azure.com
|
10584
|
+
type: string
|
10585
|
+
data_collection_rule_id:
|
10586
|
+
description: Azure data collection rule ID.
|
10587
|
+
example: dcr-000a00a000a00000a000000aa000a0aa
|
10588
|
+
type: string
|
10589
|
+
stream_name:
|
10590
|
+
description: Azure stream name.
|
10591
|
+
example: Custom-MyTable
|
10592
|
+
type: string
|
10593
|
+
writeOnly: true
|
10594
|
+
tenant_id:
|
10595
|
+
description: Tenant ID from the Datadog Azure integration.
|
10596
|
+
example: f3c9a8a1-4c2e-4d2e-b911-9f3c28c3c8b2
|
10597
|
+
type: string
|
10598
|
+
type:
|
10599
|
+
$ref: '#/components/schemas/CustomDestinationForwardDestinationMicrosoftSentinelType'
|
10600
|
+
required:
|
10601
|
+
- type
|
10602
|
+
- tenant_id
|
10603
|
+
- client_id
|
10604
|
+
- data_collection_endpoint
|
10605
|
+
- data_collection_rule_id
|
10606
|
+
- stream_name
|
10607
|
+
type: object
|
10608
|
+
CustomDestinationForwardDestinationMicrosoftSentinelType:
|
10609
|
+
default: microsoft_sentinel
|
10610
|
+
description: Type of the Microsoft Sentinel destination.
|
10611
|
+
enum:
|
10612
|
+
- microsoft_sentinel
|
10613
|
+
example: microsoft_sentinel
|
10614
|
+
type: string
|
10615
|
+
x-enum-varnames:
|
10616
|
+
- MICROSOFT_SENTINEL
|
10446
10617
|
CustomDestinationForwardDestinationSplunk:
|
10447
10618
|
description: The Splunk HTTP Event Collector (HEC) destination.
|
10448
10619
|
properties:
|
@@ -10618,6 +10789,7 @@ components:
|
|
10618
10789
|
- $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationHttp'
|
10619
10790
|
- $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationSplunk'
|
10620
10791
|
- $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationElasticsearch'
|
10792
|
+
- $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationMicrosoftSentinel'
|
10621
10793
|
CustomDestinationResponseForwardDestinationElasticsearch:
|
10622
10794
|
description: The Elasticsearch destination.
|
10623
10795
|
properties:
|
@@ -10702,6 +10874,49 @@ components:
|
|
10702
10874
|
type: string
|
10703
10875
|
x-enum-varnames:
|
10704
10876
|
- HTTP
|
10877
|
+
CustomDestinationResponseForwardDestinationMicrosoftSentinel:
|
10878
|
+
description: The Microsoft Sentinel destination.
|
10879
|
+
properties:
|
10880
|
+
client_id:
|
10881
|
+
description: Client ID from the Datadog Azure integration.
|
10882
|
+
example: 9a2f4d83-2b5e-429e-a35a-2b3c4182db71
|
10883
|
+
type: string
|
10884
|
+
data_collection_endpoint:
|
10885
|
+
description: Azure data collection endpoint.
|
10886
|
+
example: https://my-dce-5kyl.eastus-1.ingest.monitor.azure.com
|
10887
|
+
type: string
|
10888
|
+
data_collection_rule_id:
|
10889
|
+
description: Azure data collection rule ID.
|
10890
|
+
example: dcr-000a00a000a00000a000000aa000a0aa
|
10891
|
+
type: string
|
10892
|
+
stream_name:
|
10893
|
+
description: Azure stream name.
|
10894
|
+
example: Custom-MyTable
|
10895
|
+
type: string
|
10896
|
+
writeOnly: true
|
10897
|
+
tenant_id:
|
10898
|
+
description: Tenant ID from the Datadog Azure integration.
|
10899
|
+
example: f3c9a8a1-4c2e-4d2e-b911-9f3c28c3c8b2
|
10900
|
+
type: string
|
10901
|
+
type:
|
10902
|
+
$ref: '#/components/schemas/CustomDestinationResponseForwardDestinationMicrosoftSentinelType'
|
10903
|
+
required:
|
10904
|
+
- type
|
10905
|
+
- tenant_id
|
10906
|
+
- client_id
|
10907
|
+
- data_collection_endpoint
|
10908
|
+
- data_collection_rule_id
|
10909
|
+
- stream_name
|
10910
|
+
type: object
|
10911
|
+
CustomDestinationResponseForwardDestinationMicrosoftSentinelType:
|
10912
|
+
default: microsoft_sentinel
|
10913
|
+
description: Type of the Microsoft Sentinel destination.
|
10914
|
+
enum:
|
10915
|
+
- microsoft_sentinel
|
10916
|
+
example: microsoft_sentinel
|
10917
|
+
type: string
|
10918
|
+
x-enum-varnames:
|
10919
|
+
- MICROSOFT_SENTINEL
|
10705
10920
|
CustomDestinationResponseForwardDestinationSplunk:
|
10706
10921
|
description: The Splunk HTTP Event Collector (HEC) destination.
|
10707
10922
|
properties:
|
@@ -10994,6 +11209,17 @@ components:
|
|
10994
11209
|
- version
|
10995
11210
|
- name
|
10996
11211
|
type: object
|
11212
|
+
DORACustomTags:
|
11213
|
+
description: A list of user-defined tags. The tags must follow the `key:value`
|
11214
|
+
pattern. Up to 100 may be added per event.
|
11215
|
+
example:
|
11216
|
+
- language:java
|
11217
|
+
- department:engineering
|
11218
|
+
items:
|
11219
|
+
description: Tags in the form of `key:value`.
|
11220
|
+
type: string
|
11221
|
+
nullable: true
|
11222
|
+
type: array
|
10997
11223
|
DORADeploymentRequest:
|
10998
11224
|
description: Request to create a DORA deployment event.
|
10999
11225
|
properties:
|
@@ -11005,6 +11231,8 @@ components:
|
|
11005
11231
|
DORADeploymentRequestAttributes:
|
11006
11232
|
description: Attributes to create a DORA deployment event.
|
11007
11233
|
properties:
|
11234
|
+
custom_tags:
|
11235
|
+
$ref: '#/components/schemas/DORACustomTags'
|
11008
11236
|
env:
|
11009
11237
|
description: Environment name to where the service was deployed.
|
11010
11238
|
example: staging
|
@@ -11096,40 +11324,25 @@ components:
|
|
11096
11324
|
description: The type of the event.
|
11097
11325
|
type: string
|
11098
11326
|
type: object
|
11099
|
-
|
11100
|
-
description:
|
11327
|
+
DORAFailureRequest:
|
11328
|
+
description: Request to create a DORA failure event.
|
11101
11329
|
properties:
|
11102
11330
|
data:
|
11103
|
-
$ref: '#/components/schemas/
|
11104
|
-
type: object
|
11105
|
-
DORAGitInfo:
|
11106
|
-
description: Git info for DORA Metrics events.
|
11107
|
-
properties:
|
11108
|
-
commit_sha:
|
11109
|
-
$ref: '#/components/schemas/GitCommitSHA'
|
11110
|
-
repository_url:
|
11111
|
-
$ref: '#/components/schemas/GitRepositoryURL'
|
11112
|
-
required:
|
11113
|
-
- repository_url
|
11114
|
-
- commit_sha
|
11115
|
-
type: object
|
11116
|
-
DORAIncidentRequest:
|
11117
|
-
description: Request to create a DORA incident event.
|
11118
|
-
properties:
|
11119
|
-
data:
|
11120
|
-
$ref: '#/components/schemas/DORAIncidentRequestData'
|
11331
|
+
$ref: '#/components/schemas/DORAFailureRequestData'
|
11121
11332
|
required:
|
11122
11333
|
- data
|
11123
11334
|
type: object
|
11124
|
-
|
11125
|
-
description: Attributes to create a DORA
|
11335
|
+
DORAFailureRequestAttributes:
|
11336
|
+
description: Attributes to create a DORA failure event.
|
11126
11337
|
properties:
|
11338
|
+
custom_tags:
|
11339
|
+
$ref: '#/components/schemas/DORACustomTags'
|
11127
11340
|
env:
|
11128
|
-
description: Environment name that was impacted by the
|
11341
|
+
description: Environment name that was impacted by the failure.
|
11129
11342
|
example: staging
|
11130
11343
|
type: string
|
11131
11344
|
finished_at:
|
11132
|
-
description: Unix timestamp when the
|
11345
|
+
description: Unix timestamp when the failure finished. It must be in nanoseconds,
|
11133
11346
|
milliseconds, or seconds, and it should not be older than 1 hour.
|
11134
11347
|
example: 1693491984000000000
|
11135
11348
|
format: int64
|
@@ -11137,15 +11350,15 @@ components:
|
|
11137
11350
|
git:
|
11138
11351
|
$ref: '#/components/schemas/DORAGitInfo'
|
11139
11352
|
id:
|
11140
|
-
description:
|
11141
|
-
|
11353
|
+
description: Failure ID. Must have at least 16 characters. Required to update
|
11354
|
+
a previously sent failure.
|
11142
11355
|
type: string
|
11143
11356
|
name:
|
11144
|
-
description:
|
11357
|
+
description: Failure name.
|
11145
11358
|
example: Webserver is down failing all requests.
|
11146
11359
|
type: string
|
11147
11360
|
services:
|
11148
|
-
description: Service names impacted by the
|
11361
|
+
description: Service names impacted by the failure. If possible, use names
|
11149
11362
|
registered in the Service Catalog. Required when the team field is not
|
11150
11363
|
provided.
|
11151
11364
|
example:
|
@@ -11154,11 +11367,11 @@ components:
|
|
11154
11367
|
type: string
|
11155
11368
|
type: array
|
11156
11369
|
severity:
|
11157
|
-
description:
|
11370
|
+
description: Failure severity.
|
11158
11371
|
example: High
|
11159
11372
|
type: string
|
11160
11373
|
started_at:
|
11161
|
-
description: Unix timestamp when the
|
11374
|
+
description: Unix timestamp when the failure started. It must be in nanoseconds,
|
11162
11375
|
milliseconds, or seconds.
|
11163
11376
|
example: 1693491974000000000
|
11164
11377
|
format: int64
|
@@ -11176,43 +11389,60 @@ components:
|
|
11176
11389
|
required:
|
11177
11390
|
- started_at
|
11178
11391
|
type: object
|
11179
|
-
|
11392
|
+
DORAFailureRequestData:
|
11180
11393
|
description: The JSON:API data.
|
11181
11394
|
properties:
|
11182
11395
|
attributes:
|
11183
|
-
$ref: '#/components/schemas/
|
11396
|
+
$ref: '#/components/schemas/DORAFailureRequestAttributes'
|
11184
11397
|
required:
|
11185
11398
|
- attributes
|
11186
11399
|
type: object
|
11187
|
-
|
11188
|
-
description: Response after receiving a DORA
|
11400
|
+
DORAFailureResponse:
|
11401
|
+
description: Response after receiving a DORA failure event.
|
11189
11402
|
properties:
|
11190
11403
|
data:
|
11191
|
-
$ref: '#/components/schemas/
|
11404
|
+
$ref: '#/components/schemas/DORAFailureResponseData'
|
11192
11405
|
required:
|
11193
11406
|
- data
|
11194
11407
|
type: object
|
11195
|
-
|
11196
|
-
description: Response after receiving a DORA
|
11408
|
+
DORAFailureResponseData:
|
11409
|
+
description: Response after receiving a DORA failure event.
|
11197
11410
|
properties:
|
11198
11411
|
id:
|
11199
|
-
description: The ID of the received DORA
|
11412
|
+
description: The ID of the received DORA failure event.
|
11200
11413
|
example: 4242fcdd31586083
|
11201
11414
|
type: string
|
11202
11415
|
type:
|
11203
|
-
$ref: '#/components/schemas/
|
11416
|
+
$ref: '#/components/schemas/DORAFailureType'
|
11204
11417
|
required:
|
11205
11418
|
- id
|
11206
11419
|
type: object
|
11207
|
-
|
11208
|
-
default:
|
11209
|
-
description: JSON:API type for DORA
|
11420
|
+
DORAFailureType:
|
11421
|
+
default: dora_failure
|
11422
|
+
description: JSON:API type for DORA failure events.
|
11210
11423
|
enum:
|
11211
|
-
-
|
11212
|
-
example:
|
11424
|
+
- dora_failure
|
11425
|
+
example: dora_failure
|
11213
11426
|
type: string
|
11214
11427
|
x-enum-varnames:
|
11215
|
-
-
|
11428
|
+
- DORA_FAILURE
|
11429
|
+
DORAFetchResponse:
|
11430
|
+
description: Response for the DORA fetch endpoints.
|
11431
|
+
properties:
|
11432
|
+
data:
|
11433
|
+
$ref: '#/components/schemas/DORAEvent'
|
11434
|
+
type: object
|
11435
|
+
DORAGitInfo:
|
11436
|
+
description: Git info for DORA Metrics events.
|
11437
|
+
properties:
|
11438
|
+
commit_sha:
|
11439
|
+
$ref: '#/components/schemas/GitCommitSHA'
|
11440
|
+
repository_url:
|
11441
|
+
$ref: '#/components/schemas/GitRepositoryURL'
|
11442
|
+
required:
|
11443
|
+
- repository_url
|
11444
|
+
- commit_sha
|
11445
|
+
type: object
|
11216
11446
|
DORAListDeploymentsRequest:
|
11217
11447
|
description: Request to get a list of deployments.
|
11218
11448
|
properties:
|
@@ -13751,6 +13981,19 @@ components:
|
|
13751
13981
|
- retryStrategy
|
13752
13982
|
- fallbackStepName
|
13753
13983
|
type: object
|
13984
|
+
Escalation:
|
13985
|
+
description: Represents an escalation policy step.
|
13986
|
+
properties:
|
13987
|
+
id:
|
13988
|
+
description: Unique identifier of the escalation step.
|
13989
|
+
type: string
|
13990
|
+
relationships:
|
13991
|
+
$ref: '#/components/schemas/EscalationRelationships'
|
13992
|
+
type:
|
13993
|
+
$ref: '#/components/schemas/EscalationType'
|
13994
|
+
required:
|
13995
|
+
- type
|
13996
|
+
type: object
|
13754
13997
|
EscalationPolicy:
|
13755
13998
|
description: Represents a complete escalation policy response, including policy
|
13756
13999
|
data and optionally included related resources.
|
@@ -14260,6 +14503,46 @@ components:
|
|
14260
14503
|
type: string
|
14261
14504
|
x-enum-varnames:
|
14262
14505
|
- USERS
|
14506
|
+
EscalationRelationships:
|
14507
|
+
description: Contains the relationships of an escalation object, including its
|
14508
|
+
responders.
|
14509
|
+
properties:
|
14510
|
+
responders:
|
14511
|
+
$ref: '#/components/schemas/EscalationRelationshipsResponders'
|
14512
|
+
type: object
|
14513
|
+
EscalationRelationshipsResponders:
|
14514
|
+
description: Lists the users involved in a specific step of the escalation policy.
|
14515
|
+
properties:
|
14516
|
+
data:
|
14517
|
+
description: Array of user references assigned as responders for this escalation
|
14518
|
+
step.
|
14519
|
+
items:
|
14520
|
+
$ref: '#/components/schemas/EscalationRelationshipsRespondersDataItems'
|
14521
|
+
type: array
|
14522
|
+
type: object
|
14523
|
+
EscalationRelationshipsRespondersDataItems:
|
14524
|
+
description: Represents a user assigned to an escalation step.
|
14525
|
+
properties:
|
14526
|
+
id:
|
14527
|
+
description: Unique identifier of the user assigned to the escalation step.
|
14528
|
+
example: ''
|
14529
|
+
type: string
|
14530
|
+
type:
|
14531
|
+
$ref: '#/components/schemas/EscalationRelationshipsRespondersDataItemsType'
|
14532
|
+
required:
|
14533
|
+
- type
|
14534
|
+
- id
|
14535
|
+
type: object
|
14536
|
+
EscalationRelationshipsRespondersDataItemsType:
|
14537
|
+
default: users
|
14538
|
+
description: Represents the resource type for users assigned as responders in
|
14539
|
+
an escalation step.
|
14540
|
+
enum:
|
14541
|
+
- users
|
14542
|
+
example: users
|
14543
|
+
type: string
|
14544
|
+
x-enum-varnames:
|
14545
|
+
- USERS
|
14263
14546
|
EscalationTarget:
|
14264
14547
|
description: Represents an escalation target, which can be a team, user, or
|
14265
14548
|
schedule.
|
@@ -14276,6 +14559,16 @@ components:
|
|
14276
14559
|
$ref: '#/components/schemas/EscalationTarget'
|
14277
14560
|
type: array
|
14278
14561
|
type: object
|
14562
|
+
EscalationType:
|
14563
|
+
default: escalation_policy_steps
|
14564
|
+
description: Represents the resource type for individual steps in an escalation
|
14565
|
+
policy used during incident response.
|
14566
|
+
enum:
|
14567
|
+
- escalation_policy_steps
|
14568
|
+
example: escalation_policy_steps
|
14569
|
+
type: string
|
14570
|
+
x-enum-varnames:
|
14571
|
+
- ESCALATION_POLICY_STEPS
|
14279
14572
|
Event:
|
14280
14573
|
description: The metadata associated with a request.
|
14281
14574
|
properties:
|
@@ -15123,10 +15416,16 @@ components:
|
|
15123
15416
|
FindingAttributes:
|
15124
15417
|
description: The JSON:API attributes of the finding.
|
15125
15418
|
properties:
|
15419
|
+
datadog_link:
|
15420
|
+
$ref: '#/components/schemas/FindingDatadogLink'
|
15421
|
+
description:
|
15422
|
+
$ref: '#/components/schemas/FindingDescription'
|
15126
15423
|
evaluation:
|
15127
15424
|
$ref: '#/components/schemas/FindingEvaluation'
|
15128
15425
|
evaluation_changed_at:
|
15129
15426
|
$ref: '#/components/schemas/FindingEvaluationChangedAt'
|
15427
|
+
external_id:
|
15428
|
+
$ref: '#/components/schemas/FindingExternalId'
|
15130
15429
|
mute:
|
15131
15430
|
$ref: '#/components/schemas/FindingMute'
|
15132
15431
|
resource:
|
@@ -15144,6 +15443,22 @@ components:
|
|
15144
15443
|
vulnerability_type:
|
15145
15444
|
$ref: '#/components/schemas/FindingVulnerabilityType'
|
15146
15445
|
type: object
|
15446
|
+
FindingDatadogLink:
|
15447
|
+
description: The Datadog relative link for this finding.
|
15448
|
+
example: /security/compliance?panels=cpfinding%7Cevent%7CruleId%3Adef-000-u5t%7CresourceId%3Ae8c9ab7c52ebd7bf2fdb4db641082d7d%7CtabId%3Aoverview
|
15449
|
+
type: string
|
15450
|
+
FindingDescription:
|
15451
|
+
description: The description and remediation steps for this finding.
|
15452
|
+
example: '## Remediation
|
15453
|
+
|
15454
|
+
|
15455
|
+
1. In the console, go to **Storage Account**.
|
15456
|
+
|
15457
|
+
2. For each Storage Account, navigate to **Data Protection**.
|
15458
|
+
|
15459
|
+
3. Select **Set soft delete enabled** and enter the number of days to retain
|
15460
|
+
soft deleted data.'
|
15461
|
+
type: string
|
15147
15462
|
FindingEvaluation:
|
15148
15463
|
description: The evaluation of the finding.
|
15149
15464
|
enum:
|
@@ -15161,6 +15476,10 @@ components:
|
|
15161
15476
|
format: int64
|
15162
15477
|
minimum: 1
|
15163
15478
|
type: integer
|
15479
|
+
FindingExternalId:
|
15480
|
+
description: The cloud-based ID for the resource related to the finding.
|
15481
|
+
example: arn:aws:s3:::my-example-bucket
|
15482
|
+
type: string
|
15164
15483
|
FindingID:
|
15165
15484
|
description: The unique ID for this finding.
|
15166
15485
|
example: ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==
|
@@ -19121,6 +19440,90 @@ components:
|
|
19121
19440
|
- index
|
19122
19441
|
- caseIndex
|
19123
19442
|
type: object
|
19443
|
+
KindAttributes:
|
19444
|
+
description: Kind attributes.
|
19445
|
+
properties:
|
19446
|
+
description:
|
19447
|
+
description: Short description of the kind.
|
19448
|
+
type: string
|
19449
|
+
displayName:
|
19450
|
+
description: User friendly name of the kind.
|
19451
|
+
type: string
|
19452
|
+
name:
|
19453
|
+
description: The kind name.
|
19454
|
+
example: my-job
|
19455
|
+
minLength: 1
|
19456
|
+
type: string
|
19457
|
+
type: object
|
19458
|
+
KindData:
|
19459
|
+
description: Schema that defines the structure of a Kind object in the Software
|
19460
|
+
Catalog.
|
19461
|
+
properties:
|
19462
|
+
attributes:
|
19463
|
+
$ref: '#/components/schemas/KindAttributes'
|
19464
|
+
id:
|
19465
|
+
description: A read-only globally unique identifier for the entity generated
|
19466
|
+
by Datadog. User supplied values are ignored.
|
19467
|
+
example: 4b163705-23c0-4573-b2fb-f6cea2163fcb
|
19468
|
+
minLength: 1
|
19469
|
+
type: string
|
19470
|
+
meta:
|
19471
|
+
$ref: '#/components/schemas/KindMetadata'
|
19472
|
+
type:
|
19473
|
+
description: Kind.
|
19474
|
+
type: string
|
19475
|
+
type: object
|
19476
|
+
KindMetadata:
|
19477
|
+
description: Kind metadata.
|
19478
|
+
properties:
|
19479
|
+
createdAt:
|
19480
|
+
description: The creation time.
|
19481
|
+
type: string
|
19482
|
+
modifiedAt:
|
19483
|
+
description: The modification time.
|
19484
|
+
type: string
|
19485
|
+
type: object
|
19486
|
+
KindObj:
|
19487
|
+
description: Schema for kind.
|
19488
|
+
properties:
|
19489
|
+
description:
|
19490
|
+
description: Short description of the kind.
|
19491
|
+
type: string
|
19492
|
+
displayName:
|
19493
|
+
description: The display name of the kind. Automatically generated if not
|
19494
|
+
provided.
|
19495
|
+
type: string
|
19496
|
+
kind:
|
19497
|
+
description: The name of the kind to create or update. This must be in kebab-case
|
19498
|
+
format.
|
19499
|
+
example: my-job
|
19500
|
+
type: string
|
19501
|
+
required:
|
19502
|
+
- kind
|
19503
|
+
type: object
|
19504
|
+
KindRaw:
|
19505
|
+
description: Kind definition in raw JSON or YAML representation.
|
19506
|
+
example: 'kind: service
|
19507
|
+
|
19508
|
+
displayName: Service
|
19509
|
+
|
19510
|
+
description: A service entity in the catalog.
|
19511
|
+
|
19512
|
+
'
|
19513
|
+
type: string
|
19514
|
+
KindResponseData:
|
19515
|
+
description: List of kind responses.
|
19516
|
+
items:
|
19517
|
+
$ref: '#/components/schemas/KindData'
|
19518
|
+
type: array
|
19519
|
+
KindResponseMeta:
|
19520
|
+
description: Kind response metadata.
|
19521
|
+
properties:
|
19522
|
+
count:
|
19523
|
+
description: Total kinds count.
|
19524
|
+
format: int64
|
19525
|
+
type: integer
|
19526
|
+
type: object
|
19124
19527
|
Layer:
|
19125
19528
|
description: Encapsulates a layer resource, holding attributes like rotation
|
19126
19529
|
details, plus relationships to the members covering that layer.
|
@@ -19607,6 +20010,14 @@ components:
|
|
19607
20010
|
meta:
|
19608
20011
|
$ref: '#/components/schemas/HistoricalJobListMeta'
|
19609
20012
|
type: object
|
20013
|
+
ListKindCatalogResponse:
|
20014
|
+
description: List kind response.
|
20015
|
+
properties:
|
20016
|
+
data:
|
20017
|
+
$ref: '#/components/schemas/KindResponseData'
|
20018
|
+
meta:
|
20019
|
+
$ref: '#/components/schemas/KindResponseMeta'
|
20020
|
+
type: object
|
19610
20021
|
ListPipelinesResponse:
|
19611
20022
|
description: Represents the response payload containing a list of pipelines
|
19612
20023
|
and associated metadata.
|
@@ -21003,6 +21414,28 @@ components:
|
|
21003
21414
|
- ms_channel_name
|
21004
21415
|
- redirect_url
|
21005
21416
|
type: object
|
21417
|
+
MemberTeam:
|
21418
|
+
description: A member team
|
21419
|
+
properties:
|
21420
|
+
id:
|
21421
|
+
description: The member team's identifier
|
21422
|
+
example: aeadc05e-98a8-11ec-ac2c-da7ad0900001
|
21423
|
+
type: string
|
21424
|
+
type:
|
21425
|
+
$ref: '#/components/schemas/MemberTeamType'
|
21426
|
+
required:
|
21427
|
+
- id
|
21428
|
+
- type
|
21429
|
+
type: object
|
21430
|
+
MemberTeamType:
|
21431
|
+
default: member_teams
|
21432
|
+
description: Member team type
|
21433
|
+
enum:
|
21434
|
+
- member_teams
|
21435
|
+
example: member_teams
|
21436
|
+
type: string
|
21437
|
+
x-enum-varnames:
|
21438
|
+
- MEMBER_TEAMS
|
21006
21439
|
Metadata:
|
21007
21440
|
description: The metadata related to this request.
|
21008
21441
|
properties:
|
@@ -32435,6 +32868,8 @@ components:
|
|
32435
32868
|
|
32436
32869
|
based on the event counts in the previously defined queries.'
|
32437
32870
|
type: string
|
32871
|
+
customStatus:
|
32872
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleSeverity'
|
32438
32873
|
name:
|
32439
32874
|
description: Name of the case.
|
32440
32875
|
type: string
|
@@ -32921,11 +33356,13 @@ components:
|
|
32921
33356
|
SecurityMonitoringRuleTypeCreate:
|
32922
33357
|
description: The rule type.
|
32923
33358
|
enum:
|
33359
|
+
- api_security
|
32924
33360
|
- application_security
|
32925
33361
|
- log_detection
|
32926
33362
|
- workload_security
|
32927
33363
|
type: string
|
32928
33364
|
x-enum-varnames:
|
33365
|
+
- API_SECURITY
|
32929
33366
|
- APPLICATION_SECURITY
|
32930
33367
|
- LOG_DETECTION
|
32931
33368
|
- WORKLOAD_SECURITY
|
@@ -32937,6 +33374,7 @@ components:
|
|
32937
33374
|
- workload_security
|
32938
33375
|
- cloud_configuration
|
32939
33376
|
- application_security
|
33377
|
+
- api_security
|
32940
33378
|
type: string
|
32941
33379
|
x-enum-varnames:
|
32942
33380
|
- LOG_DETECTION
|
@@ -32944,6 +33382,7 @@ components:
|
|
32944
33382
|
- WORKLOAD_SECURITY
|
32945
33383
|
- CLOUD_CONFIGURATION
|
32946
33384
|
- APPLICATION_SECURITY
|
33385
|
+
- API_SECURITY
|
32947
33386
|
SecurityMonitoringRuleTypeTest:
|
32948
33387
|
description: The rule type.
|
32949
33388
|
enum:
|
@@ -32961,6 +33400,13 @@ components:
|
|
32961
33400
|
type: array
|
32962
33401
|
complianceSignalOptions:
|
32963
33402
|
$ref: '#/components/schemas/CloudConfigurationRuleComplianceSignalOptions'
|
33403
|
+
customMessage:
|
33404
|
+
description: Custom/Overridden Message for generated signals (used in case
|
33405
|
+
of Default rule update).
|
33406
|
+
type: string
|
33407
|
+
customName:
|
33408
|
+
description: Custom/Overridden name (used in case of Default rule update).
|
33409
|
+
type: string
|
32964
33410
|
filters:
|
32965
33411
|
description: Additional queries to filter matched events before they are
|
32966
33412
|
processed. This field is deprecated for log detection, signal correlation,
|
@@ -33292,6 +33738,14 @@ components:
|
|
33292
33738
|
items:
|
33293
33739
|
$ref: '#/components/schemas/SecurityMonitoringRuleCaseCreate'
|
33294
33740
|
type: array
|
33741
|
+
customMessage:
|
33742
|
+
description: Custom/Overridden message for generated signals (used in case
|
33743
|
+
of Default rule update).
|
33744
|
+
type: string
|
33745
|
+
customName:
|
33746
|
+
description: Custom/Overridden name of the rule (used in case of Default
|
33747
|
+
rule update).
|
33748
|
+
type: string
|
33295
33749
|
filters:
|
33296
33750
|
description: Additional queries to filter matched events before they are
|
33297
33751
|
processed. This field is deprecated for log detection, signal correlation,
|
@@ -33391,6 +33845,14 @@ components:
|
|
33391
33845
|
description: User ID of the user who created the rule.
|
33392
33846
|
format: int64
|
33393
33847
|
type: integer
|
33848
|
+
customMessage:
|
33849
|
+
description: Custom/Overridden message for generated signals (used in case
|
33850
|
+
of Default rule update).
|
33851
|
+
type: string
|
33852
|
+
customName:
|
33853
|
+
description: Custom/Overridden name of the rule (used in case of Default
|
33854
|
+
rule update).
|
33855
|
+
type: string
|
33394
33856
|
deprecationDate:
|
33395
33857
|
description: When the rule will be deprecated, timestamp in milliseconds.
|
33396
33858
|
format: int64
|
@@ -33778,6 +34240,14 @@ components:
|
|
33778
34240
|
items:
|
33779
34241
|
$ref: '#/components/schemas/SecurityMonitoringRuleCaseCreate'
|
33780
34242
|
type: array
|
34243
|
+
customMessage:
|
34244
|
+
description: Custom/Overridden message for generated signals (used in case
|
34245
|
+
of Default rule update).
|
34246
|
+
type: string
|
34247
|
+
customName:
|
34248
|
+
description: Custom/Overridden name of the rule (used in case of Default
|
34249
|
+
rule update).
|
34250
|
+
type: string
|
33781
34251
|
filters:
|
33782
34252
|
description: Additional queries to filter matched events before they are
|
33783
34253
|
processed. This field is deprecated for log detection, signal correlation,
|
@@ -33855,6 +34325,10 @@ components:
|
|
33855
34325
|
properties:
|
33856
34326
|
aggregation:
|
33857
34327
|
$ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation'
|
34328
|
+
customQueryExtension:
|
34329
|
+
description: Query extension to append to the logs query.
|
34330
|
+
example: a > 3
|
34331
|
+
type: string
|
33858
34332
|
dataSource:
|
33859
34333
|
$ref: '#/components/schemas/SecurityMonitoringStandardDataSource'
|
33860
34334
|
distinctFields:
|
@@ -33918,6 +34392,14 @@ components:
|
|
33918
34392
|
description: User ID of the user who created the rule.
|
33919
34393
|
format: int64
|
33920
34394
|
type: integer
|
34395
|
+
customMessage:
|
34396
|
+
description: Custom/Overridden message for generated signals (used in case
|
34397
|
+
of Default rule update).
|
34398
|
+
type: string
|
34399
|
+
customName:
|
34400
|
+
description: Custom/Overridden name of the rule (used in case of Default
|
34401
|
+
rule update).
|
34402
|
+
type: string
|
33921
34403
|
defaultTags:
|
33922
34404
|
description: Default Tags for default rules (included in tags)
|
33923
34405
|
example:
|
@@ -34364,6 +34846,8 @@ components:
|
|
34364
34846
|
SecurityMonitoringThirdPartyRuleCase:
|
34365
34847
|
description: Case when signal is generated by a third party rule.
|
34366
34848
|
properties:
|
34849
|
+
customStatus:
|
34850
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleSeverity'
|
34367
34851
|
name:
|
34368
34852
|
description: Name of the case.
|
34369
34853
|
type: string
|
@@ -34675,6 +35159,11 @@ components:
|
|
34675
35159
|
items:
|
34676
35160
|
$ref: '#/components/schemas/SensitiveDataScannerProduct'
|
34677
35161
|
type: array
|
35162
|
+
samplings:
|
35163
|
+
description: List of sampling rates per product type.
|
35164
|
+
items:
|
35165
|
+
$ref: '#/components/schemas/SensitiveDataScannerSamplings'
|
35166
|
+
type: array
|
34678
35167
|
type: object
|
34679
35168
|
SensitiveDataScannerGroupCreate:
|
34680
35169
|
description: Data related to the creation of a group.
|
@@ -35106,6 +35595,19 @@ components:
|
|
35106
35595
|
meta:
|
35107
35596
|
$ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly'
|
35108
35597
|
type: object
|
35598
|
+
SensitiveDataScannerSamplings:
|
35599
|
+
description: Sampling configurations for the Scanning Group.
|
35600
|
+
properties:
|
35601
|
+
product:
|
35602
|
+
$ref: '#/components/schemas/SensitiveDataScannerProduct'
|
35603
|
+
rate:
|
35604
|
+
description: Rate at which data in product type will be scanned, as a percentage.
|
35605
|
+
example: 100.0
|
35606
|
+
format: double
|
35607
|
+
maximum: 100.0
|
35608
|
+
minimum: 0.0
|
35609
|
+
type: number
|
35610
|
+
type: object
|
35109
35611
|
SensitiveDataScannerStandardPattern:
|
35110
35612
|
description: Data containing the standard pattern id.
|
35111
35613
|
properties:
|
@@ -37887,6 +38389,150 @@ components:
|
|
37887
38389
|
$ref: '#/components/schemas/TeamLink'
|
37888
38390
|
type: array
|
37889
38391
|
type: object
|
38392
|
+
TeamOnCallResponders:
|
38393
|
+
description: Root object representing a team's on-call responder configuration.
|
38394
|
+
example:
|
38395
|
+
data:
|
38396
|
+
id: 111ee23r-aaaaa-aaaa-aaww-1234wertsd23
|
38397
|
+
relationships:
|
38398
|
+
escalations:
|
38399
|
+
data:
|
38400
|
+
- id: 111ee23r-aaaaa-aaaa-aaww-1234wertsd23
|
38401
|
+
type: escalation_policy_steps
|
38402
|
+
responders:
|
38403
|
+
data:
|
38404
|
+
- id: 111ee23r-aaaaa-aaaa-aaww-1234wertsd23
|
38405
|
+
type: users
|
38406
|
+
type: team_oncall_responders
|
38407
|
+
included:
|
38408
|
+
- attributes:
|
38409
|
+
email: test@test.com
|
38410
|
+
name: Test User
|
38411
|
+
status: active
|
38412
|
+
id: 111ee23r-aaaaa-aaaa-aaww-1234wertsd23
|
38413
|
+
type: users
|
38414
|
+
- id: 111ee23r-aaaaa-aaaa-aaww-1234wertsd23
|
38415
|
+
relationships:
|
38416
|
+
responders:
|
38417
|
+
data:
|
38418
|
+
- id: 111ee23r-aaaaa-aaaa-aaww-1234wertsd23
|
38419
|
+
type: users
|
38420
|
+
type: escalation_policy_steps
|
38421
|
+
properties:
|
38422
|
+
data:
|
38423
|
+
$ref: '#/components/schemas/TeamOnCallRespondersData'
|
38424
|
+
included:
|
38425
|
+
description: The `TeamOnCallResponders` `included`.
|
38426
|
+
items:
|
38427
|
+
$ref: '#/components/schemas/TeamOnCallRespondersIncluded'
|
38428
|
+
type: array
|
38429
|
+
type: object
|
38430
|
+
TeamOnCallRespondersData:
|
38431
|
+
description: Defines the main on-call responder object for a team, including
|
38432
|
+
relationships and metadata.
|
38433
|
+
properties:
|
38434
|
+
id:
|
38435
|
+
description: Unique identifier of the on-call responder configuration.
|
38436
|
+
type: string
|
38437
|
+
relationships:
|
38438
|
+
$ref: '#/components/schemas/TeamOnCallRespondersDataRelationships'
|
38439
|
+
type:
|
38440
|
+
$ref: '#/components/schemas/TeamOnCallRespondersDataType'
|
38441
|
+
required:
|
38442
|
+
- type
|
38443
|
+
type: object
|
38444
|
+
TeamOnCallRespondersDataRelationships:
|
38445
|
+
description: Relationship objects linked to a team's on-call responder configuration,
|
38446
|
+
including escalations and responders.
|
38447
|
+
properties:
|
38448
|
+
escalations:
|
38449
|
+
$ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsEscalations'
|
38450
|
+
responders:
|
38451
|
+
$ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsResponders'
|
38452
|
+
type: object
|
38453
|
+
TeamOnCallRespondersDataRelationshipsEscalations:
|
38454
|
+
description: Defines the escalation policy steps linked to the team's on-call
|
38455
|
+
configuration.
|
38456
|
+
properties:
|
38457
|
+
data:
|
38458
|
+
description: Array of escalation step references.
|
38459
|
+
items:
|
38460
|
+
$ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsEscalationsDataItems'
|
38461
|
+
type: array
|
38462
|
+
type: object
|
38463
|
+
TeamOnCallRespondersDataRelationshipsEscalationsDataItems:
|
38464
|
+
description: Represents a link to a specific escalation policy step associated
|
38465
|
+
with the on-call team.
|
38466
|
+
properties:
|
38467
|
+
id:
|
38468
|
+
description: Unique identifier of the escalation step.
|
38469
|
+
example: ''
|
38470
|
+
type: string
|
38471
|
+
type:
|
38472
|
+
$ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsEscalationsDataItemsType'
|
38473
|
+
required:
|
38474
|
+
- type
|
38475
|
+
- id
|
38476
|
+
type: object
|
38477
|
+
TeamOnCallRespondersDataRelationshipsEscalationsDataItemsType:
|
38478
|
+
default: escalation_policy_steps
|
38479
|
+
description: Identifies the resource type for escalation policy steps linked
|
38480
|
+
to a team's on-call configuration.
|
38481
|
+
enum:
|
38482
|
+
- escalation_policy_steps
|
38483
|
+
example: escalation_policy_steps
|
38484
|
+
type: string
|
38485
|
+
x-enum-varnames:
|
38486
|
+
- ESCALATION_POLICY_STEPS
|
38487
|
+
TeamOnCallRespondersDataRelationshipsResponders:
|
38488
|
+
description: Defines the list of users assigned as on-call responders for the
|
38489
|
+
team.
|
38490
|
+
properties:
|
38491
|
+
data:
|
38492
|
+
description: Array of user references associated as responders.
|
38493
|
+
items:
|
38494
|
+
$ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsRespondersDataItems'
|
38495
|
+
type: array
|
38496
|
+
type: object
|
38497
|
+
TeamOnCallRespondersDataRelationshipsRespondersDataItems:
|
38498
|
+
description: Represents a user responder associated with the on-call team.
|
38499
|
+
properties:
|
38500
|
+
id:
|
38501
|
+
description: Unique identifier of the responder.
|
38502
|
+
example: ''
|
38503
|
+
type: string
|
38504
|
+
type:
|
38505
|
+
$ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsRespondersDataItemsType'
|
38506
|
+
required:
|
38507
|
+
- type
|
38508
|
+
- id
|
38509
|
+
type: object
|
38510
|
+
TeamOnCallRespondersDataRelationshipsRespondersDataItemsType:
|
38511
|
+
default: users
|
38512
|
+
description: Identifies the resource type for individual user entities associated
|
38513
|
+
with on-call response.
|
38514
|
+
enum:
|
38515
|
+
- users
|
38516
|
+
example: users
|
38517
|
+
type: string
|
38518
|
+
x-enum-varnames:
|
38519
|
+
- USERS
|
38520
|
+
TeamOnCallRespondersDataType:
|
38521
|
+
default: team_oncall_responders
|
38522
|
+
description: Represents the resource type for a group of users assigned to handle
|
38523
|
+
on-call duties within a team.
|
38524
|
+
enum:
|
38525
|
+
- team_oncall_responders
|
38526
|
+
example: team_oncall_responders
|
38527
|
+
type: string
|
38528
|
+
x-enum-varnames:
|
38529
|
+
- TEAM_ONCALL_RESPONDERS
|
38530
|
+
TeamOnCallRespondersIncluded:
|
38531
|
+
description: Represents an union of related resources included in the response,
|
38532
|
+
such as users and escalation steps.
|
38533
|
+
oneOf:
|
38534
|
+
- $ref: '#/components/schemas/User'
|
38535
|
+
- $ref: '#/components/schemas/Escalation'
|
37890
38536
|
TeamPermissionSetting:
|
37891
38537
|
description: Team permission setting
|
37892
38538
|
properties:
|
@@ -39205,6 +39851,19 @@ components:
|
|
39205
39851
|
description: Upsert entity response included item.
|
39206
39852
|
oneOf:
|
39207
39853
|
- $ref: '#/components/schemas/EntityResponseIncludedSchema'
|
39854
|
+
UpsertCatalogKindRequest:
|
39855
|
+
description: Create or update kind request.
|
39856
|
+
oneOf:
|
39857
|
+
- $ref: '#/components/schemas/KindObj'
|
39858
|
+
- $ref: '#/components/schemas/KindRaw'
|
39859
|
+
UpsertCatalogKindResponse:
|
39860
|
+
description: Upsert kind response.
|
39861
|
+
properties:
|
39862
|
+
data:
|
39863
|
+
$ref: '#/components/schemas/KindResponseData'
|
39864
|
+
meta:
|
39865
|
+
$ref: '#/components/schemas/KindResponseMeta'
|
39866
|
+
type: object
|
39208
39867
|
Urgency:
|
39209
39868
|
description: Specifies the level of urgency for a routing rule (low, high, or
|
39210
39869
|
dynamic).
|
@@ -40661,6 +41320,7 @@ components:
|
|
40661
41320
|
appsec_vm_read: View infrastructure, application code, and library vulnerabilities.
|
40662
41321
|
This does not restrict API or inventory SQL access to the vulnerability
|
40663
41322
|
data source.
|
41323
|
+
billing_read: View your organization's billing information.
|
40664
41324
|
cases_read: View Cases.
|
40665
41325
|
cases_write: Create and update cases.
|
40666
41326
|
ci_visibility_pipelines_write: Create CI Visibility pipeline spans using
|
@@ -43442,6 +44102,105 @@ paths:
|
|
43442
44102
|
summary: Delete a single entity
|
43443
44103
|
tags:
|
43444
44104
|
- Software Catalog
|
44105
|
+
/api/v2/catalog/kind:
|
44106
|
+
get:
|
44107
|
+
description: Get a list of entity kinds from Software Catalog.
|
44108
|
+
operationId: ListCatalogKind
|
44109
|
+
parameters:
|
44110
|
+
- $ref: '#/components/parameters/PageOffset'
|
44111
|
+
- description: Maximum number of kinds in the response.
|
44112
|
+
example: 100
|
44113
|
+
in: query
|
44114
|
+
name: page[limit]
|
44115
|
+
required: false
|
44116
|
+
schema:
|
44117
|
+
default: 100
|
44118
|
+
format: int64
|
44119
|
+
type: integer
|
44120
|
+
- $ref: '#/components/parameters/FilterByID'
|
44121
|
+
- $ref: '#/components/parameters/FilterByName'
|
44122
|
+
responses:
|
44123
|
+
'200':
|
44124
|
+
content:
|
44125
|
+
application/json:
|
44126
|
+
schema:
|
44127
|
+
$ref: '#/components/schemas/ListKindCatalogResponse'
|
44128
|
+
description: OK
|
44129
|
+
'400':
|
44130
|
+
$ref: '#/components/responses/BadRequestResponse'
|
44131
|
+
'403':
|
44132
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
44133
|
+
'429':
|
44134
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
44135
|
+
security:
|
44136
|
+
- apiKeyAuth: []
|
44137
|
+
appKeyAuth: []
|
44138
|
+
- AuthZ:
|
44139
|
+
- apm_service_catalog_read
|
44140
|
+
summary: Get a list of entity kinds
|
44141
|
+
tags:
|
44142
|
+
- Software Catalog
|
44143
|
+
x-pagination:
|
44144
|
+
limitParam: page[limit]
|
44145
|
+
pageOffsetParam: page[offset]
|
44146
|
+
resultsPath: data
|
44147
|
+
post:
|
44148
|
+
description: Create or update kinds in Software Catalog.
|
44149
|
+
operationId: UpsertCatalogKind
|
44150
|
+
requestBody:
|
44151
|
+
content:
|
44152
|
+
application/json:
|
44153
|
+
schema:
|
44154
|
+
$ref: '#/components/schemas/UpsertCatalogKindRequest'
|
44155
|
+
description: Kind YAML or JSON.
|
44156
|
+
required: true
|
44157
|
+
responses:
|
44158
|
+
'202':
|
44159
|
+
content:
|
44160
|
+
application/json:
|
44161
|
+
schema:
|
44162
|
+
$ref: '#/components/schemas/UpsertCatalogKindResponse'
|
44163
|
+
description: ACCEPTED
|
44164
|
+
'400':
|
44165
|
+
$ref: '#/components/responses/BadRequestResponse'
|
44166
|
+
'403':
|
44167
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
44168
|
+
'429':
|
44169
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
44170
|
+
security:
|
44171
|
+
- apiKeyAuth: []
|
44172
|
+
appKeyAuth: []
|
44173
|
+
- AuthZ:
|
44174
|
+
- apm_service_catalog_write
|
44175
|
+
summary: Create or update kinds
|
44176
|
+
tags:
|
44177
|
+
- Software Catalog
|
44178
|
+
x-codegen-request-body-name: body
|
44179
|
+
/api/v2/catalog/kind/{kind_id}:
|
44180
|
+
delete:
|
44181
|
+
description: Delete a single kind in Software Catalog.
|
44182
|
+
operationId: DeleteCatalogKind
|
44183
|
+
parameters:
|
44184
|
+
- $ref: '#/components/parameters/KindID'
|
44185
|
+
responses:
|
44186
|
+
'204':
|
44187
|
+
description: OK
|
44188
|
+
'400':
|
44189
|
+
$ref: '#/components/responses/BadRequestResponse'
|
44190
|
+
'403':
|
44191
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
44192
|
+
'404':
|
44193
|
+
$ref: '#/components/responses/NotFoundResponse'
|
44194
|
+
'429':
|
44195
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
44196
|
+
security:
|
44197
|
+
- apiKeyAuth: []
|
44198
|
+
appKeyAuth: []
|
44199
|
+
- AuthZ:
|
44200
|
+
- apm_service_catalog_write
|
44201
|
+
summary: Delete a single kind
|
44202
|
+
tags:
|
44203
|
+
- Software Catalog
|
43445
44204
|
/api/v2/catalog/relation:
|
43446
44205
|
get:
|
43447
44206
|
description: Get a list of entity relations from Software Catalog.
|
@@ -44950,13 +45709,15 @@ paths:
|
|
44950
45709
|
appKeyAuth: []
|
44951
45710
|
- AuthZ:
|
44952
45711
|
- usage_read
|
45712
|
+
- billing_read
|
44953
45713
|
summary: Get Monthly Cost Attribution
|
44954
45714
|
tags:
|
44955
45715
|
- Usage Metering
|
44956
45716
|
x-permission:
|
44957
|
-
operator:
|
45717
|
+
operator: AND
|
44958
45718
|
permissions:
|
44959
45719
|
- usage_read
|
45720
|
+
- billing_read
|
44960
45721
|
/api/v2/csm/onboarding/agents:
|
44961
45722
|
get:
|
44962
45723
|
description: Get the list of all CSM Agents running on your hosts and containers.
|
@@ -45794,9 +46555,6 @@ paths:
|
|
45794
46555
|
tags:
|
45795
46556
|
- DORA Metrics
|
45796
46557
|
x-codegen-request-body-name: body
|
45797
|
-
x-unstable: '**Note**: This endpoint is in public beta.
|
45798
|
-
|
45799
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
45800
46558
|
/api/v2/dora/deployments:
|
45801
46559
|
post:
|
45802
46560
|
description: Use this API endpoint to get a list of deployment events.
|
@@ -45874,6 +46632,52 @@ paths:
|
|
45874
46632
|
operator: OR
|
45875
46633
|
permissions:
|
45876
46634
|
- dora_metrics_read
|
46635
|
+
/api/v2/dora/failure:
|
46636
|
+
post:
|
46637
|
+
description: 'Use this API endpoint to provide failure data for DORA metrics.
|
46638
|
+
|
46639
|
+
|
46640
|
+
This is necessary for:
|
46641
|
+
|
46642
|
+
- Change Failure Rate
|
46643
|
+
|
46644
|
+
- Time to Restore'
|
46645
|
+
operationId: CreateDORAFailure
|
46646
|
+
requestBody:
|
46647
|
+
content:
|
46648
|
+
application/json:
|
46649
|
+
schema:
|
46650
|
+
$ref: '#/components/schemas/DORAFailureRequest'
|
46651
|
+
required: true
|
46652
|
+
responses:
|
46653
|
+
'200':
|
46654
|
+
content:
|
46655
|
+
application/json:
|
46656
|
+
schema:
|
46657
|
+
$ref: '#/components/schemas/DORAFailureResponse'
|
46658
|
+
description: OK
|
46659
|
+
'202':
|
46660
|
+
content:
|
46661
|
+
application/json:
|
46662
|
+
schema:
|
46663
|
+
$ref: '#/components/schemas/DORAFailureResponse'
|
46664
|
+
description: OK - but delayed due to incident
|
46665
|
+
'400':
|
46666
|
+
content:
|
46667
|
+
application/json:
|
46668
|
+
schema:
|
46669
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
46670
|
+
description: Bad Request
|
46671
|
+
'403':
|
46672
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
46673
|
+
'429':
|
46674
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
46675
|
+
security:
|
46676
|
+
- apiKeyAuth: []
|
46677
|
+
summary: Send a failure event for DORA Metrics
|
46678
|
+
tags:
|
46679
|
+
- DORA Metrics
|
46680
|
+
x-codegen-request-body-name: body
|
45877
46681
|
/api/v2/dora/failures:
|
45878
46682
|
post:
|
45879
46683
|
description: Use this API endpoint to get a list of failure events.
|
@@ -45953,7 +46757,12 @@ paths:
|
|
45953
46757
|
- dora_metrics_read
|
45954
46758
|
/api/v2/dora/incident:
|
45955
46759
|
post:
|
45956
|
-
|
46760
|
+
deprecated: true
|
46761
|
+
description: '**Note**: This endpoint is deprecated. Please use `/api/v2/dora/failure`
|
46762
|
+
instead.
|
46763
|
+
|
46764
|
+
|
46765
|
+
Use this API endpoint to provide failure data for DORA metrics.
|
45957
46766
|
|
45958
46767
|
|
45959
46768
|
This is necessary for:
|
@@ -45966,20 +46775,20 @@ paths:
|
|
45966
46775
|
content:
|
45967
46776
|
application/json:
|
45968
46777
|
schema:
|
45969
|
-
$ref: '#/components/schemas/
|
46778
|
+
$ref: '#/components/schemas/DORAFailureRequest'
|
45970
46779
|
required: true
|
45971
46780
|
responses:
|
45972
46781
|
'200':
|
45973
46782
|
content:
|
45974
46783
|
application/json:
|
45975
46784
|
schema:
|
45976
|
-
$ref: '#/components/schemas/
|
46785
|
+
$ref: '#/components/schemas/DORAFailureResponse'
|
45977
46786
|
description: OK
|
45978
46787
|
'202':
|
45979
46788
|
content:
|
45980
46789
|
application/json:
|
45981
46790
|
schema:
|
45982
|
-
$ref: '#/components/schemas/
|
46791
|
+
$ref: '#/components/schemas/DORAFailureResponse'
|
45983
46792
|
description: OK - but delayed due to incident
|
45984
46793
|
'400':
|
45985
46794
|
content:
|
@@ -45997,9 +46806,6 @@ paths:
|
|
45997
46806
|
tags:
|
45998
46807
|
- DORA Metrics
|
45999
46808
|
x-codegen-request-body-name: body
|
46000
|
-
x-unstable: '**Note**: This endpoint is in public beta.
|
46001
|
-
|
46002
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
46003
46809
|
/api/v2/downtime:
|
46004
46810
|
get:
|
46005
46811
|
description: Get all scheduled downtimes.
|
@@ -52469,6 +53275,48 @@ paths:
|
|
52469
53275
|
summary: Get the schedule on-call user
|
52470
53276
|
tags:
|
52471
53277
|
- On-Call
|
53278
|
+
/api/v2/on-call/teams/{team_id}/on-call:
|
53279
|
+
get:
|
53280
|
+
description: Get a team's on-call users at a given time
|
53281
|
+
operationId: GetTeamOnCallUsers
|
53282
|
+
parameters:
|
53283
|
+
- description: 'Comma-separated list of included relationships to be returned.
|
53284
|
+
Allowed values: `responders`, `escalations`, `escalations.responders`.'
|
53285
|
+
in: query
|
53286
|
+
name: include
|
53287
|
+
schema:
|
53288
|
+
type: string
|
53289
|
+
- description: The team ID
|
53290
|
+
in: path
|
53291
|
+
name: team_id
|
53292
|
+
required: true
|
53293
|
+
schema:
|
53294
|
+
example: 27590dae-47be-4a7d-9abf-8f4e45124020
|
53295
|
+
type: string
|
53296
|
+
responses:
|
53297
|
+
'200':
|
53298
|
+
content:
|
53299
|
+
application/json:
|
53300
|
+
schema:
|
53301
|
+
$ref: '#/components/schemas/TeamOnCallResponders'
|
53302
|
+
description: OK
|
53303
|
+
'400':
|
53304
|
+
$ref: '#/components/responses/BadRequestResponse'
|
53305
|
+
'401':
|
53306
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
53307
|
+
'403':
|
53308
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
53309
|
+
'404':
|
53310
|
+
$ref: '#/components/responses/NotFoundResponse'
|
53311
|
+
'429':
|
53312
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
53313
|
+
security:
|
53314
|
+
- apiKeyAuth: []
|
53315
|
+
appKeyAuth: []
|
53316
|
+
- AuthZ: []
|
53317
|
+
summary: Get team on-call users
|
53318
|
+
tags:
|
53319
|
+
- On-Call
|
52472
53320
|
/api/v2/on-call/teams/{team_id}/routing-rules:
|
52473
53321
|
get:
|
52474
53322
|
description: Get a team's On-Call routing rules
|
@@ -52695,13 +53543,19 @@ paths:
|
|
52695
53543
|
the equal sign: `filter[evaluation_changed_at]=>=1678809373257`.\n\nQuery
|
52696
53544
|
parameters must be only among the documented ones and with values of correct
|
52697
53545
|
types. Duplicated query parameters (e.g. `filter[status]=low&filter[status]=info`)
|
52698
|
-
are not allowed.\n\n###
|
52699
|
-
|
52700
|
-
|
52701
|
-
|
52702
|
-
|
52703
|
-
|
52704
|
-
|
53546
|
+
are not allowed.\n\n### Additional extension fields\n\nAdditional extension
|
53547
|
+
fields are available for some findings.\n\nThe data is available when you
|
53548
|
+
include the query parameter `?detailed_findings=true` in the request.\n\nThe
|
53549
|
+
following fields are available for findings:\n- `external_id`: The resource
|
53550
|
+
external ID related to the finding.\n- `description`: The description and
|
53551
|
+
remediation steps for the finding.\n- `datadog_link`: The Datadog relative
|
53552
|
+
link for the finding.\n\n### Response\n\nThe response includes an array of
|
53553
|
+
finding objects, pagination metadata, and a count of items that match the
|
53554
|
+
query.\n\nEach finding object contains the following:\n\n- The finding ID
|
53555
|
+
that can be used in a `GetFinding` request to retrieve the full finding details.\n-
|
53556
|
+
Core attributes, including status, evaluation, high-level resource details,
|
53557
|
+
muted state, and rule details.\n- `evaluation_changed_at` and `resource_discovery_date`
|
53558
|
+
time stamps.\n- An array of associated tags.\n"
|
52705
53559
|
operationId: ListFindings
|
52706
53560
|
parameters:
|
52707
53561
|
- description: Limit the number of findings returned. Must be <= 1000.
|
@@ -52804,6 +53658,14 @@ paths:
|
|
52804
53658
|
items:
|
52805
53659
|
$ref: '#/components/schemas/FindingVulnerabilityType'
|
52806
53660
|
type: array
|
53661
|
+
- description: Return additional fields for some findings.
|
53662
|
+
example:
|
53663
|
+
- true
|
53664
|
+
in: query
|
53665
|
+
name: detailed_findings
|
53666
|
+
required: false
|
53667
|
+
schema:
|
53668
|
+
type: boolean
|
52807
53669
|
responses:
|
52808
53670
|
'200':
|
52809
53671
|
content:
|
@@ -54215,6 +55077,8 @@ paths:
|
|
54215
55077
|
|
54216
55078
|
- Connection Groups: `connection-group`
|
54217
55079
|
|
55080
|
+
- RUM Applications: `rum-application`
|
55081
|
+
|
54218
55082
|
|
54219
55083
|
#### Supported relations for resources
|
54220
55084
|
|
@@ -54254,7 +55118,9 @@ paths:
|
|
54254
55118
|
|
54255
55119
|
Connections | `viewer`, `resolver`, `editor`
|
54256
55120
|
|
54257
|
-
Connection Groups | `viewer`, `editor`
|
55121
|
+
Connection Groups | `viewer`, `editor`
|
55122
|
+
|
55123
|
+
RUM Application | `viewer`, `editor`'
|
54258
55124
|
operationId: UpdateRestrictionPolicy
|
54259
55125
|
parameters:
|
54260
55126
|
- $ref: '#/components/parameters/ResourceID'
|
@@ -59781,6 +60647,156 @@ paths:
|
|
59781
60647
|
permissions:
|
59782
60648
|
- teams_read
|
59783
60649
|
- teams_manage
|
60650
|
+
/api/v2/team/{super_team_id}/member_teams:
|
60651
|
+
get:
|
60652
|
+
description: Get all member teams.
|
60653
|
+
operationId: ListMemberTeams
|
60654
|
+
parameters:
|
60655
|
+
- description: None
|
60656
|
+
in: path
|
60657
|
+
name: super_team_id
|
60658
|
+
required: true
|
60659
|
+
schema:
|
60660
|
+
type: string
|
60661
|
+
- $ref: '#/components/parameters/PageSize'
|
60662
|
+
- $ref: '#/components/parameters/PageNumber'
|
60663
|
+
- description: List of fields that need to be fetched.
|
60664
|
+
explode: false
|
60665
|
+
in: query
|
60666
|
+
name: fields[team]
|
60667
|
+
required: false
|
60668
|
+
schema:
|
60669
|
+
items:
|
60670
|
+
$ref: '#/components/schemas/TeamsField'
|
60671
|
+
type: array
|
60672
|
+
responses:
|
60673
|
+
'200':
|
60674
|
+
content:
|
60675
|
+
application/json:
|
60676
|
+
schema:
|
60677
|
+
$ref: '#/components/schemas/TeamsResponse'
|
60678
|
+
description: OK
|
60679
|
+
'403':
|
60680
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
60681
|
+
'404':
|
60682
|
+
content:
|
60683
|
+
application/json:
|
60684
|
+
schema:
|
60685
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
60686
|
+
description: API error response.
|
60687
|
+
'429':
|
60688
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
60689
|
+
security:
|
60690
|
+
- apiKeyAuth: []
|
60691
|
+
appKeyAuth: []
|
60692
|
+
- AuthZ:
|
60693
|
+
- teams_read
|
60694
|
+
summary: Get all member teams
|
60695
|
+
tags:
|
60696
|
+
- Teams
|
60697
|
+
x-pagination:
|
60698
|
+
limitParam: page[size]
|
60699
|
+
pageParam: page[number]
|
60700
|
+
resultsPath: data
|
60701
|
+
x-permission:
|
60702
|
+
operator: OR
|
60703
|
+
permissions:
|
60704
|
+
- teams_read
|
60705
|
+
x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback,
|
60706
|
+
|
60707
|
+
contact [Datadog support](https://docs.datadoghq.com/help/).'
|
60708
|
+
post:
|
60709
|
+
description: 'Add a member team.
|
60710
|
+
|
60711
|
+
Adds the team given by the `id` in the body as a member team of the super
|
60712
|
+
team.'
|
60713
|
+
operationId: AddMemberTeam
|
60714
|
+
parameters:
|
60715
|
+
- description: None
|
60716
|
+
in: path
|
60717
|
+
name: super_team_id
|
60718
|
+
required: true
|
60719
|
+
schema:
|
60720
|
+
type: string
|
60721
|
+
requestBody:
|
60722
|
+
content:
|
60723
|
+
application/json:
|
60724
|
+
schema:
|
60725
|
+
$ref: '#/components/schemas/AddMemberTeamRequest'
|
60726
|
+
required: true
|
60727
|
+
responses:
|
60728
|
+
'204':
|
60729
|
+
description: Added
|
60730
|
+
'403':
|
60731
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
60732
|
+
'409':
|
60733
|
+
content:
|
60734
|
+
application/json:
|
60735
|
+
schema:
|
60736
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
60737
|
+
description: API error response.
|
60738
|
+
'429':
|
60739
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
60740
|
+
security:
|
60741
|
+
- apiKeyAuth: []
|
60742
|
+
appKeyAuth: []
|
60743
|
+
- AuthZ:
|
60744
|
+
- teams_read
|
60745
|
+
summary: Add a member team
|
60746
|
+
tags:
|
60747
|
+
- Teams
|
60748
|
+
x-permission:
|
60749
|
+
operator: OR
|
60750
|
+
permissions:
|
60751
|
+
- teams_read
|
60752
|
+
x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback,
|
60753
|
+
|
60754
|
+
contact [Datadog support](https://docs.datadoghq.com/help/).'
|
60755
|
+
/api/v2/team/{super_team_id}/member_teams/{member_team_id}:
|
60756
|
+
delete:
|
60757
|
+
description: Remove a super team's member team identified by `member_team_id`.
|
60758
|
+
operationId: RemoveMemberTeam
|
60759
|
+
parameters:
|
60760
|
+
- description: None
|
60761
|
+
in: path
|
60762
|
+
name: super_team_id
|
60763
|
+
required: true
|
60764
|
+
schema:
|
60765
|
+
type: string
|
60766
|
+
- description: None
|
60767
|
+
in: path
|
60768
|
+
name: member_team_id
|
60769
|
+
required: true
|
60770
|
+
schema:
|
60771
|
+
type: string
|
60772
|
+
responses:
|
60773
|
+
'204':
|
60774
|
+
description: No Content
|
60775
|
+
'403':
|
60776
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
60777
|
+
'404':
|
60778
|
+
content:
|
60779
|
+
application/json:
|
60780
|
+
schema:
|
60781
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
60782
|
+
description: API error response.
|
60783
|
+
'429':
|
60784
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
60785
|
+
security:
|
60786
|
+
- apiKeyAuth: []
|
60787
|
+
appKeyAuth: []
|
60788
|
+
- AuthZ:
|
60789
|
+
- teams_read
|
60790
|
+
summary: Remove a member team
|
60791
|
+
tags:
|
60792
|
+
- Teams
|
60793
|
+
x-permission:
|
60794
|
+
operator: OR
|
60795
|
+
permissions:
|
60796
|
+
- teams_read
|
60797
|
+
x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback,
|
60798
|
+
|
60799
|
+
contact [Datadog support](https://docs.datadoghq.com/help/).'
|
59784
60800
|
/api/v2/team/{team_id}:
|
59785
60801
|
delete:
|
59786
60802
|
description: Remove a team using the team's `id`.
|
@@ -60843,13 +61859,15 @@ paths:
|
|
60843
61859
|
appKeyAuth: []
|
60844
61860
|
- AuthZ:
|
60845
61861
|
- usage_read
|
61862
|
+
- billing_read
|
60846
61863
|
summary: Get cost across multi-org account
|
60847
61864
|
tags:
|
60848
61865
|
- Usage Metering
|
60849
61866
|
x-permission:
|
60850
|
-
operator:
|
61867
|
+
operator: AND
|
60851
61868
|
permissions:
|
60852
61869
|
- usage_read
|
61870
|
+
- billing_read
|
60853
61871
|
/api/v2/usage/estimated_cost:
|
60854
61872
|
get:
|
60855
61873
|
description: 'Get estimated cost across multi-org and single root-org accounts.
|
@@ -60947,13 +61965,15 @@ paths:
|
|
60947
61965
|
appKeyAuth: []
|
60948
61966
|
- AuthZ:
|
60949
61967
|
- usage_read
|
61968
|
+
- billing_read
|
60950
61969
|
summary: Get estimated cost across your account
|
60951
61970
|
tags:
|
60952
61971
|
- Usage Metering
|
60953
61972
|
x-permission:
|
60954
|
-
operator:
|
61973
|
+
operator: AND
|
60955
61974
|
permissions:
|
60956
61975
|
- usage_read
|
61976
|
+
- billing_read
|
60957
61977
|
/api/v2/usage/historical_cost:
|
60958
61978
|
get:
|
60959
61979
|
description: 'Get historical cost across multi-org and single root-org accounts.
|
@@ -61028,13 +62048,15 @@ paths:
|
|
61028
62048
|
appKeyAuth: []
|
61029
62049
|
- AuthZ:
|
61030
62050
|
- usage_read
|
62051
|
+
- billing_read
|
61031
62052
|
summary: Get historical cost across your account
|
61032
62053
|
tags:
|
61033
62054
|
- Usage Metering
|
61034
62055
|
x-permission:
|
61035
|
-
operator:
|
62056
|
+
operator: AND
|
61036
62057
|
permissions:
|
61037
62058
|
- usage_read
|
62059
|
+
- billing_read
|
61038
62060
|
/api/v2/usage/hourly_usage:
|
61039
62061
|
get:
|
61040
62062
|
description: Get hourly usage by product family.
|
@@ -61362,13 +62384,15 @@ paths:
|
|
61362
62384
|
appKeyAuth: []
|
61363
62385
|
- AuthZ:
|
61364
62386
|
- usage_read
|
62387
|
+
- billing_read
|
61365
62388
|
summary: Get projected cost across your account
|
61366
62389
|
tags:
|
61367
62390
|
- Usage Metering
|
61368
62391
|
x-permission:
|
61369
|
-
operator:
|
62392
|
+
operator: AND
|
61370
62393
|
permissions:
|
61371
62394
|
- usage_read
|
62395
|
+
- billing_read
|
61372
62396
|
/api/v2/user_invitations:
|
61373
62397
|
post:
|
61374
62398
|
description: Sends emails to one or more users inviting them to join the organization.
|