datadog_api_client 2.34.0 → 2.35.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 -3
- data/.generator/schemas/v2/openapi.yaml +738 -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 +19 -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 +32 -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/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/lib/datadog_api_client/configuration.rb +0 -2
- data/lib/datadog_api_client/inflector.rb +34 -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_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/models/action_query_spec_inputs.rb +1 -1
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_action.rb +23 -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/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_incident_response.rb → dora_failure_response.rb} +5 -5
- 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/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 +44 -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
|
@@ -7526,6 +7534,50 @@ components:
|
|
7526
7534
|
type: string
|
7527
7535
|
kill:
|
7528
7536
|
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleKill'
|
7537
|
+
metadata:
|
7538
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActionMetadata'
|
7539
|
+
set:
|
7540
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActionSet'
|
7541
|
+
type: object
|
7542
|
+
CloudWorkloadSecurityAgentRuleActionMetadata:
|
7543
|
+
description: The metadata action applied on the scope matching the rule
|
7544
|
+
properties:
|
7545
|
+
image_tag:
|
7546
|
+
description: The image tag of the metadata action
|
7547
|
+
type: string
|
7548
|
+
service:
|
7549
|
+
description: The service of the metadata action
|
7550
|
+
type: string
|
7551
|
+
short_image:
|
7552
|
+
description: The short image of the metadata action
|
7553
|
+
type: string
|
7554
|
+
type: object
|
7555
|
+
CloudWorkloadSecurityAgentRuleActionSet:
|
7556
|
+
description: The set action applied on the scope matching the rule
|
7557
|
+
properties:
|
7558
|
+
append:
|
7559
|
+
description: Whether the value should be appended to the field
|
7560
|
+
type: boolean
|
7561
|
+
field:
|
7562
|
+
description: The field of the set action
|
7563
|
+
type: string
|
7564
|
+
name:
|
7565
|
+
description: The name of the set action
|
7566
|
+
type: string
|
7567
|
+
scope:
|
7568
|
+
description: The scope of the set action
|
7569
|
+
type: string
|
7570
|
+
size:
|
7571
|
+
description: The size of the set action
|
7572
|
+
format: int64
|
7573
|
+
type: integer
|
7574
|
+
ttl:
|
7575
|
+
description: The time to live of the set action
|
7576
|
+
format: int64
|
7577
|
+
type: integer
|
7578
|
+
value:
|
7579
|
+
description: The value of the set action
|
7580
|
+
type: string
|
7529
7581
|
type: object
|
7530
7582
|
CloudWorkloadSecurityAgentRuleActions:
|
7531
7583
|
description: The array of actions the rule can perform if triggered
|
@@ -7541,6 +7593,11 @@ components:
|
|
7541
7593
|
agentConstraint:
|
7542
7594
|
description: The version of the Agent
|
7543
7595
|
type: string
|
7596
|
+
blocking:
|
7597
|
+
description: The blocking policies that the rule belongs to
|
7598
|
+
items:
|
7599
|
+
type: string
|
7600
|
+
type: array
|
7544
7601
|
category:
|
7545
7602
|
description: The category of the Agent rule
|
7546
7603
|
example: Process Activity
|
@@ -7564,6 +7621,11 @@ components:
|
|
7564
7621
|
description: The description of the Agent rule
|
7565
7622
|
example: My Agent rule
|
7566
7623
|
type: string
|
7624
|
+
disabled:
|
7625
|
+
description: The disabled policies that the rule belongs to
|
7626
|
+
items:
|
7627
|
+
type: string
|
7628
|
+
type: array
|
7567
7629
|
enabled:
|
7568
7630
|
description: Whether the Agent rule is enabled
|
7569
7631
|
example: true
|
@@ -7577,6 +7639,11 @@ components:
|
|
7577
7639
|
items:
|
7578
7640
|
type: string
|
7579
7641
|
type: array
|
7642
|
+
monitoring:
|
7643
|
+
description: The monitoring policies that the rule belongs to
|
7644
|
+
items:
|
7645
|
+
type: string
|
7646
|
+
type: array
|
7580
7647
|
name:
|
7581
7648
|
description: The name of the Agent rule
|
7582
7649
|
example: my_agent_rule
|
@@ -7611,10 +7678,22 @@ components:
|
|
7611
7678
|
CloudWorkloadSecurityAgentRuleCreateAttributes:
|
7612
7679
|
description: Create a new Cloud Workload Security Agent rule.
|
7613
7680
|
properties:
|
7681
|
+
actions:
|
7682
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActions'
|
7683
|
+
blocking:
|
7684
|
+
description: The blocking policies that the rule belongs to
|
7685
|
+
items:
|
7686
|
+
type: string
|
7687
|
+
type: array
|
7614
7688
|
description:
|
7615
7689
|
description: The description of the Agent rule.
|
7616
7690
|
example: My Agent rule
|
7617
7691
|
type: string
|
7692
|
+
disabled:
|
7693
|
+
description: The disabled policies that the rule belongs to
|
7694
|
+
items:
|
7695
|
+
type: string
|
7696
|
+
type: array
|
7618
7697
|
enabled:
|
7619
7698
|
description: Whether the Agent rule is enabled
|
7620
7699
|
example: true
|
@@ -7628,6 +7707,11 @@ components:
|
|
7628
7707
|
items:
|
7629
7708
|
type: string
|
7630
7709
|
type: array
|
7710
|
+
monitoring:
|
7711
|
+
description: The monitoring policies that the rule belongs to
|
7712
|
+
items:
|
7713
|
+
type: string
|
7714
|
+
type: array
|
7631
7715
|
name:
|
7632
7716
|
description: The name of the Agent rule.
|
7633
7717
|
example: my_agent_rule
|
@@ -7718,10 +7802,22 @@ components:
|
|
7718
7802
|
CloudWorkloadSecurityAgentRuleUpdateAttributes:
|
7719
7803
|
description: Update an existing Cloud Workload Security Agent rule
|
7720
7804
|
properties:
|
7805
|
+
actions:
|
7806
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActions'
|
7807
|
+
blocking:
|
7808
|
+
description: The blocking policies that the rule belongs to
|
7809
|
+
items:
|
7810
|
+
type: string
|
7811
|
+
type: array
|
7721
7812
|
description:
|
7722
7813
|
description: The description of the Agent rule
|
7723
7814
|
example: My Agent rule
|
7724
7815
|
type: string
|
7816
|
+
disabled:
|
7817
|
+
description: The disabled policies that the rule belongs to
|
7818
|
+
items:
|
7819
|
+
type: string
|
7820
|
+
type: array
|
7725
7821
|
enabled:
|
7726
7822
|
description: Whether the Agent rule is enabled
|
7727
7823
|
example: true
|
@@ -7730,6 +7826,11 @@ components:
|
|
7730
7826
|
description: The SECL expression of the Agent rule
|
7731
7827
|
example: exec.file.name == "sh"
|
7732
7828
|
type: string
|
7829
|
+
monitoring:
|
7830
|
+
description: The monitoring policies that the rule belongs to
|
7831
|
+
items:
|
7832
|
+
type: string
|
7833
|
+
type: array
|
7733
7834
|
policy_id:
|
7734
7835
|
description: The ID of the policy where the Agent rule is saved
|
7735
7836
|
example: a8c8e364-6556-434d-b798-a4c23de29c0b
|
@@ -10994,6 +11095,17 @@ components:
|
|
10994
11095
|
- version
|
10995
11096
|
- name
|
10996
11097
|
type: object
|
11098
|
+
DORACustomTags:
|
11099
|
+
description: A list of user-defined tags. The tags must follow the `key:value`
|
11100
|
+
pattern. Up to 100 may be added per event.
|
11101
|
+
example:
|
11102
|
+
- language:java
|
11103
|
+
- department:engineering
|
11104
|
+
items:
|
11105
|
+
description: Tags in the form of `key:value`.
|
11106
|
+
type: string
|
11107
|
+
nullable: true
|
11108
|
+
type: array
|
10997
11109
|
DORADeploymentRequest:
|
10998
11110
|
description: Request to create a DORA deployment event.
|
10999
11111
|
properties:
|
@@ -11005,6 +11117,8 @@ components:
|
|
11005
11117
|
DORADeploymentRequestAttributes:
|
11006
11118
|
description: Attributes to create a DORA deployment event.
|
11007
11119
|
properties:
|
11120
|
+
custom_tags:
|
11121
|
+
$ref: '#/components/schemas/DORACustomTags'
|
11008
11122
|
env:
|
11009
11123
|
description: Environment name to where the service was deployed.
|
11010
11124
|
example: staging
|
@@ -11096,40 +11210,25 @@ components:
|
|
11096
11210
|
description: The type of the event.
|
11097
11211
|
type: string
|
11098
11212
|
type: object
|
11099
|
-
|
11100
|
-
description:
|
11101
|
-
properties:
|
11102
|
-
data:
|
11103
|
-
$ref: '#/components/schemas/DORAEvent'
|
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.
|
11213
|
+
DORAFailureRequest:
|
11214
|
+
description: Request to create a DORA failure event.
|
11118
11215
|
properties:
|
11119
11216
|
data:
|
11120
|
-
$ref: '#/components/schemas/
|
11217
|
+
$ref: '#/components/schemas/DORAFailureRequestData'
|
11121
11218
|
required:
|
11122
11219
|
- data
|
11123
11220
|
type: object
|
11124
|
-
|
11125
|
-
description: Attributes to create a DORA
|
11221
|
+
DORAFailureRequestAttributes:
|
11222
|
+
description: Attributes to create a DORA failure event.
|
11126
11223
|
properties:
|
11224
|
+
custom_tags:
|
11225
|
+
$ref: '#/components/schemas/DORACustomTags'
|
11127
11226
|
env:
|
11128
|
-
description: Environment name that was impacted by the
|
11227
|
+
description: Environment name that was impacted by the failure.
|
11129
11228
|
example: staging
|
11130
11229
|
type: string
|
11131
11230
|
finished_at:
|
11132
|
-
description: Unix timestamp when the
|
11231
|
+
description: Unix timestamp when the failure finished. It must be in nanoseconds,
|
11133
11232
|
milliseconds, or seconds, and it should not be older than 1 hour.
|
11134
11233
|
example: 1693491984000000000
|
11135
11234
|
format: int64
|
@@ -11137,15 +11236,15 @@ components:
|
|
11137
11236
|
git:
|
11138
11237
|
$ref: '#/components/schemas/DORAGitInfo'
|
11139
11238
|
id:
|
11140
|
-
description:
|
11141
|
-
|
11239
|
+
description: Failure ID. Must have at least 16 characters. Required to update
|
11240
|
+
a previously sent failure.
|
11142
11241
|
type: string
|
11143
11242
|
name:
|
11144
|
-
description:
|
11243
|
+
description: Failure name.
|
11145
11244
|
example: Webserver is down failing all requests.
|
11146
11245
|
type: string
|
11147
11246
|
services:
|
11148
|
-
description: Service names impacted by the
|
11247
|
+
description: Service names impacted by the failure. If possible, use names
|
11149
11248
|
registered in the Service Catalog. Required when the team field is not
|
11150
11249
|
provided.
|
11151
11250
|
example:
|
@@ -11154,11 +11253,11 @@ components:
|
|
11154
11253
|
type: string
|
11155
11254
|
type: array
|
11156
11255
|
severity:
|
11157
|
-
description:
|
11256
|
+
description: Failure severity.
|
11158
11257
|
example: High
|
11159
11258
|
type: string
|
11160
11259
|
started_at:
|
11161
|
-
description: Unix timestamp when the
|
11260
|
+
description: Unix timestamp when the failure started. It must be in nanoseconds,
|
11162
11261
|
milliseconds, or seconds.
|
11163
11262
|
example: 1693491974000000000
|
11164
11263
|
format: int64
|
@@ -11176,43 +11275,60 @@ components:
|
|
11176
11275
|
required:
|
11177
11276
|
- started_at
|
11178
11277
|
type: object
|
11179
|
-
|
11278
|
+
DORAFailureRequestData:
|
11180
11279
|
description: The JSON:API data.
|
11181
11280
|
properties:
|
11182
11281
|
attributes:
|
11183
|
-
$ref: '#/components/schemas/
|
11282
|
+
$ref: '#/components/schemas/DORAFailureRequestAttributes'
|
11184
11283
|
required:
|
11185
11284
|
- attributes
|
11186
11285
|
type: object
|
11187
|
-
|
11188
|
-
description: Response after receiving a DORA
|
11286
|
+
DORAFailureResponse:
|
11287
|
+
description: Response after receiving a DORA failure event.
|
11189
11288
|
properties:
|
11190
11289
|
data:
|
11191
|
-
$ref: '#/components/schemas/
|
11290
|
+
$ref: '#/components/schemas/DORAFailureResponseData'
|
11192
11291
|
required:
|
11193
11292
|
- data
|
11194
11293
|
type: object
|
11195
|
-
|
11196
|
-
description: Response after receiving a DORA
|
11294
|
+
DORAFailureResponseData:
|
11295
|
+
description: Response after receiving a DORA failure event.
|
11197
11296
|
properties:
|
11198
11297
|
id:
|
11199
|
-
description: The ID of the received DORA
|
11298
|
+
description: The ID of the received DORA failure event.
|
11200
11299
|
example: 4242fcdd31586083
|
11201
11300
|
type: string
|
11202
11301
|
type:
|
11203
|
-
$ref: '#/components/schemas/
|
11302
|
+
$ref: '#/components/schemas/DORAFailureType'
|
11204
11303
|
required:
|
11205
11304
|
- id
|
11206
11305
|
type: object
|
11207
|
-
|
11208
|
-
default:
|
11209
|
-
description: JSON:API type for DORA
|
11306
|
+
DORAFailureType:
|
11307
|
+
default: dora_failure
|
11308
|
+
description: JSON:API type for DORA failure events.
|
11210
11309
|
enum:
|
11211
|
-
-
|
11212
|
-
example:
|
11310
|
+
- dora_failure
|
11311
|
+
example: dora_failure
|
11213
11312
|
type: string
|
11214
11313
|
x-enum-varnames:
|
11215
|
-
-
|
11314
|
+
- DORA_FAILURE
|
11315
|
+
DORAFetchResponse:
|
11316
|
+
description: Response for the DORA fetch endpoints.
|
11317
|
+
properties:
|
11318
|
+
data:
|
11319
|
+
$ref: '#/components/schemas/DORAEvent'
|
11320
|
+
type: object
|
11321
|
+
DORAGitInfo:
|
11322
|
+
description: Git info for DORA Metrics events.
|
11323
|
+
properties:
|
11324
|
+
commit_sha:
|
11325
|
+
$ref: '#/components/schemas/GitCommitSHA'
|
11326
|
+
repository_url:
|
11327
|
+
$ref: '#/components/schemas/GitRepositoryURL'
|
11328
|
+
required:
|
11329
|
+
- repository_url
|
11330
|
+
- commit_sha
|
11331
|
+
type: object
|
11216
11332
|
DORAListDeploymentsRequest:
|
11217
11333
|
description: Request to get a list of deployments.
|
11218
11334
|
properties:
|
@@ -13751,6 +13867,19 @@ components:
|
|
13751
13867
|
- retryStrategy
|
13752
13868
|
- fallbackStepName
|
13753
13869
|
type: object
|
13870
|
+
Escalation:
|
13871
|
+
description: Represents an escalation policy step.
|
13872
|
+
properties:
|
13873
|
+
id:
|
13874
|
+
description: Unique identifier of the escalation step.
|
13875
|
+
type: string
|
13876
|
+
relationships:
|
13877
|
+
$ref: '#/components/schemas/EscalationRelationships'
|
13878
|
+
type:
|
13879
|
+
$ref: '#/components/schemas/EscalationType'
|
13880
|
+
required:
|
13881
|
+
- type
|
13882
|
+
type: object
|
13754
13883
|
EscalationPolicy:
|
13755
13884
|
description: Represents a complete escalation policy response, including policy
|
13756
13885
|
data and optionally included related resources.
|
@@ -14260,6 +14389,46 @@ components:
|
|
14260
14389
|
type: string
|
14261
14390
|
x-enum-varnames:
|
14262
14391
|
- USERS
|
14392
|
+
EscalationRelationships:
|
14393
|
+
description: Contains the relationships of an escalation object, including its
|
14394
|
+
responders.
|
14395
|
+
properties:
|
14396
|
+
responders:
|
14397
|
+
$ref: '#/components/schemas/EscalationRelationshipsResponders'
|
14398
|
+
type: object
|
14399
|
+
EscalationRelationshipsResponders:
|
14400
|
+
description: Lists the users involved in a specific step of the escalation policy.
|
14401
|
+
properties:
|
14402
|
+
data:
|
14403
|
+
description: Array of user references assigned as responders for this escalation
|
14404
|
+
step.
|
14405
|
+
items:
|
14406
|
+
$ref: '#/components/schemas/EscalationRelationshipsRespondersDataItems'
|
14407
|
+
type: array
|
14408
|
+
type: object
|
14409
|
+
EscalationRelationshipsRespondersDataItems:
|
14410
|
+
description: Represents a user assigned to an escalation step.
|
14411
|
+
properties:
|
14412
|
+
id:
|
14413
|
+
description: Unique identifier of the user assigned to the escalation step.
|
14414
|
+
example: ''
|
14415
|
+
type: string
|
14416
|
+
type:
|
14417
|
+
$ref: '#/components/schemas/EscalationRelationshipsRespondersDataItemsType'
|
14418
|
+
required:
|
14419
|
+
- type
|
14420
|
+
- id
|
14421
|
+
type: object
|
14422
|
+
EscalationRelationshipsRespondersDataItemsType:
|
14423
|
+
default: users
|
14424
|
+
description: Represents the resource type for users assigned as responders in
|
14425
|
+
an escalation step.
|
14426
|
+
enum:
|
14427
|
+
- users
|
14428
|
+
example: users
|
14429
|
+
type: string
|
14430
|
+
x-enum-varnames:
|
14431
|
+
- USERS
|
14263
14432
|
EscalationTarget:
|
14264
14433
|
description: Represents an escalation target, which can be a team, user, or
|
14265
14434
|
schedule.
|
@@ -14276,6 +14445,16 @@ components:
|
|
14276
14445
|
$ref: '#/components/schemas/EscalationTarget'
|
14277
14446
|
type: array
|
14278
14447
|
type: object
|
14448
|
+
EscalationType:
|
14449
|
+
default: escalation_policy_steps
|
14450
|
+
description: Represents the resource type for individual steps in an escalation
|
14451
|
+
policy used during incident response.
|
14452
|
+
enum:
|
14453
|
+
- escalation_policy_steps
|
14454
|
+
example: escalation_policy_steps
|
14455
|
+
type: string
|
14456
|
+
x-enum-varnames:
|
14457
|
+
- ESCALATION_POLICY_STEPS
|
14279
14458
|
Event:
|
14280
14459
|
description: The metadata associated with a request.
|
14281
14460
|
properties:
|
@@ -15123,10 +15302,16 @@ components:
|
|
15123
15302
|
FindingAttributes:
|
15124
15303
|
description: The JSON:API attributes of the finding.
|
15125
15304
|
properties:
|
15305
|
+
datadog_link:
|
15306
|
+
$ref: '#/components/schemas/FindingDatadogLink'
|
15307
|
+
description:
|
15308
|
+
$ref: '#/components/schemas/FindingDescription'
|
15126
15309
|
evaluation:
|
15127
15310
|
$ref: '#/components/schemas/FindingEvaluation'
|
15128
15311
|
evaluation_changed_at:
|
15129
15312
|
$ref: '#/components/schemas/FindingEvaluationChangedAt'
|
15313
|
+
external_id:
|
15314
|
+
$ref: '#/components/schemas/FindingExternalId'
|
15130
15315
|
mute:
|
15131
15316
|
$ref: '#/components/schemas/FindingMute'
|
15132
15317
|
resource:
|
@@ -15144,6 +15329,22 @@ components:
|
|
15144
15329
|
vulnerability_type:
|
15145
15330
|
$ref: '#/components/schemas/FindingVulnerabilityType'
|
15146
15331
|
type: object
|
15332
|
+
FindingDatadogLink:
|
15333
|
+
description: The Datadog relative link for this finding.
|
15334
|
+
example: /security/compliance?panels=cpfinding%7Cevent%7CruleId%3Adef-000-u5t%7CresourceId%3Ae8c9ab7c52ebd7bf2fdb4db641082d7d%7CtabId%3Aoverview
|
15335
|
+
type: string
|
15336
|
+
FindingDescription:
|
15337
|
+
description: The description and remediation steps for this finding.
|
15338
|
+
example: '## Remediation
|
15339
|
+
|
15340
|
+
|
15341
|
+
1. In the console, go to **Storage Account**.
|
15342
|
+
|
15343
|
+
2. For each Storage Account, navigate to **Data Protection**.
|
15344
|
+
|
15345
|
+
3. Select **Set soft delete enabled** and enter the number of days to retain
|
15346
|
+
soft deleted data.'
|
15347
|
+
type: string
|
15147
15348
|
FindingEvaluation:
|
15148
15349
|
description: The evaluation of the finding.
|
15149
15350
|
enum:
|
@@ -15161,6 +15362,10 @@ components:
|
|
15161
15362
|
format: int64
|
15162
15363
|
minimum: 1
|
15163
15364
|
type: integer
|
15365
|
+
FindingExternalId:
|
15366
|
+
description: The cloud-based ID for the resource related to the finding.
|
15367
|
+
example: arn:aws:s3:::my-example-bucket
|
15368
|
+
type: string
|
15164
15369
|
FindingID:
|
15165
15370
|
description: The unique ID for this finding.
|
15166
15371
|
example: ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==
|
@@ -19121,6 +19326,90 @@ components:
|
|
19121
19326
|
- index
|
19122
19327
|
- caseIndex
|
19123
19328
|
type: object
|
19329
|
+
KindAttributes:
|
19330
|
+
description: Kind attributes.
|
19331
|
+
properties:
|
19332
|
+
description:
|
19333
|
+
description: Short description of the kind.
|
19334
|
+
type: string
|
19335
|
+
displayName:
|
19336
|
+
description: User friendly name of the kind.
|
19337
|
+
type: string
|
19338
|
+
name:
|
19339
|
+
description: The kind name.
|
19340
|
+
example: my-job
|
19341
|
+
minLength: 1
|
19342
|
+
type: string
|
19343
|
+
type: object
|
19344
|
+
KindData:
|
19345
|
+
description: Schema that defines the structure of a Kind object in the Software
|
19346
|
+
Catalog.
|
19347
|
+
properties:
|
19348
|
+
attributes:
|
19349
|
+
$ref: '#/components/schemas/KindAttributes'
|
19350
|
+
id:
|
19351
|
+
description: A read-only globally unique identifier for the entity generated
|
19352
|
+
by Datadog. User supplied values are ignored.
|
19353
|
+
example: 4b163705-23c0-4573-b2fb-f6cea2163fcb
|
19354
|
+
minLength: 1
|
19355
|
+
type: string
|
19356
|
+
meta:
|
19357
|
+
$ref: '#/components/schemas/KindMetadata'
|
19358
|
+
type:
|
19359
|
+
description: Kind.
|
19360
|
+
type: string
|
19361
|
+
type: object
|
19362
|
+
KindMetadata:
|
19363
|
+
description: Kind metadata.
|
19364
|
+
properties:
|
19365
|
+
createdAt:
|
19366
|
+
description: The creation time.
|
19367
|
+
type: string
|
19368
|
+
modifiedAt:
|
19369
|
+
description: The modification time.
|
19370
|
+
type: string
|
19371
|
+
type: object
|
19372
|
+
KindObj:
|
19373
|
+
description: Schema for kind.
|
19374
|
+
properties:
|
19375
|
+
description:
|
19376
|
+
description: Short description of the kind.
|
19377
|
+
type: string
|
19378
|
+
displayName:
|
19379
|
+
description: The display name of the kind. Automatically generated if not
|
19380
|
+
provided.
|
19381
|
+
type: string
|
19382
|
+
kind:
|
19383
|
+
description: The name of the kind to create or update. This must be in kebab-case
|
19384
|
+
format.
|
19385
|
+
example: my-job
|
19386
|
+
type: string
|
19387
|
+
required:
|
19388
|
+
- kind
|
19389
|
+
type: object
|
19390
|
+
KindRaw:
|
19391
|
+
description: Kind definition in raw JSON or YAML representation.
|
19392
|
+
example: 'kind: service
|
19393
|
+
|
19394
|
+
displayName: Service
|
19395
|
+
|
19396
|
+
description: A service entity in the catalog.
|
19397
|
+
|
19398
|
+
'
|
19399
|
+
type: string
|
19400
|
+
KindResponseData:
|
19401
|
+
description: List of kind responses.
|
19402
|
+
items:
|
19403
|
+
$ref: '#/components/schemas/KindData'
|
19404
|
+
type: array
|
19405
|
+
KindResponseMeta:
|
19406
|
+
description: Kind response metadata.
|
19407
|
+
properties:
|
19408
|
+
count:
|
19409
|
+
description: Total kinds count.
|
19410
|
+
format: int64
|
19411
|
+
type: integer
|
19412
|
+
type: object
|
19124
19413
|
Layer:
|
19125
19414
|
description: Encapsulates a layer resource, holding attributes like rotation
|
19126
19415
|
details, plus relationships to the members covering that layer.
|
@@ -19607,6 +19896,14 @@ components:
|
|
19607
19896
|
meta:
|
19608
19897
|
$ref: '#/components/schemas/HistoricalJobListMeta'
|
19609
19898
|
type: object
|
19899
|
+
ListKindCatalogResponse:
|
19900
|
+
description: List kind response.
|
19901
|
+
properties:
|
19902
|
+
data:
|
19903
|
+
$ref: '#/components/schemas/KindResponseData'
|
19904
|
+
meta:
|
19905
|
+
$ref: '#/components/schemas/KindResponseMeta'
|
19906
|
+
type: object
|
19610
19907
|
ListPipelinesResponse:
|
19611
19908
|
description: Represents the response payload containing a list of pipelines
|
19612
19909
|
and associated metadata.
|
@@ -37887,6 +38184,150 @@ components:
|
|
37887
38184
|
$ref: '#/components/schemas/TeamLink'
|
37888
38185
|
type: array
|
37889
38186
|
type: object
|
38187
|
+
TeamOnCallResponders:
|
38188
|
+
description: Root object representing a team's on-call responder configuration.
|
38189
|
+
example:
|
38190
|
+
data:
|
38191
|
+
id: 111ee23r-aaaaa-aaaa-aaww-1234wertsd23
|
38192
|
+
relationships:
|
38193
|
+
escalations:
|
38194
|
+
data:
|
38195
|
+
- id: 111ee23r-aaaaa-aaaa-aaww-1234wertsd23
|
38196
|
+
type: escalation_policy_steps
|
38197
|
+
responders:
|
38198
|
+
data:
|
38199
|
+
- id: 111ee23r-aaaaa-aaaa-aaww-1234wertsd23
|
38200
|
+
type: users
|
38201
|
+
type: team_oncall_responders
|
38202
|
+
included:
|
38203
|
+
- attributes:
|
38204
|
+
email: test@test.com
|
38205
|
+
name: Test User
|
38206
|
+
status: active
|
38207
|
+
id: 111ee23r-aaaaa-aaaa-aaww-1234wertsd23
|
38208
|
+
type: users
|
38209
|
+
- id: 111ee23r-aaaaa-aaaa-aaww-1234wertsd23
|
38210
|
+
relationships:
|
38211
|
+
responders:
|
38212
|
+
data:
|
38213
|
+
- id: 111ee23r-aaaaa-aaaa-aaww-1234wertsd23
|
38214
|
+
type: users
|
38215
|
+
type: escalation_policy_steps
|
38216
|
+
properties:
|
38217
|
+
data:
|
38218
|
+
$ref: '#/components/schemas/TeamOnCallRespondersData'
|
38219
|
+
included:
|
38220
|
+
description: The `TeamOnCallResponders` `included`.
|
38221
|
+
items:
|
38222
|
+
$ref: '#/components/schemas/TeamOnCallRespondersIncluded'
|
38223
|
+
type: array
|
38224
|
+
type: object
|
38225
|
+
TeamOnCallRespondersData:
|
38226
|
+
description: Defines the main on-call responder object for a team, including
|
38227
|
+
relationships and metadata.
|
38228
|
+
properties:
|
38229
|
+
id:
|
38230
|
+
description: Unique identifier of the on-call responder configuration.
|
38231
|
+
type: string
|
38232
|
+
relationships:
|
38233
|
+
$ref: '#/components/schemas/TeamOnCallRespondersDataRelationships'
|
38234
|
+
type:
|
38235
|
+
$ref: '#/components/schemas/TeamOnCallRespondersDataType'
|
38236
|
+
required:
|
38237
|
+
- type
|
38238
|
+
type: object
|
38239
|
+
TeamOnCallRespondersDataRelationships:
|
38240
|
+
description: Relationship objects linked to a team's on-call responder configuration,
|
38241
|
+
including escalations and responders.
|
38242
|
+
properties:
|
38243
|
+
escalations:
|
38244
|
+
$ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsEscalations'
|
38245
|
+
responders:
|
38246
|
+
$ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsResponders'
|
38247
|
+
type: object
|
38248
|
+
TeamOnCallRespondersDataRelationshipsEscalations:
|
38249
|
+
description: Defines the escalation policy steps linked to the team's on-call
|
38250
|
+
configuration.
|
38251
|
+
properties:
|
38252
|
+
data:
|
38253
|
+
description: Array of escalation step references.
|
38254
|
+
items:
|
38255
|
+
$ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsEscalationsDataItems'
|
38256
|
+
type: array
|
38257
|
+
type: object
|
38258
|
+
TeamOnCallRespondersDataRelationshipsEscalationsDataItems:
|
38259
|
+
description: Represents a link to a specific escalation policy step associated
|
38260
|
+
with the on-call team.
|
38261
|
+
properties:
|
38262
|
+
id:
|
38263
|
+
description: Unique identifier of the escalation step.
|
38264
|
+
example: ''
|
38265
|
+
type: string
|
38266
|
+
type:
|
38267
|
+
$ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsEscalationsDataItemsType'
|
38268
|
+
required:
|
38269
|
+
- type
|
38270
|
+
- id
|
38271
|
+
type: object
|
38272
|
+
TeamOnCallRespondersDataRelationshipsEscalationsDataItemsType:
|
38273
|
+
default: escalation_policy_steps
|
38274
|
+
description: Identifies the resource type for escalation policy steps linked
|
38275
|
+
to a team's on-call configuration.
|
38276
|
+
enum:
|
38277
|
+
- escalation_policy_steps
|
38278
|
+
example: escalation_policy_steps
|
38279
|
+
type: string
|
38280
|
+
x-enum-varnames:
|
38281
|
+
- ESCALATION_POLICY_STEPS
|
38282
|
+
TeamOnCallRespondersDataRelationshipsResponders:
|
38283
|
+
description: Defines the list of users assigned as on-call responders for the
|
38284
|
+
team.
|
38285
|
+
properties:
|
38286
|
+
data:
|
38287
|
+
description: Array of user references associated as responders.
|
38288
|
+
items:
|
38289
|
+
$ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsRespondersDataItems'
|
38290
|
+
type: array
|
38291
|
+
type: object
|
38292
|
+
TeamOnCallRespondersDataRelationshipsRespondersDataItems:
|
38293
|
+
description: Represents a user responder associated with the on-call team.
|
38294
|
+
properties:
|
38295
|
+
id:
|
38296
|
+
description: Unique identifier of the responder.
|
38297
|
+
example: ''
|
38298
|
+
type: string
|
38299
|
+
type:
|
38300
|
+
$ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsRespondersDataItemsType'
|
38301
|
+
required:
|
38302
|
+
- type
|
38303
|
+
- id
|
38304
|
+
type: object
|
38305
|
+
TeamOnCallRespondersDataRelationshipsRespondersDataItemsType:
|
38306
|
+
default: users
|
38307
|
+
description: Identifies the resource type for individual user entities associated
|
38308
|
+
with on-call response.
|
38309
|
+
enum:
|
38310
|
+
- users
|
38311
|
+
example: users
|
38312
|
+
type: string
|
38313
|
+
x-enum-varnames:
|
38314
|
+
- USERS
|
38315
|
+
TeamOnCallRespondersDataType:
|
38316
|
+
default: team_oncall_responders
|
38317
|
+
description: Represents the resource type for a group of users assigned to handle
|
38318
|
+
on-call duties within a team.
|
38319
|
+
enum:
|
38320
|
+
- team_oncall_responders
|
38321
|
+
example: team_oncall_responders
|
38322
|
+
type: string
|
38323
|
+
x-enum-varnames:
|
38324
|
+
- TEAM_ONCALL_RESPONDERS
|
38325
|
+
TeamOnCallRespondersIncluded:
|
38326
|
+
description: Represents an union of related resources included in the response,
|
38327
|
+
such as users and escalation steps.
|
38328
|
+
oneOf:
|
38329
|
+
- $ref: '#/components/schemas/User'
|
38330
|
+
- $ref: '#/components/schemas/Escalation'
|
37890
38331
|
TeamPermissionSetting:
|
37891
38332
|
description: Team permission setting
|
37892
38333
|
properties:
|
@@ -39205,6 +39646,19 @@ components:
|
|
39205
39646
|
description: Upsert entity response included item.
|
39206
39647
|
oneOf:
|
39207
39648
|
- $ref: '#/components/schemas/EntityResponseIncludedSchema'
|
39649
|
+
UpsertCatalogKindRequest:
|
39650
|
+
description: Create or update kind request.
|
39651
|
+
oneOf:
|
39652
|
+
- $ref: '#/components/schemas/KindObj'
|
39653
|
+
- $ref: '#/components/schemas/KindRaw'
|
39654
|
+
UpsertCatalogKindResponse:
|
39655
|
+
description: Upsert kind response.
|
39656
|
+
properties:
|
39657
|
+
data:
|
39658
|
+
$ref: '#/components/schemas/KindResponseData'
|
39659
|
+
meta:
|
39660
|
+
$ref: '#/components/schemas/KindResponseMeta'
|
39661
|
+
type: object
|
39208
39662
|
Urgency:
|
39209
39663
|
description: Specifies the level of urgency for a routing rule (low, high, or
|
39210
39664
|
dynamic).
|
@@ -40661,6 +41115,7 @@ components:
|
|
40661
41115
|
appsec_vm_read: View infrastructure, application code, and library vulnerabilities.
|
40662
41116
|
This does not restrict API or inventory SQL access to the vulnerability
|
40663
41117
|
data source.
|
41118
|
+
billing_read: View your organization's billing information.
|
40664
41119
|
cases_read: View Cases.
|
40665
41120
|
cases_write: Create and update cases.
|
40666
41121
|
ci_visibility_pipelines_write: Create CI Visibility pipeline spans using
|
@@ -43442,6 +43897,105 @@ paths:
|
|
43442
43897
|
summary: Delete a single entity
|
43443
43898
|
tags:
|
43444
43899
|
- Software Catalog
|
43900
|
+
/api/v2/catalog/kind:
|
43901
|
+
get:
|
43902
|
+
description: Get a list of entity kinds from Software Catalog.
|
43903
|
+
operationId: ListCatalogKind
|
43904
|
+
parameters:
|
43905
|
+
- $ref: '#/components/parameters/PageOffset'
|
43906
|
+
- description: Maximum number of kinds in the response.
|
43907
|
+
example: 100
|
43908
|
+
in: query
|
43909
|
+
name: page[limit]
|
43910
|
+
required: false
|
43911
|
+
schema:
|
43912
|
+
default: 100
|
43913
|
+
format: int64
|
43914
|
+
type: integer
|
43915
|
+
- $ref: '#/components/parameters/FilterByID'
|
43916
|
+
- $ref: '#/components/parameters/FilterByName'
|
43917
|
+
responses:
|
43918
|
+
'200':
|
43919
|
+
content:
|
43920
|
+
application/json:
|
43921
|
+
schema:
|
43922
|
+
$ref: '#/components/schemas/ListKindCatalogResponse'
|
43923
|
+
description: OK
|
43924
|
+
'400':
|
43925
|
+
$ref: '#/components/responses/BadRequestResponse'
|
43926
|
+
'403':
|
43927
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
43928
|
+
'429':
|
43929
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
43930
|
+
security:
|
43931
|
+
- apiKeyAuth: []
|
43932
|
+
appKeyAuth: []
|
43933
|
+
- AuthZ:
|
43934
|
+
- apm_service_catalog_read
|
43935
|
+
summary: Get a list of entity kinds
|
43936
|
+
tags:
|
43937
|
+
- Software Catalog
|
43938
|
+
x-pagination:
|
43939
|
+
limitParam: page[limit]
|
43940
|
+
pageOffsetParam: page[offset]
|
43941
|
+
resultsPath: data
|
43942
|
+
post:
|
43943
|
+
description: Create or update kinds in Software Catalog.
|
43944
|
+
operationId: UpsertCatalogKind
|
43945
|
+
requestBody:
|
43946
|
+
content:
|
43947
|
+
application/json:
|
43948
|
+
schema:
|
43949
|
+
$ref: '#/components/schemas/UpsertCatalogKindRequest'
|
43950
|
+
description: Kind YAML or JSON.
|
43951
|
+
required: true
|
43952
|
+
responses:
|
43953
|
+
'202':
|
43954
|
+
content:
|
43955
|
+
application/json:
|
43956
|
+
schema:
|
43957
|
+
$ref: '#/components/schemas/UpsertCatalogKindResponse'
|
43958
|
+
description: ACCEPTED
|
43959
|
+
'400':
|
43960
|
+
$ref: '#/components/responses/BadRequestResponse'
|
43961
|
+
'403':
|
43962
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
43963
|
+
'429':
|
43964
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
43965
|
+
security:
|
43966
|
+
- apiKeyAuth: []
|
43967
|
+
appKeyAuth: []
|
43968
|
+
- AuthZ:
|
43969
|
+
- apm_service_catalog_write
|
43970
|
+
summary: Create or update kinds
|
43971
|
+
tags:
|
43972
|
+
- Software Catalog
|
43973
|
+
x-codegen-request-body-name: body
|
43974
|
+
/api/v2/catalog/kind/{kind_id}:
|
43975
|
+
delete:
|
43976
|
+
description: Delete a single kind in Software Catalog.
|
43977
|
+
operationId: DeleteCatalogKind
|
43978
|
+
parameters:
|
43979
|
+
- $ref: '#/components/parameters/KindID'
|
43980
|
+
responses:
|
43981
|
+
'204':
|
43982
|
+
description: OK
|
43983
|
+
'400':
|
43984
|
+
$ref: '#/components/responses/BadRequestResponse'
|
43985
|
+
'403':
|
43986
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
43987
|
+
'404':
|
43988
|
+
$ref: '#/components/responses/NotFoundResponse'
|
43989
|
+
'429':
|
43990
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
43991
|
+
security:
|
43992
|
+
- apiKeyAuth: []
|
43993
|
+
appKeyAuth: []
|
43994
|
+
- AuthZ:
|
43995
|
+
- apm_service_catalog_write
|
43996
|
+
summary: Delete a single kind
|
43997
|
+
tags:
|
43998
|
+
- Software Catalog
|
43445
43999
|
/api/v2/catalog/relation:
|
43446
44000
|
get:
|
43447
44001
|
description: Get a list of entity relations from Software Catalog.
|
@@ -44950,13 +45504,15 @@ paths:
|
|
44950
45504
|
appKeyAuth: []
|
44951
45505
|
- AuthZ:
|
44952
45506
|
- usage_read
|
45507
|
+
- billing_read
|
44953
45508
|
summary: Get Monthly Cost Attribution
|
44954
45509
|
tags:
|
44955
45510
|
- Usage Metering
|
44956
45511
|
x-permission:
|
44957
|
-
operator:
|
45512
|
+
operator: AND
|
44958
45513
|
permissions:
|
44959
45514
|
- usage_read
|
45515
|
+
- billing_read
|
44960
45516
|
/api/v2/csm/onboarding/agents:
|
44961
45517
|
get:
|
44962
45518
|
description: Get the list of all CSM Agents running on your hosts and containers.
|
@@ -45794,9 +46350,6 @@ paths:
|
|
45794
46350
|
tags:
|
45795
46351
|
- DORA Metrics
|
45796
46352
|
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
46353
|
/api/v2/dora/deployments:
|
45801
46354
|
post:
|
45802
46355
|
description: Use this API endpoint to get a list of deployment events.
|
@@ -45874,6 +46427,52 @@ paths:
|
|
45874
46427
|
operator: OR
|
45875
46428
|
permissions:
|
45876
46429
|
- dora_metrics_read
|
46430
|
+
/api/v2/dora/failure:
|
46431
|
+
post:
|
46432
|
+
description: 'Use this API endpoint to provide failure data for DORA metrics.
|
46433
|
+
|
46434
|
+
|
46435
|
+
This is necessary for:
|
46436
|
+
|
46437
|
+
- Change Failure Rate
|
46438
|
+
|
46439
|
+
- Time to Restore'
|
46440
|
+
operationId: CreateDORAFailure
|
46441
|
+
requestBody:
|
46442
|
+
content:
|
46443
|
+
application/json:
|
46444
|
+
schema:
|
46445
|
+
$ref: '#/components/schemas/DORAFailureRequest'
|
46446
|
+
required: true
|
46447
|
+
responses:
|
46448
|
+
'200':
|
46449
|
+
content:
|
46450
|
+
application/json:
|
46451
|
+
schema:
|
46452
|
+
$ref: '#/components/schemas/DORAFailureResponse'
|
46453
|
+
description: OK
|
46454
|
+
'202':
|
46455
|
+
content:
|
46456
|
+
application/json:
|
46457
|
+
schema:
|
46458
|
+
$ref: '#/components/schemas/DORAFailureResponse'
|
46459
|
+
description: OK - but delayed due to incident
|
46460
|
+
'400':
|
46461
|
+
content:
|
46462
|
+
application/json:
|
46463
|
+
schema:
|
46464
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
46465
|
+
description: Bad Request
|
46466
|
+
'403':
|
46467
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
46468
|
+
'429':
|
46469
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
46470
|
+
security:
|
46471
|
+
- apiKeyAuth: []
|
46472
|
+
summary: Send a failure event for DORA Metrics
|
46473
|
+
tags:
|
46474
|
+
- DORA Metrics
|
46475
|
+
x-codegen-request-body-name: body
|
45877
46476
|
/api/v2/dora/failures:
|
45878
46477
|
post:
|
45879
46478
|
description: Use this API endpoint to get a list of failure events.
|
@@ -45953,7 +46552,12 @@ paths:
|
|
45953
46552
|
- dora_metrics_read
|
45954
46553
|
/api/v2/dora/incident:
|
45955
46554
|
post:
|
45956
|
-
|
46555
|
+
deprecated: true
|
46556
|
+
description: '**Note**: This endpoint is deprecated. Please use `/api/v2/dora/failure`
|
46557
|
+
instead.
|
46558
|
+
|
46559
|
+
|
46560
|
+
Use this API endpoint to provide failure data for DORA metrics.
|
45957
46561
|
|
45958
46562
|
|
45959
46563
|
This is necessary for:
|
@@ -45966,20 +46570,20 @@ paths:
|
|
45966
46570
|
content:
|
45967
46571
|
application/json:
|
45968
46572
|
schema:
|
45969
|
-
$ref: '#/components/schemas/
|
46573
|
+
$ref: '#/components/schemas/DORAFailureRequest'
|
45970
46574
|
required: true
|
45971
46575
|
responses:
|
45972
46576
|
'200':
|
45973
46577
|
content:
|
45974
46578
|
application/json:
|
45975
46579
|
schema:
|
45976
|
-
$ref: '#/components/schemas/
|
46580
|
+
$ref: '#/components/schemas/DORAFailureResponse'
|
45977
46581
|
description: OK
|
45978
46582
|
'202':
|
45979
46583
|
content:
|
45980
46584
|
application/json:
|
45981
46585
|
schema:
|
45982
|
-
$ref: '#/components/schemas/
|
46586
|
+
$ref: '#/components/schemas/DORAFailureResponse'
|
45983
46587
|
description: OK - but delayed due to incident
|
45984
46588
|
'400':
|
45985
46589
|
content:
|
@@ -45997,9 +46601,6 @@ paths:
|
|
45997
46601
|
tags:
|
45998
46602
|
- DORA Metrics
|
45999
46603
|
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
46604
|
/api/v2/downtime:
|
46004
46605
|
get:
|
46005
46606
|
description: Get all scheduled downtimes.
|
@@ -52469,6 +53070,48 @@ paths:
|
|
52469
53070
|
summary: Get the schedule on-call user
|
52470
53071
|
tags:
|
52471
53072
|
- On-Call
|
53073
|
+
/api/v2/on-call/teams/{team_id}/on-call:
|
53074
|
+
get:
|
53075
|
+
description: Get a team's on-call users at a given time
|
53076
|
+
operationId: GetTeamOnCallUsers
|
53077
|
+
parameters:
|
53078
|
+
- description: 'Comma-separated list of included relationships to be returned.
|
53079
|
+
Allowed values: `responders`, `escalations`, `escalations.responders`.'
|
53080
|
+
in: query
|
53081
|
+
name: include
|
53082
|
+
schema:
|
53083
|
+
type: string
|
53084
|
+
- description: The team ID
|
53085
|
+
in: path
|
53086
|
+
name: team_id
|
53087
|
+
required: true
|
53088
|
+
schema:
|
53089
|
+
example: 27590dae-47be-4a7d-9abf-8f4e45124020
|
53090
|
+
type: string
|
53091
|
+
responses:
|
53092
|
+
'200':
|
53093
|
+
content:
|
53094
|
+
application/json:
|
53095
|
+
schema:
|
53096
|
+
$ref: '#/components/schemas/TeamOnCallResponders'
|
53097
|
+
description: OK
|
53098
|
+
'400':
|
53099
|
+
$ref: '#/components/responses/BadRequestResponse'
|
53100
|
+
'401':
|
53101
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
53102
|
+
'403':
|
53103
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
53104
|
+
'404':
|
53105
|
+
$ref: '#/components/responses/NotFoundResponse'
|
53106
|
+
'429':
|
53107
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
53108
|
+
security:
|
53109
|
+
- apiKeyAuth: []
|
53110
|
+
appKeyAuth: []
|
53111
|
+
- AuthZ: []
|
53112
|
+
summary: Get team on-call users
|
53113
|
+
tags:
|
53114
|
+
- On-Call
|
52472
53115
|
/api/v2/on-call/teams/{team_id}/routing-rules:
|
52473
53116
|
get:
|
52474
53117
|
description: Get a team's On-Call routing rules
|
@@ -52695,13 +53338,19 @@ paths:
|
|
52695
53338
|
the equal sign: `filter[evaluation_changed_at]=>=1678809373257`.\n\nQuery
|
52696
53339
|
parameters must be only among the documented ones and with values of correct
|
52697
53340
|
types. Duplicated query parameters (e.g. `filter[status]=low&filter[status]=info`)
|
52698
|
-
are not allowed.\n\n###
|
52699
|
-
|
52700
|
-
|
52701
|
-
|
52702
|
-
|
52703
|
-
|
52704
|
-
|
53341
|
+
are not allowed.\n\n### Additional extension fields\n\nAdditional extension
|
53342
|
+
fields are available for some findings.\n\nThe data is available when you
|
53343
|
+
include the query parameter `?detailed_findings=true` in the request.\n\nThe
|
53344
|
+
following fields are available for findings:\n- `external_id`: The resource
|
53345
|
+
external ID related to the finding.\n- `description`: The description and
|
53346
|
+
remediation steps for the finding.\n- `datadog_link`: The Datadog relative
|
53347
|
+
link for the finding.\n\n### Response\n\nThe response includes an array of
|
53348
|
+
finding objects, pagination metadata, and a count of items that match the
|
53349
|
+
query.\n\nEach finding object contains the following:\n\n- The finding ID
|
53350
|
+
that can be used in a `GetFinding` request to retrieve the full finding details.\n-
|
53351
|
+
Core attributes, including status, evaluation, high-level resource details,
|
53352
|
+
muted state, and rule details.\n- `evaluation_changed_at` and `resource_discovery_date`
|
53353
|
+
time stamps.\n- An array of associated tags.\n"
|
52705
53354
|
operationId: ListFindings
|
52706
53355
|
parameters:
|
52707
53356
|
- description: Limit the number of findings returned. Must be <= 1000.
|
@@ -52804,6 +53453,14 @@ paths:
|
|
52804
53453
|
items:
|
52805
53454
|
$ref: '#/components/schemas/FindingVulnerabilityType'
|
52806
53455
|
type: array
|
53456
|
+
- description: Return additional fields for some findings.
|
53457
|
+
example:
|
53458
|
+
- true
|
53459
|
+
in: query
|
53460
|
+
name: detailed_findings
|
53461
|
+
required: false
|
53462
|
+
schema:
|
53463
|
+
type: boolean
|
52807
53464
|
responses:
|
52808
53465
|
'200':
|
52809
53466
|
content:
|
@@ -54215,6 +54872,8 @@ paths:
|
|
54215
54872
|
|
54216
54873
|
- Connection Groups: `connection-group`
|
54217
54874
|
|
54875
|
+
- RUM Applications: `rum-application`
|
54876
|
+
|
54218
54877
|
|
54219
54878
|
#### Supported relations for resources
|
54220
54879
|
|
@@ -54254,7 +54913,9 @@ paths:
|
|
54254
54913
|
|
54255
54914
|
Connections | `viewer`, `resolver`, `editor`
|
54256
54915
|
|
54257
|
-
Connection Groups | `viewer`, `editor`
|
54916
|
+
Connection Groups | `viewer`, `editor`
|
54917
|
+
|
54918
|
+
RUM Application | `viewer`, `editor`'
|
54258
54919
|
operationId: UpdateRestrictionPolicy
|
54259
54920
|
parameters:
|
54260
54921
|
- $ref: '#/components/parameters/ResourceID'
|
@@ -60843,13 +61504,15 @@ paths:
|
|
60843
61504
|
appKeyAuth: []
|
60844
61505
|
- AuthZ:
|
60845
61506
|
- usage_read
|
61507
|
+
- billing_read
|
60846
61508
|
summary: Get cost across multi-org account
|
60847
61509
|
tags:
|
60848
61510
|
- Usage Metering
|
60849
61511
|
x-permission:
|
60850
|
-
operator:
|
61512
|
+
operator: AND
|
60851
61513
|
permissions:
|
60852
61514
|
- usage_read
|
61515
|
+
- billing_read
|
60853
61516
|
/api/v2/usage/estimated_cost:
|
60854
61517
|
get:
|
60855
61518
|
description: 'Get estimated cost across multi-org and single root-org accounts.
|
@@ -60947,13 +61610,15 @@ paths:
|
|
60947
61610
|
appKeyAuth: []
|
60948
61611
|
- AuthZ:
|
60949
61612
|
- usage_read
|
61613
|
+
- billing_read
|
60950
61614
|
summary: Get estimated cost across your account
|
60951
61615
|
tags:
|
60952
61616
|
- Usage Metering
|
60953
61617
|
x-permission:
|
60954
|
-
operator:
|
61618
|
+
operator: AND
|
60955
61619
|
permissions:
|
60956
61620
|
- usage_read
|
61621
|
+
- billing_read
|
60957
61622
|
/api/v2/usage/historical_cost:
|
60958
61623
|
get:
|
60959
61624
|
description: 'Get historical cost across multi-org and single root-org accounts.
|
@@ -61028,13 +61693,15 @@ paths:
|
|
61028
61693
|
appKeyAuth: []
|
61029
61694
|
- AuthZ:
|
61030
61695
|
- usage_read
|
61696
|
+
- billing_read
|
61031
61697
|
summary: Get historical cost across your account
|
61032
61698
|
tags:
|
61033
61699
|
- Usage Metering
|
61034
61700
|
x-permission:
|
61035
|
-
operator:
|
61701
|
+
operator: AND
|
61036
61702
|
permissions:
|
61037
61703
|
- usage_read
|
61704
|
+
- billing_read
|
61038
61705
|
/api/v2/usage/hourly_usage:
|
61039
61706
|
get:
|
61040
61707
|
description: Get hourly usage by product family.
|
@@ -61362,13 +62029,15 @@ paths:
|
|
61362
62029
|
appKeyAuth: []
|
61363
62030
|
- AuthZ:
|
61364
62031
|
- usage_read
|
62032
|
+
- billing_read
|
61365
62033
|
summary: Get projected cost across your account
|
61366
62034
|
tags:
|
61367
62035
|
- Usage Metering
|
61368
62036
|
x-permission:
|
61369
|
-
operator:
|
62037
|
+
operator: AND
|
61370
62038
|
permissions:
|
61371
62039
|
- usage_read
|
62040
|
+
- billing_read
|
61372
62041
|
/api/v2/user_invitations:
|
61373
62042
|
post:
|
61374
62043
|
description: Sends emails to one or more users inviting them to join the organization.
|