datadog_api_client 2.24.0 → 2.25.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.apigentools-info +4 -4
- data/.generator/conftest.py +2 -0
- data/.generator/schemas/v1/openapi.yaml +265 -8
- data/.generator/schemas/v2/openapi.yaml +1471 -32
- data/.generator/src/generator/openapi.py +4 -0
- data/CHANGELOG.md +41 -0
- data/examples/v1/azure-integration/CreateAzureIntegration.rb +1 -1
- data/examples/v1/azure-integration/UpdateAzureHostFilters.rb +7 -1
- data/examples/v1/azure-integration/UpdateAzureIntegration.rb +7 -1
- data/examples/v1/dashboards/CreateDashboard_985012506.rb +61 -0
- data/examples/v1/synthetics/CreateSyntheticsAPITest_1717840259.rb +163 -0
- data/examples/v1/synthetics/CreateSyntheticsBrowserTest.rb +2 -0
- data/examples/v2/cloud-cost-management/DeleteCustomCostsFile.rb +5 -0
- data/examples/v2/cloud-cost-management/DeleteCustomCostsFile_372970393.rb +5 -0
- data/examples/v2/cloud-cost-management/GetCustomCostsFile.rb +5 -0
- data/examples/v2/cloud-cost-management/GetCustomCostsFile_1307381576.rb +5 -0
- data/examples/v2/cloud-cost-management/ListCustomCostsFiles.rb +5 -0
- data/examples/v2/cloud-cost-management/ListCustomCostsFiles_1968771127.rb +5 -0
- data/examples/v2/cloud-cost-management/UploadCustomCostsFile.rb +15 -0
- data/examples/v2/cloud-cost-management/UploadCustomCostsFile_4125168396.rb +19 -0
- data/examples/v2/network-device-monitoring/GetDevice.rb +5 -0
- data/examples/v2/network-device-monitoring/GetInterfaces.rb +5 -0
- data/examples/v2/network-device-monitoring/ListDeviceUserTags.rb +5 -0
- data/examples/v2/network-device-monitoring/ListDevices.rb +10 -0
- data/examples/v2/network-device-monitoring/UpdateDeviceUserTags.rb +18 -0
- data/examples/v2/roles/CreateRole.rb +0 -3
- data/examples/v2/security-monitoring/ConvertExistingSecurityMonitoringRule.rb +8 -0
- data/examples/v2/security-monitoring/ConvertSecurityMonitoringRuleFromJSONToTerraform.rb +36 -0
- data/examples/v2/service-scorecards/UpdateScorecardRule.rb +24 -0
- data/examples/v2/workflow-automation/CancelWorkflowInstance.rb +5 -0
- data/examples/v2/workflow-automation/CreateWorkflowInstance.rb +13 -0
- data/examples/v2/workflow-automation/GetWorkflowInstance.rb +5 -0
- data/examples/v2/workflow-automation/ListWorkflowInstances.rb +5 -0
- data/lib/datadog_api_client/configuration.rb +1 -0
- data/lib/datadog_api_client/inflector.rb +53 -1
- data/lib/datadog_api_client/v1/api/aws_logs_integration_api.rb +1 -1
- data/lib/datadog_api_client/v1/api/hosts_api.rb +1 -1
- data/lib/datadog_api_client/v1/api/monitors_api.rb +12 -1
- data/lib/datadog_api_client/v1/api/usage_metering_api.rb +7 -3
- data/lib/datadog_api_client/v1/models/azure_account.rb +14 -1
- data/lib/datadog_api_client/v1/models/azure_account_metrics_config.rb +85 -0
- data/lib/datadog_api_client/v1/models/formula_and_function_apm_dependency_stats_query_definition.rb +24 -1
- data/lib/datadog_api_client/v1/models/formula_and_function_apm_resource_stats_query_definition.rb +24 -1
- data/lib/datadog_api_client/v1/models/formula_and_function_cloud_cost_query_definition.rb +24 -1
- data/lib/datadog_api_client/v1/models/formula_and_function_event_query_definition.rb +24 -1
- data/lib/datadog_api_client/v1/models/formula_and_function_events_data_source.rb +1 -0
- data/lib/datadog_api_client/v1/models/formula_and_function_metric_query_definition.rb +24 -1
- data/lib/datadog_api_client/v1/models/formula_and_function_process_query_definition.rb +24 -1
- data/lib/datadog_api_client/v1/models/formula_and_function_slo_query_definition.rb +24 -1
- data/lib/datadog_api_client/v1/models/formula_and_function_slo_query_type.rb +1 -0
- data/lib/datadog_api_client/v1/models/hourly_usage_attribution_usage_type.rb +2 -0
- data/lib/datadog_api_client/v1/models/list_stream_source.rb +1 -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/monitor_type.rb +1 -0
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_supported_metrics.rb +4 -0
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_values.rb +41 -1
- data/lib/datadog_api_client/v1/models/synthetics_basic_auth_digest.rb +12 -1
- data/lib/datadog_api_client/v1/models/synthetics_basic_auth_oauth_client.rb +12 -1
- data/lib/datadog_api_client/v1/models/synthetics_basic_auth_oauth_rop.rb +12 -1
- data/lib/datadog_api_client/v1/models/synthetics_delete_tests_payload.rb +12 -1
- data/lib/datadog_api_client/v1/models/synthetics_test_options.rb +21 -1
- data/lib/datadog_api_client/v1/models/usage_billable_summary_hour.rb +21 -1
- data/lib/datadog_api_client/v1/models/usage_summary_date.rb +61 -1
- data/lib/datadog_api_client/v1/models/usage_summary_date_org.rb +81 -1
- data/lib/datadog_api_client/v1/models/usage_summary_response.rb +61 -1
- data/lib/datadog_api_client/v2/api/api_management_api.rb +5 -5
- data/lib/datadog_api_client/v2/api/authn_mappings_api.rb +6 -0
- data/lib/datadog_api_client/v2/api/case_management_api.rb +13 -13
- data/lib/datadog_api_client/v2/api/cloud_cost_management_api.rb +260 -0
- data/lib/datadog_api_client/v2/api/network_device_monitoring_api.rb +362 -0
- data/lib/datadog_api_client/v2/api/organizations_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/restriction_policies_api.rb +15 -7
- data/lib/datadog_api_client/v2/api/security_monitoring_api.rb +134 -0
- data/lib/datadog_api_client/v2/api/service_scorecards_api.rb +79 -1
- data/lib/datadog_api_client/v2/api/usage_metering_api.rb +8 -0
- data/lib/datadog_api_client/v2/api/workflow_automation_api.rb +307 -0
- data/lib/datadog_api_client/v2/models/api_key_relationships.rb +9 -1
- data/lib/datadog_api_client/v2/models/authn_mapping_resource_type.rb +27 -0
- data/lib/datadog_api_client/v2/models/cost_by_org_attributes.rb +21 -1
- data/lib/datadog_api_client/v2/models/custom_cost_get_response_meta.rb +80 -0
- data/lib/datadog_api_client/v2/models/custom_cost_list_response_meta.rb +90 -0
- data/lib/datadog_api_client/v2/models/custom_cost_upload_response_meta.rb +80 -0
- data/lib/datadog_api_client/v2/models/custom_costs_file_get_response.rb +90 -0
- data/lib/datadog_api_client/v2/models/custom_costs_file_line_item.rb +173 -0
- data/lib/datadog_api_client/v2/models/custom_costs_file_list_response.rb +92 -0
- data/lib/datadog_api_client/v2/models/custom_costs_file_metadata.rb +152 -0
- data/lib/datadog_api_client/v2/models/custom_costs_file_metadata_high_level.rb +100 -0
- data/lib/datadog_api_client/v2/models/custom_costs_file_metadata_with_content.rb +164 -0
- data/lib/datadog_api_client/v2/models/custom_costs_file_metadata_with_content_high_level.rb +100 -0
- data/lib/datadog_api_client/v2/models/custom_costs_file_upload_response.rb +90 -0
- data/lib/datadog_api_client/v2/models/custom_costs_file_usage_charge_period.rb +90 -0
- data/lib/datadog_api_client/v2/models/custom_costs_user.rb +100 -0
- data/lib/datadog_api_client/v2/models/device_attributes.rb +272 -0
- data/lib/datadog_api_client/v2/models/device_attributes_interface_statuses.rb +110 -0
- data/lib/datadog_api_client/v2/models/devices_list_data.rb +100 -0
- data/lib/datadog_api_client/v2/models/dora_deployment_request_attributes.rb +2 -2
- data/lib/datadog_api_client/v2/models/dora_incident_request_attributes.rb +2 -2
- data/lib/datadog_api_client/v2/models/full_application_key_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/get_device_attributes.rb +262 -0
- data/lib/datadog_api_client/v2/models/get_device_data.rb +100 -0
- data/lib/datadog_api_client/v2/models/get_device_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/get_interfaces_data.rb +100 -0
- data/lib/datadog_api_client/v2/models/get_interfaces_response.rb +82 -0
- data/lib/datadog_api_client/v2/models/hourly_usage_attributes.rb +21 -1
- data/lib/datadog_api_client/v2/models/interface_attributes.rb +130 -0
- data/lib/datadog_api_client/v2/models/interface_attributes_status.rb +29 -0
- data/lib/datadog_api_client/v2/models/list_devices_response.rb +92 -0
- data/lib/datadog_api_client/v2/models/list_devices_response_metadata.rb +80 -0
- data/lib/datadog_api_client/v2/models/list_devices_response_metadata_page.rb +80 -0
- data/lib/datadog_api_client/v2/models/list_tags_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/list_tags_response_data.rb +100 -0
- data/lib/datadog_api_client/v2/models/list_tags_response_data_attributes.rb +82 -0
- data/lib/datadog_api_client/v2/models/projected_cost_attributes.rb +21 -1
- data/lib/datadog_api_client/v2/models/role_relationships.rb +4 -14
- data/lib/datadog_api_client/v2/models/role_update_attributes.rb +32 -4
- data/lib/datadog_api_client/v2/models/rum_application_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/rum_application_create_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/rum_application_list_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/rum_application_update_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_convert_payload.rb +63 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_convert_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_detection_method.rb +1 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_evaluation_window.rb +1 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_keep_alive.rb +1 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_options.rb +2 -2
- data/lib/datadog_api_client/v2/models/update_rule_request.rb +80 -0
- data/lib/datadog_api_client/v2/models/update_rule_request_data.rb +90 -0
- data/lib/datadog_api_client/v2/models/update_rule_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/update_rule_response_data.rb +110 -0
- data/lib/datadog_api_client/v2/models/user_attributes.rb +11 -1
- data/lib/datadog_api_client/v2/models/workflow_instance_create_meta.rb +80 -0
- data/lib/datadog_api_client/v2/models/workflow_instance_create_request.rb +80 -0
- data/lib/datadog_api_client/v2/models/workflow_instance_create_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/workflow_instance_create_response_data.rb +80 -0
- data/lib/datadog_api_client/v2/models/workflow_instance_list_item.rb +80 -0
- data/lib/datadog_api_client/v2/models/workflow_list_instances_response.rb +92 -0
- data/lib/datadog_api_client/v2/models/workflow_list_instances_response_meta.rb +80 -0
- data/lib/datadog_api_client/v2/models/workflow_list_instances_response_meta_page.rb +80 -0
- data/lib/datadog_api_client/v2/models/worklflow_cancel_instance_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/worklflow_cancel_instance_response_data.rb +80 -0
- data/lib/datadog_api_client/v2/models/worklflow_get_instance_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/worklflow_get_instance_response_data.rb +80 -0
- data/lib/datadog_api_client/v2/models/worklflow_get_instance_response_data_attributes.rb +80 -0
- data/lib/datadog_api_client/version.rb +1 -1
- metadata +76 -2
|
@@ -216,6 +216,13 @@ components:
|
|
|
216
216
|
required: true
|
|
217
217
|
schema:
|
|
218
218
|
type: string
|
|
219
|
+
FileID:
|
|
220
|
+
description: File ID.
|
|
221
|
+
in: path
|
|
222
|
+
name: file_id
|
|
223
|
+
required: true
|
|
224
|
+
schema:
|
|
225
|
+
type: string
|
|
219
226
|
GCPSTSServiceAccountID:
|
|
220
227
|
description: Your GCP STS enabled service account's unique ID.
|
|
221
228
|
in: path
|
|
@@ -351,6 +358,13 @@ components:
|
|
|
351
358
|
required: true
|
|
352
359
|
schema:
|
|
353
360
|
type: string
|
|
361
|
+
InstanceId:
|
|
362
|
+
description: The ID of the workflow instance.
|
|
363
|
+
in: path
|
|
364
|
+
name: instance_id
|
|
365
|
+
required: true
|
|
366
|
+
schema:
|
|
367
|
+
type: string
|
|
354
368
|
MetricID:
|
|
355
369
|
description: The name of the log-based metric.
|
|
356
370
|
in: path
|
|
@@ -450,7 +464,7 @@ components:
|
|
|
450
464
|
schema:
|
|
451
465
|
type: string
|
|
452
466
|
RuleId:
|
|
453
|
-
description: The ID of the rule
|
|
467
|
+
description: The ID of the rule.
|
|
454
468
|
in: path
|
|
455
469
|
name: rule_id
|
|
456
470
|
required: true
|
|
@@ -536,6 +550,13 @@ components:
|
|
|
536
550
|
schema:
|
|
537
551
|
example: 00000000-0000-9999-0000-000000000000
|
|
538
552
|
type: string
|
|
553
|
+
WorkflowId:
|
|
554
|
+
description: The ID of the workflow.
|
|
555
|
+
in: path
|
|
556
|
+
name: workflow_id
|
|
557
|
+
required: true
|
|
558
|
+
schema:
|
|
559
|
+
type: string
|
|
539
560
|
requestBodies: {}
|
|
540
561
|
responses:
|
|
541
562
|
BadRequestResponse:
|
|
@@ -684,7 +705,7 @@ components:
|
|
|
684
705
|
created_by:
|
|
685
706
|
$ref: '#/components/schemas/RelationshipToUser'
|
|
686
707
|
modified_by:
|
|
687
|
-
$ref: '#/components/schemas/
|
|
708
|
+
$ref: '#/components/schemas/NullableRelationshipToUser'
|
|
688
709
|
type: object
|
|
689
710
|
APIKeyResponse:
|
|
690
711
|
description: Response for retrieving an API key.
|
|
@@ -1384,6 +1405,15 @@ components:
|
|
|
1384
1405
|
team:
|
|
1385
1406
|
$ref: '#/components/schemas/RelationshipToTeam'
|
|
1386
1407
|
type: object
|
|
1408
|
+
AuthNMappingResourceType:
|
|
1409
|
+
description: The type of resource being mapped to.
|
|
1410
|
+
enum:
|
|
1411
|
+
- role
|
|
1412
|
+
- team
|
|
1413
|
+
type: string
|
|
1414
|
+
x-enum-varnames:
|
|
1415
|
+
- ROLE
|
|
1416
|
+
- TEAM
|
|
1387
1417
|
AuthNMappingResponse:
|
|
1388
1418
|
description: AuthN Mapping response from the API.
|
|
1389
1419
|
properties:
|
|
@@ -5390,6 +5420,12 @@ components:
|
|
|
5390
5420
|
CostByOrgAttributes:
|
|
5391
5421
|
description: Cost attributes data.
|
|
5392
5422
|
properties:
|
|
5423
|
+
account_name:
|
|
5424
|
+
description: The account name.
|
|
5425
|
+
type: string
|
|
5426
|
+
account_public_id:
|
|
5427
|
+
description: The account public ID.
|
|
5428
|
+
type: string
|
|
5393
5429
|
charges:
|
|
5394
5430
|
description: List of charges data reported for the requested month.
|
|
5395
5431
|
items:
|
|
@@ -5501,6 +5537,234 @@ components:
|
|
|
5501
5537
|
nullable: true
|
|
5502
5538
|
type: string
|
|
5503
5539
|
type: object
|
|
5540
|
+
CustomCostGetResponseMeta:
|
|
5541
|
+
description: Meta for the response from the Get Custom Costs endpoints.
|
|
5542
|
+
properties:
|
|
5543
|
+
version:
|
|
5544
|
+
description: Version of Custom Costs file
|
|
5545
|
+
type: string
|
|
5546
|
+
type: object
|
|
5547
|
+
CustomCostListResponseMeta:
|
|
5548
|
+
description: Meta for the response from the List Custom Costs endpoints.
|
|
5549
|
+
properties:
|
|
5550
|
+
total_filtered_count:
|
|
5551
|
+
description: Number of Custom Costs files returned by the List Custom Costs
|
|
5552
|
+
endpoint
|
|
5553
|
+
format: int64
|
|
5554
|
+
type: integer
|
|
5555
|
+
version:
|
|
5556
|
+
description: Version of Custom Costs file
|
|
5557
|
+
type: string
|
|
5558
|
+
type: object
|
|
5559
|
+
CustomCostUploadResponseMeta:
|
|
5560
|
+
description: Meta for the response from the Upload Custom Costs endpoints.
|
|
5561
|
+
properties:
|
|
5562
|
+
version:
|
|
5563
|
+
description: Version of Custom Costs file
|
|
5564
|
+
type: string
|
|
5565
|
+
type: object
|
|
5566
|
+
CustomCostsFileGetResponse:
|
|
5567
|
+
description: Response for Get Custom Costs files.
|
|
5568
|
+
properties:
|
|
5569
|
+
data:
|
|
5570
|
+
$ref: '#/components/schemas/CustomCostsFileMetadataWithContentHighLevel'
|
|
5571
|
+
meta:
|
|
5572
|
+
$ref: '#/components/schemas/CustomCostGetResponseMeta'
|
|
5573
|
+
type: object
|
|
5574
|
+
CustomCostsFileLineItem:
|
|
5575
|
+
description: Line item details from a Custom Costs file.
|
|
5576
|
+
properties:
|
|
5577
|
+
BilledCost:
|
|
5578
|
+
description: Total cost in the cost file.
|
|
5579
|
+
example: 100.5
|
|
5580
|
+
format: double
|
|
5581
|
+
type: number
|
|
5582
|
+
BillingCurrency:
|
|
5583
|
+
description: Currency used in the Custom Costs file.
|
|
5584
|
+
example: USD
|
|
5585
|
+
type: string
|
|
5586
|
+
ChargeDescription:
|
|
5587
|
+
description: Description for the line item cost.
|
|
5588
|
+
example: Monthly usage charge for my service
|
|
5589
|
+
type: string
|
|
5590
|
+
ChargePeriodEnd:
|
|
5591
|
+
description: End date of the usage charge.
|
|
5592
|
+
example: '2023-02-28'
|
|
5593
|
+
pattern: ^\d{4}-\d{2}-\d{2}$
|
|
5594
|
+
type: string
|
|
5595
|
+
ChargePeriodStart:
|
|
5596
|
+
description: Start date of the usage charge.
|
|
5597
|
+
example: '2023-02-01'
|
|
5598
|
+
pattern: ^\d{4}-\d{2}-\d{2}$
|
|
5599
|
+
type: string
|
|
5600
|
+
ProviderName:
|
|
5601
|
+
description: Name of the provider for the line item.
|
|
5602
|
+
type: string
|
|
5603
|
+
Tags:
|
|
5604
|
+
additionalProperties:
|
|
5605
|
+
type: string
|
|
5606
|
+
description: Additional tags for the line item.
|
|
5607
|
+
type: object
|
|
5608
|
+
type: object
|
|
5609
|
+
CustomCostsFileListResponse:
|
|
5610
|
+
description: Response for List Custom Costs files.
|
|
5611
|
+
properties:
|
|
5612
|
+
data:
|
|
5613
|
+
description: List of Custom Costs files.
|
|
5614
|
+
items:
|
|
5615
|
+
$ref: '#/components/schemas/CustomCostsFileMetadataHighLevel'
|
|
5616
|
+
type: array
|
|
5617
|
+
meta:
|
|
5618
|
+
$ref: '#/components/schemas/CustomCostListResponseMeta'
|
|
5619
|
+
type: object
|
|
5620
|
+
CustomCostsFileMetadata:
|
|
5621
|
+
description: Schema of a Custom Costs metadata.
|
|
5622
|
+
properties:
|
|
5623
|
+
billed_cost:
|
|
5624
|
+
description: Total cost in the cost file.
|
|
5625
|
+
example: 100.5
|
|
5626
|
+
format: double
|
|
5627
|
+
type: number
|
|
5628
|
+
billing_currency:
|
|
5629
|
+
description: Currency used in the Custom Costs file.
|
|
5630
|
+
example: USD
|
|
5631
|
+
type: string
|
|
5632
|
+
charge_period:
|
|
5633
|
+
$ref: '#/components/schemas/CustomCostsFileUsageChargePeriod'
|
|
5634
|
+
name:
|
|
5635
|
+
description: Name of the Custom Costs file.
|
|
5636
|
+
example: my_file.json
|
|
5637
|
+
type: string
|
|
5638
|
+
provider_names:
|
|
5639
|
+
description: Providers contained in the Custom Costs file.
|
|
5640
|
+
items:
|
|
5641
|
+
description: Name of the provider.
|
|
5642
|
+
example: my_provider
|
|
5643
|
+
type: string
|
|
5644
|
+
type: array
|
|
5645
|
+
status:
|
|
5646
|
+
description: Status of the Custom Costs file.
|
|
5647
|
+
example: active
|
|
5648
|
+
type: string
|
|
5649
|
+
uploaded_at:
|
|
5650
|
+
description: Timestamp, in millisecond, of the upload time of the Custom
|
|
5651
|
+
Costs file.
|
|
5652
|
+
example: 1704067200000
|
|
5653
|
+
format: double
|
|
5654
|
+
type: number
|
|
5655
|
+
uploaded_by:
|
|
5656
|
+
$ref: '#/components/schemas/CustomCostsUser'
|
|
5657
|
+
type: object
|
|
5658
|
+
CustomCostsFileMetadataHighLevel:
|
|
5659
|
+
description: JSON API format for a Custom Costs file.
|
|
5660
|
+
properties:
|
|
5661
|
+
attributes:
|
|
5662
|
+
$ref: '#/components/schemas/CustomCostsFileMetadata'
|
|
5663
|
+
id:
|
|
5664
|
+
description: ID of the Custom Costs metadata.
|
|
5665
|
+
type: string
|
|
5666
|
+
type:
|
|
5667
|
+
description: Type of the Custom Costs file metadata.
|
|
5668
|
+
type: string
|
|
5669
|
+
type: object
|
|
5670
|
+
CustomCostsFileMetadataWithContent:
|
|
5671
|
+
description: Schema of a cost file's metadata.
|
|
5672
|
+
properties:
|
|
5673
|
+
billed_cost:
|
|
5674
|
+
description: Total cost in the cost file.
|
|
5675
|
+
example: 100.5
|
|
5676
|
+
format: double
|
|
5677
|
+
type: number
|
|
5678
|
+
billing_currency:
|
|
5679
|
+
description: Currency used in the Custom Costs file.
|
|
5680
|
+
example: USD
|
|
5681
|
+
type: string
|
|
5682
|
+
charge_period:
|
|
5683
|
+
$ref: '#/components/schemas/CustomCostsFileUsageChargePeriod'
|
|
5684
|
+
content:
|
|
5685
|
+
description: Detail of the line items from the Custom Costs file.
|
|
5686
|
+
items:
|
|
5687
|
+
$ref: '#/components/schemas/CustomCostsFileLineItem'
|
|
5688
|
+
type: array
|
|
5689
|
+
name:
|
|
5690
|
+
description: Name of the Custom Costs file.
|
|
5691
|
+
example: my_file.json
|
|
5692
|
+
type: string
|
|
5693
|
+
provider_names:
|
|
5694
|
+
description: Providers contained in the Custom Costs file.
|
|
5695
|
+
items:
|
|
5696
|
+
description: Name of a provider.
|
|
5697
|
+
example: my_provider
|
|
5698
|
+
type: string
|
|
5699
|
+
type: array
|
|
5700
|
+
status:
|
|
5701
|
+
description: Status of the Custom Costs file.
|
|
5702
|
+
example: active
|
|
5703
|
+
type: string
|
|
5704
|
+
uploaded_at:
|
|
5705
|
+
description: Timestamp in millisecond of the upload time of the Custom Costs
|
|
5706
|
+
file.
|
|
5707
|
+
example: 1704067200000
|
|
5708
|
+
format: double
|
|
5709
|
+
type: number
|
|
5710
|
+
uploaded_by:
|
|
5711
|
+
$ref: '#/components/schemas/CustomCostsUser'
|
|
5712
|
+
type: object
|
|
5713
|
+
CustomCostsFileMetadataWithContentHighLevel:
|
|
5714
|
+
description: JSON API format of for a Custom Costs file with content.
|
|
5715
|
+
properties:
|
|
5716
|
+
attributes:
|
|
5717
|
+
$ref: '#/components/schemas/CustomCostsFileMetadataWithContent'
|
|
5718
|
+
id:
|
|
5719
|
+
description: ID of the Custom Costs metadata.
|
|
5720
|
+
type: string
|
|
5721
|
+
type:
|
|
5722
|
+
description: Type of the Custom Costs file metadata.
|
|
5723
|
+
type: string
|
|
5724
|
+
type: object
|
|
5725
|
+
CustomCostsFileUploadRequest:
|
|
5726
|
+
description: Request for uploading a Custom Costs file.
|
|
5727
|
+
items:
|
|
5728
|
+
$ref: '#/components/schemas/CustomCostsFileLineItem'
|
|
5729
|
+
type: array
|
|
5730
|
+
CustomCostsFileUploadResponse:
|
|
5731
|
+
description: Response for Uploaded Custom Costs files.
|
|
5732
|
+
properties:
|
|
5733
|
+
data:
|
|
5734
|
+
$ref: '#/components/schemas/CustomCostsFileMetadataHighLevel'
|
|
5735
|
+
meta:
|
|
5736
|
+
$ref: '#/components/schemas/CustomCostUploadResponseMeta'
|
|
5737
|
+
type: object
|
|
5738
|
+
CustomCostsFileUsageChargePeriod:
|
|
5739
|
+
description: Usage charge period of a Custom Costs file.
|
|
5740
|
+
properties:
|
|
5741
|
+
end:
|
|
5742
|
+
description: End of the usage of the Custom Costs file.
|
|
5743
|
+
example: 1706745600000
|
|
5744
|
+
format: double
|
|
5745
|
+
type: number
|
|
5746
|
+
start:
|
|
5747
|
+
description: Start of the usage of the Custom Costs file.
|
|
5748
|
+
example: 1704067200000
|
|
5749
|
+
format: double
|
|
5750
|
+
type: number
|
|
5751
|
+
type: object
|
|
5752
|
+
CustomCostsUser:
|
|
5753
|
+
description: Metadata of the user that has uploaded the Custom Costs file.
|
|
5754
|
+
properties:
|
|
5755
|
+
email:
|
|
5756
|
+
description: The name of the Custom Costs file.
|
|
5757
|
+
example: email.test@datadohq.com
|
|
5758
|
+
type: string
|
|
5759
|
+
icon:
|
|
5760
|
+
description: The name of the Custom Costs file.
|
|
5761
|
+
example: icon.png
|
|
5762
|
+
type: string
|
|
5763
|
+
name:
|
|
5764
|
+
description: Name of the user.
|
|
5765
|
+
example: Test User
|
|
5766
|
+
type: string
|
|
5767
|
+
type: object
|
|
5504
5768
|
CustomDestinationAttributeTagsRestrictionListType:
|
|
5505
5769
|
default: ALLOW_LIST
|
|
5506
5770
|
description: 'How `forward_tags_restriction_list` parameter should be interpreted.
|
|
@@ -6132,8 +6396,9 @@ components:
|
|
|
6132
6396
|
example: staging
|
|
6133
6397
|
type: string
|
|
6134
6398
|
finished_at:
|
|
6135
|
-
description: Unix timestamp
|
|
6136
|
-
|
|
6399
|
+
description: Unix timestamp when the deployment finished. It must be in
|
|
6400
|
+
nanoseconds, milliseconds, or seconds, and it should not be older than
|
|
6401
|
+
1 hour.
|
|
6137
6402
|
example: 1693491984000000000
|
|
6138
6403
|
format: int64
|
|
6139
6404
|
type: integer
|
|
@@ -6147,7 +6412,8 @@ components:
|
|
|
6147
6412
|
example: shopist
|
|
6148
6413
|
type: string
|
|
6149
6414
|
started_at:
|
|
6150
|
-
description: Unix timestamp
|
|
6415
|
+
description: Unix timestamp when the deployment started. It must be in nanoseconds,
|
|
6416
|
+
milliseconds, or seconds.
|
|
6151
6417
|
example: 1693491974000000000
|
|
6152
6418
|
format: int64
|
|
6153
6419
|
type: integer
|
|
@@ -6224,8 +6490,8 @@ components:
|
|
|
6224
6490
|
example: staging
|
|
6225
6491
|
type: string
|
|
6226
6492
|
finished_at:
|
|
6227
|
-
description: Unix timestamp
|
|
6228
|
-
should not be older than 1 hour.
|
|
6493
|
+
description: Unix timestamp when the incident finished. It must be in nanoseconds,
|
|
6494
|
+
milliseconds, or seconds, and it should not be older than 1 hour.
|
|
6229
6495
|
example: 1693491984000000000
|
|
6230
6496
|
format: int64
|
|
6231
6497
|
type: integer
|
|
@@ -6252,7 +6518,8 @@ components:
|
|
|
6252
6518
|
example: High
|
|
6253
6519
|
type: string
|
|
6254
6520
|
started_at:
|
|
6255
|
-
description: Unix timestamp
|
|
6521
|
+
description: Unix timestamp when the incident started. It must be in nanoseconds,
|
|
6522
|
+
milliseconds, or seconds.
|
|
6256
6523
|
example: 1693491974000000000
|
|
6257
6524
|
format: int64
|
|
6258
6525
|
type: integer
|
|
@@ -6573,6 +6840,129 @@ components:
|
|
|
6573
6840
|
type: string
|
|
6574
6841
|
x-enum-varnames:
|
|
6575
6842
|
- DETAILED_FINDING
|
|
6843
|
+
DeviceAttributes:
|
|
6844
|
+
description: The device attributes
|
|
6845
|
+
properties:
|
|
6846
|
+
description:
|
|
6847
|
+
description: The device description
|
|
6848
|
+
example: a device monitored with NDM
|
|
6849
|
+
type: string
|
|
6850
|
+
device_type:
|
|
6851
|
+
description: The device type
|
|
6852
|
+
example: other
|
|
6853
|
+
type: string
|
|
6854
|
+
integration:
|
|
6855
|
+
description: The device integration
|
|
6856
|
+
example: snmp
|
|
6857
|
+
type: string
|
|
6858
|
+
interface_statuses:
|
|
6859
|
+
$ref: '#/components/schemas/DeviceAttributesInterfaceStatuses'
|
|
6860
|
+
ip_address:
|
|
6861
|
+
description: The device IP address
|
|
6862
|
+
example: 1.2.3.4
|
|
6863
|
+
type: string
|
|
6864
|
+
location:
|
|
6865
|
+
description: The device location
|
|
6866
|
+
example: paris
|
|
6867
|
+
type: string
|
|
6868
|
+
model:
|
|
6869
|
+
description: The device model
|
|
6870
|
+
example: xx-123
|
|
6871
|
+
type: string
|
|
6872
|
+
name:
|
|
6873
|
+
description: The device name
|
|
6874
|
+
example: example device
|
|
6875
|
+
type: string
|
|
6876
|
+
os_hostname:
|
|
6877
|
+
description: The device OS hostname
|
|
6878
|
+
type: string
|
|
6879
|
+
os_name:
|
|
6880
|
+
description: The device OS name
|
|
6881
|
+
example: example OS
|
|
6882
|
+
type: string
|
|
6883
|
+
os_version:
|
|
6884
|
+
description: The device OS version
|
|
6885
|
+
example: 1.0.2
|
|
6886
|
+
type: string
|
|
6887
|
+
ping_status:
|
|
6888
|
+
description: The device ping status
|
|
6889
|
+
example: unmonitored
|
|
6890
|
+
type: string
|
|
6891
|
+
product_name:
|
|
6892
|
+
description: The device product name
|
|
6893
|
+
example: example device
|
|
6894
|
+
type: string
|
|
6895
|
+
serial_number:
|
|
6896
|
+
description: The device serial number
|
|
6897
|
+
example: X12345
|
|
6898
|
+
type: string
|
|
6899
|
+
status:
|
|
6900
|
+
description: The device SNMP status
|
|
6901
|
+
example: ok
|
|
6902
|
+
type: string
|
|
6903
|
+
subnet:
|
|
6904
|
+
description: The device subnet
|
|
6905
|
+
example: 1.2.3.4/24
|
|
6906
|
+
type: string
|
|
6907
|
+
sys_object_id:
|
|
6908
|
+
description: The device `sys_object_id`
|
|
6909
|
+
example: 1.3.6.1.4.1.99999
|
|
6910
|
+
type: string
|
|
6911
|
+
tags:
|
|
6912
|
+
description: The list of device tags
|
|
6913
|
+
example:
|
|
6914
|
+
- device_ip:1.2.3.4
|
|
6915
|
+
- device_id:example:1.2.3.4
|
|
6916
|
+
items:
|
|
6917
|
+
type: string
|
|
6918
|
+
type: array
|
|
6919
|
+
vendor:
|
|
6920
|
+
description: The device vendor
|
|
6921
|
+
example: example vendor
|
|
6922
|
+
type: string
|
|
6923
|
+
version:
|
|
6924
|
+
description: The device version
|
|
6925
|
+
example: 1.2.3
|
|
6926
|
+
type: string
|
|
6927
|
+
type: object
|
|
6928
|
+
DeviceAttributesInterfaceStatuses:
|
|
6929
|
+
description: Count of the device interfaces by status
|
|
6930
|
+
example:
|
|
6931
|
+
down: 1
|
|
6932
|
+
'off': 2
|
|
6933
|
+
up: 12
|
|
6934
|
+
warning: 5
|
|
6935
|
+
properties:
|
|
6936
|
+
down:
|
|
6937
|
+
description: The number of interfaces that are down
|
|
6938
|
+
format: int64
|
|
6939
|
+
type: integer
|
|
6940
|
+
'off':
|
|
6941
|
+
description: The number of interfaces that are off
|
|
6942
|
+
format: int64
|
|
6943
|
+
type: integer
|
|
6944
|
+
up:
|
|
6945
|
+
description: The number of interfaces that are up
|
|
6946
|
+
format: int64
|
|
6947
|
+
type: integer
|
|
6948
|
+
warning:
|
|
6949
|
+
description: The number of interfaces that are in a warning state
|
|
6950
|
+
format: int64
|
|
6951
|
+
type: integer
|
|
6952
|
+
type: object
|
|
6953
|
+
DevicesListData:
|
|
6954
|
+
description: The devices list data
|
|
6955
|
+
properties:
|
|
6956
|
+
attributes:
|
|
6957
|
+
$ref: '#/components/schemas/DeviceAttributes'
|
|
6958
|
+
id:
|
|
6959
|
+
description: The device ID
|
|
6960
|
+
example: example:1.2.3.4
|
|
6961
|
+
type: string
|
|
6962
|
+
type:
|
|
6963
|
+
description: The type of the resource. The value should always be device.
|
|
6964
|
+
type: string
|
|
6965
|
+
type: object
|
|
6576
6966
|
DowntimeCreateRequest:
|
|
6577
6967
|
description: Request for creating a downtime.
|
|
6578
6968
|
properties:
|
|
@@ -8106,6 +8496,7 @@ components:
|
|
|
8106
8496
|
created_at:
|
|
8107
8497
|
description: Creation date of the application key.
|
|
8108
8498
|
example: '2020-11-23T10:00:00.000Z'
|
|
8499
|
+
format: date-time
|
|
8109
8500
|
readOnly: true
|
|
8110
8501
|
type: string
|
|
8111
8502
|
key:
|
|
@@ -8301,6 +8692,109 @@ components:
|
|
|
8301
8692
|
type: string
|
|
8302
8693
|
x-enum-varnames:
|
|
8303
8694
|
- GCP_SERVICE_ACCOUNT
|
|
8695
|
+
GetDeviceAttributes:
|
|
8696
|
+
description: The device attributes
|
|
8697
|
+
properties:
|
|
8698
|
+
description:
|
|
8699
|
+
description: A description of the device.
|
|
8700
|
+
example: a device monitored with NDM
|
|
8701
|
+
type: string
|
|
8702
|
+
device_type:
|
|
8703
|
+
description: The type of the device.
|
|
8704
|
+
example: other
|
|
8705
|
+
type: string
|
|
8706
|
+
integration:
|
|
8707
|
+
description: The integration of the device.
|
|
8708
|
+
example: snmp
|
|
8709
|
+
type: string
|
|
8710
|
+
ip_address:
|
|
8711
|
+
description: The IP address of the device.
|
|
8712
|
+
example: 1.2.3.4
|
|
8713
|
+
type: string
|
|
8714
|
+
location:
|
|
8715
|
+
description: The location of the device.
|
|
8716
|
+
example: paris
|
|
8717
|
+
type: string
|
|
8718
|
+
model:
|
|
8719
|
+
description: The model of the device.
|
|
8720
|
+
example: xx-123
|
|
8721
|
+
type: string
|
|
8722
|
+
name:
|
|
8723
|
+
description: The name of the device.
|
|
8724
|
+
example: example device
|
|
8725
|
+
type: string
|
|
8726
|
+
os_hostname:
|
|
8727
|
+
description: The operating system hostname of the device.
|
|
8728
|
+
example: 1.0.2
|
|
8729
|
+
type: string
|
|
8730
|
+
os_name:
|
|
8731
|
+
description: The operating system name of the device.
|
|
8732
|
+
example: example OS
|
|
8733
|
+
type: string
|
|
8734
|
+
os_version:
|
|
8735
|
+
description: The operating system version of the device.
|
|
8736
|
+
example: 1.0.2
|
|
8737
|
+
type: string
|
|
8738
|
+
ping_status:
|
|
8739
|
+
description: The ping status of the device.
|
|
8740
|
+
example: unmonitored
|
|
8741
|
+
type: string
|
|
8742
|
+
product_name:
|
|
8743
|
+
description: The product name of the device.
|
|
8744
|
+
example: example device
|
|
8745
|
+
type: string
|
|
8746
|
+
serial_number:
|
|
8747
|
+
description: The serial number of the device.
|
|
8748
|
+
example: X12345
|
|
8749
|
+
type: string
|
|
8750
|
+
status:
|
|
8751
|
+
description: The status of the device.
|
|
8752
|
+
example: ok
|
|
8753
|
+
type: string
|
|
8754
|
+
subnet:
|
|
8755
|
+
description: The subnet of the device.
|
|
8756
|
+
example: 1.2.3.4/24
|
|
8757
|
+
type: string
|
|
8758
|
+
sys_object_id:
|
|
8759
|
+
description: The device `sys_object_id`.
|
|
8760
|
+
example: 1.3.6.1.4.1.99999
|
|
8761
|
+
type: string
|
|
8762
|
+
tags:
|
|
8763
|
+
description: A list of tags associated with the device.
|
|
8764
|
+
example:
|
|
8765
|
+
- device_ip:1.2.3.4
|
|
8766
|
+
- device_id:example:1.2.3.4
|
|
8767
|
+
items:
|
|
8768
|
+
type: string
|
|
8769
|
+
type: array
|
|
8770
|
+
vendor:
|
|
8771
|
+
description: The vendor of the device.
|
|
8772
|
+
example: example vendor
|
|
8773
|
+
type: string
|
|
8774
|
+
version:
|
|
8775
|
+
description: The version of the device.
|
|
8776
|
+
example: 1.2.3
|
|
8777
|
+
type: string
|
|
8778
|
+
type: object
|
|
8779
|
+
GetDeviceData:
|
|
8780
|
+
description: Get device response data.
|
|
8781
|
+
properties:
|
|
8782
|
+
attributes:
|
|
8783
|
+
$ref: '#/components/schemas/GetDeviceAttributes'
|
|
8784
|
+
id:
|
|
8785
|
+
description: The device ID
|
|
8786
|
+
example: example:1.2.3.4
|
|
8787
|
+
type: string
|
|
8788
|
+
type:
|
|
8789
|
+
description: The type of the resource. The value should always be device.
|
|
8790
|
+
type: string
|
|
8791
|
+
type: object
|
|
8792
|
+
GetDeviceResponse:
|
|
8793
|
+
description: The `GetDevice` operation's response.
|
|
8794
|
+
properties:
|
|
8795
|
+
data:
|
|
8796
|
+
$ref: '#/components/schemas/GetDeviceData'
|
|
8797
|
+
type: object
|
|
8304
8798
|
GetFindingResponse:
|
|
8305
8799
|
description: The expected response schema when getting a finding.
|
|
8306
8800
|
properties:
|
|
@@ -8309,6 +8803,28 @@ components:
|
|
|
8309
8803
|
required:
|
|
8310
8804
|
- data
|
|
8311
8805
|
type: object
|
|
8806
|
+
GetInterfacesData:
|
|
8807
|
+
description: The interfaces list data
|
|
8808
|
+
properties:
|
|
8809
|
+
attributes:
|
|
8810
|
+
$ref: '#/components/schemas/InterfaceAttributes'
|
|
8811
|
+
id:
|
|
8812
|
+
description: The interface ID
|
|
8813
|
+
example: example:1.2.3.4:99
|
|
8814
|
+
type: string
|
|
8815
|
+
type:
|
|
8816
|
+
description: The type of the resource. The value should always be interface.
|
|
8817
|
+
type: string
|
|
8818
|
+
type: object
|
|
8819
|
+
GetInterfacesResponse:
|
|
8820
|
+
description: The `GetInterfaces` operation's response.
|
|
8821
|
+
properties:
|
|
8822
|
+
data:
|
|
8823
|
+
description: Get Interfaces response
|
|
8824
|
+
items:
|
|
8825
|
+
$ref: '#/components/schemas/GetInterfacesData'
|
|
8826
|
+
type: array
|
|
8827
|
+
type: object
|
|
8312
8828
|
GetTeamMembershipsSort:
|
|
8313
8829
|
description: Specifies the order of returned team memberships
|
|
8314
8830
|
enum:
|
|
@@ -8487,6 +9003,12 @@ components:
|
|
|
8487
9003
|
description: Attributes of hourly usage for a product family for an org for
|
|
8488
9004
|
a time period.
|
|
8489
9005
|
properties:
|
|
9006
|
+
account_name:
|
|
9007
|
+
description: The account name.
|
|
9008
|
+
type: string
|
|
9009
|
+
account_public_id:
|
|
9010
|
+
description: The account public ID.
|
|
9011
|
+
type: string
|
|
8490
9012
|
measurements:
|
|
8491
9013
|
description: List of the measured usage values for the product family for
|
|
8492
9014
|
the org for the time period.
|
|
@@ -10474,6 +10996,47 @@ components:
|
|
|
10474
10996
|
type: string
|
|
10475
10997
|
type: array
|
|
10476
10998
|
type: object
|
|
10999
|
+
InterfaceAttributes:
|
|
11000
|
+
description: The interface attributes
|
|
11001
|
+
properties:
|
|
11002
|
+
alias:
|
|
11003
|
+
description: The interface alias
|
|
11004
|
+
example: interface_0
|
|
11005
|
+
type: string
|
|
11006
|
+
description:
|
|
11007
|
+
description: The interface description
|
|
11008
|
+
example: a network interface
|
|
11009
|
+
type: string
|
|
11010
|
+
index:
|
|
11011
|
+
description: The interface index
|
|
11012
|
+
example: 0
|
|
11013
|
+
format: int64
|
|
11014
|
+
type: integer
|
|
11015
|
+
mac_address:
|
|
11016
|
+
description: The interface MAC address
|
|
11017
|
+
example: 00:00:00:00:00:00
|
|
11018
|
+
type: string
|
|
11019
|
+
name:
|
|
11020
|
+
description: The interface name
|
|
11021
|
+
example: if0
|
|
11022
|
+
type: string
|
|
11023
|
+
status:
|
|
11024
|
+
$ref: '#/components/schemas/InterfaceAttributesStatus'
|
|
11025
|
+
type: object
|
|
11026
|
+
InterfaceAttributesStatus:
|
|
11027
|
+
description: The interface status
|
|
11028
|
+
enum:
|
|
11029
|
+
- up
|
|
11030
|
+
- down
|
|
11031
|
+
- warning
|
|
11032
|
+
- 'off'
|
|
11033
|
+
example: up
|
|
11034
|
+
type: string
|
|
11035
|
+
x-enum-varnames:
|
|
11036
|
+
- UP
|
|
11037
|
+
- DOWN
|
|
11038
|
+
- WARNING
|
|
11039
|
+
- 'OFF'
|
|
10477
11040
|
JSONAPIErrorItem:
|
|
10478
11041
|
description: API error response body
|
|
10479
11042
|
properties:
|
|
@@ -10635,6 +11198,32 @@ components:
|
|
|
10635
11198
|
meta:
|
|
10636
11199
|
$ref: '#/components/schemas/ApplicationKeyResponseMeta'
|
|
10637
11200
|
type: object
|
|
11201
|
+
ListDevicesResponse:
|
|
11202
|
+
description: List devices response.
|
|
11203
|
+
properties:
|
|
11204
|
+
data:
|
|
11205
|
+
description: The list devices response data.
|
|
11206
|
+
items:
|
|
11207
|
+
$ref: '#/components/schemas/DevicesListData'
|
|
11208
|
+
type: array
|
|
11209
|
+
meta:
|
|
11210
|
+
$ref: '#/components/schemas/ListDevicesResponseMetadata'
|
|
11211
|
+
type: object
|
|
11212
|
+
ListDevicesResponseMetadata:
|
|
11213
|
+
description: Object describing meta attributes of response.
|
|
11214
|
+
properties:
|
|
11215
|
+
page:
|
|
11216
|
+
$ref: '#/components/schemas/ListDevicesResponseMetadataPage'
|
|
11217
|
+
type: object
|
|
11218
|
+
ListDevicesResponseMetadataPage:
|
|
11219
|
+
description: Pagination object.
|
|
11220
|
+
properties:
|
|
11221
|
+
total_filtered_count:
|
|
11222
|
+
description: Total count of devices matched by the filter.
|
|
11223
|
+
example: 1
|
|
11224
|
+
format: int64
|
|
11225
|
+
type: integer
|
|
11226
|
+
type: object
|
|
10638
11227
|
ListDowntimesResponse:
|
|
10639
11228
|
description: Response for retrieving all downtimes.
|
|
10640
11229
|
properties:
|
|
@@ -10745,6 +11334,37 @@ components:
|
|
|
10745
11334
|
example: /api/v2/scorecard/rules?page%5Blimit%5D=2&page%5Boffset%5D=2&page%5Bsize%5D=2
|
|
10746
11335
|
type: string
|
|
10747
11336
|
type: object
|
|
11337
|
+
ListTagsResponse:
|
|
11338
|
+
description: List tags response.
|
|
11339
|
+
properties:
|
|
11340
|
+
data:
|
|
11341
|
+
$ref: '#/components/schemas/ListTagsResponseData'
|
|
11342
|
+
type: object
|
|
11343
|
+
ListTagsResponseData:
|
|
11344
|
+
description: The list tags response data.
|
|
11345
|
+
properties:
|
|
11346
|
+
attributes:
|
|
11347
|
+
$ref: '#/components/schemas/ListTagsResponseDataAttributes'
|
|
11348
|
+
id:
|
|
11349
|
+
description: The device ID
|
|
11350
|
+
example: example:1.2.3.4
|
|
11351
|
+
type: string
|
|
11352
|
+
type:
|
|
11353
|
+
description: The type of the resource. The value should always be tags.
|
|
11354
|
+
type: string
|
|
11355
|
+
type: object
|
|
11356
|
+
ListTagsResponseDataAttributes:
|
|
11357
|
+
description: The definition of ListTagsResponseDataAttributes object.
|
|
11358
|
+
properties:
|
|
11359
|
+
tags:
|
|
11360
|
+
description: The list of tags
|
|
11361
|
+
example:
|
|
11362
|
+
- tag:test
|
|
11363
|
+
- tag:testbis
|
|
11364
|
+
items:
|
|
11365
|
+
type: string
|
|
11366
|
+
type: array
|
|
11367
|
+
type: object
|
|
10748
11368
|
ListTeamsInclude:
|
|
10749
11369
|
description: Included related resources optionally requested.
|
|
10750
11370
|
enum:
|
|
@@ -14836,6 +15456,12 @@ components:
|
|
|
14836
15456
|
ProjectedCostAttributes:
|
|
14837
15457
|
description: Projected Cost attributes data.
|
|
14838
15458
|
properties:
|
|
15459
|
+
account_name:
|
|
15460
|
+
description: The account name.
|
|
15461
|
+
type: string
|
|
15462
|
+
account_public_id:
|
|
15463
|
+
description: The account public ID.
|
|
15464
|
+
type: string
|
|
14839
15465
|
charges:
|
|
14840
15466
|
description: List of charges data reported for the requested month.
|
|
14841
15467
|
items:
|
|
@@ -15096,7 +15722,8 @@ components:
|
|
|
15096
15722
|
type: integer
|
|
15097
15723
|
type:
|
|
15098
15724
|
description: Type of the RUM application. Supported values are `browser`,
|
|
15099
|
-
`ios`, `android`, `react-native`, `flutter
|
|
15725
|
+
`ios`, `android`, `react-native`, `flutter`, `roku`, `electron`, `unity`,
|
|
15726
|
+
`kotlin-multiplatform`.
|
|
15100
15727
|
example: browser
|
|
15101
15728
|
type: string
|
|
15102
15729
|
updated_at:
|
|
@@ -15139,7 +15766,8 @@ components:
|
|
|
15139
15766
|
type: string
|
|
15140
15767
|
type:
|
|
15141
15768
|
description: Type of the RUM application. Supported values are `browser`,
|
|
15142
|
-
`ios`, `android`, `react-native`, `flutter
|
|
15769
|
+
`ios`, `android`, `react-native`, `flutter`, `roku`, `electron`, `unity`,
|
|
15770
|
+
`kotlin-multiplatform`.
|
|
15143
15771
|
example: browser
|
|
15144
15772
|
type: string
|
|
15145
15773
|
required:
|
|
@@ -15212,7 +15840,8 @@ components:
|
|
|
15212
15840
|
type: integer
|
|
15213
15841
|
type:
|
|
15214
15842
|
description: Type of the RUM application. Supported values are `browser`,
|
|
15215
|
-
`ios`, `android`, `react-native`, `flutter
|
|
15843
|
+
`ios`, `android`, `react-native`, `flutter`, `roku`, `electron`, `unity`,
|
|
15844
|
+
`kotlin-multiplatform`.
|
|
15216
15845
|
example: browser
|
|
15217
15846
|
type: string
|
|
15218
15847
|
updated_at:
|
|
@@ -15282,7 +15911,8 @@ components:
|
|
|
15282
15911
|
type: string
|
|
15283
15912
|
type:
|
|
15284
15913
|
description: Type of the RUM application. Supported values are `browser`,
|
|
15285
|
-
`ios`, `android`, `react-native`, `flutter
|
|
15914
|
+
`ios`, `android`, `react-native`, `flutter`, `roku`, `electron`, `unity`,
|
|
15915
|
+
`kotlin-multiplatform`.
|
|
15286
15916
|
example: browser
|
|
15287
15917
|
type: string
|
|
15288
15918
|
type: object
|
|
@@ -15951,7 +16581,7 @@ components:
|
|
|
15951
16581
|
properties:
|
|
15952
16582
|
id:
|
|
15953
16583
|
description: The unique ID for a scorecard.
|
|
15954
|
-
example:
|
|
16584
|
+
example: q8MQxk8TCqrHnWkp
|
|
15955
16585
|
type: string
|
|
15956
16586
|
type:
|
|
15957
16587
|
$ref: '#/components/schemas/ScorecardType'
|
|
@@ -16640,8 +17270,6 @@ components:
|
|
|
16640
17270
|
properties:
|
|
16641
17271
|
permissions:
|
|
16642
17272
|
$ref: '#/components/schemas/RelationshipToPermissions'
|
|
16643
|
-
users:
|
|
16644
|
-
$ref: '#/components/schemas/RelationshipToUsers'
|
|
16645
17273
|
type: object
|
|
16646
17274
|
RoleResponse:
|
|
16647
17275
|
description: Response containing information about a single role.
|
|
@@ -16671,6 +17299,11 @@ components:
|
|
|
16671
17299
|
name:
|
|
16672
17300
|
description: Name of the role.
|
|
16673
17301
|
type: string
|
|
17302
|
+
user_count:
|
|
17303
|
+
description: The user count.
|
|
17304
|
+
format: int32
|
|
17305
|
+
maximum: 2147483647
|
|
17306
|
+
type: integer
|
|
16674
17307
|
type: object
|
|
16675
17308
|
RoleUpdateData:
|
|
16676
17309
|
description: Data related to the update of a role.
|
|
@@ -16796,7 +17429,7 @@ components:
|
|
|
16796
17429
|
type: object
|
|
16797
17430
|
RuleId:
|
|
16798
17431
|
description: The unique ID for a scorecard rule.
|
|
16799
|
-
example:
|
|
17432
|
+
example: q8MQxk8TCqrHnWkx
|
|
16800
17433
|
type: string
|
|
16801
17434
|
RuleOutcomeRelationships:
|
|
16802
17435
|
description: The JSON:API relationship to a scorecard rule.
|
|
@@ -17373,6 +18006,18 @@ components:
|
|
|
17373
18006
|
required:
|
|
17374
18007
|
- status
|
|
17375
18008
|
type: object
|
|
18009
|
+
SecurityMonitoringRuleConvertPayload:
|
|
18010
|
+
description: Convert a rule from JSON to Terraform.
|
|
18011
|
+
oneOf:
|
|
18012
|
+
- $ref: '#/components/schemas/SecurityMonitoringStandardRulePayload'
|
|
18013
|
+
- $ref: '#/components/schemas/SecurityMonitoringSignalRulePayload'
|
|
18014
|
+
SecurityMonitoringRuleConvertResponse:
|
|
18015
|
+
description: Result of the convert rule request containing Terraform content.
|
|
18016
|
+
properties:
|
|
18017
|
+
terraformContent:
|
|
18018
|
+
description: Terraform string as a result of converting the rule from JSON.
|
|
18019
|
+
type: string
|
|
18020
|
+
type: object
|
|
17376
18021
|
SecurityMonitoringRuleCreatePayload:
|
|
17377
18022
|
description: Create a new rule.
|
|
17378
18023
|
oneOf:
|
|
@@ -17399,6 +18044,7 @@ components:
|
|
|
17399
18044
|
- impossible_travel
|
|
17400
18045
|
- hardcoded
|
|
17401
18046
|
- third_party
|
|
18047
|
+
- anomaly_threshold
|
|
17402
18048
|
type: string
|
|
17403
18049
|
x-enum-varnames:
|
|
17404
18050
|
- THRESHOLD
|
|
@@ -17407,11 +18053,12 @@ components:
|
|
|
17407
18053
|
- IMPOSSIBLE_TRAVEL
|
|
17408
18054
|
- HARDCODED
|
|
17409
18055
|
- THIRD_PARTY
|
|
18056
|
+
- ANOMALY_THRESHOLD
|
|
17410
18057
|
SecurityMonitoringRuleEvaluationWindow:
|
|
17411
18058
|
description: 'A time window is specified to match when at least one of the cases
|
|
17412
18059
|
matches true. This is a sliding window
|
|
17413
18060
|
|
|
17414
|
-
and evaluates in real time.'
|
|
18061
|
+
and evaluates in real time. For third party rules, this field is not used.'
|
|
17415
18062
|
enum:
|
|
17416
18063
|
- 0
|
|
17417
18064
|
- 60
|
|
@@ -17455,7 +18102,8 @@ components:
|
|
|
17455
18102
|
type: boolean
|
|
17456
18103
|
SecurityMonitoringRuleKeepAlive:
|
|
17457
18104
|
description: "Once a signal is generated, the signal will remain \u201Copen\u201D
|
|
17458
|
-
if a case is matched at least once within\nthis keep alive window.
|
|
18105
|
+
if a case is matched at least once within\nthis keep alive window. For third
|
|
18106
|
+
party rules, this field is not used."
|
|
17459
18107
|
enum:
|
|
17460
18108
|
- 0
|
|
17461
18109
|
- 60
|
|
@@ -22008,6 +22656,7 @@ components:
|
|
|
22008
22656
|
url:
|
|
22009
22657
|
description: The URL for the link
|
|
22010
22658
|
example: https://example.com
|
|
22659
|
+
format: url
|
|
22011
22660
|
type: string
|
|
22012
22661
|
required:
|
|
22013
22662
|
- label
|
|
@@ -22618,6 +23267,38 @@ components:
|
|
|
22618
23267
|
id:
|
|
22619
23268
|
$ref: '#/components/schemas/ApiID'
|
|
22620
23269
|
type: object
|
|
23270
|
+
UpdateRuleRequest:
|
|
23271
|
+
description: Request to update a scorecard rule.
|
|
23272
|
+
properties:
|
|
23273
|
+
data:
|
|
23274
|
+
$ref: '#/components/schemas/UpdateRuleRequestData'
|
|
23275
|
+
type: object
|
|
23276
|
+
UpdateRuleRequestData:
|
|
23277
|
+
description: Data for the request to update a scorecard rule.
|
|
23278
|
+
properties:
|
|
23279
|
+
attributes:
|
|
23280
|
+
$ref: '#/components/schemas/RuleAttributes'
|
|
23281
|
+
type:
|
|
23282
|
+
$ref: '#/components/schemas/RuleType'
|
|
23283
|
+
type: object
|
|
23284
|
+
UpdateRuleResponse:
|
|
23285
|
+
description: The response from a rule update request.
|
|
23286
|
+
properties:
|
|
23287
|
+
data:
|
|
23288
|
+
$ref: '#/components/schemas/UpdateRuleResponseData'
|
|
23289
|
+
type: object
|
|
23290
|
+
UpdateRuleResponseData:
|
|
23291
|
+
description: The data for a rule update response.
|
|
23292
|
+
properties:
|
|
23293
|
+
attributes:
|
|
23294
|
+
$ref: '#/components/schemas/RuleAttributes'
|
|
23295
|
+
id:
|
|
23296
|
+
$ref: '#/components/schemas/RuleId'
|
|
23297
|
+
relationships:
|
|
23298
|
+
$ref: '#/components/schemas/RelationshipToRule'
|
|
23299
|
+
type:
|
|
23300
|
+
$ref: '#/components/schemas/RuleType'
|
|
23301
|
+
type: object
|
|
22621
23302
|
UsageApplicationSecurityMonitoringResponse:
|
|
22622
23303
|
description: Application Security Monitoring usage response.
|
|
22623
23304
|
properties:
|
|
@@ -22735,6 +23416,10 @@ components:
|
|
|
22735
23416
|
icon:
|
|
22736
23417
|
description: URL of the user's icon.
|
|
22737
23418
|
type: string
|
|
23419
|
+
mfa_enabled:
|
|
23420
|
+
description: If user has MFA enabled.
|
|
23421
|
+
readOnly: true
|
|
23422
|
+
type: boolean
|
|
22738
23423
|
modified_at:
|
|
22739
23424
|
description: Time that the user was last modified.
|
|
22740
23425
|
format: date-time
|
|
@@ -23233,6 +23918,107 @@ components:
|
|
|
23233
23918
|
- PAST_SIX_MONTHS
|
|
23234
23919
|
- PAST_ONE_YEAR
|
|
23235
23920
|
- ALERT
|
|
23921
|
+
WorkflowInstanceCreateMeta:
|
|
23922
|
+
description: Additional information for creating a workflow instance.
|
|
23923
|
+
properties:
|
|
23924
|
+
payload:
|
|
23925
|
+
additionalProperties: {}
|
|
23926
|
+
description: The input parameters to the workflow.
|
|
23927
|
+
type: object
|
|
23928
|
+
type: object
|
|
23929
|
+
WorkflowInstanceCreateRequest:
|
|
23930
|
+
description: Request used to create a workflow instance.
|
|
23931
|
+
properties:
|
|
23932
|
+
meta:
|
|
23933
|
+
$ref: '#/components/schemas/WorkflowInstanceCreateMeta'
|
|
23934
|
+
type: object
|
|
23935
|
+
WorkflowInstanceCreateResponse:
|
|
23936
|
+
additionalProperties: {}
|
|
23937
|
+
description: Response returned upon successful workflow instance creation.
|
|
23938
|
+
properties:
|
|
23939
|
+
data:
|
|
23940
|
+
$ref: '#/components/schemas/WorkflowInstanceCreateResponseData'
|
|
23941
|
+
type: object
|
|
23942
|
+
WorkflowInstanceCreateResponseData:
|
|
23943
|
+
additionalProperties: {}
|
|
23944
|
+
description: Data about the created workflow instance.
|
|
23945
|
+
properties:
|
|
23946
|
+
id:
|
|
23947
|
+
description: The ID of the workflow execution. It can be used to fetch the
|
|
23948
|
+
execution status.
|
|
23949
|
+
type: string
|
|
23950
|
+
type: object
|
|
23951
|
+
WorkflowInstanceListItem:
|
|
23952
|
+
additionalProperties: {}
|
|
23953
|
+
description: An item in the workflow instances list.
|
|
23954
|
+
properties:
|
|
23955
|
+
id:
|
|
23956
|
+
description: The ID of the workflow instance
|
|
23957
|
+
type: string
|
|
23958
|
+
type: object
|
|
23959
|
+
WorkflowListInstancesResponse:
|
|
23960
|
+
additionalProperties: {}
|
|
23961
|
+
description: Response returned when listing workflow instances.
|
|
23962
|
+
properties:
|
|
23963
|
+
data:
|
|
23964
|
+
description: A list of workflow instances.
|
|
23965
|
+
items:
|
|
23966
|
+
$ref: '#/components/schemas/WorkflowInstanceListItem'
|
|
23967
|
+
type: array
|
|
23968
|
+
meta:
|
|
23969
|
+
$ref: '#/components/schemas/WorkflowListInstancesResponseMeta'
|
|
23970
|
+
type: object
|
|
23971
|
+
WorkflowListInstancesResponseMeta:
|
|
23972
|
+
additionalProperties: {}
|
|
23973
|
+
description: Metadata about the instances list
|
|
23974
|
+
properties:
|
|
23975
|
+
page:
|
|
23976
|
+
$ref: '#/components/schemas/WorkflowListInstancesResponseMetaPage'
|
|
23977
|
+
type: object
|
|
23978
|
+
WorkflowListInstancesResponseMetaPage:
|
|
23979
|
+
additionalProperties: {}
|
|
23980
|
+
description: Page information for the list instances response.
|
|
23981
|
+
properties:
|
|
23982
|
+
totalCount:
|
|
23983
|
+
description: The total count of items.
|
|
23984
|
+
format: int64
|
|
23985
|
+
type: integer
|
|
23986
|
+
type: object
|
|
23987
|
+
WorklflowCancelInstanceResponse:
|
|
23988
|
+
description: Information about the canceled instance.
|
|
23989
|
+
properties:
|
|
23990
|
+
data:
|
|
23991
|
+
$ref: '#/components/schemas/WorklflowCancelInstanceResponseData'
|
|
23992
|
+
type: object
|
|
23993
|
+
WorklflowCancelInstanceResponseData:
|
|
23994
|
+
description: Data about the canceled instance.
|
|
23995
|
+
properties:
|
|
23996
|
+
id:
|
|
23997
|
+
description: The id of the canceled instance
|
|
23998
|
+
type: string
|
|
23999
|
+
type: object
|
|
24000
|
+
WorklflowGetInstanceResponse:
|
|
24001
|
+
additionalProperties: {}
|
|
24002
|
+
description: The state of the given workflow instance.
|
|
24003
|
+
properties:
|
|
24004
|
+
data:
|
|
24005
|
+
$ref: '#/components/schemas/WorklflowGetInstanceResponseData'
|
|
24006
|
+
type: object
|
|
24007
|
+
WorklflowGetInstanceResponseData:
|
|
24008
|
+
additionalProperties: {}
|
|
24009
|
+
description: The data of the instance response.
|
|
24010
|
+
properties:
|
|
24011
|
+
attributes:
|
|
24012
|
+
$ref: '#/components/schemas/WorklflowGetInstanceResponseDataAttributes'
|
|
24013
|
+
type: object
|
|
24014
|
+
WorklflowGetInstanceResponseDataAttributes:
|
|
24015
|
+
additionalProperties: {}
|
|
24016
|
+
description: The attributes of the instance response data.
|
|
24017
|
+
properties:
|
|
24018
|
+
id:
|
|
24019
|
+
description: The id of the instance.
|
|
24020
|
+
type: string
|
|
24021
|
+
type: object
|
|
23236
24022
|
securitySchemes:
|
|
23237
24023
|
AuthZ:
|
|
23238
24024
|
description: This API uses OAuth 2 with the implicit grant flow.
|
|
@@ -23566,6 +24352,11 @@ paths:
|
|
|
23566
24352
|
description: Forbidden
|
|
23567
24353
|
'429':
|
|
23568
24354
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
24355
|
+
security:
|
|
24356
|
+
- apiKeyAuth: []
|
|
24357
|
+
appKeyAuth: []
|
|
24358
|
+
- AuthZ:
|
|
24359
|
+
- apm_api_catalog_read
|
|
23569
24360
|
summary: List APIs
|
|
23570
24361
|
tags:
|
|
23571
24362
|
- API Management
|
|
@@ -23606,6 +24397,11 @@ paths:
|
|
|
23606
24397
|
description: API not found error
|
|
23607
24398
|
'429':
|
|
23608
24399
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
24400
|
+
security:
|
|
24401
|
+
- apiKeyAuth: []
|
|
24402
|
+
appKeyAuth: []
|
|
24403
|
+
- AuthZ:
|
|
24404
|
+
- apm_api_catalog_write
|
|
23609
24405
|
summary: Delete an API
|
|
23610
24406
|
tags:
|
|
23611
24407
|
- API Management
|
|
@@ -23652,6 +24448,11 @@ paths:
|
|
|
23652
24448
|
description: API not found error
|
|
23653
24449
|
'429':
|
|
23654
24450
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
24451
|
+
security:
|
|
24452
|
+
- apiKeyAuth: []
|
|
24453
|
+
appKeyAuth: []
|
|
24454
|
+
- AuthZ:
|
|
24455
|
+
- apm_api_catalog_read
|
|
23655
24456
|
summary: Get an API
|
|
23656
24457
|
tags:
|
|
23657
24458
|
- API Management
|
|
@@ -23707,6 +24508,11 @@ paths:
|
|
|
23707
24508
|
description: API not found error
|
|
23708
24509
|
'429':
|
|
23709
24510
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
24511
|
+
security:
|
|
24512
|
+
- apiKeyAuth: []
|
|
24513
|
+
appKeyAuth: []
|
|
24514
|
+
- AuthZ:
|
|
24515
|
+
- apm_api_catalog_write
|
|
23710
24516
|
summary: Update an API
|
|
23711
24517
|
tags:
|
|
23712
24518
|
- API Management
|
|
@@ -23754,6 +24560,11 @@ paths:
|
|
|
23754
24560
|
description: Forbidden
|
|
23755
24561
|
'429':
|
|
23756
24562
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
24563
|
+
security:
|
|
24564
|
+
- apiKeyAuth: []
|
|
24565
|
+
appKeyAuth: []
|
|
24566
|
+
- AuthZ:
|
|
24567
|
+
- apm_api_catalog_write
|
|
23757
24568
|
summary: Create a new API
|
|
23758
24569
|
tags:
|
|
23759
24570
|
- API Management
|
|
@@ -24326,6 +25137,11 @@ paths:
|
|
|
24326
25137
|
required: false
|
|
24327
25138
|
schema:
|
|
24328
25139
|
type: string
|
|
25140
|
+
- description: Filter by mapping resource type. Defaults to "role" if not specified.
|
|
25141
|
+
in: query
|
|
25142
|
+
name: resource_type
|
|
25143
|
+
schema:
|
|
25144
|
+
$ref: '#/components/schemas/AuthNMappingResourceType'
|
|
24329
25145
|
responses:
|
|
24330
25146
|
'200':
|
|
24331
25147
|
content:
|
|
@@ -24546,6 +25362,11 @@ paths:
|
|
|
24546
25362
|
$ref: '#/components/responses/NotFoundResponse'
|
|
24547
25363
|
'429':
|
|
24548
25364
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
25365
|
+
security:
|
|
25366
|
+
- apiKeyAuth: []
|
|
25367
|
+
appKeyAuth: []
|
|
25368
|
+
- AuthZ:
|
|
25369
|
+
- cases_read
|
|
24549
25370
|
summary: Search cases
|
|
24550
25371
|
tags:
|
|
24551
25372
|
- Case Management
|
|
@@ -24580,6 +25401,11 @@ paths:
|
|
|
24580
25401
|
$ref: '#/components/responses/NotFoundResponse'
|
|
24581
25402
|
'429':
|
|
24582
25403
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
25404
|
+
security:
|
|
25405
|
+
- apiKeyAuth: []
|
|
25406
|
+
appKeyAuth: []
|
|
25407
|
+
- AuthZ:
|
|
25408
|
+
- cases_write
|
|
24583
25409
|
summary: Create a case
|
|
24584
25410
|
tags:
|
|
24585
25411
|
- Case Management
|
|
@@ -24604,6 +25430,11 @@ paths:
|
|
|
24604
25430
|
$ref: '#/components/responses/NotFoundResponse'
|
|
24605
25431
|
'429':
|
|
24606
25432
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
25433
|
+
security:
|
|
25434
|
+
- apiKeyAuth: []
|
|
25435
|
+
appKeyAuth: []
|
|
25436
|
+
- AuthZ:
|
|
25437
|
+
- cases_read
|
|
24607
25438
|
summary: Get all projects
|
|
24608
25439
|
tags:
|
|
24609
25440
|
- Case Management
|
|
@@ -24634,6 +25465,11 @@ paths:
|
|
|
24634
25465
|
$ref: '#/components/responses/NotFoundResponse'
|
|
24635
25466
|
'429':
|
|
24636
25467
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
25468
|
+
security:
|
|
25469
|
+
- apiKeyAuth: []
|
|
25470
|
+
appKeyAuth: []
|
|
25471
|
+
- AuthZ:
|
|
25472
|
+
- cases_write
|
|
24637
25473
|
summary: Create a project
|
|
24638
25474
|
tags:
|
|
24639
25475
|
- Case Management
|
|
@@ -24656,6 +25492,11 @@ paths:
|
|
|
24656
25492
|
description: API error response
|
|
24657
25493
|
'429':
|
|
24658
25494
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
25495
|
+
security:
|
|
25496
|
+
- apiKeyAuth: []
|
|
25497
|
+
appKeyAuth: []
|
|
25498
|
+
- AuthZ:
|
|
25499
|
+
- cases_write
|
|
24659
25500
|
summary: Remove a project
|
|
24660
25501
|
tags:
|
|
24661
25502
|
- Case Management
|
|
@@ -24681,6 +25522,11 @@ paths:
|
|
|
24681
25522
|
$ref: '#/components/responses/NotFoundResponse'
|
|
24682
25523
|
'429':
|
|
24683
25524
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
25525
|
+
security:
|
|
25526
|
+
- apiKeyAuth: []
|
|
25527
|
+
appKeyAuth: []
|
|
25528
|
+
- AuthZ:
|
|
25529
|
+
- cases_read
|
|
24684
25530
|
summary: Get the details of a project
|
|
24685
25531
|
tags:
|
|
24686
25532
|
- Case Management
|
|
@@ -24707,6 +25553,11 @@ paths:
|
|
|
24707
25553
|
$ref: '#/components/responses/NotFoundResponse'
|
|
24708
25554
|
'429':
|
|
24709
25555
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
25556
|
+
security:
|
|
25557
|
+
- apiKeyAuth: []
|
|
25558
|
+
appKeyAuth: []
|
|
25559
|
+
- AuthZ:
|
|
25560
|
+
- cases_read
|
|
24710
25561
|
summary: Get the details of a case
|
|
24711
25562
|
tags:
|
|
24712
25563
|
- Case Management
|
|
@@ -24740,6 +25591,11 @@ paths:
|
|
|
24740
25591
|
$ref: '#/components/responses/NotFoundResponse'
|
|
24741
25592
|
'429':
|
|
24742
25593
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
25594
|
+
security:
|
|
25595
|
+
- apiKeyAuth: []
|
|
25596
|
+
appKeyAuth: []
|
|
25597
|
+
- AuthZ:
|
|
25598
|
+
- cases_write
|
|
24743
25599
|
summary: Archive case
|
|
24744
25600
|
tags:
|
|
24745
25601
|
- Case Management
|
|
@@ -24773,6 +25629,11 @@ paths:
|
|
|
24773
25629
|
$ref: '#/components/responses/NotFoundResponse'
|
|
24774
25630
|
'429':
|
|
24775
25631
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
25632
|
+
security:
|
|
25633
|
+
- apiKeyAuth: []
|
|
25634
|
+
appKeyAuth: []
|
|
25635
|
+
- AuthZ:
|
|
25636
|
+
- cases_write
|
|
24776
25637
|
summary: Assign case
|
|
24777
25638
|
tags:
|
|
24778
25639
|
- Case Management
|
|
@@ -24806,6 +25667,11 @@ paths:
|
|
|
24806
25667
|
$ref: '#/components/responses/NotFoundResponse'
|
|
24807
25668
|
'429':
|
|
24808
25669
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
25670
|
+
security:
|
|
25671
|
+
- apiKeyAuth: []
|
|
25672
|
+
appKeyAuth: []
|
|
25673
|
+
- AuthZ:
|
|
25674
|
+
- cases_write
|
|
24809
25675
|
summary: Update case priority
|
|
24810
25676
|
tags:
|
|
24811
25677
|
- Case Management
|
|
@@ -24839,6 +25705,11 @@ paths:
|
|
|
24839
25705
|
$ref: '#/components/responses/NotFoundResponse'
|
|
24840
25706
|
'429':
|
|
24841
25707
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
25708
|
+
security:
|
|
25709
|
+
- apiKeyAuth: []
|
|
25710
|
+
appKeyAuth: []
|
|
25711
|
+
- AuthZ:
|
|
25712
|
+
- cases_write
|
|
24842
25713
|
summary: Update case status
|
|
24843
25714
|
tags:
|
|
24844
25715
|
- Case Management
|
|
@@ -24872,6 +25743,11 @@ paths:
|
|
|
24872
25743
|
$ref: '#/components/responses/NotFoundResponse'
|
|
24873
25744
|
'429':
|
|
24874
25745
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
25746
|
+
security:
|
|
25747
|
+
- apiKeyAuth: []
|
|
25748
|
+
appKeyAuth: []
|
|
25749
|
+
- AuthZ:
|
|
25750
|
+
- cases_write
|
|
24875
25751
|
summary: Unarchive case
|
|
24876
25752
|
tags:
|
|
24877
25753
|
- Case Management
|
|
@@ -24905,6 +25781,11 @@ paths:
|
|
|
24905
25781
|
$ref: '#/components/responses/NotFoundResponse'
|
|
24906
25782
|
'429':
|
|
24907
25783
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
25784
|
+
security:
|
|
25785
|
+
- apiKeyAuth: []
|
|
25786
|
+
appKeyAuth: []
|
|
25787
|
+
- AuthZ:
|
|
25788
|
+
- cases_write
|
|
24908
25789
|
summary: Unassign case
|
|
24909
25790
|
tags:
|
|
24910
25791
|
- Case Management
|
|
@@ -25591,6 +26472,7 @@ paths:
|
|
|
25591
26472
|
- Cloud Cost Management
|
|
25592
26473
|
/api/v2/cost/aws_related_accounts:
|
|
25593
26474
|
get:
|
|
26475
|
+
deprecated: true
|
|
25594
26476
|
description: List the AWS accounts in an organization by calling 'organizations:ListAccounts'
|
|
25595
26477
|
from the specified management account.
|
|
25596
26478
|
operationId: ListAWSRelatedAccounts
|
|
@@ -25767,6 +26649,118 @@ paths:
|
|
|
25767
26649
|
summary: Update Cloud Cost Management Azure config
|
|
25768
26650
|
tags:
|
|
25769
26651
|
- Cloud Cost Management
|
|
26652
|
+
/api/v2/cost/custom_costs:
|
|
26653
|
+
get:
|
|
26654
|
+
description: List the Custom Costs files.
|
|
26655
|
+
operationId: ListCustomCostsFiles
|
|
26656
|
+
responses:
|
|
26657
|
+
'200':
|
|
26658
|
+
content:
|
|
26659
|
+
application/json:
|
|
26660
|
+
schema:
|
|
26661
|
+
$ref: '#/components/schemas/CustomCostsFileListResponse'
|
|
26662
|
+
description: OK
|
|
26663
|
+
'403':
|
|
26664
|
+
content:
|
|
26665
|
+
application/json:
|
|
26666
|
+
schema:
|
|
26667
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
26668
|
+
description: Forbidden
|
|
26669
|
+
'429':
|
|
26670
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
26671
|
+
security:
|
|
26672
|
+
- apiKeyAuth: []
|
|
26673
|
+
appKeyAuth: []
|
|
26674
|
+
- AuthZ:
|
|
26675
|
+
- cloud_cost_management_read
|
|
26676
|
+
summary: List Custom Costs files
|
|
26677
|
+
tags:
|
|
26678
|
+
- Cloud Cost Management
|
|
26679
|
+
put:
|
|
26680
|
+
description: Upload a Custom Costs file.
|
|
26681
|
+
operationId: UploadCustomCostsFile
|
|
26682
|
+
requestBody:
|
|
26683
|
+
content:
|
|
26684
|
+
application/json:
|
|
26685
|
+
schema:
|
|
26686
|
+
$ref: '#/components/schemas/CustomCostsFileUploadRequest'
|
|
26687
|
+
required: true
|
|
26688
|
+
responses:
|
|
26689
|
+
'202':
|
|
26690
|
+
content:
|
|
26691
|
+
application/json:
|
|
26692
|
+
schema:
|
|
26693
|
+
$ref: '#/components/schemas/CustomCostsFileUploadResponse'
|
|
26694
|
+
description: Accepted
|
|
26695
|
+
'403':
|
|
26696
|
+
content:
|
|
26697
|
+
application/json:
|
|
26698
|
+
schema:
|
|
26699
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
26700
|
+
description: Forbidden
|
|
26701
|
+
'429':
|
|
26702
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
26703
|
+
security:
|
|
26704
|
+
- apiKeyAuth: []
|
|
26705
|
+
appKeyAuth: []
|
|
26706
|
+
- AuthZ:
|
|
26707
|
+
- cloud_cost_management_write
|
|
26708
|
+
summary: Upload Custom Costs file
|
|
26709
|
+
tags:
|
|
26710
|
+
- Cloud Cost Management
|
|
26711
|
+
/api/v2/cost/custom_costs/{file_id}:
|
|
26712
|
+
delete:
|
|
26713
|
+
description: Delete the specified Custom Costs file.
|
|
26714
|
+
operationId: DeleteCustomCostsFile
|
|
26715
|
+
parameters:
|
|
26716
|
+
- $ref: '#/components/parameters/FileID'
|
|
26717
|
+
responses:
|
|
26718
|
+
'204':
|
|
26719
|
+
description: No Content
|
|
26720
|
+
'403':
|
|
26721
|
+
content:
|
|
26722
|
+
application/json:
|
|
26723
|
+
schema:
|
|
26724
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
26725
|
+
description: Forbidden
|
|
26726
|
+
'429':
|
|
26727
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
26728
|
+
security:
|
|
26729
|
+
- apiKeyAuth: []
|
|
26730
|
+
appKeyAuth: []
|
|
26731
|
+
- AuthZ:
|
|
26732
|
+
- cloud_cost_management_write
|
|
26733
|
+
summary: Delete Custom Costs file
|
|
26734
|
+
tags:
|
|
26735
|
+
- Cloud Cost Management
|
|
26736
|
+
get:
|
|
26737
|
+
description: Fetch the specified Custom Costs file.
|
|
26738
|
+
operationId: GetCustomCostsFile
|
|
26739
|
+
parameters:
|
|
26740
|
+
- $ref: '#/components/parameters/FileID'
|
|
26741
|
+
responses:
|
|
26742
|
+
'200':
|
|
26743
|
+
content:
|
|
26744
|
+
application/json:
|
|
26745
|
+
schema:
|
|
26746
|
+
$ref: '#/components/schemas/CustomCostsFileGetResponse'
|
|
26747
|
+
description: OK
|
|
26748
|
+
'403':
|
|
26749
|
+
content:
|
|
26750
|
+
application/json:
|
|
26751
|
+
schema:
|
|
26752
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
26753
|
+
description: Forbidden
|
|
26754
|
+
'429':
|
|
26755
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
26756
|
+
security:
|
|
26757
|
+
- apiKeyAuth: []
|
|
26758
|
+
appKeyAuth: []
|
|
26759
|
+
- AuthZ:
|
|
26760
|
+
- cloud_cost_management_read
|
|
26761
|
+
summary: Get Custom Costs file
|
|
26762
|
+
tags:
|
|
26763
|
+
- Cloud Cost Management
|
|
25770
26764
|
/api/v2/cost/enabled:
|
|
25771
26765
|
get:
|
|
25772
26766
|
description: Get the Cloud Cost Management activity.
|
|
@@ -30517,6 +31511,172 @@ paths:
|
|
|
30517
31511
|
limitParam: page[limit]
|
|
30518
31512
|
pageOffsetParam: page[offset]
|
|
30519
31513
|
resultsPath: data
|
|
31514
|
+
/api/v2/ndm/devices:
|
|
31515
|
+
get:
|
|
31516
|
+
description: Get the list of devices.
|
|
31517
|
+
operationId: ListDevices
|
|
31518
|
+
parameters:
|
|
31519
|
+
- description: The page number to fetch.
|
|
31520
|
+
example: 0
|
|
31521
|
+
in: query
|
|
31522
|
+
name: page[number]
|
|
31523
|
+
required: false
|
|
31524
|
+
schema:
|
|
31525
|
+
format: int64
|
|
31526
|
+
type: integer
|
|
31527
|
+
- description: The number of devices to return per page.
|
|
31528
|
+
example: 10
|
|
31529
|
+
in: query
|
|
31530
|
+
name: page[size]
|
|
31531
|
+
required: false
|
|
31532
|
+
schema:
|
|
31533
|
+
format: int64
|
|
31534
|
+
type: integer
|
|
31535
|
+
- description: The field to sort the devices by.
|
|
31536
|
+
example: status
|
|
31537
|
+
in: query
|
|
31538
|
+
name: sort
|
|
31539
|
+
required: false
|
|
31540
|
+
schema:
|
|
31541
|
+
type: string
|
|
31542
|
+
- description: Filter devices by tag.
|
|
31543
|
+
example: status:ok
|
|
31544
|
+
in: query
|
|
31545
|
+
name: filter[tag]
|
|
31546
|
+
required: false
|
|
31547
|
+
schema:
|
|
31548
|
+
type: string
|
|
31549
|
+
responses:
|
|
31550
|
+
'200':
|
|
31551
|
+
content:
|
|
31552
|
+
application/json:
|
|
31553
|
+
schema:
|
|
31554
|
+
$ref: '#/components/schemas/ListDevicesResponse'
|
|
31555
|
+
description: OK
|
|
31556
|
+
'400':
|
|
31557
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
31558
|
+
'403':
|
|
31559
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
31560
|
+
'429':
|
|
31561
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
31562
|
+
summary: Get the list of devices
|
|
31563
|
+
tags:
|
|
31564
|
+
- Network Device Monitoring
|
|
31565
|
+
/api/v2/ndm/devices/{device_id}:
|
|
31566
|
+
get:
|
|
31567
|
+
description: Get the device details.
|
|
31568
|
+
operationId: GetDevice
|
|
31569
|
+
parameters:
|
|
31570
|
+
- description: The id of the device to fetch.
|
|
31571
|
+
example: example:1.2.3.4
|
|
31572
|
+
in: path
|
|
31573
|
+
name: device_id
|
|
31574
|
+
required: true
|
|
31575
|
+
schema:
|
|
31576
|
+
type: string
|
|
31577
|
+
responses:
|
|
31578
|
+
'200':
|
|
31579
|
+
content:
|
|
31580
|
+
application/json:
|
|
31581
|
+
schema:
|
|
31582
|
+
$ref: '#/components/schemas/GetDeviceResponse'
|
|
31583
|
+
description: OK
|
|
31584
|
+
'403':
|
|
31585
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
31586
|
+
'404':
|
|
31587
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
31588
|
+
'429':
|
|
31589
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
31590
|
+
summary: Get the device details
|
|
31591
|
+
tags:
|
|
31592
|
+
- Network Device Monitoring
|
|
31593
|
+
/api/v2/ndm/interfaces:
|
|
31594
|
+
get:
|
|
31595
|
+
description: Get the list of interfaces of the device.
|
|
31596
|
+
operationId: GetInterfaces
|
|
31597
|
+
parameters:
|
|
31598
|
+
- description: The ID of the device to get interfaces from.
|
|
31599
|
+
example: example:1.2.3.4
|
|
31600
|
+
in: query
|
|
31601
|
+
name: device_id
|
|
31602
|
+
required: true
|
|
31603
|
+
schema:
|
|
31604
|
+
type: string
|
|
31605
|
+
responses:
|
|
31606
|
+
'200':
|
|
31607
|
+
content:
|
|
31608
|
+
application/json:
|
|
31609
|
+
schema:
|
|
31610
|
+
$ref: '#/components/schemas/GetInterfacesResponse'
|
|
31611
|
+
description: OK
|
|
31612
|
+
'403':
|
|
31613
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
31614
|
+
'429':
|
|
31615
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
31616
|
+
summary: Get the list of interfaces of the device
|
|
31617
|
+
tags:
|
|
31618
|
+
- Network Device Monitoring
|
|
31619
|
+
/api/v2/ndm/tags/devices/{device_id}:
|
|
31620
|
+
get:
|
|
31621
|
+
description: Get the list of tags for a device.
|
|
31622
|
+
operationId: ListDeviceUserTags
|
|
31623
|
+
parameters:
|
|
31624
|
+
- description: The id of the device to fetch tags for.
|
|
31625
|
+
example: example:1.2.3.4
|
|
31626
|
+
in: path
|
|
31627
|
+
name: device_id
|
|
31628
|
+
required: true
|
|
31629
|
+
schema:
|
|
31630
|
+
type: string
|
|
31631
|
+
responses:
|
|
31632
|
+
'200':
|
|
31633
|
+
content:
|
|
31634
|
+
application/json:
|
|
31635
|
+
schema:
|
|
31636
|
+
$ref: '#/components/schemas/ListTagsResponse'
|
|
31637
|
+
description: OK
|
|
31638
|
+
'403':
|
|
31639
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
31640
|
+
'404':
|
|
31641
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
31642
|
+
'429':
|
|
31643
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
31644
|
+
summary: Get the list of tags for a device
|
|
31645
|
+
tags:
|
|
31646
|
+
- Network Device Monitoring
|
|
31647
|
+
patch:
|
|
31648
|
+
description: Update the tags for a device.
|
|
31649
|
+
operationId: UpdateDeviceUserTags
|
|
31650
|
+
parameters:
|
|
31651
|
+
- description: The id of the device to update tags for.
|
|
31652
|
+
example: example:1.2.3.4
|
|
31653
|
+
in: path
|
|
31654
|
+
name: device_id
|
|
31655
|
+
required: true
|
|
31656
|
+
schema:
|
|
31657
|
+
type: string
|
|
31658
|
+
requestBody:
|
|
31659
|
+
content:
|
|
31660
|
+
application/json:
|
|
31661
|
+
schema:
|
|
31662
|
+
$ref: '#/components/schemas/ListTagsResponse'
|
|
31663
|
+
required: true
|
|
31664
|
+
responses:
|
|
31665
|
+
'200':
|
|
31666
|
+
content:
|
|
31667
|
+
application/json:
|
|
31668
|
+
schema:
|
|
31669
|
+
$ref: '#/components/schemas/ListTagsResponse'
|
|
31670
|
+
description: OK
|
|
31671
|
+
'403':
|
|
31672
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
31673
|
+
'404':
|
|
31674
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
31675
|
+
'429':
|
|
31676
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
31677
|
+
summary: Update the tags for a device
|
|
31678
|
+
tags:
|
|
31679
|
+
- Network Device Monitoring
|
|
30520
31680
|
/api/v2/org_configs:
|
|
30521
31681
|
get:
|
|
30522
31682
|
description: Returns all Org Configs (name, description, and value).
|
|
@@ -30599,11 +31759,6 @@ paths:
|
|
|
30599
31759
|
$ref: '#/components/responses/NotFoundResponse'
|
|
30600
31760
|
'429':
|
|
30601
31761
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
30602
|
-
security:
|
|
30603
|
-
- apiKeyAuth: []
|
|
30604
|
-
appKeyAuth: []
|
|
30605
|
-
- AuthZ:
|
|
30606
|
-
- org_management
|
|
30607
31762
|
summary: Update a specific Org Config
|
|
30608
31763
|
tags:
|
|
30609
31764
|
- Organizations
|
|
@@ -31454,22 +32609,38 @@ paths:
|
|
|
31454
32609
|
|
|
31455
32610
|
- Service Level Objectives: `slo`
|
|
31456
32611
|
|
|
32612
|
+
- Synthetic Global Variables: `synthetic-global-variable`
|
|
32613
|
+
|
|
32614
|
+
- Synthetic Tests: `synthetic-test`
|
|
32615
|
+
|
|
32616
|
+
- Synthetic Private Locations: `synthetic-private-location`
|
|
32617
|
+
|
|
32618
|
+
- Monitors: `monitor`
|
|
32619
|
+
|
|
31457
32620
|
|
|
31458
32621
|
#### Supported relations for resources
|
|
31459
32622
|
|
|
31460
|
-
Resource Type
|
|
32623
|
+
Resource Type | Supported Relations
|
|
32624
|
+
|
|
32625
|
+
----------------------------|--------------------------
|
|
31461
32626
|
|
|
31462
|
-
|
|
32627
|
+
Dashboards | `viewer`, `editor`
|
|
31463
32628
|
|
|
31464
|
-
|
|
32629
|
+
Notebooks | `viewer`, `editor`
|
|
31465
32630
|
|
|
31466
|
-
|
|
32631
|
+
Powerpacks | `viewer`, `editor`
|
|
31467
32632
|
|
|
31468
|
-
|
|
32633
|
+
Security Rules | `viewer`, `editor`
|
|
31469
32634
|
|
|
31470
|
-
|
|
32635
|
+
Service Level Objectives | `viewer`, `editor`
|
|
31471
32636
|
|
|
31472
|
-
|
|
32637
|
+
Synthetic Global Variables | `viewer`, `editor`
|
|
32638
|
+
|
|
32639
|
+
Synthetic Tests | `viewer`, `editor`
|
|
32640
|
+
|
|
32641
|
+
Synthetic Private Locations | `viewer`, `editor`
|
|
32642
|
+
|
|
32643
|
+
Monitors | `viewer`, `editor`'
|
|
31473
32644
|
operationId: UpdateRestrictionPolicy
|
|
31474
32645
|
parameters:
|
|
31475
32646
|
- $ref: '#/components/parameters/ResourceID'
|
|
@@ -32650,6 +33821,43 @@ paths:
|
|
|
32650
33821
|
x-unstable: '**Note**: This endpoint is in public beta.
|
|
32651
33822
|
|
|
32652
33823
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
33824
|
+
put:
|
|
33825
|
+
description: Updates an existing rule.
|
|
33826
|
+
operationId: UpdateScorecardRule
|
|
33827
|
+
parameters:
|
|
33828
|
+
- $ref: '#/components/parameters/RuleId'
|
|
33829
|
+
requestBody:
|
|
33830
|
+
content:
|
|
33831
|
+
application/json:
|
|
33832
|
+
schema:
|
|
33833
|
+
$ref: '#/components/schemas/UpdateRuleRequest'
|
|
33834
|
+
description: Rule attributes.
|
|
33835
|
+
required: true
|
|
33836
|
+
responses:
|
|
33837
|
+
'200':
|
|
33838
|
+
content:
|
|
33839
|
+
application/json:
|
|
33840
|
+
schema:
|
|
33841
|
+
$ref: '#/components/schemas/UpdateRuleResponse'
|
|
33842
|
+
description: Rule updated successfully
|
|
33843
|
+
'400':
|
|
33844
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
33845
|
+
'403':
|
|
33846
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
33847
|
+
'429':
|
|
33848
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
33849
|
+
security:
|
|
33850
|
+
- apiKeyAuth: []
|
|
33851
|
+
appKeyAuth: []
|
|
33852
|
+
- AuthZ:
|
|
33853
|
+
- apm_service_catalog_write
|
|
33854
|
+
summary: Update an existing rule
|
|
33855
|
+
tags:
|
|
33856
|
+
- Service Scorecards
|
|
33857
|
+
x-codegen-request-body-name: body
|
|
33858
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
|
33859
|
+
|
|
33860
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
32653
33861
|
/api/v2/security/cloud_workload/policy/download:
|
|
32654
33862
|
get:
|
|
32655
33863
|
description: 'The download endpoint generates a Cloud Workload Security policy
|
|
@@ -33152,6 +34360,45 @@ paths:
|
|
|
33152
34360
|
tags:
|
|
33153
34361
|
- Security Monitoring
|
|
33154
34362
|
x-codegen-request-body-name: body
|
|
34363
|
+
/api/v2/security_monitoring/rules/convert:
|
|
34364
|
+
post:
|
|
34365
|
+
description: 'Convert a rule that doesn''t (yet) exist from JSON to Terraform
|
|
34366
|
+
for datadog provider
|
|
34367
|
+
|
|
34368
|
+
resource datadog_security_monitoring_rule.'
|
|
34369
|
+
operationId: ConvertSecurityMonitoringRuleFromJSONToTerraform
|
|
34370
|
+
requestBody:
|
|
34371
|
+
content:
|
|
34372
|
+
application/json:
|
|
34373
|
+
schema:
|
|
34374
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleConvertPayload'
|
|
34375
|
+
required: true
|
|
34376
|
+
responses:
|
|
34377
|
+
'200':
|
|
34378
|
+
content:
|
|
34379
|
+
application/json:
|
|
34380
|
+
schema:
|
|
34381
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleConvertResponse'
|
|
34382
|
+
description: OK
|
|
34383
|
+
'400':
|
|
34384
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
34385
|
+
'401':
|
|
34386
|
+
$ref: '#/components/responses/ConcurrentModificationResponse'
|
|
34387
|
+
'403':
|
|
34388
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
34389
|
+
'404':
|
|
34390
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
34391
|
+
'429':
|
|
34392
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
34393
|
+
security:
|
|
34394
|
+
- apiKeyAuth: []
|
|
34395
|
+
appKeyAuth: []
|
|
34396
|
+
- AuthZ:
|
|
34397
|
+
- security_monitoring_rules_write
|
|
34398
|
+
summary: Convert a rule from JSON to Terraform
|
|
34399
|
+
tags:
|
|
34400
|
+
- Security Monitoring
|
|
34401
|
+
x-codegen-request-body-name: body
|
|
33155
34402
|
/api/v2/security_monitoring/rules/test:
|
|
33156
34403
|
post:
|
|
33157
34404
|
description: Test a rule.
|
|
@@ -33309,6 +34556,37 @@ paths:
|
|
|
33309
34556
|
tags:
|
|
33310
34557
|
- Security Monitoring
|
|
33311
34558
|
x-codegen-request-body-name: body
|
|
34559
|
+
/api/v2/security_monitoring/rules/{rule_id}/convert:
|
|
34560
|
+
get:
|
|
34561
|
+
description: 'Convert an existing rule from JSON to Terraform for datadog provider
|
|
34562
|
+
|
|
34563
|
+
resource datadog_security_monitoring_rule.'
|
|
34564
|
+
operationId: ConvertExistingSecurityMonitoringRule
|
|
34565
|
+
parameters:
|
|
34566
|
+
- $ref: '#/components/parameters/SecurityMonitoringRuleID'
|
|
34567
|
+
responses:
|
|
34568
|
+
'200':
|
|
34569
|
+
content:
|
|
34570
|
+
application/json:
|
|
34571
|
+
schema:
|
|
34572
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleConvertResponse'
|
|
34573
|
+
description: OK
|
|
34574
|
+
'400':
|
|
34575
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
34576
|
+
'403':
|
|
34577
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
34578
|
+
'404':
|
|
34579
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
34580
|
+
'429':
|
|
34581
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
34582
|
+
security:
|
|
34583
|
+
- apiKeyAuth: []
|
|
34584
|
+
appKeyAuth: []
|
|
34585
|
+
- AuthZ:
|
|
34586
|
+
- security_monitoring_rules_read
|
|
34587
|
+
summary: Convert an existing rule from JSON to Terraform
|
|
34588
|
+
tags:
|
|
34589
|
+
- Security Monitoring
|
|
33312
34590
|
/api/v2/security_monitoring/rules/{rule_id}/test:
|
|
33313
34591
|
post:
|
|
33314
34592
|
description: Test an existing rule.
|
|
@@ -36005,6 +37283,15 @@ paths:
|
|
|
36005
37283
|
schema:
|
|
36006
37284
|
format: date-time
|
|
36007
37285
|
type: string
|
|
37286
|
+
- description: 'Boolean to specify whether to include accounts connected to
|
|
37287
|
+
the current account as partner customers in the Datadog partner network
|
|
37288
|
+
program. Defaults to `false`. '
|
|
37289
|
+
in: query
|
|
37290
|
+
name: include_connected_accounts
|
|
37291
|
+
required: false
|
|
37292
|
+
schema:
|
|
37293
|
+
default: false
|
|
37294
|
+
type: boolean
|
|
36008
37295
|
responses:
|
|
36009
37296
|
'200':
|
|
36010
37297
|
content:
|
|
@@ -36073,6 +37360,15 @@ paths:
|
|
|
36073
37360
|
schema:
|
|
36074
37361
|
format: date-time
|
|
36075
37362
|
type: string
|
|
37363
|
+
- description: 'Boolean to specify whether to include accounts connected to
|
|
37364
|
+
the current account as partner customers in the Datadog partner network
|
|
37365
|
+
program. Defaults to `false`. '
|
|
37366
|
+
in: query
|
|
37367
|
+
name: include_connected_accounts
|
|
37368
|
+
required: false
|
|
37369
|
+
schema:
|
|
37370
|
+
default: false
|
|
37371
|
+
type: boolean
|
|
36076
37372
|
responses:
|
|
36077
37373
|
'200':
|
|
36078
37374
|
content:
|
|
@@ -36160,6 +37456,15 @@ paths:
|
|
|
36160
37456
|
schema:
|
|
36161
37457
|
default: false
|
|
36162
37458
|
type: boolean
|
|
37459
|
+
- description: Boolean to specify whether to include accounts connected to the
|
|
37460
|
+
current account as partner customers in the Datadog partner network program.
|
|
37461
|
+
Defaults to false.
|
|
37462
|
+
in: query
|
|
37463
|
+
name: filter[include_connected_accounts]
|
|
37464
|
+
required: false
|
|
37465
|
+
schema:
|
|
37466
|
+
default: false
|
|
37467
|
+
type: boolean
|
|
36163
37468
|
- description: Include breakdown of usage by subcategories where applicable
|
|
36164
37469
|
(for product family logs only). Defaults to false.
|
|
36165
37470
|
in: query
|
|
@@ -36370,6 +37675,15 @@ paths:
|
|
|
36370
37675
|
required: false
|
|
36371
37676
|
schema:
|
|
36372
37677
|
type: string
|
|
37678
|
+
- description: 'Boolean to specify whether to include accounts connected to
|
|
37679
|
+
the current account as partner customers in the Datadog partner network
|
|
37680
|
+
program. Defaults to `false`. '
|
|
37681
|
+
in: query
|
|
37682
|
+
name: include_connected_accounts
|
|
37683
|
+
required: false
|
|
37684
|
+
schema:
|
|
37685
|
+
default: false
|
|
37686
|
+
type: boolean
|
|
36373
37687
|
responses:
|
|
36374
37688
|
'200':
|
|
36375
37689
|
content:
|
|
@@ -36838,6 +38152,122 @@ paths:
|
|
|
36838
38152
|
summary: Get user memberships
|
|
36839
38153
|
tags:
|
|
36840
38154
|
- Teams
|
|
38155
|
+
/api/v2/workflows/{workflow_id}/instances:
|
|
38156
|
+
get:
|
|
38157
|
+
description: List all instances of a given workflow. This API requires an application
|
|
38158
|
+
key scoped with the workflows_read permission.
|
|
38159
|
+
operationId: ListWorkflowInstances
|
|
38160
|
+
parameters:
|
|
38161
|
+
- $ref: '#/components/parameters/WorkflowId'
|
|
38162
|
+
- $ref: '#/components/parameters/PageSize'
|
|
38163
|
+
- $ref: '#/components/parameters/PageNumber'
|
|
38164
|
+
responses:
|
|
38165
|
+
'200':
|
|
38166
|
+
content:
|
|
38167
|
+
application/json:
|
|
38168
|
+
schema:
|
|
38169
|
+
$ref: '#/components/schemas/WorkflowListInstancesResponse'
|
|
38170
|
+
description: OK
|
|
38171
|
+
'400':
|
|
38172
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
38173
|
+
'403':
|
|
38174
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
38175
|
+
'429':
|
|
38176
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
38177
|
+
security:
|
|
38178
|
+
- apiKeyAuth: []
|
|
38179
|
+
appKeyAuth: []
|
|
38180
|
+
- AuthZ:
|
|
38181
|
+
- workflows_read
|
|
38182
|
+
summary: List workflow instances
|
|
38183
|
+
tags:
|
|
38184
|
+
- Workflow Automation
|
|
38185
|
+
post:
|
|
38186
|
+
description: Execute the given workflow. This API requires an application key
|
|
38187
|
+
scoped with the workflows_run permission.
|
|
38188
|
+
operationId: CreateWorkflowInstance
|
|
38189
|
+
parameters:
|
|
38190
|
+
- $ref: '#/components/parameters/WorkflowId'
|
|
38191
|
+
requestBody:
|
|
38192
|
+
content:
|
|
38193
|
+
application/json:
|
|
38194
|
+
schema:
|
|
38195
|
+
$ref: '#/components/schemas/WorkflowInstanceCreateRequest'
|
|
38196
|
+
required: true
|
|
38197
|
+
responses:
|
|
38198
|
+
'200':
|
|
38199
|
+
content:
|
|
38200
|
+
application/json:
|
|
38201
|
+
schema:
|
|
38202
|
+
$ref: '#/components/schemas/WorkflowInstanceCreateResponse'
|
|
38203
|
+
description: Created
|
|
38204
|
+
'400':
|
|
38205
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
38206
|
+
'403':
|
|
38207
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
38208
|
+
'429':
|
|
38209
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
38210
|
+
summary: Execute a workflow
|
|
38211
|
+
tags:
|
|
38212
|
+
- Workflow Automation
|
|
38213
|
+
x-codegen-request-body-name: body
|
|
38214
|
+
/api/v2/workflows/{workflow_id}/instances/{instance_id}:
|
|
38215
|
+
get:
|
|
38216
|
+
description: Get a specific execution of a given workflow. This API requires
|
|
38217
|
+
an application key scoped with the workflows_read permission.
|
|
38218
|
+
operationId: GetWorkflowInstance
|
|
38219
|
+
parameters:
|
|
38220
|
+
- $ref: '#/components/parameters/WorkflowId'
|
|
38221
|
+
- $ref: '#/components/parameters/InstanceId'
|
|
38222
|
+
responses:
|
|
38223
|
+
'200':
|
|
38224
|
+
content:
|
|
38225
|
+
application/json:
|
|
38226
|
+
schema:
|
|
38227
|
+
$ref: '#/components/schemas/WorklflowGetInstanceResponse'
|
|
38228
|
+
description: OK
|
|
38229
|
+
'400':
|
|
38230
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
38231
|
+
'403':
|
|
38232
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
38233
|
+
'404':
|
|
38234
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
38235
|
+
'429':
|
|
38236
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
38237
|
+
security:
|
|
38238
|
+
- apiKeyAuth: []
|
|
38239
|
+
appKeyAuth: []
|
|
38240
|
+
- AuthZ:
|
|
38241
|
+
- workflows_read
|
|
38242
|
+
summary: Get a workflow instance
|
|
38243
|
+
tags:
|
|
38244
|
+
- Workflow Automation
|
|
38245
|
+
/api/v2/workflows/{workflow_id}/instances/{instance_id}/cancel:
|
|
38246
|
+
put:
|
|
38247
|
+
description: Cancels a specific execution of a given workflow. This API requires
|
|
38248
|
+
an application key scoped with the workflows_run permission.
|
|
38249
|
+
operationId: CancelWorkflowInstance
|
|
38250
|
+
parameters:
|
|
38251
|
+
- $ref: '#/components/parameters/WorkflowId'
|
|
38252
|
+
- $ref: '#/components/parameters/InstanceId'
|
|
38253
|
+
responses:
|
|
38254
|
+
'200':
|
|
38255
|
+
content:
|
|
38256
|
+
application/json:
|
|
38257
|
+
schema:
|
|
38258
|
+
$ref: '#/components/schemas/WorklflowCancelInstanceResponse'
|
|
38259
|
+
description: OK
|
|
38260
|
+
'400':
|
|
38261
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
38262
|
+
'403':
|
|
38263
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
38264
|
+
'404':
|
|
38265
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
38266
|
+
'429':
|
|
38267
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
38268
|
+
summary: Cancel a workflow instance
|
|
38269
|
+
tags:
|
|
38270
|
+
- Workflow Automation
|
|
36841
38271
|
security:
|
|
36842
38272
|
- apiKeyAuth: []
|
|
36843
38273
|
appKeyAuth: []
|
|
@@ -37059,6 +38489,10 @@ tags:
|
|
|
37059
38489
|
description: Find out more at
|
|
37060
38490
|
url: https://docs.datadoghq.com/monitors/create/types/
|
|
37061
38491
|
name: Monitors
|
|
38492
|
+
- description: The Network Device Monitoring API allows you to fetch devices and interfaces
|
|
38493
|
+
and their attributes. See the [Network Device Monitoring page](https://docs.datadoghq.com/network_monitoring/)
|
|
38494
|
+
for more information.
|
|
38495
|
+
name: Network Device Monitoring
|
|
37062
38496
|
- description: Configure your [Datadog Okta integration](https://docs.datadoghq.com/integrations/okta/)
|
|
37063
38497
|
directly through the Datadog API.
|
|
37064
38498
|
name: Okta Integration
|
|
@@ -37154,8 +38588,8 @@ tags:
|
|
|
37154
38588
|
|
|
37155
38589
|
and improve communication with internal and external users.'
|
|
37156
38590
|
name: Service Level Objectives
|
|
37157
|
-
- description: 'API to create
|
|
37158
|
-
for more information.
|
|
38591
|
+
- description: 'API to create and update scorecard rules and outcomes. See [Service
|
|
38592
|
+
Scorecards](https://docs.datadoghq.com/service_catalog/scorecards) for more information.
|
|
37159
38593
|
|
|
37160
38594
|
|
|
37161
38595
|
This feature is currently in BETA. If you have any feedback, contact [Datadog
|
|
@@ -37205,4 +38639,9 @@ tags:
|
|
|
37205
38639
|
externalDocs:
|
|
37206
38640
|
url: https://docs.datadoghq.com/account_management/users
|
|
37207
38641
|
name: Users
|
|
38642
|
+
- description: Automate your teams operational processes with Datadog Workflow Automation.
|
|
38643
|
+
externalDocs:
|
|
38644
|
+
description: Find out more at
|
|
38645
|
+
url: https://docs.datadoghq.com/service_management/workflows/
|
|
38646
|
+
name: Workflow Automation
|
|
37208
38647
|
x-group-parameters: true
|