datadog_api_client 2.20.0 → 2.21.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.apigentools-info +4 -4
- data/.generator/conftest.py +5 -0
- data/.generator/schemas/v1/openapi.yaml +333 -128
- data/.generator/schemas/v2/openapi.yaml +2450 -131
- data/CHANGELOG.md +28 -0
- data/examples/v1/gcp-integration/CreateGCPIntegration.rb +3 -0
- data/examples/v1/gcp-integration/UpdateGCPIntegration_3544259255.rb +25 -0
- data/examples/v1/synthetics/CreateSyntheticsAPITest_1279271422.rb +29 -0
- data/examples/v1/synthetics/UpdateBrowserTest.rb +1 -0
- data/examples/v2/case-management/ArchiveCase.rb +14 -0
- data/examples/v2/case-management/AssignCase.rb +20 -0
- data/examples/v2/case-management/CreateCase.rb +33 -0
- data/examples/v2/case-management/CreateProject.rb +15 -0
- data/examples/v2/case-management/DeleteProject.rb +5 -0
- data/examples/v2/case-management/GetCase.rb +8 -0
- data/examples/v2/case-management/GetProject.rb +5 -0
- data/examples/v2/case-management/GetProjects.rb +5 -0
- data/examples/v2/case-management/SearchCases.rb +5 -0
- data/examples/v2/case-management/SearchCases_3433960044.rb +5 -0
- data/examples/v2/case-management/UnarchiveCase.rb +14 -0
- data/examples/v2/case-management/UnassignCase.rb +14 -0
- data/examples/v2/case-management/UpdatePriority.rb +17 -0
- data/examples/v2/case-management/UpdateStatus.rb +17 -0
- data/examples/v2/cloud-workload-security/CreateCSMThreatsAgentRule.rb +17 -0
- data/examples/v2/cloud-workload-security/DeleteCSMThreatsAgentRule.rb +8 -0
- data/examples/v2/cloud-workload-security/DownloadCSMThreatsPolicy.rb +5 -0
- data/examples/v2/cloud-workload-security/GetCSMThreatsAgentRule.rb +8 -0
- data/examples/v2/cloud-workload-security/ListCSMThreatsAgentRules.rb +5 -0
- data/examples/v2/cloud-workload-security/UpdateCSMThreatsAgentRule.rb +20 -0
- data/examples/v2/dora-metrics/CreateDORAIncident.rb +6 -3
- data/examples/v2/gcp-integration/CreateGCPSTSAccount_194782945.rb +18 -0
- data/examples/v2/gcp-integration/UpdateGCPSTSAccount_2241994060.rb +21 -0
- data/examples/v2/logs-custom-destinations/CreateLogsCustomDestination.rb +31 -0
- data/examples/v2/logs-custom-destinations/CreateLogsCustomDestination_1091442807.rb +31 -0
- data/examples/v2/logs-custom-destinations/CreateLogsCustomDestination_1288180912.rb +27 -0
- data/examples/v2/logs-custom-destinations/CreateLogsCustomDestination_141236188.rb +32 -0
- data/examples/v2/logs-custom-destinations/CreateLogsCustomDestination_2184123765.rb +31 -0
- data/examples/v2/logs-custom-destinations/DeleteLogsCustomDestination.rb +8 -0
- data/examples/v2/logs-custom-destinations/GetLogsCustomDestination.rb +8 -0
- data/examples/v2/logs-custom-destinations/ListLogsCustomDestinations.rb +5 -0
- data/examples/v2/logs-custom-destinations/UpdateLogsCustomDestination.rb +18 -0
- data/examples/v2/metrics/ListMetricAssets.rb +5 -0
- data/lib/datadog_api_client/inflector.rb +112 -0
- data/lib/datadog_api_client/v1/api/monitors_api.rb +1 -3
- data/lib/datadog_api_client/v1/api/usage_metering_api.rb +5 -5
- data/lib/datadog_api_client/v1/models/gcp_account.rb +14 -1
- data/lib/datadog_api_client/v1/models/hourly_usage_attribution_usage_type.rb +6 -0
- data/lib/datadog_api_client/v1/models/monitor_formula_and_function_events_data_source.rb +1 -0
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_supported_metrics.rb +8 -0
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_values.rb +84 -4
- data/lib/datadog_api_client/v1/models/synthetics_api_step_subtype.rb +1 -0
- data/lib/datadog_api_client/v1/models/synthetics_test_request.rb +11 -1
- data/lib/datadog_api_client/v1/models/usage_attribution_body.rb +1 -1
- data/lib/datadog_api_client/v1/models/usage_attribution_sort.rb +2 -0
- data/lib/datadog_api_client/v1/models/usage_attribution_supported_metrics.rb +2 -0
- data/lib/datadog_api_client/v1/models/usage_summary_date.rb +81 -1
- data/lib/datadog_api_client/v1/models/usage_summary_date_org.rb +83 -3
- data/lib/datadog_api_client/v1/models/usage_summary_response.rb +182 -102
- data/lib/datadog_api_client/v2/api/case_management_api.rb +942 -0
- data/lib/datadog_api_client/v2/api/ci_visibility_tests_api.rb +2 -2
- data/lib/datadog_api_client/v2/api/cloud_workload_security_api.rb +392 -0
- data/lib/datadog_api_client/v2/api/incident_services_api.rb +15 -0
- data/lib/datadog_api_client/v2/api/logs_custom_destinations_api.rb +355 -0
- data/lib/datadog_api_client/v2/api/metrics_api.rb +69 -1
- data/lib/datadog_api_client/v2/api/service_definition_api.rb +2 -1
- data/lib/datadog_api_client/v2/api/usage_metering_api.rb +3 -3
- data/lib/datadog_api_client/v2/models/case.rb +150 -0
- data/lib/datadog_api_client/v2/models/case3rd_party_ticket_status.rb +28 -0
- data/lib/datadog_api_client/v2/models/case_assign.rb +119 -0
- data/lib/datadog_api_client/v2/models/case_assign_attributes.rb +98 -0
- data/lib/datadog_api_client/v2/models/case_assign_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/case_attributes.rb +202 -0
- data/lib/datadog_api_client/v2/models/case_create.rb +129 -0
- data/lib/datadog_api_client/v2/models/case_create_attributes.rb +139 -0
- data/lib/datadog_api_client/v2/models/case_create_relationships.rb +116 -0
- data/lib/datadog_api_client/v2/models/case_create_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/case_empty.rb +98 -0
- data/lib/datadog_api_client/v2/models/case_empty_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/case_priority.rb +31 -0
- data/lib/datadog_api_client/v2/models/case_relationships.rb +120 -0
- data/lib/datadog_api_client/v2/models/case_resource_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/case_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/case_sortable_field.rb +28 -0
- data/lib/datadog_api_client/v2/models/case_status.rb +28 -0
- data/lib/datadog_api_client/v2/models/case_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/case_update_priority.rb +119 -0
- data/lib/datadog_api_client/v2/models/case_update_priority_attributes.rb +98 -0
- data/lib/datadog_api_client/v2/models/case_update_priority_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/case_update_status.rb +119 -0
- data/lib/datadog_api_client/v2/models/case_update_status_attributes.rb +98 -0
- data/lib/datadog_api_client/v2/models/case_update_status_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/cases_response.rb +92 -0
- data/lib/datadog_api_client/v2/models/cases_response_meta.rb +80 -0
- data/lib/datadog_api_client/v2/models/cases_response_meta_pagination.rb +100 -0
- data/lib/datadog_api_client/v2/models/ci_app_aggregate_sort.rb +1 -1
- data/lib/datadog_api_client/v2/models/ci_app_pipelines_group_by.rb +1 -1
- data/lib/datadog_api_client/v2/models/ci_app_tests_group_by.rb +1 -1
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_action.rb +90 -0
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_attributes.rb +21 -1
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_kill.rb +80 -0
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_update_data.rb +11 -1
- data/lib/datadog_api_client/v2/models/custom_destination_attribute_tags_restriction_list_type.rb +31 -0
- data/lib/datadog_api_client/v2/models/custom_destination_create_request.rb +80 -0
- data/lib/datadog_api_client/v2/models/custom_destination_create_request_attributes.rb +193 -0
- data/lib/datadog_api_client/v2/models/custom_destination_create_request_definition.rb +119 -0
- data/lib/datadog_api_client/v2/models/custom_destination_elasticsearch_destination_auth.rb +119 -0
- data/lib/datadog_api_client/v2/models/custom_destination_forward_destination.rb +64 -0
- data/lib/datadog_api_client/v2/models/custom_destination_forward_destination_elasticsearch.rb +181 -0
- data/lib/datadog_api_client/v2/models/custom_destination_forward_destination_elasticsearch_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/custom_destination_forward_destination_http.rb +141 -0
- data/lib/datadog_api_client/v2/models/custom_destination_forward_destination_http_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/custom_destination_forward_destination_splunk.rb +141 -0
- data/lib/datadog_api_client/v2/models/custom_destination_forward_destination_splunk_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/custom_destination_http_destination_auth.rb +63 -0
- data/lib/datadog_api_client/v2/models/custom_destination_http_destination_auth_basic.rb +140 -0
- data/lib/datadog_api_client/v2/models/custom_destination_http_destination_auth_basic_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/custom_destination_http_destination_auth_custom_header.rb +140 -0
- data/lib/datadog_api_client/v2/models/custom_destination_http_destination_auth_custom_header_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/custom_destination_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/custom_destination_response_attributes.rb +171 -0
- data/lib/datadog_api_client/v2/models/custom_destination_response_definition.rb +100 -0
- data/lib/datadog_api_client/v2/models/custom_destination_response_forward_destination.rb +64 -0
- data/lib/datadog_api_client/v2/models/custom_destination_response_forward_destination_elasticsearch.rb +181 -0
- data/lib/datadog_api_client/v2/models/custom_destination_response_forward_destination_elasticsearch_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/custom_destination_response_forward_destination_http.rb +141 -0
- data/lib/datadog_api_client/v2/models/custom_destination_response_forward_destination_http_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/custom_destination_response_forward_destination_splunk.rb +120 -0
- data/lib/datadog_api_client/v2/models/custom_destination_response_forward_destination_splunk_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/custom_destination_response_http_destination_auth.rb +63 -0
- data/lib/datadog_api_client/v2/models/custom_destination_response_http_destination_auth_basic.rb +98 -0
- data/lib/datadog_api_client/v2/models/custom_destination_response_http_destination_auth_basic_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/custom_destination_response_http_destination_auth_custom_header.rb +119 -0
- data/lib/datadog_api_client/v2/models/custom_destination_response_http_destination_auth_custom_header_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/custom_destination_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/custom_destination_update_request.rb +80 -0
- data/lib/datadog_api_client/v2/models/custom_destination_update_request_attributes.rb +169 -0
- data/lib/datadog_api_client/v2/models/custom_destination_update_request_definition.rb +129 -0
- data/lib/datadog_api_client/v2/models/custom_destinations_response.rb +82 -0
- data/lib/datadog_api_client/v2/models/dora_incident_request_attributes.rb +21 -20
- data/lib/datadog_api_client/v2/models/gcpsts_service_account_attributes.rb +14 -1
- data/lib/datadog_api_client/v2/models/jira_issue.rb +90 -0
- data/lib/datadog_api_client/v2/models/jira_issue_result.rb +110 -0
- data/lib/datadog_api_client/v2/models/logs_archive_integration_gcs.rb +1 -12
- data/lib/datadog_api_client/v2/models/metric_asset_attributes.rb +80 -0
- data/lib/datadog_api_client/v2/models/metric_asset_dashboard_relationship.rb +90 -0
- data/lib/datadog_api_client/v2/models/metric_asset_dashboard_relationships.rb +82 -0
- data/lib/datadog_api_client/v2/models/metric_asset_monitor_relationship.rb +90 -0
- data/lib/datadog_api_client/v2/models/metric_asset_monitor_relationships.rb +82 -0
- data/lib/datadog_api_client/v2/models/metric_asset_notebook_relationship.rb +90 -0
- data/lib/datadog_api_client/v2/models/metric_asset_notebook_relationships.rb +82 -0
- data/lib/datadog_api_client/v2/models/metric_asset_response_data.rb +129 -0
- data/lib/datadog_api_client/v2/models/metric_asset_response_included.rb +65 -0
- data/lib/datadog_api_client/v2/models/metric_asset_response_relationships.rb +110 -0
- data/lib/datadog_api_client/v2/models/metric_asset_slo_relationship.rb +90 -0
- data/lib/datadog_api_client/v2/models/metric_asset_slo_relationships.rb +82 -0
- data/lib/datadog_api_client/v2/models/metric_assets_response.rb +92 -0
- data/lib/datadog_api_client/v2/models/metric_dashboard_asset.rb +129 -0
- data/lib/datadog_api_client/v2/models/metric_dashboard_attributes.rb +112 -0
- data/lib/datadog_api_client/v2/models/metric_dashboard_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/metric_monitor_asset.rb +129 -0
- data/lib/datadog_api_client/v2/models/metric_monitor_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/metric_notebook_asset.rb +129 -0
- data/lib/datadog_api_client/v2/models/metric_notebook_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/metric_slo_asset.rb +129 -0
- data/lib/datadog_api_client/v2/models/metric_slo_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/nullable_user_relationship.rb +88 -0
- data/lib/datadog_api_client/v2/models/nullable_user_relationship_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/project.rb +150 -0
- data/lib/datadog_api_client/v2/models/project_attributes.rb +90 -0
- data/lib/datadog_api_client/v2/models/project_create.rb +119 -0
- data/lib/datadog_api_client/v2/models/project_create_attributes.rb +119 -0
- data/lib/datadog_api_client/v2/models/project_create_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/project_relationship.rb +98 -0
- data/lib/datadog_api_client/v2/models/project_relationship_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/project_relationships.rb +90 -0
- data/lib/datadog_api_client/v2/models/project_resource_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/project_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/projects_response.rb +82 -0
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_standard_pattern_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/service_now_ticket.rb +90 -0
- data/lib/datadog_api_client/v2/models/service_now_ticket_result.rb +80 -0
- data/lib/datadog_api_client/v2/models/user_relationship_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/user_resource_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/user_team_included.rb +62 -0
- data/lib/datadog_api_client/v2/models/user_team_response.rb +16 -4
- data/lib/datadog_api_client/v2/models/users_relationship.rb +100 -0
- data/lib/datadog_api_client/version.rb +1 -1
- metadata +147 -2
@@ -151,6 +151,21 @@ components:
|
|
151
151
|
required: true
|
152
152
|
schema:
|
153
153
|
type: string
|
154
|
+
CaseIDPathParameter:
|
155
|
+
description: Case's UUID or key
|
156
|
+
example: f98a5a5b-e0ff-45d4-b2f5-afe6e74de504
|
157
|
+
in: path
|
158
|
+
name: case_id
|
159
|
+
required: true
|
160
|
+
schema:
|
161
|
+
type: string
|
162
|
+
CaseSortableFieldParameter:
|
163
|
+
description: Specify which field to sort
|
164
|
+
in: query
|
165
|
+
name: sort[field]
|
166
|
+
required: false
|
167
|
+
schema:
|
168
|
+
$ref: '#/components/schemas/CaseSortableField'
|
154
169
|
CloudAccountID:
|
155
170
|
description: Cloud Account id.
|
156
171
|
in: path
|
@@ -180,6 +195,13 @@ components:
|
|
180
195
|
required: true
|
181
196
|
schema:
|
182
197
|
type: string
|
198
|
+
CustomDestinationId:
|
199
|
+
description: The ID of the custom destination.
|
200
|
+
in: path
|
201
|
+
name: custom_destination_id
|
202
|
+
required: true
|
203
|
+
schema:
|
204
|
+
type: string
|
183
205
|
FastlyAccountID:
|
184
206
|
description: Fastly Account id.
|
185
207
|
in: path
|
@@ -381,6 +403,14 @@ components:
|
|
381
403
|
example: 10
|
382
404
|
format: int64
|
383
405
|
type: integer
|
406
|
+
ProjectIDPathParameter:
|
407
|
+
description: Project UUID
|
408
|
+
example: e555e290-ed65-49bd-ae18-8acbfcf18db7
|
409
|
+
in: path
|
410
|
+
name: project_id
|
411
|
+
required: true
|
412
|
+
schema:
|
413
|
+
type: string
|
384
414
|
ResourceID:
|
385
415
|
description: 'Identifier, formatted as `type:id`. Supported types: `connection`,
|
386
416
|
`dashboard`, `notebook`, `security-rule`, `slo`.'
|
@@ -2016,7 +2046,8 @@ components:
|
|
2016
2046
|
type: number
|
2017
2047
|
type: object
|
2018
2048
|
CIAppAggregateSort:
|
2019
|
-
description: A sort rule.
|
2049
|
+
description: A sort rule. The `aggregation` field is required when `type` is
|
2050
|
+
`measure`.
|
2020
2051
|
example:
|
2021
2052
|
aggregation: count
|
2022
2053
|
order: asc
|
@@ -3332,6 +3363,345 @@ components:
|
|
3332
3363
|
from the other indexes
|
3333
3364
|
type: string
|
3334
3365
|
type: object
|
3366
|
+
Case:
|
3367
|
+
description: A case
|
3368
|
+
properties:
|
3369
|
+
attributes:
|
3370
|
+
$ref: '#/components/schemas/CaseAttributes'
|
3371
|
+
id:
|
3372
|
+
description: Case's identifier
|
3373
|
+
example: aeadc05e-98a8-11ec-ac2c-da7ad0900001
|
3374
|
+
type: string
|
3375
|
+
relationships:
|
3376
|
+
$ref: '#/components/schemas/CaseRelationships'
|
3377
|
+
type:
|
3378
|
+
$ref: '#/components/schemas/CaseResourceType'
|
3379
|
+
required:
|
3380
|
+
- id
|
3381
|
+
- type
|
3382
|
+
- attributes
|
3383
|
+
type: object
|
3384
|
+
Case3rdPartyTicketStatus:
|
3385
|
+
default: IN_PROGRESS
|
3386
|
+
description: Case status
|
3387
|
+
enum:
|
3388
|
+
- IN_PROGRESS
|
3389
|
+
- COMPLETED
|
3390
|
+
- FAILED
|
3391
|
+
example: COMPLETED
|
3392
|
+
readOnly: true
|
3393
|
+
type: string
|
3394
|
+
x-enum-varnames:
|
3395
|
+
- IN_PROGRESS
|
3396
|
+
- COMPLETED
|
3397
|
+
- FAILED
|
3398
|
+
CaseAssign:
|
3399
|
+
description: Case assign
|
3400
|
+
properties:
|
3401
|
+
attributes:
|
3402
|
+
$ref: '#/components/schemas/CaseAssignAttributes'
|
3403
|
+
type:
|
3404
|
+
$ref: '#/components/schemas/CaseResourceType'
|
3405
|
+
required:
|
3406
|
+
- attributes
|
3407
|
+
- type
|
3408
|
+
type: object
|
3409
|
+
CaseAssignAttributes:
|
3410
|
+
description: Case assign attributes
|
3411
|
+
properties:
|
3412
|
+
assignee_id:
|
3413
|
+
description: Assignee's UUID
|
3414
|
+
example: f98a5a5b-e0ff-45d4-b2f5-afe6e74de504
|
3415
|
+
type: string
|
3416
|
+
required:
|
3417
|
+
- assignee_id
|
3418
|
+
type: object
|
3419
|
+
CaseAssignRequest:
|
3420
|
+
description: Case assign request
|
3421
|
+
properties:
|
3422
|
+
data:
|
3423
|
+
$ref: '#/components/schemas/CaseAssign'
|
3424
|
+
required:
|
3425
|
+
- data
|
3426
|
+
type: object
|
3427
|
+
CaseAttributes:
|
3428
|
+
description: Case attributes
|
3429
|
+
properties:
|
3430
|
+
archived_at:
|
3431
|
+
description: Timestamp of when the case was archived
|
3432
|
+
format: date-time
|
3433
|
+
nullable: true
|
3434
|
+
readOnly: true
|
3435
|
+
type: string
|
3436
|
+
closed_at:
|
3437
|
+
description: Timestamp of when the case was closed
|
3438
|
+
format: date-time
|
3439
|
+
nullable: true
|
3440
|
+
readOnly: true
|
3441
|
+
type: string
|
3442
|
+
created_at:
|
3443
|
+
description: Timestamp of when the case was created
|
3444
|
+
format: date-time
|
3445
|
+
readOnly: true
|
3446
|
+
type: string
|
3447
|
+
description:
|
3448
|
+
description: Description
|
3449
|
+
type: string
|
3450
|
+
jira_issue:
|
3451
|
+
$ref: '#/components/schemas/JiraIssue'
|
3452
|
+
key:
|
3453
|
+
description: Key
|
3454
|
+
example: CASEM-4523
|
3455
|
+
type: string
|
3456
|
+
modified_at:
|
3457
|
+
description: Timestamp of when the case was last modified
|
3458
|
+
format: date-time
|
3459
|
+
nullable: true
|
3460
|
+
readOnly: true
|
3461
|
+
type: string
|
3462
|
+
priority:
|
3463
|
+
$ref: '#/components/schemas/CasePriority'
|
3464
|
+
service_now_ticket:
|
3465
|
+
$ref: '#/components/schemas/ServiceNowTicket'
|
3466
|
+
status:
|
3467
|
+
$ref: '#/components/schemas/CaseStatus'
|
3468
|
+
title:
|
3469
|
+
description: Title
|
3470
|
+
example: Memory leak investigation on API
|
3471
|
+
type: string
|
3472
|
+
type:
|
3473
|
+
$ref: '#/components/schemas/CaseType'
|
3474
|
+
type: object
|
3475
|
+
CaseCreate:
|
3476
|
+
description: Case creation data
|
3477
|
+
properties:
|
3478
|
+
attributes:
|
3479
|
+
$ref: '#/components/schemas/CaseCreateAttributes'
|
3480
|
+
relationships:
|
3481
|
+
$ref: '#/components/schemas/CaseCreateRelationships'
|
3482
|
+
type:
|
3483
|
+
$ref: '#/components/schemas/CaseResourceType'
|
3484
|
+
required:
|
3485
|
+
- attributes
|
3486
|
+
- type
|
3487
|
+
type: object
|
3488
|
+
CaseCreateAttributes:
|
3489
|
+
description: Case creation attributes
|
3490
|
+
properties:
|
3491
|
+
description:
|
3492
|
+
description: Description
|
3493
|
+
type: string
|
3494
|
+
priority:
|
3495
|
+
$ref: '#/components/schemas/CasePriority'
|
3496
|
+
title:
|
3497
|
+
description: Title
|
3498
|
+
example: Security breach investigation
|
3499
|
+
type: string
|
3500
|
+
type:
|
3501
|
+
$ref: '#/components/schemas/CaseType'
|
3502
|
+
required:
|
3503
|
+
- title
|
3504
|
+
- type
|
3505
|
+
type: object
|
3506
|
+
CaseCreateRelationships:
|
3507
|
+
description: Relationships formed with the case on creation
|
3508
|
+
properties:
|
3509
|
+
assignee:
|
3510
|
+
$ref: '#/components/schemas/NullableUserRelationship'
|
3511
|
+
project:
|
3512
|
+
$ref: '#/components/schemas/ProjectRelationship'
|
3513
|
+
required:
|
3514
|
+
- project
|
3515
|
+
type: object
|
3516
|
+
CaseCreateRequest:
|
3517
|
+
description: Case create request
|
3518
|
+
properties:
|
3519
|
+
data:
|
3520
|
+
$ref: '#/components/schemas/CaseCreate'
|
3521
|
+
required:
|
3522
|
+
- data
|
3523
|
+
type: object
|
3524
|
+
CaseEmpty:
|
3525
|
+
description: Case empty request data
|
3526
|
+
properties:
|
3527
|
+
type:
|
3528
|
+
$ref: '#/components/schemas/CaseResourceType'
|
3529
|
+
required:
|
3530
|
+
- type
|
3531
|
+
type: object
|
3532
|
+
CaseEmptyRequest:
|
3533
|
+
description: Case empty request
|
3534
|
+
properties:
|
3535
|
+
data:
|
3536
|
+
$ref: '#/components/schemas/CaseEmpty'
|
3537
|
+
required:
|
3538
|
+
- data
|
3539
|
+
type: object
|
3540
|
+
CasePriority:
|
3541
|
+
default: NOT_DEFINED
|
3542
|
+
description: Case priority
|
3543
|
+
enum:
|
3544
|
+
- NOT_DEFINED
|
3545
|
+
- P1
|
3546
|
+
- P2
|
3547
|
+
- P3
|
3548
|
+
- P4
|
3549
|
+
- P5
|
3550
|
+
example: NOT_DEFINED
|
3551
|
+
type: string
|
3552
|
+
x-enum-varnames:
|
3553
|
+
- NOT_DEFINED
|
3554
|
+
- P1
|
3555
|
+
- P2
|
3556
|
+
- P3
|
3557
|
+
- P4
|
3558
|
+
- P5
|
3559
|
+
CaseRelationships:
|
3560
|
+
description: Resources related to a case
|
3561
|
+
properties:
|
3562
|
+
assignee:
|
3563
|
+
$ref: '#/components/schemas/NullableUserRelationship'
|
3564
|
+
created_by:
|
3565
|
+
$ref: '#/components/schemas/NullableUserRelationship'
|
3566
|
+
modified_by:
|
3567
|
+
$ref: '#/components/schemas/NullableUserRelationship'
|
3568
|
+
project:
|
3569
|
+
$ref: '#/components/schemas/ProjectRelationship'
|
3570
|
+
type: object
|
3571
|
+
CaseResourceType:
|
3572
|
+
default: case
|
3573
|
+
description: Case resource type
|
3574
|
+
enum:
|
3575
|
+
- case
|
3576
|
+
example: case
|
3577
|
+
type: string
|
3578
|
+
x-enum-varnames:
|
3579
|
+
- CASE
|
3580
|
+
CaseResponse:
|
3581
|
+
description: Case response
|
3582
|
+
properties:
|
3583
|
+
data:
|
3584
|
+
$ref: '#/components/schemas/Case'
|
3585
|
+
type: object
|
3586
|
+
CaseSortableField:
|
3587
|
+
description: Case field that can be sorted on
|
3588
|
+
enum:
|
3589
|
+
- created_at
|
3590
|
+
- priority
|
3591
|
+
- status
|
3592
|
+
example: created_at
|
3593
|
+
type: string
|
3594
|
+
x-enum-varnames:
|
3595
|
+
- CREATED_AT
|
3596
|
+
- PRIORITY
|
3597
|
+
- STATUS
|
3598
|
+
CaseStatus:
|
3599
|
+
description: Case status
|
3600
|
+
enum:
|
3601
|
+
- OPEN
|
3602
|
+
- IN_PROGRESS
|
3603
|
+
- CLOSED
|
3604
|
+
example: OPEN
|
3605
|
+
type: string
|
3606
|
+
x-enum-varnames:
|
3607
|
+
- OPEN
|
3608
|
+
- IN_PROGRESS
|
3609
|
+
- CLOSED
|
3610
|
+
CaseType:
|
3611
|
+
description: Case type
|
3612
|
+
enum:
|
3613
|
+
- STANDARD
|
3614
|
+
example: STANDARD
|
3615
|
+
type: string
|
3616
|
+
x-enum-varnames:
|
3617
|
+
- STANDARD
|
3618
|
+
CaseUpdatePriority:
|
3619
|
+
description: Case priority status
|
3620
|
+
properties:
|
3621
|
+
attributes:
|
3622
|
+
$ref: '#/components/schemas/CaseUpdatePriorityAttributes'
|
3623
|
+
type:
|
3624
|
+
$ref: '#/components/schemas/CaseResourceType'
|
3625
|
+
required:
|
3626
|
+
- attributes
|
3627
|
+
- type
|
3628
|
+
type: object
|
3629
|
+
CaseUpdatePriorityAttributes:
|
3630
|
+
description: Case update priority attributes
|
3631
|
+
properties:
|
3632
|
+
priority:
|
3633
|
+
$ref: '#/components/schemas/CasePriority'
|
3634
|
+
required:
|
3635
|
+
- priority
|
3636
|
+
type: object
|
3637
|
+
CaseUpdatePriorityRequest:
|
3638
|
+
description: Case update priority request
|
3639
|
+
properties:
|
3640
|
+
data:
|
3641
|
+
$ref: '#/components/schemas/CaseUpdatePriority'
|
3642
|
+
required:
|
3643
|
+
- data
|
3644
|
+
type: object
|
3645
|
+
CaseUpdateStatus:
|
3646
|
+
description: Case update status
|
3647
|
+
properties:
|
3648
|
+
attributes:
|
3649
|
+
$ref: '#/components/schemas/CaseUpdateStatusAttributes'
|
3650
|
+
type:
|
3651
|
+
$ref: '#/components/schemas/CaseResourceType'
|
3652
|
+
required:
|
3653
|
+
- attributes
|
3654
|
+
- type
|
3655
|
+
type: object
|
3656
|
+
CaseUpdateStatusAttributes:
|
3657
|
+
description: Case update status attributes
|
3658
|
+
properties:
|
3659
|
+
status:
|
3660
|
+
$ref: '#/components/schemas/CaseStatus'
|
3661
|
+
required:
|
3662
|
+
- status
|
3663
|
+
type: object
|
3664
|
+
CaseUpdateStatusRequest:
|
3665
|
+
description: Case update status request
|
3666
|
+
properties:
|
3667
|
+
data:
|
3668
|
+
$ref: '#/components/schemas/CaseUpdateStatus'
|
3669
|
+
required:
|
3670
|
+
- data
|
3671
|
+
type: object
|
3672
|
+
CasesResponse:
|
3673
|
+
description: Response with cases
|
3674
|
+
properties:
|
3675
|
+
data:
|
3676
|
+
description: Cases response data
|
3677
|
+
items:
|
3678
|
+
$ref: '#/components/schemas/Case'
|
3679
|
+
type: array
|
3680
|
+
meta:
|
3681
|
+
$ref: '#/components/schemas/CasesResponseMeta'
|
3682
|
+
type: object
|
3683
|
+
CasesResponseMeta:
|
3684
|
+
description: Cases response metadata
|
3685
|
+
properties:
|
3686
|
+
page:
|
3687
|
+
$ref: '#/components/schemas/CasesResponseMetaPagination'
|
3688
|
+
type: object
|
3689
|
+
CasesResponseMetaPagination:
|
3690
|
+
description: Pagination metadata
|
3691
|
+
properties:
|
3692
|
+
current:
|
3693
|
+
description: Current page number
|
3694
|
+
format: int64
|
3695
|
+
type: integer
|
3696
|
+
size:
|
3697
|
+
description: Number of cases in current page
|
3698
|
+
format: int64
|
3699
|
+
type: integer
|
3700
|
+
total:
|
3701
|
+
description: Total number of pages
|
3702
|
+
format: int64
|
3703
|
+
type: integer
|
3704
|
+
type: object
|
3335
3705
|
ChargebackBreakdown:
|
3336
3706
|
description: Charges breakdown.
|
3337
3707
|
properties:
|
@@ -3556,9 +3926,27 @@ components:
|
|
3556
3926
|
type: string
|
3557
3927
|
x-enum-varnames:
|
3558
3928
|
- CLOUD_COST_ACTIVITY
|
3929
|
+
CloudWorkloadSecurityAgentRuleAction:
|
3930
|
+
description: The action the rule can perform if triggered.
|
3931
|
+
properties:
|
3932
|
+
filter:
|
3933
|
+
description: SECL expression used to target the container to apply the action
|
3934
|
+
on
|
3935
|
+
type: string
|
3936
|
+
kill:
|
3937
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleKill'
|
3938
|
+
type: object
|
3939
|
+
CloudWorkloadSecurityAgentRuleActions:
|
3940
|
+
description: The array of actions the rule can perform if triggered.
|
3941
|
+
items:
|
3942
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleAction'
|
3943
|
+
nullable: true
|
3944
|
+
type: array
|
3559
3945
|
CloudWorkloadSecurityAgentRuleAttributes:
|
3560
3946
|
description: A Cloud Workload Security Agent rule returned by the API.
|
3561
3947
|
properties:
|
3948
|
+
actions:
|
3949
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActions'
|
3562
3950
|
agentConstraint:
|
3563
3951
|
description: The version of the agent.
|
3564
3952
|
type: string
|
@@ -3691,6 +4079,17 @@ components:
|
|
3691
4079
|
type:
|
3692
4080
|
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleType'
|
3693
4081
|
type: object
|
4082
|
+
CloudWorkloadSecurityAgentRuleID:
|
4083
|
+
description: The ID of the agent rule.
|
4084
|
+
example: 3dd-0uc-h1s
|
4085
|
+
type: string
|
4086
|
+
CloudWorkloadSecurityAgentRuleKill:
|
4087
|
+
description: Kill system call applied on the container matching the rule
|
4088
|
+
properties:
|
4089
|
+
signal:
|
4090
|
+
description: Supported signals for the kill system call.
|
4091
|
+
type: string
|
4092
|
+
type: object
|
3694
4093
|
CloudWorkloadSecurityAgentRuleResponse:
|
3695
4094
|
description: Response object that includes an Agent rule.
|
3696
4095
|
properties:
|
@@ -3727,6 +4126,8 @@ components:
|
|
3727
4126
|
properties:
|
3728
4127
|
attributes:
|
3729
4128
|
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateAttributes'
|
4129
|
+
id:
|
4130
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleID'
|
3730
4131
|
type:
|
3731
4132
|
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleType'
|
3732
4133
|
required:
|
@@ -4947,6 +5348,621 @@ components:
|
|
4947
5348
|
nullable: true
|
4948
5349
|
type: string
|
4949
5350
|
type: object
|
5351
|
+
CustomDestinationAttributeTagsRestrictionListType:
|
5352
|
+
default: ALLOW_LIST
|
5353
|
+
description: 'How `forward_tags_restriction_list` parameter should be interpreted.
|
5354
|
+
|
5355
|
+
If `ALLOW_LIST`, then only tags whose keys on the forwarded logs match the
|
5356
|
+
ones on the restriction list
|
5357
|
+
|
5358
|
+
are forwarded.
|
5359
|
+
|
5360
|
+
|
5361
|
+
`BLOCK_LIST` works the opposite way. It does not forward the tags matching
|
5362
|
+
the ones on the list.'
|
5363
|
+
enum:
|
5364
|
+
- ALLOW_LIST
|
5365
|
+
- BLOCK_LIST
|
5366
|
+
example: ALLOW_LIST
|
5367
|
+
type: string
|
5368
|
+
x-enum-varnames:
|
5369
|
+
- ALLOW_LIST
|
5370
|
+
- BLOCK_LIST
|
5371
|
+
CustomDestinationCreateRequest:
|
5372
|
+
description: The custom destination.
|
5373
|
+
properties:
|
5374
|
+
data:
|
5375
|
+
$ref: '#/components/schemas/CustomDestinationCreateRequestDefinition'
|
5376
|
+
type: object
|
5377
|
+
CustomDestinationCreateRequestAttributes:
|
5378
|
+
description: The attributes associated with the custom destination.
|
5379
|
+
properties:
|
5380
|
+
enabled:
|
5381
|
+
default: true
|
5382
|
+
description: Whether logs matching this custom destination should be forwarded
|
5383
|
+
or not.
|
5384
|
+
example: true
|
5385
|
+
type: boolean
|
5386
|
+
forward_tags:
|
5387
|
+
default: true
|
5388
|
+
description: Whether tags from the forwarded logs should be forwarded or
|
5389
|
+
not.
|
5390
|
+
example: true
|
5391
|
+
type: boolean
|
5392
|
+
forward_tags_restriction_list:
|
5393
|
+
default: []
|
5394
|
+
description: 'List of [keys of tags](https://docs.datadoghq.com/getting_started/tagging/#define-tags)
|
5395
|
+
to be filtered.
|
5396
|
+
|
5397
|
+
|
5398
|
+
An empty list represents no restriction is in place and either all or
|
5399
|
+
no tags will be
|
5400
|
+
|
5401
|
+
forwarded depending on `forward_tags_restriction_list_type` parameter.'
|
5402
|
+
example:
|
5403
|
+
- datacenter
|
5404
|
+
- host
|
5405
|
+
items:
|
5406
|
+
description: The [key part of a tag](https://docs.datadoghq.com/getting_started/tagging/#define-tags).
|
5407
|
+
type: string
|
5408
|
+
maxItems: 10
|
5409
|
+
minItems: 0
|
5410
|
+
type: array
|
5411
|
+
forward_tags_restriction_list_type:
|
5412
|
+
$ref: '#/components/schemas/CustomDestinationAttributeTagsRestrictionListType'
|
5413
|
+
forwarder_destination:
|
5414
|
+
$ref: '#/components/schemas/CustomDestinationForwardDestination'
|
5415
|
+
name:
|
5416
|
+
description: The custom destination name.
|
5417
|
+
example: Nginx logs
|
5418
|
+
type: string
|
5419
|
+
query:
|
5420
|
+
default: ''
|
5421
|
+
description: The custom destination query and filter. Logs matching this
|
5422
|
+
query are forwarded to the destination.
|
5423
|
+
example: source:nginx
|
5424
|
+
type: string
|
5425
|
+
required:
|
5426
|
+
- name
|
5427
|
+
- forwarder_destination
|
5428
|
+
type: object
|
5429
|
+
CustomDestinationCreateRequestDefinition:
|
5430
|
+
description: The definition of a custom destination.
|
5431
|
+
properties:
|
5432
|
+
attributes:
|
5433
|
+
$ref: '#/components/schemas/CustomDestinationCreateRequestAttributes'
|
5434
|
+
type:
|
5435
|
+
$ref: '#/components/schemas/CustomDestinationType'
|
5436
|
+
required:
|
5437
|
+
- type
|
5438
|
+
- attributes
|
5439
|
+
type: object
|
5440
|
+
CustomDestinationElasticsearchDestinationAuth:
|
5441
|
+
description: Basic access authentication.
|
5442
|
+
properties:
|
5443
|
+
password:
|
5444
|
+
description: The password of the authentication. This field is not returned
|
5445
|
+
by the API.
|
5446
|
+
example: datadog-custom-destination-password
|
5447
|
+
type: string
|
5448
|
+
writeOnly: true
|
5449
|
+
username:
|
5450
|
+
description: The username of the authentication. This field is not returned
|
5451
|
+
by the API.
|
5452
|
+
example: datadog-custom-destination-username
|
5453
|
+
type: string
|
5454
|
+
writeOnly: true
|
5455
|
+
required:
|
5456
|
+
- username
|
5457
|
+
- password
|
5458
|
+
type: object
|
5459
|
+
CustomDestinationForwardDestination:
|
5460
|
+
description: A custom destination's location to forward logs.
|
5461
|
+
oneOf:
|
5462
|
+
- $ref: '#/components/schemas/CustomDestinationForwardDestinationHttp'
|
5463
|
+
- $ref: '#/components/schemas/CustomDestinationForwardDestinationSplunk'
|
5464
|
+
- $ref: '#/components/schemas/CustomDestinationForwardDestinationElasticsearch'
|
5465
|
+
type: object
|
5466
|
+
CustomDestinationForwardDestinationElasticsearch:
|
5467
|
+
description: The Elasticsearch destination.
|
5468
|
+
properties:
|
5469
|
+
auth:
|
5470
|
+
$ref: '#/components/schemas/CustomDestinationElasticsearchDestinationAuth'
|
5471
|
+
endpoint:
|
5472
|
+
description: 'The destination for which logs will be forwarded to.
|
5473
|
+
|
5474
|
+
Must have HTTPS scheme and forwarding back to Datadog is not allowed.'
|
5475
|
+
example: https://example.com
|
5476
|
+
type: string
|
5477
|
+
index_name:
|
5478
|
+
description: Name of the Elasticsearch index (must follow [Elasticsearch's
|
5479
|
+
criteria](https://www.elastic.co/guide/en/elasticsearch/reference/8.11/indices-create-index.html#indices-create-api-path-params)).
|
5480
|
+
example: nginx-logs
|
5481
|
+
type: string
|
5482
|
+
index_rotation:
|
5483
|
+
description: 'Date pattern with US locale and UTC timezone to be appended
|
5484
|
+
to the index name after adding `-`
|
5485
|
+
|
5486
|
+
(that is, `${index_name}-${indexPattern}`).
|
5487
|
+
|
5488
|
+
You can customize the index rotation naming pattern by choosing one of
|
5489
|
+
these options:
|
5490
|
+
|
5491
|
+
- Hourly: `yyyy-MM-dd-HH` (as an example, it would render: `2022-10-19-09`)
|
5492
|
+
|
5493
|
+
- Daily: `yyyy-MM-dd` (as an example, it would render: `2022-10-19`)
|
5494
|
+
|
5495
|
+
- Weekly: `yyyy-''W''ww` (as an example, it would render: `2022-W42`)
|
5496
|
+
|
5497
|
+
- Monthly: `yyyy-MM` (as an example, it would render: `2022-10`)
|
5498
|
+
|
5499
|
+
|
5500
|
+
If this field is missing or is blank, it means that the index name will
|
5501
|
+
always be the same
|
5502
|
+
|
5503
|
+
(that is, no rotation).'
|
5504
|
+
example: yyyy-MM-dd
|
5505
|
+
type: string
|
5506
|
+
type:
|
5507
|
+
$ref: '#/components/schemas/CustomDestinationForwardDestinationElasticsearchType'
|
5508
|
+
required:
|
5509
|
+
- type
|
5510
|
+
- endpoint
|
5511
|
+
- auth
|
5512
|
+
- index_name
|
5513
|
+
type: object
|
5514
|
+
CustomDestinationForwardDestinationElasticsearchType:
|
5515
|
+
default: elasticsearch
|
5516
|
+
description: Type of the Elasticsearch destination.
|
5517
|
+
enum:
|
5518
|
+
- elasticsearch
|
5519
|
+
example: elasticsearch
|
5520
|
+
type: string
|
5521
|
+
x-enum-varnames:
|
5522
|
+
- ELASTICSEARCH
|
5523
|
+
CustomDestinationForwardDestinationHttp:
|
5524
|
+
description: The HTTP destination.
|
5525
|
+
properties:
|
5526
|
+
auth:
|
5527
|
+
$ref: '#/components/schemas/CustomDestinationHttpDestinationAuth'
|
5528
|
+
endpoint:
|
5529
|
+
description: 'The destination for which logs will be forwarded to.
|
5530
|
+
|
5531
|
+
Must have HTTPS scheme and forwarding back to Datadog is not allowed.'
|
5532
|
+
example: https://example.com
|
5533
|
+
type: string
|
5534
|
+
type:
|
5535
|
+
$ref: '#/components/schemas/CustomDestinationForwardDestinationHttpType'
|
5536
|
+
required:
|
5537
|
+
- type
|
5538
|
+
- endpoint
|
5539
|
+
- auth
|
5540
|
+
type: object
|
5541
|
+
CustomDestinationForwardDestinationHttpType:
|
5542
|
+
default: http
|
5543
|
+
description: Type of the HTTP destination.
|
5544
|
+
enum:
|
5545
|
+
- http
|
5546
|
+
example: http
|
5547
|
+
type: string
|
5548
|
+
x-enum-varnames:
|
5549
|
+
- HTTP
|
5550
|
+
CustomDestinationForwardDestinationSplunk:
|
5551
|
+
description: The Splunk HTTP Event Collector (HEC) destination.
|
5552
|
+
properties:
|
5553
|
+
access_token:
|
5554
|
+
description: Access token of the Splunk HTTP Event Collector. This field
|
5555
|
+
is not returned by the API.
|
5556
|
+
example: splunk_access_token
|
5557
|
+
type: string
|
5558
|
+
writeOnly: true
|
5559
|
+
endpoint:
|
5560
|
+
description: 'The destination for which logs will be forwarded to.
|
5561
|
+
|
5562
|
+
Must have HTTPS scheme and forwarding back to Datadog is not allowed.'
|
5563
|
+
example: https://example.com
|
5564
|
+
type: string
|
5565
|
+
type:
|
5566
|
+
$ref: '#/components/schemas/CustomDestinationForwardDestinationSplunkType'
|
5567
|
+
required:
|
5568
|
+
- type
|
5569
|
+
- endpoint
|
5570
|
+
- access_token
|
5571
|
+
type: object
|
5572
|
+
CustomDestinationForwardDestinationSplunkType:
|
5573
|
+
default: splunk_hec
|
5574
|
+
description: Type of the Splunk HTTP Event Collector (HEC) destination.
|
5575
|
+
enum:
|
5576
|
+
- splunk_hec
|
5577
|
+
example: splunk_hec
|
5578
|
+
type: string
|
5579
|
+
x-enum-varnames:
|
5580
|
+
- SPLUNK_HEC
|
5581
|
+
CustomDestinationHttpDestinationAuth:
|
5582
|
+
description: Authentication method of the HTTP requests.
|
5583
|
+
oneOf:
|
5584
|
+
- $ref: '#/components/schemas/CustomDestinationHttpDestinationAuthBasic'
|
5585
|
+
- $ref: '#/components/schemas/CustomDestinationHttpDestinationAuthCustomHeader'
|
5586
|
+
type: object
|
5587
|
+
CustomDestinationHttpDestinationAuthBasic:
|
5588
|
+
description: Basic access authentication.
|
5589
|
+
properties:
|
5590
|
+
password:
|
5591
|
+
description: The password of the authentication. This field is not returned
|
5592
|
+
by the API.
|
5593
|
+
example: datadog-custom-destination-password
|
5594
|
+
type: string
|
5595
|
+
writeOnly: true
|
5596
|
+
type:
|
5597
|
+
$ref: '#/components/schemas/CustomDestinationHttpDestinationAuthBasicType'
|
5598
|
+
username:
|
5599
|
+
description: The username of the authentication. This field is not returned
|
5600
|
+
by the API.
|
5601
|
+
example: datadog-custom-destination-username
|
5602
|
+
type: string
|
5603
|
+
writeOnly: true
|
5604
|
+
required:
|
5605
|
+
- type
|
5606
|
+
- username
|
5607
|
+
- password
|
5608
|
+
type: object
|
5609
|
+
CustomDestinationHttpDestinationAuthBasicType:
|
5610
|
+
default: basic
|
5611
|
+
description: Type of the basic access authentication.
|
5612
|
+
enum:
|
5613
|
+
- basic
|
5614
|
+
example: basic
|
5615
|
+
type: string
|
5616
|
+
x-enum-varnames:
|
5617
|
+
- BASIC
|
5618
|
+
CustomDestinationHttpDestinationAuthCustomHeader:
|
5619
|
+
description: Custom header access authentication.
|
5620
|
+
properties:
|
5621
|
+
header_name:
|
5622
|
+
description: The header name of the authentication.
|
5623
|
+
example: CUSTOM-HEADER-NAME
|
5624
|
+
type: string
|
5625
|
+
header_value:
|
5626
|
+
description: The header value of the authentication. This field is not returned
|
5627
|
+
by the API.
|
5628
|
+
example: CUSTOM-HEADER-AUTHENTICATION-VALUE
|
5629
|
+
type: string
|
5630
|
+
writeOnly: true
|
5631
|
+
type:
|
5632
|
+
$ref: '#/components/schemas/CustomDestinationHttpDestinationAuthCustomHeaderType'
|
5633
|
+
required:
|
5634
|
+
- type
|
5635
|
+
- header_name
|
5636
|
+
- header_value
|
5637
|
+
type: object
|
5638
|
+
CustomDestinationHttpDestinationAuthCustomHeaderType:
|
5639
|
+
default: custom_header
|
5640
|
+
description: Type of the custom header access authentication.
|
5641
|
+
enum:
|
5642
|
+
- custom_header
|
5643
|
+
example: custom_header
|
5644
|
+
type: string
|
5645
|
+
x-enum-varnames:
|
5646
|
+
- CUSTOM_HEADER
|
5647
|
+
CustomDestinationResponse:
|
5648
|
+
description: The custom destination.
|
5649
|
+
properties:
|
5650
|
+
data:
|
5651
|
+
$ref: '#/components/schemas/CustomDestinationResponseDefinition'
|
5652
|
+
type: object
|
5653
|
+
CustomDestinationResponseAttributes:
|
5654
|
+
description: The attributes associated with the custom destination.
|
5655
|
+
properties:
|
5656
|
+
enabled:
|
5657
|
+
default: true
|
5658
|
+
description: Whether logs matching this custom destination should be forwarded
|
5659
|
+
or not.
|
5660
|
+
example: true
|
5661
|
+
type: boolean
|
5662
|
+
forward_tags:
|
5663
|
+
default: true
|
5664
|
+
description: Whether tags from the forwarded logs should be forwarded or
|
5665
|
+
not.
|
5666
|
+
example: true
|
5667
|
+
type: boolean
|
5668
|
+
forward_tags_restriction_list:
|
5669
|
+
default: []
|
5670
|
+
description: 'List of [keys of tags](https://docs.datadoghq.com/getting_started/tagging/#define-tags)
|
5671
|
+
to be filtered.
|
5672
|
+
|
5673
|
+
|
5674
|
+
An empty list represents no restriction is in place and either all or
|
5675
|
+
no tags will be
|
5676
|
+
|
5677
|
+
forwarded depending on `forward_tags_restriction_list_type` parameter.'
|
5678
|
+
example:
|
5679
|
+
- datacenter
|
5680
|
+
- host
|
5681
|
+
items:
|
5682
|
+
description: The [key part of a tag](https://docs.datadoghq.com/getting_started/tagging/#define-tags).
|
5683
|
+
type: string
|
5684
|
+
maxItems: 10
|
5685
|
+
minItems: 0
|
5686
|
+
type: array
|
5687
|
+
forward_tags_restriction_list_type:
|
5688
|
+
$ref: '#/components/schemas/CustomDestinationAttributeTagsRestrictionListType'
|
5689
|
+
forwarder_destination:
|
5690
|
+
$ref: '#/components/schemas/CustomDestinationResponseForwardDestination'
|
5691
|
+
name:
|
5692
|
+
description: The custom destination name.
|
5693
|
+
example: Nginx logs
|
5694
|
+
type: string
|
5695
|
+
query:
|
5696
|
+
default: ''
|
5697
|
+
description: The custom destination query filter. Logs matching this query
|
5698
|
+
are forwarded to the destination.
|
5699
|
+
example: source:nginx
|
5700
|
+
type: string
|
5701
|
+
type: object
|
5702
|
+
CustomDestinationResponseDefinition:
|
5703
|
+
description: The definition of a custom destination.
|
5704
|
+
properties:
|
5705
|
+
attributes:
|
5706
|
+
$ref: '#/components/schemas/CustomDestinationResponseAttributes'
|
5707
|
+
id:
|
5708
|
+
description: The custom destination ID.
|
5709
|
+
example: be5d7a69-d0c8-4d4d-8ee8-bba292d98139
|
5710
|
+
readOnly: true
|
5711
|
+
type: string
|
5712
|
+
type:
|
5713
|
+
$ref: '#/components/schemas/CustomDestinationType'
|
5714
|
+
type: object
|
5715
|
+
CustomDestinationResponseElasticsearchDestinationAuth:
|
5716
|
+
additionalProperties:
|
5717
|
+
description: Basic access authentication.
|
5718
|
+
description: Basic access authentication.
|
5719
|
+
type: object
|
5720
|
+
CustomDestinationResponseForwardDestination:
|
5721
|
+
description: A custom destination's location to forward logs.
|
5722
|
+
oneOf:
|
5723
|
+
- $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationHttp'
|
5724
|
+
- $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationSplunk'
|
5725
|
+
- $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationElasticsearch'
|
5726
|
+
type: object
|
5727
|
+
CustomDestinationResponseForwardDestinationElasticsearch:
|
5728
|
+
description: The Elasticsearch destination.
|
5729
|
+
properties:
|
5730
|
+
auth:
|
5731
|
+
$ref: '#/components/schemas/CustomDestinationResponseElasticsearchDestinationAuth'
|
5732
|
+
endpoint:
|
5733
|
+
description: 'The destination for which logs will be forwarded to.
|
5734
|
+
|
5735
|
+
Must have HTTPS scheme and forwarding back to Datadog is not allowed.'
|
5736
|
+
example: https://example.com
|
5737
|
+
type: string
|
5738
|
+
index_name:
|
5739
|
+
description: Name of the Elasticsearch index (must follow [Elasticsearch's
|
5740
|
+
criteria](https://www.elastic.co/guide/en/elasticsearch/reference/8.11/indices-create-index.html#indices-create-api-path-params)).
|
5741
|
+
example: nginx-logs
|
5742
|
+
type: string
|
5743
|
+
index_rotation:
|
5744
|
+
description: 'Date pattern with US locale and UTC timezone to be appended
|
5745
|
+
to the index name after adding `-`
|
5746
|
+
|
5747
|
+
(that is, `${index_name}-${indexPattern}`).
|
5748
|
+
|
5749
|
+
You can customize the index rotation naming pattern by choosing one of
|
5750
|
+
these options:
|
5751
|
+
|
5752
|
+
- Hourly: `yyyy-MM-dd-HH` (as an example, it would render: `2022-10-19-09`)
|
5753
|
+
|
5754
|
+
- Daily: `yyyy-MM-dd` (as an example, it would render: `2022-10-19`)
|
5755
|
+
|
5756
|
+
- Weekly: `yyyy-''W''ww` (as an example, it would render: `2022-W42`)
|
5757
|
+
|
5758
|
+
- Monthly: `yyyy-MM` (as an example, it would render: `2022-10`)
|
5759
|
+
|
5760
|
+
|
5761
|
+
If this field is missing or is blank, it means that the index name will
|
5762
|
+
always be the same
|
5763
|
+
|
5764
|
+
(that is, no rotation).'
|
5765
|
+
example: yyyy-MM-dd
|
5766
|
+
type: string
|
5767
|
+
type:
|
5768
|
+
$ref: '#/components/schemas/CustomDestinationResponseForwardDestinationElasticsearchType'
|
5769
|
+
required:
|
5770
|
+
- type
|
5771
|
+
- endpoint
|
5772
|
+
- auth
|
5773
|
+
- index_name
|
5774
|
+
type: object
|
5775
|
+
CustomDestinationResponseForwardDestinationElasticsearchType:
|
5776
|
+
default: elasticsearch
|
5777
|
+
description: Type of the Elasticsearch destination.
|
5778
|
+
enum:
|
5779
|
+
- elasticsearch
|
5780
|
+
example: elasticsearch
|
5781
|
+
type: string
|
5782
|
+
x-enum-varnames:
|
5783
|
+
- ELASTICSEARCH
|
5784
|
+
CustomDestinationResponseForwardDestinationHttp:
|
5785
|
+
description: The HTTP destination.
|
5786
|
+
properties:
|
5787
|
+
auth:
|
5788
|
+
$ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuth'
|
5789
|
+
endpoint:
|
5790
|
+
description: 'The destination for which logs will be forwarded to.
|
5791
|
+
|
5792
|
+
Must have HTTPS scheme and forwarding back to Datadog is not allowed.'
|
5793
|
+
example: https://example.com
|
5794
|
+
type: string
|
5795
|
+
type:
|
5796
|
+
$ref: '#/components/schemas/CustomDestinationResponseForwardDestinationHttpType'
|
5797
|
+
required:
|
5798
|
+
- type
|
5799
|
+
- endpoint
|
5800
|
+
- auth
|
5801
|
+
type: object
|
5802
|
+
CustomDestinationResponseForwardDestinationHttpType:
|
5803
|
+
default: http
|
5804
|
+
description: Type of the HTTP destination.
|
5805
|
+
enum:
|
5806
|
+
- http
|
5807
|
+
example: http
|
5808
|
+
type: string
|
5809
|
+
x-enum-varnames:
|
5810
|
+
- HTTP
|
5811
|
+
CustomDestinationResponseForwardDestinationSplunk:
|
5812
|
+
description: The Splunk HTTP Event Collector (HEC) destination.
|
5813
|
+
properties:
|
5814
|
+
endpoint:
|
5815
|
+
description: 'The destination for which logs will be forwarded to.
|
5816
|
+
|
5817
|
+
Must have HTTPS scheme and forwarding back to Datadog is not allowed.'
|
5818
|
+
example: https://example.com
|
5819
|
+
type: string
|
5820
|
+
type:
|
5821
|
+
$ref: '#/components/schemas/CustomDestinationResponseForwardDestinationSplunkType'
|
5822
|
+
required:
|
5823
|
+
- type
|
5824
|
+
- endpoint
|
5825
|
+
type: object
|
5826
|
+
CustomDestinationResponseForwardDestinationSplunkType:
|
5827
|
+
default: splunk_hec
|
5828
|
+
description: Type of the Splunk HTTP Event Collector (HEC) destination.
|
5829
|
+
enum:
|
5830
|
+
- splunk_hec
|
5831
|
+
example: splunk_hec
|
5832
|
+
type: string
|
5833
|
+
x-enum-varnames:
|
5834
|
+
- SPLUNK_HEC
|
5835
|
+
CustomDestinationResponseHttpDestinationAuth:
|
5836
|
+
description: Authentication method of the HTTP requests.
|
5837
|
+
oneOf:
|
5838
|
+
- $ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuthBasic'
|
5839
|
+
- $ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuthCustomHeader'
|
5840
|
+
type: object
|
5841
|
+
CustomDestinationResponseHttpDestinationAuthBasic:
|
5842
|
+
description: Basic access authentication.
|
5843
|
+
properties:
|
5844
|
+
type:
|
5845
|
+
$ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuthBasicType'
|
5846
|
+
required:
|
5847
|
+
- type
|
5848
|
+
type: object
|
5849
|
+
CustomDestinationResponseHttpDestinationAuthBasicType:
|
5850
|
+
default: basic
|
5851
|
+
description: Type of the basic access authentication.
|
5852
|
+
enum:
|
5853
|
+
- basic
|
5854
|
+
example: basic
|
5855
|
+
type: string
|
5856
|
+
x-enum-varnames:
|
5857
|
+
- BASIC
|
5858
|
+
CustomDestinationResponseHttpDestinationAuthCustomHeader:
|
5859
|
+
description: Custom header access authentication.
|
5860
|
+
properties:
|
5861
|
+
header_name:
|
5862
|
+
description: The header name of the authentication.
|
5863
|
+
example: CUSTOM-HEADER-NAME
|
5864
|
+
type: string
|
5865
|
+
type:
|
5866
|
+
$ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuthCustomHeaderType'
|
5867
|
+
required:
|
5868
|
+
- type
|
5869
|
+
- header_name
|
5870
|
+
type: object
|
5871
|
+
CustomDestinationResponseHttpDestinationAuthCustomHeaderType:
|
5872
|
+
default: custom_header
|
5873
|
+
description: Type of the custom header access authentication.
|
5874
|
+
enum:
|
5875
|
+
- custom_header
|
5876
|
+
example: custom_header
|
5877
|
+
type: string
|
5878
|
+
x-enum-varnames:
|
5879
|
+
- CUSTOM_HEADER
|
5880
|
+
CustomDestinationType:
|
5881
|
+
default: custom_destination
|
5882
|
+
description: The type of the resource. The value should always be `custom_destination`.
|
5883
|
+
enum:
|
5884
|
+
- custom_destination
|
5885
|
+
example: custom_destination
|
5886
|
+
type: string
|
5887
|
+
x-enum-varnames:
|
5888
|
+
- custom_destination
|
5889
|
+
CustomDestinationUpdateRequest:
|
5890
|
+
description: The custom destination.
|
5891
|
+
properties:
|
5892
|
+
data:
|
5893
|
+
$ref: '#/components/schemas/CustomDestinationUpdateRequestDefinition'
|
5894
|
+
type: object
|
5895
|
+
CustomDestinationUpdateRequestAttributes:
|
5896
|
+
description: The attributes associated with the custom destination.
|
5897
|
+
properties:
|
5898
|
+
enabled:
|
5899
|
+
default: true
|
5900
|
+
description: Whether logs matching this custom destination should be forwarded
|
5901
|
+
or not.
|
5902
|
+
example: true
|
5903
|
+
type: boolean
|
5904
|
+
forward_tags:
|
5905
|
+
default: true
|
5906
|
+
description: Whether tags from the forwarded logs should be forwarded or
|
5907
|
+
not.
|
5908
|
+
example: true
|
5909
|
+
type: boolean
|
5910
|
+
forward_tags_restriction_list:
|
5911
|
+
default: []
|
5912
|
+
description: 'List of [keys of tags](https://docs.datadoghq.com/getting_started/tagging/#define-tags)
|
5913
|
+
to be restricted from being forwarded.
|
5914
|
+
|
5915
|
+
An empty list represents no restriction is in place and either all or
|
5916
|
+
no tags will be forwarded depending on `forward_tags_restriction_list_type`
|
5917
|
+
parameter.'
|
5918
|
+
example:
|
5919
|
+
- datacenter
|
5920
|
+
- host
|
5921
|
+
items:
|
5922
|
+
description: The [key part of a tag](https://docs.datadoghq.com/getting_started/tagging/#define-tags).
|
5923
|
+
type: string
|
5924
|
+
maxItems: 10
|
5925
|
+
minItems: 0
|
5926
|
+
type: array
|
5927
|
+
forward_tags_restriction_list_type:
|
5928
|
+
$ref: '#/components/schemas/CustomDestinationAttributeTagsRestrictionListType'
|
5929
|
+
forwarder_destination:
|
5930
|
+
$ref: '#/components/schemas/CustomDestinationForwardDestination'
|
5931
|
+
name:
|
5932
|
+
description: The custom destination name.
|
5933
|
+
example: Nginx logs
|
5934
|
+
type: string
|
5935
|
+
query:
|
5936
|
+
default: ''
|
5937
|
+
description: The custom destination query and filter. Logs matching this
|
5938
|
+
query are forwarded to the destination.
|
5939
|
+
example: source:nginx
|
5940
|
+
type: string
|
5941
|
+
type: object
|
5942
|
+
CustomDestinationUpdateRequestDefinition:
|
5943
|
+
description: The definition of a custom destination.
|
5944
|
+
properties:
|
5945
|
+
attributes:
|
5946
|
+
$ref: '#/components/schemas/CustomDestinationUpdateRequestAttributes'
|
5947
|
+
id:
|
5948
|
+
description: The custom destination ID.
|
5949
|
+
example: be5d7a69-d0c8-4d4d-8ee8-bba292d98139
|
5950
|
+
type: string
|
5951
|
+
type:
|
5952
|
+
$ref: '#/components/schemas/CustomDestinationType'
|
5953
|
+
required:
|
5954
|
+
- type
|
5955
|
+
- id
|
5956
|
+
type: object
|
5957
|
+
CustomDestinationsResponse:
|
5958
|
+
description: The available custom destinations.
|
5959
|
+
properties:
|
5960
|
+
data:
|
5961
|
+
description: A list of custom destinations.
|
5962
|
+
items:
|
5963
|
+
$ref: '#/components/schemas/CustomDestinationResponseDefinition'
|
5964
|
+
type: array
|
5965
|
+
type: object
|
4950
5966
|
DORADeploymentRequest:
|
4951
5967
|
description: Request to create a DORA deployment event.
|
4952
5968
|
properties:
|
@@ -5063,16 +6079,21 @@ components:
|
|
5063
6079
|
git:
|
5064
6080
|
$ref: '#/components/schemas/DORAGitInfo'
|
5065
6081
|
id:
|
5066
|
-
description: Incident ID
|
6082
|
+
description: Incident ID. Required to update a previously sent incident.
|
5067
6083
|
type: string
|
5068
6084
|
name:
|
5069
6085
|
description: Incident name.
|
5070
|
-
example: Webserver is down failing all requests
|
5071
|
-
type: string
|
5072
|
-
service:
|
5073
|
-
description: Service name from a service available in the Service Catalog.
|
5074
|
-
example: shopist
|
6086
|
+
example: Webserver is down failing all requests.
|
5075
6087
|
type: string
|
6088
|
+
services:
|
6089
|
+
description: Service names impacted by the incident. If possible, use names
|
6090
|
+
registered in the Service Catalog. Required when the team field is not
|
6091
|
+
provided.
|
6092
|
+
example:
|
6093
|
+
- shopist
|
6094
|
+
items:
|
6095
|
+
type: string
|
6096
|
+
type: array
|
5076
6097
|
severity:
|
5077
6098
|
description: Incident severity.
|
5078
6099
|
example: High
|
@@ -5082,12 +6103,17 @@ components:
|
|
5082
6103
|
example: 1693491974000000000
|
5083
6104
|
format: int64
|
5084
6105
|
type: integer
|
6106
|
+
team:
|
6107
|
+
description: Name of the team owning the services impacted. If possible,
|
6108
|
+
use team handles registered in Datadog. Required when the services field
|
6109
|
+
is not provided.
|
6110
|
+
example: backend
|
6111
|
+
type: string
|
5085
6112
|
version:
|
5086
6113
|
description: Version to correlate with [APM Deployment Tracking](https://docs.datadoghq.com/tracing/services/deployment_tracking/).
|
5087
6114
|
example: v1.12.07
|
5088
6115
|
type: string
|
5089
6116
|
required:
|
5090
|
-
- service
|
5091
6117
|
- started_at
|
5092
6118
|
type: object
|
5093
6119
|
DORAIncidentRequestData:
|
@@ -5741,7 +6767,7 @@ components:
|
|
5741
6767
|
type: string
|
5742
6768
|
type: object
|
5743
6769
|
DowntimeScheduleOneTimeCreateUpdateRequest:
|
5744
|
-
additionalProperties:
|
6770
|
+
additionalProperties: false
|
5745
6771
|
description: A one-time downtime definition.
|
5746
6772
|
properties:
|
5747
6773
|
end:
|
@@ -5876,6 +6902,7 @@ components:
|
|
5876
6902
|
- recurrences
|
5877
6903
|
type: object
|
5878
6904
|
DowntimeScheduleRecurrencesUpdateRequest:
|
6905
|
+
additionalProperties: false
|
5879
6906
|
description: A recurring downtime schedule definition.
|
5880
6907
|
properties:
|
5881
6908
|
recurrences:
|
@@ -7016,6 +8043,18 @@ components:
|
|
7016
8043
|
description: Your service account email address.
|
7017
8044
|
example: datadog-service-account@test-project.iam.gserviceaccount.com
|
7018
8045
|
type: string
|
8046
|
+
cloud_run_revision_filters:
|
8047
|
+
description: 'List of filters to limit the Cloud Run revisions that are
|
8048
|
+
pulled into Datadog by using tags.
|
8049
|
+
|
8050
|
+
Only Cloud Run revision resources that apply to specified filters are
|
8051
|
+
imported into Datadog.'
|
8052
|
+
example:
|
8053
|
+
- $KEY:$VALUE
|
8054
|
+
items:
|
8055
|
+
description: Cloud Run Filters
|
8056
|
+
type: string
|
8057
|
+
type: array
|
7019
8058
|
host_filters:
|
7020
8059
|
description: Your Host Filters.
|
7021
8060
|
items:
|
@@ -9344,6 +10383,32 @@ components:
|
|
9344
10383
|
- project_key
|
9345
10384
|
- account
|
9346
10385
|
type: object
|
10386
|
+
JiraIssue:
|
10387
|
+
description: Jira issue attached to case
|
10388
|
+
nullable: true
|
10389
|
+
properties:
|
10390
|
+
result:
|
10391
|
+
$ref: '#/components/schemas/JiraIssueResult'
|
10392
|
+
status:
|
10393
|
+
$ref: '#/components/schemas/Case3rdPartyTicketStatus'
|
10394
|
+
readOnly: true
|
10395
|
+
type: object
|
10396
|
+
JiraIssueResult:
|
10397
|
+
description: Jira issue information
|
10398
|
+
properties:
|
10399
|
+
issue_id:
|
10400
|
+
description: Jira issue ID
|
10401
|
+
type: string
|
10402
|
+
issue_key:
|
10403
|
+
description: Jira issue key
|
10404
|
+
type: string
|
10405
|
+
issue_url:
|
10406
|
+
description: Jira issue URL
|
10407
|
+
type: string
|
10408
|
+
project_key:
|
10409
|
+
description: Jira project key
|
10410
|
+
type: string
|
10411
|
+
type: object
|
9347
10412
|
ListApplicationKeysResponse:
|
9348
10413
|
description: Response for a list of application keys.
|
9349
10414
|
properties:
|
@@ -9999,7 +11064,6 @@ components:
|
|
9999
11064
|
example: project-id
|
10000
11065
|
type: string
|
10001
11066
|
required:
|
10002
|
-
- project_id
|
10003
11067
|
- client_email
|
10004
11068
|
type: object
|
10005
11069
|
LogsArchiveIntegrationS3:
|
@@ -10672,6 +11736,136 @@ components:
|
|
10672
11736
|
$ref: '#/components/schemas/MetricAllTags'
|
10673
11737
|
readOnly: true
|
10674
11738
|
type: object
|
11739
|
+
MetricAssetAttributes:
|
11740
|
+
description: Assets where only included attribute is its title
|
11741
|
+
properties:
|
11742
|
+
title:
|
11743
|
+
description: Title of the asset.
|
11744
|
+
type: string
|
11745
|
+
type: object
|
11746
|
+
MetricAssetDashboardRelationship:
|
11747
|
+
description: An object of type `dashboard` that can be referenced in the `included`
|
11748
|
+
data.
|
11749
|
+
properties:
|
11750
|
+
id:
|
11751
|
+
$ref: '#/components/schemas/MetricDashboardID'
|
11752
|
+
type:
|
11753
|
+
$ref: '#/components/schemas/MetricDashboardType'
|
11754
|
+
type: object
|
11755
|
+
MetricAssetDashboardRelationships:
|
11756
|
+
description: An object containing the list of dashboards that can be referenced
|
11757
|
+
in the `included` data.
|
11758
|
+
properties:
|
11759
|
+
data:
|
11760
|
+
description: A list of dashboards that can be referenced in the `included`
|
11761
|
+
data.
|
11762
|
+
items:
|
11763
|
+
$ref: '#/components/schemas/MetricAssetDashboardRelationship'
|
11764
|
+
type: array
|
11765
|
+
type: object
|
11766
|
+
MetricAssetMonitorRelationship:
|
11767
|
+
description: An object of type `monitor` that can be referenced in the `included`
|
11768
|
+
data.
|
11769
|
+
properties:
|
11770
|
+
id:
|
11771
|
+
$ref: '#/components/schemas/MetricMonitorID'
|
11772
|
+
type:
|
11773
|
+
$ref: '#/components/schemas/MetricMonitorType'
|
11774
|
+
type: object
|
11775
|
+
MetricAssetMonitorRelationships:
|
11776
|
+
description: A object containing the list of monitors that can be referenced
|
11777
|
+
in the `included` data.
|
11778
|
+
properties:
|
11779
|
+
data:
|
11780
|
+
description: A list of monitors that can be referenced in the `included`
|
11781
|
+
data.
|
11782
|
+
items:
|
11783
|
+
$ref: '#/components/schemas/MetricAssetMonitorRelationship'
|
11784
|
+
type: array
|
11785
|
+
type: object
|
11786
|
+
MetricAssetNotebookRelationship:
|
11787
|
+
description: An object of type `notebook` that can be referenced in the `included`
|
11788
|
+
data.
|
11789
|
+
properties:
|
11790
|
+
id:
|
11791
|
+
$ref: '#/components/schemas/MetricNotebookID'
|
11792
|
+
type:
|
11793
|
+
$ref: '#/components/schemas/MetricNotebookType'
|
11794
|
+
type: object
|
11795
|
+
MetricAssetNotebookRelationships:
|
11796
|
+
description: An object containing the list of notebooks that can be referenced
|
11797
|
+
in the `included` data.
|
11798
|
+
properties:
|
11799
|
+
data:
|
11800
|
+
description: A list of notebooks that can be referenced in the `included`
|
11801
|
+
data.
|
11802
|
+
items:
|
11803
|
+
$ref: '#/components/schemas/MetricAssetNotebookRelationship'
|
11804
|
+
type: array
|
11805
|
+
type: object
|
11806
|
+
MetricAssetResponseData:
|
11807
|
+
description: Metric assets response data.
|
11808
|
+
properties:
|
11809
|
+
id:
|
11810
|
+
$ref: '#/components/schemas/MetricName'
|
11811
|
+
relationships:
|
11812
|
+
$ref: '#/components/schemas/MetricAssetResponseRelationships'
|
11813
|
+
type:
|
11814
|
+
$ref: '#/components/schemas/MetricType'
|
11815
|
+
required:
|
11816
|
+
- id
|
11817
|
+
- type
|
11818
|
+
type: object
|
11819
|
+
MetricAssetResponseIncluded:
|
11820
|
+
description: List of included assets with full set of attributes.
|
11821
|
+
oneOf:
|
11822
|
+
- $ref: '#/components/schemas/MetricDashboardAsset'
|
11823
|
+
- $ref: '#/components/schemas/MetricMonitorAsset'
|
11824
|
+
- $ref: '#/components/schemas/MetricNotebookAsset'
|
11825
|
+
- $ref: '#/components/schemas/MetricSLOAsset'
|
11826
|
+
MetricAssetResponseRelationships:
|
11827
|
+
description: Relationships to assets related to the metric.
|
11828
|
+
properties:
|
11829
|
+
dashboards:
|
11830
|
+
$ref: '#/components/schemas/MetricAssetDashboardRelationships'
|
11831
|
+
monitors:
|
11832
|
+
$ref: '#/components/schemas/MetricAssetMonitorRelationships'
|
11833
|
+
notebooks:
|
11834
|
+
$ref: '#/components/schemas/MetricAssetNotebookRelationships'
|
11835
|
+
slos:
|
11836
|
+
$ref: '#/components/schemas/MetricAssetSLORelationships'
|
11837
|
+
type: object
|
11838
|
+
MetricAssetSLORelationship:
|
11839
|
+
description: An object of type `slos` that can be referenced in the `included`
|
11840
|
+
data.
|
11841
|
+
properties:
|
11842
|
+
id:
|
11843
|
+
$ref: '#/components/schemas/MetricSLOID'
|
11844
|
+
type:
|
11845
|
+
$ref: '#/components/schemas/MetricSLOType'
|
11846
|
+
type: object
|
11847
|
+
MetricAssetSLORelationships:
|
11848
|
+
description: An object containing a list of SLOs that can be referenced in the
|
11849
|
+
`included` data.
|
11850
|
+
properties:
|
11851
|
+
data:
|
11852
|
+
description: A list of SLOs that can be referenced in the `included` data.
|
11853
|
+
items:
|
11854
|
+
$ref: '#/components/schemas/MetricAssetSLORelationship'
|
11855
|
+
type: array
|
11856
|
+
type: object
|
11857
|
+
MetricAssetsResponse:
|
11858
|
+
description: Response object that includes related dashboards, monitors, notebooks,
|
11859
|
+
and SLOs.
|
11860
|
+
properties:
|
11861
|
+
data:
|
11862
|
+
$ref: '#/components/schemas/MetricAssetResponseData'
|
11863
|
+
included:
|
11864
|
+
description: Array of objects related to the metric assets.
|
11865
|
+
items:
|
11866
|
+
$ref: '#/components/schemas/MetricAssetResponseIncluded'
|
11867
|
+
type: array
|
11868
|
+
type: object
|
10675
11869
|
MetricBulkConfigureTagsType:
|
10676
11870
|
default: metric_bulk_configure_tags
|
10677
11871
|
description: The metric bulk configure tags resource.
|
@@ -10913,6 +12107,44 @@ components:
|
|
10913
12107
|
- MAX
|
10914
12108
|
- MIN
|
10915
12109
|
- SUM
|
12110
|
+
MetricDashboardAsset:
|
12111
|
+
description: A dashboard object with title and popularity.
|
12112
|
+
properties:
|
12113
|
+
attributes:
|
12114
|
+
$ref: '#/components/schemas/MetricDashboardAttributes'
|
12115
|
+
id:
|
12116
|
+
$ref: '#/components/schemas/MetricDashboardID'
|
12117
|
+
type:
|
12118
|
+
$ref: '#/components/schemas/MetricDashboardType'
|
12119
|
+
required:
|
12120
|
+
- id
|
12121
|
+
- type
|
12122
|
+
type: object
|
12123
|
+
MetricDashboardAttributes:
|
12124
|
+
description: Attributes related to the dashboard, including title and popularity.
|
12125
|
+
properties:
|
12126
|
+
popularity:
|
12127
|
+
description: Value from 0 to 5 that ranks popularity of the dashboard.
|
12128
|
+
format: double
|
12129
|
+
maximum: 5
|
12130
|
+
minimum: 0
|
12131
|
+
type: number
|
12132
|
+
title:
|
12133
|
+
description: Title of the asset.
|
12134
|
+
type: string
|
12135
|
+
type: object
|
12136
|
+
MetricDashboardID:
|
12137
|
+
description: The related dashboard's ID.
|
12138
|
+
example: xxx-yyy-zzz
|
12139
|
+
type: string
|
12140
|
+
MetricDashboardType:
|
12141
|
+
description: Dashboard resource type.
|
12142
|
+
enum:
|
12143
|
+
- dashboards
|
12144
|
+
example: dashboards
|
12145
|
+
type: string
|
12146
|
+
x-enum-varnames:
|
12147
|
+
- DASHBOARDS
|
10916
12148
|
MetricDistinctVolume:
|
10917
12149
|
description: Object for a single metric's distinct volume.
|
10918
12150
|
properties:
|
@@ -11053,10 +12285,60 @@ components:
|
|
11053
12285
|
origin:
|
11054
12286
|
$ref: '#/components/schemas/MetricOrigin'
|
11055
12287
|
type: object
|
12288
|
+
MetricMonitorAsset:
|
12289
|
+
description: A monitor object with title.
|
12290
|
+
properties:
|
12291
|
+
attributes:
|
12292
|
+
$ref: '#/components/schemas/MetricAssetAttributes'
|
12293
|
+
id:
|
12294
|
+
$ref: '#/components/schemas/MetricMonitorID'
|
12295
|
+
type:
|
12296
|
+
$ref: '#/components/schemas/MetricMonitorType'
|
12297
|
+
required:
|
12298
|
+
- id
|
12299
|
+
- type
|
12300
|
+
type: object
|
12301
|
+
MetricMonitorID:
|
12302
|
+
description: The related monitor's ID.
|
12303
|
+
example: '1775073'
|
12304
|
+
type: string
|
12305
|
+
MetricMonitorType:
|
12306
|
+
description: Monitor resource type.
|
12307
|
+
enum:
|
12308
|
+
- monitors
|
12309
|
+
example: monitors
|
12310
|
+
type: string
|
12311
|
+
x-enum-varnames:
|
12312
|
+
- MONITORS
|
11056
12313
|
MetricName:
|
11057
12314
|
description: The metric name for this resource.
|
11058
12315
|
example: test.metric.latency
|
11059
12316
|
type: string
|
12317
|
+
MetricNotebookAsset:
|
12318
|
+
description: A notebook object with title.
|
12319
|
+
properties:
|
12320
|
+
attributes:
|
12321
|
+
$ref: '#/components/schemas/MetricAssetAttributes'
|
12322
|
+
id:
|
12323
|
+
$ref: '#/components/schemas/MetricNotebookID'
|
12324
|
+
type:
|
12325
|
+
$ref: '#/components/schemas/MetricNotebookType'
|
12326
|
+
required:
|
12327
|
+
- id
|
12328
|
+
- type
|
12329
|
+
type: object
|
12330
|
+
MetricNotebookID:
|
12331
|
+
description: The related notebook's ID.
|
12332
|
+
example: '12345'
|
12333
|
+
type: string
|
12334
|
+
MetricNotebookType:
|
12335
|
+
description: Notebook resource type.
|
12336
|
+
enum:
|
12337
|
+
- notebooks
|
12338
|
+
example: notebooks
|
12339
|
+
type: string
|
12340
|
+
x-enum-varnames:
|
12341
|
+
- NOTEBOOKS
|
11060
12342
|
MetricOrigin:
|
11061
12343
|
description: Metric origin information.
|
11062
12344
|
properties:
|
@@ -11130,6 +12412,31 @@ components:
|
|
11130
12412
|
description: The type of the resource.
|
11131
12413
|
type: string
|
11132
12414
|
type: object
|
12415
|
+
MetricSLOAsset:
|
12416
|
+
description: A SLO object with title.
|
12417
|
+
properties:
|
12418
|
+
attributes:
|
12419
|
+
$ref: '#/components/schemas/MetricAssetAttributes'
|
12420
|
+
id:
|
12421
|
+
$ref: '#/components/schemas/MetricSLOID'
|
12422
|
+
type:
|
12423
|
+
$ref: '#/components/schemas/MetricSLOType'
|
12424
|
+
required:
|
12425
|
+
- id
|
12426
|
+
- type
|
12427
|
+
type: object
|
12428
|
+
MetricSLOID:
|
12429
|
+
description: The SLO ID.
|
12430
|
+
example: 9ffef113b389520db54391d67d652dfb
|
12431
|
+
type: string
|
12432
|
+
MetricSLOType:
|
12433
|
+
description: SLO resource type.
|
12434
|
+
enum:
|
12435
|
+
- slos
|
12436
|
+
example: slos
|
12437
|
+
type: string
|
12438
|
+
x-enum-varnames:
|
12439
|
+
- SLOS
|
11133
12440
|
MetricSeries:
|
11134
12441
|
description: 'A metric to submit to Datadog.
|
11135
12442
|
|
@@ -11943,6 +13250,29 @@ components:
|
|
11943
13250
|
- id
|
11944
13251
|
- type
|
11945
13252
|
type: object
|
13253
|
+
NullableUserRelationship:
|
13254
|
+
description: Relationship to user.
|
13255
|
+
nullable: true
|
13256
|
+
properties:
|
13257
|
+
data:
|
13258
|
+
$ref: '#/components/schemas/NullableUserRelationshipData'
|
13259
|
+
required:
|
13260
|
+
- data
|
13261
|
+
type: object
|
13262
|
+
NullableUserRelationshipData:
|
13263
|
+
description: Relationship to user object.
|
13264
|
+
nullable: true
|
13265
|
+
properties:
|
13266
|
+
id:
|
13267
|
+
description: A unique identifier that represents the user.
|
13268
|
+
example: 00000000-0000-0000-0000-000000000000
|
13269
|
+
type: string
|
13270
|
+
type:
|
13271
|
+
$ref: '#/components/schemas/UserResourceType'
|
13272
|
+
required:
|
13273
|
+
- id
|
13274
|
+
- type
|
13275
|
+
type: object
|
11946
13276
|
OktaAccount:
|
11947
13277
|
description: Schema for an Okta account.
|
11948
13278
|
properties:
|
@@ -13075,6 +14405,113 @@ components:
|
|
13075
14405
|
type: string
|
13076
14406
|
x-enum-varnames:
|
13077
14407
|
- PROCESS
|
14408
|
+
Project:
|
14409
|
+
description: A Project
|
14410
|
+
properties:
|
14411
|
+
attributes:
|
14412
|
+
$ref: '#/components/schemas/ProjectAttributes'
|
14413
|
+
id:
|
14414
|
+
description: The Project's identifier
|
14415
|
+
example: aeadc05e-98a8-11ec-ac2c-da7ad0900001
|
14416
|
+
type: string
|
14417
|
+
relationships:
|
14418
|
+
$ref: '#/components/schemas/ProjectRelationships'
|
14419
|
+
type:
|
14420
|
+
$ref: '#/components/schemas/ProjectResourceType'
|
14421
|
+
required:
|
14422
|
+
- id
|
14423
|
+
- type
|
14424
|
+
- attributes
|
14425
|
+
type: object
|
14426
|
+
ProjectAttributes:
|
14427
|
+
description: Project attributes
|
14428
|
+
properties:
|
14429
|
+
key:
|
14430
|
+
description: The project's key
|
14431
|
+
example: CASEM
|
14432
|
+
type: string
|
14433
|
+
name:
|
14434
|
+
description: Project's name
|
14435
|
+
type: string
|
14436
|
+
type: object
|
14437
|
+
ProjectCreate:
|
14438
|
+
description: Project create
|
14439
|
+
properties:
|
14440
|
+
attributes:
|
14441
|
+
$ref: '#/components/schemas/ProjectCreateAttributes'
|
14442
|
+
type:
|
14443
|
+
$ref: '#/components/schemas/ProjectResourceType'
|
14444
|
+
required:
|
14445
|
+
- attributes
|
14446
|
+
- type
|
14447
|
+
type: object
|
14448
|
+
ProjectCreateAttributes:
|
14449
|
+
description: Project creation attributes
|
14450
|
+
properties:
|
14451
|
+
key:
|
14452
|
+
description: Project's key. Cannot be "CASE"
|
14453
|
+
example: SEC
|
14454
|
+
type: string
|
14455
|
+
name:
|
14456
|
+
description: name
|
14457
|
+
example: Security Investigation
|
14458
|
+
type: string
|
14459
|
+
required:
|
14460
|
+
- name
|
14461
|
+
- key
|
14462
|
+
type: object
|
14463
|
+
ProjectCreateRequest:
|
14464
|
+
description: Project create request
|
14465
|
+
properties:
|
14466
|
+
data:
|
14467
|
+
$ref: '#/components/schemas/ProjectCreate'
|
14468
|
+
required:
|
14469
|
+
- data
|
14470
|
+
type: object
|
14471
|
+
ProjectRelationship:
|
14472
|
+
description: Relationship to project
|
14473
|
+
properties:
|
14474
|
+
data:
|
14475
|
+
$ref: '#/components/schemas/ProjectRelationshipData'
|
14476
|
+
required:
|
14477
|
+
- data
|
14478
|
+
type: object
|
14479
|
+
ProjectRelationshipData:
|
14480
|
+
description: Relationship to project object
|
14481
|
+
properties:
|
14482
|
+
id:
|
14483
|
+
description: A unique identifier that represents the project
|
14484
|
+
example: e555e290-ed65-49bd-ae18-8acbfcf18db7
|
14485
|
+
type: string
|
14486
|
+
type:
|
14487
|
+
$ref: '#/components/schemas/ProjectResourceType'
|
14488
|
+
required:
|
14489
|
+
- id
|
14490
|
+
- type
|
14491
|
+
type: object
|
14492
|
+
ProjectRelationships:
|
14493
|
+
description: Project relationships
|
14494
|
+
properties:
|
14495
|
+
member_team:
|
14496
|
+
$ref: '#/components/schemas/RelationshipToTeamLinks'
|
14497
|
+
member_user:
|
14498
|
+
$ref: '#/components/schemas/UsersRelationship'
|
14499
|
+
type: object
|
14500
|
+
ProjectResourceType:
|
14501
|
+
default: project
|
14502
|
+
description: Project resource type
|
14503
|
+
enum:
|
14504
|
+
- project
|
14505
|
+
example: project
|
14506
|
+
type: string
|
14507
|
+
x-enum-varnames:
|
14508
|
+
- PROJECT
|
14509
|
+
ProjectResponse:
|
14510
|
+
description: Project response
|
14511
|
+
properties:
|
14512
|
+
data:
|
14513
|
+
$ref: '#/components/schemas/Project'
|
14514
|
+
type: object
|
13078
14515
|
ProjectedCost:
|
13079
14516
|
description: Projected Cost data.
|
13080
14517
|
properties:
|
@@ -13131,6 +14568,15 @@ components:
|
|
13131
14568
|
type: string
|
13132
14569
|
x-enum-varnames:
|
13133
14570
|
- PROJECt_COST
|
14571
|
+
ProjectsResponse:
|
14572
|
+
description: Response with projects
|
14573
|
+
properties:
|
14574
|
+
data:
|
14575
|
+
description: Projects response data
|
14576
|
+
items:
|
14577
|
+
$ref: '#/components/schemas/Project'
|
14578
|
+
type: array
|
14579
|
+
type: object
|
13134
14580
|
QueryFormula:
|
13135
14581
|
description: A formula for calculation based on one or more queries.
|
13136
14582
|
properties:
|
@@ -17524,7 +18970,10 @@ components:
|
|
17524
18970
|
description: Name of the standard pattern.
|
17525
18971
|
type: string
|
17526
18972
|
pattern:
|
17527
|
-
|
18973
|
+
deprecated: true
|
18974
|
+
description: (Deprecated) Regex to match, optionally documented for older
|
18975
|
+
standard rules. Refer to the `description` field to understand what the
|
18976
|
+
rule does.
|
17528
18977
|
type: string
|
17529
18978
|
priority:
|
17530
18979
|
description: Integer from 1 (high) to 5 (low) indicating standard pattern
|
@@ -18614,6 +20063,23 @@ components:
|
|
18614
20063
|
$ref: '#/components/schemas/ServiceDefinitionData'
|
18615
20064
|
type: array
|
18616
20065
|
type: object
|
20066
|
+
ServiceNowTicket:
|
20067
|
+
description: ServiceNow ticket attached to case
|
20068
|
+
nullable: true
|
20069
|
+
properties:
|
20070
|
+
result:
|
20071
|
+
$ref: '#/components/schemas/ServiceNowTicketResult'
|
20072
|
+
status:
|
20073
|
+
$ref: '#/components/schemas/Case3rdPartyTicketStatus'
|
20074
|
+
readOnly: true
|
20075
|
+
type: object
|
20076
|
+
ServiceNowTicketResult:
|
20077
|
+
description: ServiceNow ticket information
|
20078
|
+
properties:
|
20079
|
+
sys_target_link:
|
20080
|
+
description: Link to the Incident created on ServiceNow
|
20081
|
+
type: string
|
20082
|
+
type: object
|
18617
20083
|
SlackIntegrationMetadata:
|
18618
20084
|
description: Incident integration metadata for the Slack integration.
|
18619
20085
|
properties:
|
@@ -20615,12 +22081,34 @@ components:
|
|
20615
22081
|
type: string
|
20616
22082
|
x-enum-varnames:
|
20617
22083
|
- USER_INVITATIONS
|
22084
|
+
UserRelationshipData:
|
22085
|
+
description: Relationship to user object.
|
22086
|
+
properties:
|
22087
|
+
id:
|
22088
|
+
description: A unique identifier that represents the user.
|
22089
|
+
example: 00000000-0000-0000-0000-000000000000
|
22090
|
+
type: string
|
22091
|
+
type:
|
22092
|
+
$ref: '#/components/schemas/UserResourceType'
|
22093
|
+
required:
|
22094
|
+
- id
|
22095
|
+
- type
|
22096
|
+
type: object
|
20618
22097
|
UserRelationships:
|
20619
22098
|
description: Relationships of the user object.
|
20620
22099
|
properties:
|
20621
22100
|
roles:
|
20622
22101
|
$ref: '#/components/schemas/RelationshipToRoles'
|
20623
22102
|
type: object
|
22103
|
+
UserResourceType:
|
22104
|
+
default: user
|
22105
|
+
description: User resource type.
|
22106
|
+
enum:
|
22107
|
+
- user
|
22108
|
+
example: user
|
22109
|
+
type: string
|
22110
|
+
x-enum-varnames:
|
22111
|
+
- USER
|
20624
22112
|
UserResponse:
|
20625
22113
|
description: Response containing information about a single user.
|
20626
22114
|
properties:
|
@@ -20699,6 +22187,10 @@ components:
|
|
20699
22187
|
required:
|
20700
22188
|
- type
|
20701
22189
|
type: object
|
22190
|
+
UserTeamIncluded:
|
22191
|
+
description: Included resources related to the team membership
|
22192
|
+
oneOf:
|
22193
|
+
- $ref: '#/components/schemas/User'
|
20702
22194
|
UserTeamPermission:
|
20703
22195
|
description: A user's permissions for a given team
|
20704
22196
|
properties:
|
@@ -20753,6 +22245,11 @@ components:
|
|
20753
22245
|
properties:
|
20754
22246
|
data:
|
20755
22247
|
$ref: '#/components/schemas/UserTeam'
|
22248
|
+
included:
|
22249
|
+
description: Resources related to the team memberships
|
22250
|
+
items:
|
22251
|
+
$ref: '#/components/schemas/UserTeamIncluded'
|
22252
|
+
type: array
|
20756
22253
|
type: object
|
20757
22254
|
UserTeamRole:
|
20758
22255
|
description: The user's role within the team
|
@@ -20857,6 +22354,18 @@ components:
|
|
20857
22354
|
required:
|
20858
22355
|
- data
|
20859
22356
|
type: object
|
22357
|
+
UsersRelationship:
|
22358
|
+
description: Relationship to users.
|
22359
|
+
properties:
|
22360
|
+
data:
|
22361
|
+
description: Relationships to user objects.
|
22362
|
+
example: []
|
22363
|
+
items:
|
22364
|
+
$ref: '#/components/schemas/UserRelationshipData'
|
22365
|
+
type: array
|
22366
|
+
required:
|
22367
|
+
- data
|
22368
|
+
type: object
|
20860
22369
|
UsersResponse:
|
20861
22370
|
description: Response containing information about multiple users.
|
20862
22371
|
properties:
|
@@ -20929,6 +22438,8 @@ components:
|
|
20929
22438
|
apm_service_catalog_read: View service catalog and service definitions.
|
20930
22439
|
apm_service_catalog_write: Add, modify, and delete service catalog definitions
|
20931
22440
|
when those definitions are maintained by Datadog.
|
22441
|
+
cases_read: Read all cases data.
|
22442
|
+
cases_write: Create, update and delete cases data.
|
20932
22443
|
ci_visibility_pipelines_write: Create CI Visibility pipeline spans using
|
20933
22444
|
the API.
|
20934
22445
|
ci_visibility_read: View CI Visibility.
|
@@ -22117,6 +23628,472 @@ paths:
|
|
22117
23628
|
- AuthN Mappings
|
22118
23629
|
x-codegen-request-body-name: body
|
22119
23630
|
x-permission: OR(USER_ACCESS_MANAGE)
|
23631
|
+
/api/v2/cases:
|
23632
|
+
get:
|
23633
|
+
description: Search cases.
|
23634
|
+
operationId: SearchCases
|
23635
|
+
parameters:
|
23636
|
+
- $ref: '#/components/parameters/PageSize'
|
23637
|
+
- $ref: '#/components/parameters/PageOffset'
|
23638
|
+
- $ref: '#/components/parameters/CaseSortableFieldParameter'
|
23639
|
+
- description: Search query
|
23640
|
+
in: query
|
23641
|
+
name: filter
|
23642
|
+
required: false
|
23643
|
+
schema:
|
23644
|
+
example: status:open (team:case-management OR team:event-management)
|
23645
|
+
type: string
|
23646
|
+
- description: Specify if order is ascending or not
|
23647
|
+
in: query
|
23648
|
+
name: sort[asc]
|
23649
|
+
required: false
|
23650
|
+
schema:
|
23651
|
+
default: false
|
23652
|
+
type: boolean
|
23653
|
+
responses:
|
23654
|
+
'200':
|
23655
|
+
content:
|
23656
|
+
application/json:
|
23657
|
+
schema:
|
23658
|
+
$ref: '#/components/schemas/CasesResponse'
|
23659
|
+
description: OK
|
23660
|
+
'400':
|
23661
|
+
$ref: '#/components/responses/BadRequestResponse'
|
23662
|
+
'401':
|
23663
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
23664
|
+
'403':
|
23665
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
23666
|
+
'404':
|
23667
|
+
$ref: '#/components/responses/NotFoundResponse'
|
23668
|
+
'429':
|
23669
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
23670
|
+
security:
|
23671
|
+
- apiKeyAuth: []
|
23672
|
+
appKeyAuth: []
|
23673
|
+
- AuthZ:
|
23674
|
+
- cases_read
|
23675
|
+
summary: Search cases
|
23676
|
+
tags:
|
23677
|
+
- Case Management
|
23678
|
+
x-pagination:
|
23679
|
+
limitParam: page[size]
|
23680
|
+
pageOffsetParam: page[offset]
|
23681
|
+
resultsPath: data
|
23682
|
+
post:
|
23683
|
+
description: Create a Case
|
23684
|
+
operationId: CreateCase
|
23685
|
+
requestBody:
|
23686
|
+
content:
|
23687
|
+
application/json:
|
23688
|
+
schema:
|
23689
|
+
$ref: '#/components/schemas/CaseCreateRequest'
|
23690
|
+
description: Case payload
|
23691
|
+
required: true
|
23692
|
+
responses:
|
23693
|
+
'201':
|
23694
|
+
content:
|
23695
|
+
application/json:
|
23696
|
+
schema:
|
23697
|
+
$ref: '#/components/schemas/CaseResponse'
|
23698
|
+
description: CREATED
|
23699
|
+
'400':
|
23700
|
+
$ref: '#/components/responses/BadRequestResponse'
|
23701
|
+
'401':
|
23702
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
23703
|
+
'403':
|
23704
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
23705
|
+
'404':
|
23706
|
+
$ref: '#/components/responses/NotFoundResponse'
|
23707
|
+
'429':
|
23708
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
23709
|
+
security:
|
23710
|
+
- apiKeyAuth: []
|
23711
|
+
appKeyAuth: []
|
23712
|
+
- AuthZ:
|
23713
|
+
- cases_write
|
23714
|
+
summary: Create a case
|
23715
|
+
tags:
|
23716
|
+
- Case Management
|
23717
|
+
/api/v2/cases/projects:
|
23718
|
+
get:
|
23719
|
+
description: Get all projects.
|
23720
|
+
operationId: GetProjects
|
23721
|
+
responses:
|
23722
|
+
'200':
|
23723
|
+
content:
|
23724
|
+
application/json:
|
23725
|
+
schema:
|
23726
|
+
$ref: '#/components/schemas/ProjectsResponse'
|
23727
|
+
description: OK
|
23728
|
+
'400':
|
23729
|
+
$ref: '#/components/responses/BadRequestResponse'
|
23730
|
+
'401':
|
23731
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
23732
|
+
'403':
|
23733
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
23734
|
+
'404':
|
23735
|
+
$ref: '#/components/responses/NotFoundResponse'
|
23736
|
+
'429':
|
23737
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
23738
|
+
security:
|
23739
|
+
- apiKeyAuth: []
|
23740
|
+
appKeyAuth: []
|
23741
|
+
- AuthZ:
|
23742
|
+
- cases_read
|
23743
|
+
summary: Get all projects
|
23744
|
+
tags:
|
23745
|
+
- Case Management
|
23746
|
+
post:
|
23747
|
+
description: Create a project.
|
23748
|
+
operationId: CreateProject
|
23749
|
+
requestBody:
|
23750
|
+
content:
|
23751
|
+
application/json:
|
23752
|
+
schema:
|
23753
|
+
$ref: '#/components/schemas/ProjectCreateRequest'
|
23754
|
+
description: Project payload
|
23755
|
+
required: true
|
23756
|
+
responses:
|
23757
|
+
'201':
|
23758
|
+
content:
|
23759
|
+
application/json:
|
23760
|
+
schema:
|
23761
|
+
$ref: '#/components/schemas/ProjectResponse'
|
23762
|
+
description: CREATED
|
23763
|
+
'400':
|
23764
|
+
$ref: '#/components/responses/BadRequestResponse'
|
23765
|
+
'401':
|
23766
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
23767
|
+
'403':
|
23768
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
23769
|
+
'404':
|
23770
|
+
$ref: '#/components/responses/NotFoundResponse'
|
23771
|
+
'429':
|
23772
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
23773
|
+
security:
|
23774
|
+
- apiKeyAuth: []
|
23775
|
+
appKeyAuth: []
|
23776
|
+
- AuthZ:
|
23777
|
+
- cases_write
|
23778
|
+
summary: Create a project
|
23779
|
+
tags:
|
23780
|
+
- Case Management
|
23781
|
+
/api/v2/cases/projects/{project_id}:
|
23782
|
+
delete:
|
23783
|
+
description: Remove a project using the project's `id`.
|
23784
|
+
operationId: DeleteProject
|
23785
|
+
parameters:
|
23786
|
+
- $ref: '#/components/parameters/ProjectIDPathParameter'
|
23787
|
+
responses:
|
23788
|
+
'204':
|
23789
|
+
description: No Content
|
23790
|
+
'403':
|
23791
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
23792
|
+
'404':
|
23793
|
+
content:
|
23794
|
+
application/json:
|
23795
|
+
schema:
|
23796
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
23797
|
+
description: API error response
|
23798
|
+
'429':
|
23799
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
23800
|
+
security:
|
23801
|
+
- apiKeyAuth: []
|
23802
|
+
appKeyAuth: []
|
23803
|
+
- AuthZ:
|
23804
|
+
- cases_write
|
23805
|
+
summary: Remove a project
|
23806
|
+
tags:
|
23807
|
+
- Case Management
|
23808
|
+
get:
|
23809
|
+
description: Get the details of a project by `project_id`.
|
23810
|
+
operationId: GetProject
|
23811
|
+
parameters:
|
23812
|
+
- $ref: '#/components/parameters/ProjectIDPathParameter'
|
23813
|
+
responses:
|
23814
|
+
'200':
|
23815
|
+
content:
|
23816
|
+
application/json:
|
23817
|
+
schema:
|
23818
|
+
$ref: '#/components/schemas/ProjectResponse'
|
23819
|
+
description: OK
|
23820
|
+
'400':
|
23821
|
+
$ref: '#/components/responses/BadRequestResponse'
|
23822
|
+
'401':
|
23823
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
23824
|
+
'403':
|
23825
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
23826
|
+
'404':
|
23827
|
+
$ref: '#/components/responses/NotFoundResponse'
|
23828
|
+
'429':
|
23829
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
23830
|
+
security:
|
23831
|
+
- apiKeyAuth: []
|
23832
|
+
appKeyAuth: []
|
23833
|
+
- AuthZ:
|
23834
|
+
- cases_read
|
23835
|
+
summary: Get the details of a project
|
23836
|
+
tags:
|
23837
|
+
- Case Management
|
23838
|
+
/api/v2/cases/{case_id}:
|
23839
|
+
get:
|
23840
|
+
description: Get the details of case by `case_id`
|
23841
|
+
operationId: GetCase
|
23842
|
+
parameters:
|
23843
|
+
- $ref: '#/components/parameters/CaseIDPathParameter'
|
23844
|
+
responses:
|
23845
|
+
'200':
|
23846
|
+
content:
|
23847
|
+
application/json:
|
23848
|
+
schema:
|
23849
|
+
$ref: '#/components/schemas/CaseResponse'
|
23850
|
+
description: OK
|
23851
|
+
'400':
|
23852
|
+
$ref: '#/components/responses/BadRequestResponse'
|
23853
|
+
'401':
|
23854
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
23855
|
+
'403':
|
23856
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
23857
|
+
'404':
|
23858
|
+
$ref: '#/components/responses/NotFoundResponse'
|
23859
|
+
'429':
|
23860
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
23861
|
+
security:
|
23862
|
+
- apiKeyAuth: []
|
23863
|
+
appKeyAuth: []
|
23864
|
+
- AuthZ:
|
23865
|
+
- cases_read
|
23866
|
+
summary: Get the details of a case
|
23867
|
+
tags:
|
23868
|
+
- Case Management
|
23869
|
+
/api/v2/cases/{case_id}/archive:
|
23870
|
+
post:
|
23871
|
+
description: Archive case
|
23872
|
+
operationId: ArchiveCase
|
23873
|
+
parameters:
|
23874
|
+
- $ref: '#/components/parameters/CaseIDPathParameter'
|
23875
|
+
requestBody:
|
23876
|
+
content:
|
23877
|
+
application/json:
|
23878
|
+
schema:
|
23879
|
+
$ref: '#/components/schemas/CaseEmptyRequest'
|
23880
|
+
description: Archive case payload
|
23881
|
+
required: true
|
23882
|
+
responses:
|
23883
|
+
'200':
|
23884
|
+
content:
|
23885
|
+
application/json:
|
23886
|
+
schema:
|
23887
|
+
$ref: '#/components/schemas/CaseResponse'
|
23888
|
+
description: OK
|
23889
|
+
'400':
|
23890
|
+
$ref: '#/components/responses/BadRequestResponse'
|
23891
|
+
'401':
|
23892
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
23893
|
+
'403':
|
23894
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
23895
|
+
'404':
|
23896
|
+
$ref: '#/components/responses/NotFoundResponse'
|
23897
|
+
'429':
|
23898
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
23899
|
+
security:
|
23900
|
+
- apiKeyAuth: []
|
23901
|
+
appKeyAuth: []
|
23902
|
+
- AuthZ:
|
23903
|
+
- cases_write
|
23904
|
+
summary: Archive case
|
23905
|
+
tags:
|
23906
|
+
- Case Management
|
23907
|
+
/api/v2/cases/{case_id}/assign:
|
23908
|
+
post:
|
23909
|
+
description: Assign case to a user
|
23910
|
+
operationId: AssignCase
|
23911
|
+
parameters:
|
23912
|
+
- $ref: '#/components/parameters/CaseIDPathParameter'
|
23913
|
+
requestBody:
|
23914
|
+
content:
|
23915
|
+
application/json:
|
23916
|
+
schema:
|
23917
|
+
$ref: '#/components/schemas/CaseAssignRequest'
|
23918
|
+
description: Assign case payload
|
23919
|
+
required: true
|
23920
|
+
responses:
|
23921
|
+
'200':
|
23922
|
+
content:
|
23923
|
+
application/json:
|
23924
|
+
schema:
|
23925
|
+
$ref: '#/components/schemas/CaseResponse'
|
23926
|
+
description: OK
|
23927
|
+
'400':
|
23928
|
+
$ref: '#/components/responses/BadRequestResponse'
|
23929
|
+
'401':
|
23930
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
23931
|
+
'403':
|
23932
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
23933
|
+
'404':
|
23934
|
+
$ref: '#/components/responses/NotFoundResponse'
|
23935
|
+
'429':
|
23936
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
23937
|
+
security:
|
23938
|
+
- apiKeyAuth: []
|
23939
|
+
appKeyAuth: []
|
23940
|
+
- AuthZ:
|
23941
|
+
- cases_write
|
23942
|
+
summary: Assign case
|
23943
|
+
tags:
|
23944
|
+
- Case Management
|
23945
|
+
/api/v2/cases/{case_id}/priority:
|
23946
|
+
post:
|
23947
|
+
description: Update case priority
|
23948
|
+
operationId: UpdatePriority
|
23949
|
+
parameters:
|
23950
|
+
- $ref: '#/components/parameters/CaseIDPathParameter'
|
23951
|
+
requestBody:
|
23952
|
+
content:
|
23953
|
+
application/json:
|
23954
|
+
schema:
|
23955
|
+
$ref: '#/components/schemas/CaseUpdatePriorityRequest'
|
23956
|
+
description: Case priority update payload
|
23957
|
+
required: true
|
23958
|
+
responses:
|
23959
|
+
'200':
|
23960
|
+
content:
|
23961
|
+
application/json:
|
23962
|
+
schema:
|
23963
|
+
$ref: '#/components/schemas/CaseResponse'
|
23964
|
+
description: OK
|
23965
|
+
'400':
|
23966
|
+
$ref: '#/components/responses/BadRequestResponse'
|
23967
|
+
'401':
|
23968
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
23969
|
+
'403':
|
23970
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
23971
|
+
'404':
|
23972
|
+
$ref: '#/components/responses/NotFoundResponse'
|
23973
|
+
'429':
|
23974
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
23975
|
+
security:
|
23976
|
+
- apiKeyAuth: []
|
23977
|
+
appKeyAuth: []
|
23978
|
+
- AuthZ:
|
23979
|
+
- cases_write
|
23980
|
+
summary: Update case priority
|
23981
|
+
tags:
|
23982
|
+
- Case Management
|
23983
|
+
/api/v2/cases/{case_id}/status:
|
23984
|
+
post:
|
23985
|
+
description: Update case status
|
23986
|
+
operationId: UpdateStatus
|
23987
|
+
parameters:
|
23988
|
+
- $ref: '#/components/parameters/CaseIDPathParameter'
|
23989
|
+
requestBody:
|
23990
|
+
content:
|
23991
|
+
application/json:
|
23992
|
+
schema:
|
23993
|
+
$ref: '#/components/schemas/CaseUpdateStatusRequest'
|
23994
|
+
description: Case status update payload
|
23995
|
+
required: true
|
23996
|
+
responses:
|
23997
|
+
'200':
|
23998
|
+
content:
|
23999
|
+
application/json:
|
24000
|
+
schema:
|
24001
|
+
$ref: '#/components/schemas/CaseResponse'
|
24002
|
+
description: OK
|
24003
|
+
'400':
|
24004
|
+
$ref: '#/components/responses/BadRequestResponse'
|
24005
|
+
'401':
|
24006
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
24007
|
+
'403':
|
24008
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
24009
|
+
'404':
|
24010
|
+
$ref: '#/components/responses/NotFoundResponse'
|
24011
|
+
'429':
|
24012
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
24013
|
+
security:
|
24014
|
+
- apiKeyAuth: []
|
24015
|
+
appKeyAuth: []
|
24016
|
+
- AuthZ:
|
24017
|
+
- cases_write
|
24018
|
+
summary: Update case status
|
24019
|
+
tags:
|
24020
|
+
- Case Management
|
24021
|
+
/api/v2/cases/{case_id}/unarchive:
|
24022
|
+
post:
|
24023
|
+
description: Unarchive case
|
24024
|
+
operationId: UnarchiveCase
|
24025
|
+
parameters:
|
24026
|
+
- $ref: '#/components/parameters/CaseIDPathParameter'
|
24027
|
+
requestBody:
|
24028
|
+
content:
|
24029
|
+
application/json:
|
24030
|
+
schema:
|
24031
|
+
$ref: '#/components/schemas/CaseEmptyRequest'
|
24032
|
+
description: Unarchive case payload
|
24033
|
+
required: true
|
24034
|
+
responses:
|
24035
|
+
'200':
|
24036
|
+
content:
|
24037
|
+
application/json:
|
24038
|
+
schema:
|
24039
|
+
$ref: '#/components/schemas/CaseResponse'
|
24040
|
+
description: OK
|
24041
|
+
'400':
|
24042
|
+
$ref: '#/components/responses/BadRequestResponse'
|
24043
|
+
'401':
|
24044
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
24045
|
+
'403':
|
24046
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
24047
|
+
'404':
|
24048
|
+
$ref: '#/components/responses/NotFoundResponse'
|
24049
|
+
'429':
|
24050
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
24051
|
+
security:
|
24052
|
+
- apiKeyAuth: []
|
24053
|
+
appKeyAuth: []
|
24054
|
+
- AuthZ:
|
24055
|
+
- cases_write
|
24056
|
+
summary: Unarchive case
|
24057
|
+
tags:
|
24058
|
+
- Case Management
|
24059
|
+
/api/v2/cases/{case_id}/unassign:
|
24060
|
+
post:
|
24061
|
+
description: Unassign case
|
24062
|
+
operationId: UnassignCase
|
24063
|
+
parameters:
|
24064
|
+
- $ref: '#/components/parameters/CaseIDPathParameter'
|
24065
|
+
requestBody:
|
24066
|
+
content:
|
24067
|
+
application/json:
|
24068
|
+
schema:
|
24069
|
+
$ref: '#/components/schemas/CaseEmptyRequest'
|
24070
|
+
description: Unassign case payload
|
24071
|
+
required: true
|
24072
|
+
responses:
|
24073
|
+
'200':
|
24074
|
+
content:
|
24075
|
+
application/json:
|
24076
|
+
schema:
|
24077
|
+
$ref: '#/components/schemas/CaseResponse'
|
24078
|
+
description: OK
|
24079
|
+
'400':
|
24080
|
+
$ref: '#/components/responses/BadRequestResponse'
|
24081
|
+
'401':
|
24082
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
24083
|
+
'403':
|
24084
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
24085
|
+
'404':
|
24086
|
+
$ref: '#/components/responses/NotFoundResponse'
|
24087
|
+
'429':
|
24088
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
24089
|
+
security:
|
24090
|
+
- apiKeyAuth: []
|
24091
|
+
appKeyAuth: []
|
24092
|
+
- AuthZ:
|
24093
|
+
- cases_write
|
24094
|
+
summary: Unassign case
|
24095
|
+
tags:
|
24096
|
+
- Case Management
|
22120
24097
|
/api/v2/ci/pipeline:
|
22121
24098
|
post:
|
22122
24099
|
description: 'Send your pipeline event to your Datadog platform over HTTP. For
|
@@ -22389,8 +24366,8 @@ paths:
|
|
22389
24366
|
x-codegen-request-body-name: body
|
22390
24367
|
/api/v2/ci/tests/events:
|
22391
24368
|
get:
|
22392
|
-
description: 'List endpoint returns CI Visibility test events that match a [
|
22393
|
-
|
24369
|
+
description: 'List endpoint returns CI Visibility test events that match a [search
|
24370
|
+
query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).
|
22394
24371
|
|
22395
24372
|
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).
|
22396
24373
|
|
@@ -22473,8 +24450,8 @@ paths:
|
|
22473
24450
|
resultsPath: data
|
22474
24451
|
/api/v2/ci/tests/events/search:
|
22475
24452
|
post:
|
22476
|
-
description: 'List endpoint returns CI Visibility test events that match a [
|
22477
|
-
|
24453
|
+
description: 'List endpoint returns CI Visibility test events that match a [search
|
24454
|
+
query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).
|
22478
24455
|
|
22479
24456
|
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).
|
22480
24457
|
|
@@ -22996,7 +24973,7 @@ paths:
|
|
22996
24973
|
/api/v2/cost_by_tag/active_billing_dimensions:
|
22997
24974
|
get:
|
22998
24975
|
description: Get active billing dimensions for cost attribution. Cost data for
|
22999
|
-
a given month becomes available no later than the
|
24976
|
+
a given month becomes available no later than the 19th of the following month.
|
23000
24977
|
operationId: GetActiveBillingDimensions
|
23001
24978
|
responses:
|
23002
24979
|
'200':
|
@@ -23038,7 +25015,7 @@ paths:
|
|
23038
25015
|
get:
|
23039
25016
|
description: "Get monthly cost attribution by tag across multi-org and single
|
23040
25017
|
root-org accounts.\nCost Attribution data for a given month becomes available
|
23041
|
-
no later than the
|
25018
|
+
no later than the 19th of the following month.\nThis API endpoint is paginated.
|
23042
25019
|
To make sure you receive all records, check if the value of `next_record_id`
|
23043
25020
|
is\nset in the response. If it is, make another request and pass `next_record_id`
|
23044
25021
|
as a parameter.\nPseudo code example:\n```\nresponse := GetMonthlyCostAttribution(start_month,
|
@@ -26397,6 +28374,135 @@ paths:
|
|
26397
28374
|
tags:
|
26398
28375
|
- Logs Archives
|
26399
28376
|
x-codegen-request-body-name: body
|
28377
|
+
/api/v2/logs/config/custom-destinations:
|
28378
|
+
get:
|
28379
|
+
description: Get the list of configured custom destinations in your organization
|
28380
|
+
with their definitions.
|
28381
|
+
operationId: ListLogsCustomDestinations
|
28382
|
+
responses:
|
28383
|
+
'200':
|
28384
|
+
content:
|
28385
|
+
application/json:
|
28386
|
+
schema:
|
28387
|
+
$ref: '#/components/schemas/CustomDestinationsResponse'
|
28388
|
+
description: OK
|
28389
|
+
'403':
|
28390
|
+
content:
|
28391
|
+
application/json:
|
28392
|
+
schema:
|
28393
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
28394
|
+
description: Forbidden
|
28395
|
+
'429':
|
28396
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
28397
|
+
summary: Get all custom destinations
|
28398
|
+
tags:
|
28399
|
+
- Logs Custom Destinations
|
28400
|
+
post:
|
28401
|
+
description: Create a custom destination in your organization.
|
28402
|
+
operationId: CreateLogsCustomDestination
|
28403
|
+
requestBody:
|
28404
|
+
content:
|
28405
|
+
application/json:
|
28406
|
+
schema:
|
28407
|
+
$ref: '#/components/schemas/CustomDestinationCreateRequest'
|
28408
|
+
description: The definition of the new custom destination.
|
28409
|
+
required: true
|
28410
|
+
responses:
|
28411
|
+
'200':
|
28412
|
+
content:
|
28413
|
+
application/json:
|
28414
|
+
schema:
|
28415
|
+
$ref: '#/components/schemas/CustomDestinationResponse'
|
28416
|
+
description: OK
|
28417
|
+
'400':
|
28418
|
+
$ref: '#/components/responses/BadRequestResponse'
|
28419
|
+
'403':
|
28420
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
28421
|
+
'409':
|
28422
|
+
$ref: '#/components/responses/ConflictResponse'
|
28423
|
+
'429':
|
28424
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
28425
|
+
summary: Create a custom destination
|
28426
|
+
tags:
|
28427
|
+
- Logs Custom Destinations
|
28428
|
+
x-codegen-request-body-name: body
|
28429
|
+
/api/v2/logs/config/custom-destinations/{custom_destination_id}:
|
28430
|
+
delete:
|
28431
|
+
description: Delete a specific custom destination in your organization.
|
28432
|
+
operationId: DeleteLogsCustomDestination
|
28433
|
+
parameters:
|
28434
|
+
- $ref: '#/components/parameters/CustomDestinationId'
|
28435
|
+
responses:
|
28436
|
+
'204':
|
28437
|
+
description: OK
|
28438
|
+
'400':
|
28439
|
+
$ref: '#/components/responses/BadRequestResponse'
|
28440
|
+
'403':
|
28441
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
28442
|
+
'404':
|
28443
|
+
$ref: '#/components/responses/NotFoundResponse'
|
28444
|
+
'429':
|
28445
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
28446
|
+
summary: Delete a custom destination
|
28447
|
+
tags:
|
28448
|
+
- Logs Custom Destinations
|
28449
|
+
get:
|
28450
|
+
description: Get a specific custom destination in your organization.
|
28451
|
+
operationId: GetLogsCustomDestination
|
28452
|
+
parameters:
|
28453
|
+
- $ref: '#/components/parameters/CustomDestinationId'
|
28454
|
+
responses:
|
28455
|
+
'200':
|
28456
|
+
content:
|
28457
|
+
application/json:
|
28458
|
+
schema:
|
28459
|
+
$ref: '#/components/schemas/CustomDestinationResponse'
|
28460
|
+
description: OK
|
28461
|
+
'400':
|
28462
|
+
$ref: '#/components/responses/BadRequestResponse'
|
28463
|
+
'403':
|
28464
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
28465
|
+
'404':
|
28466
|
+
$ref: '#/components/responses/NotFoundResponse'
|
28467
|
+
'429':
|
28468
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
28469
|
+
summary: Get a custom destination
|
28470
|
+
tags:
|
28471
|
+
- Logs Custom Destinations
|
28472
|
+
patch:
|
28473
|
+
description: Update the given fields of a specific custom destination in your
|
28474
|
+
organization.
|
28475
|
+
operationId: UpdateLogsCustomDestination
|
28476
|
+
parameters:
|
28477
|
+
- $ref: '#/components/parameters/CustomDestinationId'
|
28478
|
+
requestBody:
|
28479
|
+
content:
|
28480
|
+
application/json:
|
28481
|
+
schema:
|
28482
|
+
$ref: '#/components/schemas/CustomDestinationUpdateRequest'
|
28483
|
+
description: New definition of the custom destination's fields.
|
28484
|
+
required: true
|
28485
|
+
responses:
|
28486
|
+
'200':
|
28487
|
+
content:
|
28488
|
+
application/json:
|
28489
|
+
schema:
|
28490
|
+
$ref: '#/components/schemas/CustomDestinationResponse'
|
28491
|
+
description: OK
|
28492
|
+
'400':
|
28493
|
+
$ref: '#/components/responses/BadRequestResponse'
|
28494
|
+
'403':
|
28495
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
28496
|
+
'404':
|
28497
|
+
$ref: '#/components/responses/NotFoundResponse'
|
28498
|
+
'409':
|
28499
|
+
$ref: '#/components/responses/ConflictResponse'
|
28500
|
+
'429':
|
28501
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
28502
|
+
summary: Update a custom destination
|
28503
|
+
tags:
|
28504
|
+
- Logs Custom Destinations
|
28505
|
+
x-codegen-request-body-name: body
|
26400
28506
|
/api/v2/logs/config/metrics:
|
26401
28507
|
get:
|
26402
28508
|
description: Get the list of configured log-based metrics with their definitions.
|
@@ -26841,45 +28947,98 @@ paths:
|
|
26841
28947
|
schema:
|
26842
28948
|
$ref: '#/components/schemas/APIErrorResponse'
|
26843
28949
|
description: Too Many Requests
|
26844
|
-
summary: Delete tags for multiple metrics
|
28950
|
+
summary: Delete tags for multiple metrics
|
28951
|
+
tags:
|
28952
|
+
- Metrics
|
28953
|
+
x-codegen-request-body-name: body
|
28954
|
+
post:
|
28955
|
+
description: 'Create and define a list of queryable tag keys for a set of existing
|
28956
|
+
count, gauge, rate, and distribution metrics.
|
28957
|
+
|
28958
|
+
Metrics are selected by passing a metric name prefix. Use the Delete method
|
28959
|
+
of this API path to remove tag configurations.
|
28960
|
+
|
28961
|
+
Results can be sent to a set of account email addresses, just like the same
|
28962
|
+
operation in the Datadog web app.
|
28963
|
+
|
28964
|
+
If multiple calls include the same metric, the last configuration applied
|
28965
|
+
(not by submit order) is used, do not
|
28966
|
+
|
28967
|
+
expect deterministic ordering of concurrent calls. The `exclude_tags_mode`
|
28968
|
+
value will set all metrics that match the prefix to
|
28969
|
+
|
28970
|
+
the same exclusion state, metric tag configurations do not support mixed inclusion
|
28971
|
+
and exclusion for tags on the same metric.
|
28972
|
+
|
28973
|
+
Can only be used with application keys of users with the `Manage Tags for
|
28974
|
+
Metrics` permission.'
|
28975
|
+
operationId: CreateBulkTagsMetricsConfiguration
|
28976
|
+
requestBody:
|
28977
|
+
content:
|
28978
|
+
application/json:
|
28979
|
+
schema:
|
28980
|
+
$ref: '#/components/schemas/MetricBulkTagConfigCreateRequest'
|
28981
|
+
required: true
|
28982
|
+
responses:
|
28983
|
+
'202':
|
28984
|
+
content:
|
28985
|
+
application/json:
|
28986
|
+
schema:
|
28987
|
+
$ref: '#/components/schemas/MetricBulkTagConfigResponse'
|
28988
|
+
description: Accepted
|
28989
|
+
'400':
|
28990
|
+
content:
|
28991
|
+
application/json:
|
28992
|
+
schema:
|
28993
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
28994
|
+
description: Bad Request
|
28995
|
+
'403':
|
28996
|
+
content:
|
28997
|
+
application/json:
|
28998
|
+
schema:
|
28999
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
29000
|
+
description: Forbidden
|
29001
|
+
'404':
|
29002
|
+
content:
|
29003
|
+
application/json:
|
29004
|
+
schema:
|
29005
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
29006
|
+
description: Not Found
|
29007
|
+
'429':
|
29008
|
+
content:
|
29009
|
+
application/json:
|
29010
|
+
schema:
|
29011
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
29012
|
+
description: Too Many Requests
|
29013
|
+
summary: Configure tags for multiple metrics
|
26845
29014
|
tags:
|
26846
29015
|
- Metrics
|
26847
29016
|
x-codegen-request-body-name: body
|
26848
|
-
|
26849
|
-
|
26850
|
-
|
26851
|
-
|
26852
|
-
|
26853
|
-
|
26854
|
-
|
26855
|
-
|
26856
|
-
operation in the Datadog web app.
|
26857
|
-
|
26858
|
-
If multiple calls include the same metric, the last configuration applied
|
26859
|
-
(not by submit order) is used, do not
|
26860
|
-
|
26861
|
-
expect deterministic ordering of concurrent calls. The `exclude_tags_mode`
|
26862
|
-
value will set all metrics that match the prefix to
|
26863
|
-
|
26864
|
-
the same exclusion state, metric tag configurations do not support mixed inclusion
|
26865
|
-
and exclusion for tags on the same metric.
|
29017
|
+
/api/v2/metrics/{metric_name}/active-configurations:
|
29018
|
+
get:
|
29019
|
+
description: List tags and aggregations that are actively queried on dashboards
|
29020
|
+
and monitors for a given metric name.
|
29021
|
+
operationId: ListActiveMetricConfigurations
|
29022
|
+
parameters:
|
29023
|
+
- $ref: '#/components/parameters/MetricName'
|
29024
|
+
- description: 'The number of seconds of look back (from now).
|
26866
29025
|
|
26867
|
-
|
26868
|
-
|
26869
|
-
|
26870
|
-
|
26871
|
-
|
26872
|
-
|
26873
|
-
|
26874
|
-
|
26875
|
-
|
29026
|
+
Default value is 604,800 (1 week), minimum value is 7200 (2 hours), maximum
|
29027
|
+
value is 2,630,000 (1 month).'
|
29028
|
+
example: 7200
|
29029
|
+
in: query
|
29030
|
+
name: window[seconds]
|
29031
|
+
required: false
|
29032
|
+
schema:
|
29033
|
+
format: int64
|
29034
|
+
type: integer
|
26876
29035
|
responses:
|
26877
|
-
'
|
29036
|
+
'200':
|
26878
29037
|
content:
|
26879
29038
|
application/json:
|
26880
29039
|
schema:
|
26881
|
-
$ref: '#/components/schemas/
|
26882
|
-
description:
|
29040
|
+
$ref: '#/components/schemas/MetricSuggestedTagsAndAggregationsResponse'
|
29041
|
+
description: Success
|
26883
29042
|
'400':
|
26884
29043
|
content:
|
26885
29044
|
application/json:
|
@@ -26904,34 +29063,26 @@ paths:
|
|
26904
29063
|
schema:
|
26905
29064
|
$ref: '#/components/schemas/APIErrorResponse'
|
26906
29065
|
description: Too Many Requests
|
26907
|
-
|
29066
|
+
security:
|
29067
|
+
- apiKeyAuth: []
|
29068
|
+
appKeyAuth: []
|
29069
|
+
- AuthZ:
|
29070
|
+
- metrics_read
|
29071
|
+
summary: List active tags and aggregations
|
26908
29072
|
tags:
|
26909
29073
|
- Metrics
|
26910
|
-
|
26911
|
-
/api/v2/metrics/{metric_name}/active-configurations:
|
29074
|
+
/api/v2/metrics/{metric_name}/all-tags:
|
26912
29075
|
get:
|
26913
|
-
description:
|
26914
|
-
|
26915
|
-
operationId: ListActiveMetricConfigurations
|
29076
|
+
description: View indexed tag key-value pairs for a given metric name.
|
29077
|
+
operationId: ListTagsByMetricName
|
26916
29078
|
parameters:
|
26917
29079
|
- $ref: '#/components/parameters/MetricName'
|
26918
|
-
- description: 'The number of seconds of look back (from now).
|
26919
|
-
|
26920
|
-
Default value is 604,800 (1 week), minimum value is 7200 (2 hours), maximum
|
26921
|
-
value is 2,630,000 (1 month).'
|
26922
|
-
example: 7200
|
26923
|
-
in: query
|
26924
|
-
name: window[seconds]
|
26925
|
-
required: false
|
26926
|
-
schema:
|
26927
|
-
format: int64
|
26928
|
-
type: integer
|
26929
29080
|
responses:
|
26930
29081
|
'200':
|
26931
29082
|
content:
|
26932
29083
|
application/json:
|
26933
29084
|
schema:
|
26934
|
-
$ref: '#/components/schemas/
|
29085
|
+
$ref: '#/components/schemas/MetricAllTagsResponse'
|
26935
29086
|
description: Success
|
26936
29087
|
'400':
|
26937
29088
|
content:
|
@@ -26962,13 +29113,14 @@ paths:
|
|
26962
29113
|
appKeyAuth: []
|
26963
29114
|
- AuthZ:
|
26964
29115
|
- metrics_read
|
26965
|
-
summary: List
|
29116
|
+
summary: List tags by metric name
|
26966
29117
|
tags:
|
26967
29118
|
- Metrics
|
26968
|
-
/api/v2/metrics/{metric_name}/
|
29119
|
+
/api/v2/metrics/{metric_name}/assets:
|
26969
29120
|
get:
|
26970
|
-
description:
|
26971
|
-
|
29121
|
+
description: Returns dashboards, monitors, notebooks, and SLOs that a metric
|
29122
|
+
is stored in, if any. Updated every 24 hours.
|
29123
|
+
operationId: ListMetricAssets
|
26972
29124
|
parameters:
|
26973
29125
|
- $ref: '#/components/parameters/MetricName'
|
26974
29126
|
responses:
|
@@ -26976,26 +29128,26 @@ paths:
|
|
26976
29128
|
content:
|
26977
29129
|
application/json:
|
26978
29130
|
schema:
|
26979
|
-
$ref: '#/components/schemas/
|
29131
|
+
$ref: '#/components/schemas/MetricAssetsResponse'
|
26980
29132
|
description: Success
|
26981
29133
|
'400':
|
26982
29134
|
content:
|
26983
29135
|
application/json:
|
26984
29136
|
schema:
|
26985
29137
|
$ref: '#/components/schemas/APIErrorResponse'
|
26986
|
-
description:
|
29138
|
+
description: API error response.
|
26987
29139
|
'403':
|
26988
29140
|
content:
|
26989
29141
|
application/json:
|
26990
29142
|
schema:
|
26991
29143
|
$ref: '#/components/schemas/APIErrorResponse'
|
26992
|
-
description:
|
29144
|
+
description: API error response.
|
26993
29145
|
'404':
|
26994
29146
|
content:
|
26995
29147
|
application/json:
|
26996
29148
|
schema:
|
26997
29149
|
$ref: '#/components/schemas/APIErrorResponse'
|
26998
|
-
description:
|
29150
|
+
description: API error response.
|
26999
29151
|
'429':
|
27000
29152
|
content:
|
27001
29153
|
application/json:
|
@@ -27005,9 +29157,8 @@ paths:
|
|
27005
29157
|
security:
|
27006
29158
|
- apiKeyAuth: []
|
27007
29159
|
appKeyAuth: []
|
27008
|
-
- AuthZ:
|
27009
|
-
|
27010
|
-
summary: List tags by metric name
|
29160
|
+
- AuthZ: []
|
29161
|
+
summary: Related Assets to a Metric
|
27011
29162
|
tags:
|
27012
29163
|
- Metrics
|
27013
29164
|
/api/v2/metrics/{metric_name}/estimate:
|
@@ -27026,7 +29177,8 @@ paths:
|
|
27026
29177
|
schema:
|
27027
29178
|
type: string
|
27028
29179
|
- description: The number of hours of look back (from now) to estimate cardinality
|
27029
|
-
with.
|
29180
|
+
with. Estimates are based on historical data, and unspecified fields default
|
29181
|
+
to the minimum 49 hours.
|
27030
29182
|
example: 49
|
27031
29183
|
in: query
|
27032
29184
|
name: filter[hours_ago]
|
@@ -27034,6 +29186,7 @@ paths:
|
|
27034
29186
|
schema:
|
27035
29187
|
format: int32
|
27036
29188
|
maximum: 2147483647
|
29189
|
+
minimum: 49
|
27037
29190
|
type: integer
|
27038
29191
|
- description: The number of aggregations that a `count`, `rate`, or `gauge`
|
27039
29192
|
metric is configured to use. Max number of aggregation combos is 9.
|
@@ -27101,19 +29254,6 @@ paths:
|
|
27101
29254
|
summary: Tag Configuration Cardinality Estimator
|
27102
29255
|
tags:
|
27103
29256
|
- Metrics
|
27104
|
-
x-dd-ownership:
|
27105
|
-
notification_configuration:
|
27106
|
-
manual_escalation_policy: '[Points Aggregation] Primary'
|
27107
|
-
prod_high_urgency: '@pagerduty-Points-Aggregation @slack-points-aggr-ops'
|
27108
|
-
prod_low_urgency: '@slack-points-aggr-ops'
|
27109
|
-
slack_support_channel: '#points-aggregation'
|
27110
|
-
staging_high_urgency: '@slack-points-aggr-stg-ops'
|
27111
|
-
staging_low_urgency: '@slack-points-aggr-stg-ops'
|
27112
|
-
team: points-aggregation
|
27113
|
-
team_escalation: '[Points Aggregation] Primary'
|
27114
|
-
x-permission:
|
27115
|
-
operator: OPEN
|
27116
|
-
permissions: []
|
27117
29257
|
/api/v2/metrics/{metric_name}/tags:
|
27118
29258
|
delete:
|
27119
29259
|
description: 'Deletes a metric''s tag configuration. Can only be used with application
|
@@ -28224,6 +30364,154 @@ paths:
|
|
28224
30364
|
We are gradually onboarding support for more sources. If you have any
|
28225
30365
|
|
28226
30366
|
feedback, contact [Datadog Support](https://docs.datadoghq.com/help/).'
|
30367
|
+
/api/v2/remote_config/products/cws/agent_rules:
|
30368
|
+
get:
|
30369
|
+
description: Get the list of Cloud Security Management Threats Agent rules.
|
30370
|
+
operationId: ListCSMThreatsAgentRules
|
30371
|
+
responses:
|
30372
|
+
'200':
|
30373
|
+
content:
|
30374
|
+
application/json:
|
30375
|
+
schema:
|
30376
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRulesListResponse'
|
30377
|
+
description: OK
|
30378
|
+
'403':
|
30379
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
30380
|
+
'429':
|
30381
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
30382
|
+
summary: Get all CSM Threats Agent rules
|
30383
|
+
tags:
|
30384
|
+
- Cloud Workload Security
|
30385
|
+
post:
|
30386
|
+
description: Create a new Cloud Security Management Threats Agent rule with
|
30387
|
+
the given parameters.
|
30388
|
+
operationId: CreateCSMThreatsAgentRule
|
30389
|
+
requestBody:
|
30390
|
+
content:
|
30391
|
+
application/json:
|
30392
|
+
schema:
|
30393
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleCreateRequest'
|
30394
|
+
description: The definition of the new Agent rule.
|
30395
|
+
required: true
|
30396
|
+
responses:
|
30397
|
+
'200':
|
30398
|
+
content:
|
30399
|
+
application/json:
|
30400
|
+
schema:
|
30401
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleResponse'
|
30402
|
+
description: OK
|
30403
|
+
'400':
|
30404
|
+
$ref: '#/components/responses/BadRequestResponse'
|
30405
|
+
'403':
|
30406
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
30407
|
+
'409':
|
30408
|
+
$ref: '#/components/responses/ConflictResponse'
|
30409
|
+
'429':
|
30410
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
30411
|
+
summary: Create a CSM Threats Agent rule
|
30412
|
+
tags:
|
30413
|
+
- Cloud Workload Security
|
30414
|
+
x-codegen-request-body-name: body
|
30415
|
+
/api/v2/remote_config/products/cws/agent_rules/{agent_rule_id}:
|
30416
|
+
delete:
|
30417
|
+
description: Delete a specific Cloud Security Management Threats Agent rule.
|
30418
|
+
operationId: DeleteCSMThreatsAgentRule
|
30419
|
+
parameters:
|
30420
|
+
- $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID'
|
30421
|
+
responses:
|
30422
|
+
'204':
|
30423
|
+
description: OK
|
30424
|
+
'403':
|
30425
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
30426
|
+
'404':
|
30427
|
+
$ref: '#/components/responses/NotFoundResponse'
|
30428
|
+
'429':
|
30429
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
30430
|
+
summary: Delete a CSM Threats Agent rule
|
30431
|
+
tags:
|
30432
|
+
- Cloud Workload Security
|
30433
|
+
get:
|
30434
|
+
description: Get the details of a specific Cloud Security Management Threats
|
30435
|
+
Agent rule.
|
30436
|
+
operationId: GetCSMThreatsAgentRule
|
30437
|
+
parameters:
|
30438
|
+
- $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID'
|
30439
|
+
responses:
|
30440
|
+
'200':
|
30441
|
+
content:
|
30442
|
+
application/json:
|
30443
|
+
schema:
|
30444
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleResponse'
|
30445
|
+
description: OK
|
30446
|
+
'403':
|
30447
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
30448
|
+
'404':
|
30449
|
+
$ref: '#/components/responses/NotFoundResponse'
|
30450
|
+
'429':
|
30451
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
30452
|
+
summary: Get a CSM Threats Agent rule
|
30453
|
+
tags:
|
30454
|
+
- Cloud Workload Security
|
30455
|
+
patch:
|
30456
|
+
description: 'Update a specific Cloud Security Management Threats Agent rule.
|
30457
|
+
|
30458
|
+
Returns the Agent rule object when the request is successful.'
|
30459
|
+
operationId: UpdateCSMThreatsAgentRule
|
30460
|
+
parameters:
|
30461
|
+
- $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID'
|
30462
|
+
requestBody:
|
30463
|
+
content:
|
30464
|
+
application/json:
|
30465
|
+
schema:
|
30466
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateRequest'
|
30467
|
+
description: New definition of the Agent rule.
|
30468
|
+
required: true
|
30469
|
+
responses:
|
30470
|
+
'200':
|
30471
|
+
content:
|
30472
|
+
application/json:
|
30473
|
+
schema:
|
30474
|
+
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleResponse'
|
30475
|
+
description: OK
|
30476
|
+
'400':
|
30477
|
+
$ref: '#/components/responses/BadRequestResponse'
|
30478
|
+
'403':
|
30479
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
30480
|
+
'404':
|
30481
|
+
$ref: '#/components/responses/NotFoundResponse'
|
30482
|
+
'409':
|
30483
|
+
$ref: '#/components/responses/ConcurrentModificationResponse'
|
30484
|
+
'429':
|
30485
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
30486
|
+
summary: Update a CSM Threats Agent rule
|
30487
|
+
tags:
|
30488
|
+
- Cloud Workload Security
|
30489
|
+
x-codegen-request-body-name: body
|
30490
|
+
/api/v2/remote_config/products/cws/policy/download:
|
30491
|
+
get:
|
30492
|
+
description: 'The download endpoint generates a CSM Threats policy file from
|
30493
|
+
your currently active
|
30494
|
+
|
30495
|
+
CSM Threats rules, and downloads them as a `.policy` file. This file can then
|
30496
|
+
be deployed to
|
30497
|
+
|
30498
|
+
your Agents to update the policy running in your environment.'
|
30499
|
+
operationId: DownloadCSMThreatsPolicy
|
30500
|
+
responses:
|
30501
|
+
'200':
|
30502
|
+
content:
|
30503
|
+
application/zip:
|
30504
|
+
schema:
|
30505
|
+
format: binary
|
30506
|
+
type: string
|
30507
|
+
description: OK
|
30508
|
+
'403':
|
30509
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
30510
|
+
'429':
|
30511
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
30512
|
+
summary: Get the latest CSM Threats policy
|
30513
|
+
tags:
|
30514
|
+
- Cloud Workload Security
|
28227
30515
|
/api/v2/restriction_policy/{resource_id}:
|
28228
30516
|
delete:
|
28229
30517
|
description: Deletes the restriction policy associated with a specified resource.
|
@@ -30991,6 +33279,7 @@ paths:
|
|
30991
33279
|
x-codegen-request-body-name: body
|
30992
33280
|
/api/v2/services:
|
30993
33281
|
get:
|
33282
|
+
deprecated: true
|
30994
33283
|
description: Get all incident services uploaded for the requesting user's organization.
|
30995
33284
|
If the `include[users]` query parameter is provided, the included attribute
|
30996
33285
|
will contain the users related to these incident services.
|
@@ -31025,10 +33314,9 @@ paths:
|
|
31025
33314
|
summary: Get a list of all incident services
|
31026
33315
|
tags:
|
31027
33316
|
- Incident Services
|
31028
|
-
x-unstable: '**Note**: This endpoint is
|
31029
|
-
|
31030
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
33317
|
+
x-unstable: '**Note**: This endpoint is deprecated.'
|
31031
33318
|
post:
|
33319
|
+
deprecated: true
|
31032
33320
|
description: Creates a new incident service.
|
31033
33321
|
operationId: CreateIncidentService
|
31034
33322
|
requestBody:
|
@@ -31064,9 +33352,7 @@ paths:
|
|
31064
33352
|
tags:
|
31065
33353
|
- Incident Services
|
31066
33354
|
x-codegen-request-body-name: body
|
31067
|
-
x-unstable: '**Note**: This endpoint is
|
31068
|
-
|
31069
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
33355
|
+
x-unstable: '**Note**: This endpoint is deprecated.'
|
31070
33356
|
/api/v2/services/definitions:
|
31071
33357
|
get:
|
31072
33358
|
description: Get a list of all service definitions from the Datadog Service
|
@@ -31097,7 +33383,7 @@ paths:
|
|
31097
33383
|
- Service Definition
|
31098
33384
|
x-pagination:
|
31099
33385
|
limitParam: page[size]
|
31100
|
-
|
33386
|
+
pageParam: page[number]
|
31101
33387
|
resultsPath: data
|
31102
33388
|
post:
|
31103
33389
|
description: Create or update service definition in the Datadog Service Catalog.
|
@@ -31191,6 +33477,7 @@ paths:
|
|
31191
33477
|
- Service Definition
|
31192
33478
|
/api/v2/services/{service_id}:
|
31193
33479
|
delete:
|
33480
|
+
deprecated: true
|
31194
33481
|
description: Deletes an existing incident service.
|
31195
33482
|
operationId: DeleteIncidentService
|
31196
33483
|
parameters:
|
@@ -31216,10 +33503,9 @@ paths:
|
|
31216
33503
|
summary: Delete an existing incident service
|
31217
33504
|
tags:
|
31218
33505
|
- Incident Services
|
31219
|
-
x-unstable: '**Note**: This endpoint is
|
31220
|
-
|
31221
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
33506
|
+
x-unstable: '**Note**: This endpoint is deprecated.'
|
31222
33507
|
get:
|
33508
|
+
deprecated: true
|
31223
33509
|
description: 'Get details of an incident service. If the `include[users]` query
|
31224
33510
|
parameter is provided,
|
31225
33511
|
|
@@ -31253,10 +33539,9 @@ paths:
|
|
31253
33539
|
summary: Get details of an incident service
|
31254
33540
|
tags:
|
31255
33541
|
- Incident Services
|
31256
|
-
x-unstable: '**Note**: This endpoint is
|
31257
|
-
|
31258
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
33542
|
+
x-unstable: '**Note**: This endpoint is deprecated.'
|
31259
33543
|
patch:
|
33544
|
+
deprecated: true
|
31260
33545
|
description: Updates an existing incident service. Only provide the attributes
|
31261
33546
|
which should be updated as this request is a partial update.
|
31262
33547
|
operationId: UpdateIncidentService
|
@@ -31295,9 +33580,7 @@ paths:
|
|
31295
33580
|
tags:
|
31296
33581
|
- Incident Services
|
31297
33582
|
x-codegen-request-body-name: body
|
31298
|
-
x-unstable: '**Note**: This endpoint is
|
31299
|
-
|
31300
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
33583
|
+
x-unstable: '**Note**: This endpoint is deprecated.'
|
31301
33584
|
/api/v2/spans/analytics/aggregate:
|
31302
33585
|
post:
|
31303
33586
|
description: 'The API endpoint to aggregate spans into buckets and compute metrics
|
@@ -32699,10 +34982,10 @@ paths:
|
|
32699
34982
|
`application_security`, `audit_trail`, `serverless`, `ci_app`, `cloud_cost_management`,
|
32700
34983
|
|
32701
34984
|
`csm_container_enterprise`, `csm_host_enterprise`, `cspm`, `custom_events`,
|
32702
|
-
`cws`, `dbm`, `
|
34985
|
+
`cws`, `dbm`, `error_tracking`,
|
32703
34986
|
|
32704
|
-
`infra_hosts`, `incident_management`, `indexed_logs`, `indexed_spans`,
|
32705
|
-
`iot`,
|
34987
|
+
`fargate`, `infra_hosts`, `incident_management`, `indexed_logs`, `indexed_spans`,
|
34988
|
+
`ingested_spans`, `iot`,
|
32706
34989
|
|
32707
34990
|
`lambda_traced_invocations`, `logs`, `network_flows`, `network_hosts`, `netflow_monitoring`,
|
32708
34991
|
`observability_pipelines`,
|
@@ -33463,6 +35746,15 @@ tags:
|
|
33463
35746
|
[Test Visibility in Datadog page](https://docs.datadoghq.com/tests/) for more
|
33464
35747
|
information.
|
33465
35748
|
name: CI Visibility Tests
|
35749
|
+
- description: Cloud Security Management Threats (CSM Threats) monitors file, network,
|
35750
|
+
and process activity across your environment to detect real-time threats to your
|
35751
|
+
infrastructure. See [Cloud Security Management Threats](https://docs.datadoghq.com/security/threats/)
|
35752
|
+
for more information on setting up CSM Threats.
|
35753
|
+
name: CSM Threats
|
35754
|
+
- description: View and manage cases and projects within Case Management. See the
|
35755
|
+
[Case Management page](https://docs.datadoghq.com/service_management/case_management/)
|
35756
|
+
for more information.
|
35757
|
+
name: Case Management
|
33466
35758
|
- description: The Cloud Cost Management API allows you to set up, edit, and delete
|
33467
35759
|
Cloud Cost Management accounts for AWS and Azure. See the [Cloud Cost Management
|
33468
35760
|
page](https://docs.datadoghq.com/cloud_cost_management/) for more information.
|
@@ -33534,7 +35826,8 @@ tags:
|
|
33534
35826
|
|
33535
35827
|
This is an enterprise-only feature. Request access by
|
33536
35828
|
|
33537
|
-
contacting Datadog support.
|
35829
|
+
contacting Datadog support, or see the [IP Allowlist page](https://docs.datadoghq.com/account_management/org_settings/ip_allowlist/)
|
35830
|
+
for more information.'
|
33538
35831
|
name: IP Allowlist
|
33539
35832
|
- description: Create, update, delete, and retrieve services which can be associated
|
33540
35833
|
with incidents. See the [Incident Management page](https://docs.datadoghq.com/service_management/incident_management/)
|
@@ -33560,17 +35853,28 @@ tags:
|
|
33560
35853
|
url: https://docs.datadoghq.com/account_management/api-app-keys/
|
33561
35854
|
name: Key Management
|
33562
35855
|
- description: Search your logs and send them to your Datadog platform over HTTP.
|
35856
|
+
See the [Log Management page](https://docs.datadoghq.com/logs/) for more information.
|
33563
35857
|
name: Logs
|
33564
35858
|
- description: 'Archives forward all the logs ingested to a cloud storage system.
|
33565
35859
|
|
33566
35860
|
|
33567
35861
|
See the [Archives Page](https://app.datadoghq.com/logs/pipelines/archives)
|
33568
35862
|
|
33569
|
-
for a list of the archives currently configured in
|
35863
|
+
for a list of the archives currently configured in Datadog.'
|
33570
35864
|
externalDocs:
|
33571
35865
|
description: Find out more at
|
33572
35866
|
url: https://docs.datadoghq.com/logs/archives/
|
33573
35867
|
name: Logs Archives
|
35868
|
+
- description: 'Custom Destinations forward all the logs ingested to an external destination.
|
35869
|
+
|
35870
|
+
|
35871
|
+
See the [Custom Destinations Page](https://app.datadoghq.com/logs/pipelines/log-forwarding/custom-destinations)
|
35872
|
+
|
35873
|
+
for a list of the custom destinations currently configured in web UI.'
|
35874
|
+
externalDocs:
|
35875
|
+
description: Find out more at
|
35876
|
+
url: https://docs.datadoghq.com/logs/log_configuration/forwarding_custom_destinations/
|
35877
|
+
name: Logs Custom Destinations
|
33574
35878
|
- description: Manage configuration of [log-based metrics](https://app.datadoghq.com/logs/pipelines/generate-metrics)
|
33575
35879
|
for your organization.
|
33576
35880
|
externalDocs:
|
@@ -33584,7 +35888,8 @@ tags:
|
|
33584
35888
|
points\nand as the timeframe over which a metric is viewed increases,\naggregation
|
33585
35889
|
between points occurs to stay below that set number.\n\nThe Post, Patch, and Delete
|
33586
35890
|
`manage_tags` API methods can only be performed by\na user who has the `Manage
|
33587
|
-
Tags for Metrics` permission.
|
35891
|
+
Tags for Metrics` permission.\n\nSee the [Metrics page](https://docs.datadoghq.com/metrics/)
|
35892
|
+
for more information."
|
33588
35893
|
name: Metrics
|
33589
35894
|
- description: '[Monitors](https://docs.datadoghq.com/monitors) allow you to watch
|
33590
35895
|
a metric or check that you care about and
|
@@ -33600,8 +35905,8 @@ tags:
|
|
33600
35905
|
description: Find out more at
|
33601
35906
|
url: https://docs.datadoghq.com/monitors/create/types/
|
33602
35907
|
name: Monitors
|
33603
|
-
- description: Configure your Datadog Okta integration
|
33604
|
-
API.
|
35908
|
+
- description: Configure your [Datadog Okta integration](https://docs.datadoghq.com/integrations/okta/)
|
35909
|
+
directly through the Datadog API.
|
33605
35910
|
name: Okta Integration
|
33606
35911
|
- description: 'Configure your [Datadog Opsgenie integration](https://docs.datadoghq.com/integrations/opsgenie/)
|
33607
35912
|
|
@@ -33615,25 +35920,33 @@ tags:
|
|
33615
35920
|
description: Find out more at
|
33616
35921
|
url: https://docs.datadoghq.com/account_management/multi_organization
|
33617
35922
|
name: Organizations
|
33618
|
-
- description: 'The
|
35923
|
+
- description: 'The Powerpack endpoints allow you to:
|
33619
35924
|
|
33620
35925
|
|
33621
|
-
- Get a
|
35926
|
+
- Get a Powerpack
|
33622
35927
|
|
33623
|
-
- Create a
|
35928
|
+
- Create a Powerpack
|
33624
35929
|
|
33625
|
-
- Delete a
|
35930
|
+
- Delete a Powerpack
|
33626
35931
|
|
33627
|
-
- Get a list of all
|
35932
|
+
- Get a list of all Powerpacks
|
33628
35933
|
|
33629
35934
|
|
33630
|
-
The Patch and Delete API methods can only be performed on a
|
35935
|
+
The Patch and Delete API methods can only be performed on a Powerpack by
|
33631
35936
|
|
33632
|
-
a user who has the powerpack create permission for that specific
|
35937
|
+
a user who has the powerpack create permission for that specific Powerpack.
|
35938
|
+
|
35939
|
+
|
35940
|
+
Read [Scale Graphing Expertise with Powerpacks](https://docs.datadoghq.com/dashboards/guide/powerpacks-best-practices/)
|
35941
|
+
for more information.'
|
33633
35942
|
name: Powerpack
|
33634
35943
|
- description: The processes API allows you to query processes data for your organization.
|
35944
|
+
See the [Live Processes page](https://docs.datadoghq.com/infrastructure/process/)
|
35945
|
+
for more information.
|
33635
35946
|
name: Processes
|
33636
|
-
- description:
|
35947
|
+
- description: Manage your Real User Monitoring (RUM) applications, and search or
|
35948
|
+
aggregate your RUM events over HTTP. See the [RUM & Session Replay page](https://docs.datadoghq.com/real_user_monitoring/)
|
35949
|
+
for more information
|
33637
35950
|
name: RUM
|
33638
35951
|
- description: 'A restriction policy defines the access control rules for a resource,
|
33639
35952
|
mapping a set of relations
|
@@ -33659,20 +35972,24 @@ tags:
|
|
33659
35972
|
|
33660
35973
|
[Pipelines page](https://app.datadoghq.com/logs/pipelines).'
|
33661
35974
|
name: Roles
|
33662
|
-
- description:
|
33663
|
-
|
33664
|
-
|
35975
|
+
- description: Create and manage your security rules, signals, filters, and more.
|
35976
|
+
See the [Datadog Security page](https://docs.datadoghq.com/security/) for more
|
35977
|
+
information.
|
33665
35978
|
name: Security Monitoring
|
33666
35979
|
- description: Create, update, delete, and retrieve sensitive data scanner groups
|
33667
|
-
and rules.
|
35980
|
+
and rules. See the [Sensitive Data Scanner page](https://docs.datadoghq.com/sensitive_data_scanner/)
|
35981
|
+
for more information.
|
33668
35982
|
name: Sensitive Data Scanner
|
33669
|
-
- description: Create, edit, and disable service accounts.
|
35983
|
+
- description: Create, edit, and disable service accounts. See the [Service Accounts
|
35984
|
+
page](https://docs.datadoghq.com/account_management/org_settings/service_accounts/)
|
35985
|
+
for more information.
|
33670
35986
|
name: Service Accounts
|
33671
35987
|
- description: API to create, update, retrieve and delete service definitions.
|
33672
35988
|
externalDocs:
|
33673
35989
|
url: https://docs.datadoghq.com/tracing/service_catalog/
|
33674
35990
|
name: Service Definition
|
33675
|
-
- description: 'API to create, update scorecard rules and outcomes.
|
35991
|
+
- description: 'API to create, update scorecard rules and outcomes. See [Service Scorecards](https://docs.datadoghq.com/service_catalog/scorecards)
|
35992
|
+
for more information.
|
33676
35993
|
|
33677
35994
|
|
33678
35995
|
This feature is currently in BETA. If you have any feedback, contact [Datadog
|
@@ -33681,7 +35998,8 @@ tags:
|
|
33681
35998
|
- description: Search and aggregate your spans from your Datadog platform over HTTP.
|
33682
35999
|
name: Spans
|
33683
36000
|
- description: Manage configuration of [span-based metrics](https://app.datadoghq.com/apm/traces/generate-metrics)
|
33684
|
-
for your organization.
|
36001
|
+
for your organization. See [Generate Metrics from Spans](https://docs.datadoghq.com/tracing/trace_pipeline/generate_metrics/)
|
36002
|
+
for more information.
|
33685
36003
|
externalDocs:
|
33686
36004
|
description: Find out more at
|
33687
36005
|
url: https://docs.datadoghq.com/tracing/metrics/metrics_namespace/
|
@@ -33693,7 +36011,8 @@ tags:
|
|
33693
36011
|
use Datadog\u2019s API to\nmanage both test types programmatically.\n\nFor more
|
33694
36012
|
information about Synthetics, see the [Synthetics overview](https://docs.datadoghq.com/synthetics/)."
|
33695
36013
|
name: Synthetics
|
33696
|
-
- description: View and manage teams within Datadog.
|
36014
|
+
- description: View and manage teams within Datadog. See the [Teams page](https://docs.datadoghq.com/account_management/teams/)
|
36015
|
+
for more information.
|
33697
36016
|
name: Teams
|
33698
36017
|
- description: 'The usage metering API allows you to get hourly, daily, and
|
33699
36018
|
|