datadog_api_client 1.11.0 → 2.0.2
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 +2 -1
- data/.generator/schemas/v1/openapi.yaml +293 -116
- data/.generator/schemas/v2/openapi.yaml +1156 -41
- data/.generator/src/generator/cli.py +57 -40
- data/.generator/src/generator/openapi.py +12 -6
- data/.generator/src/generator/templates/api.j2 +14 -13
- data/.generator/src/generator/templates/api_client.j2 +63 -11
- data/.generator/src/generator/templates/configuration.j2 +12 -8
- data/.generator/src/generator/templates/example.j2 +6 -1
- data/.generator/src/generator/templates/inflector.j2 +28 -0
- data/.generator/src/generator/templates/model_base.j2 +2 -2
- data/.generator/src/generator/templates/model_oneof.j2 +1 -1
- data/.generator/src/generator/templates/package.j2 +7 -12
- data/.github/workflows/approved_status.yml +0 -2
- data/.github/workflows/codeql-analysis.yml +49 -0
- data/.github/workflows/docs.yml +1 -1
- data/.github/workflows/prepare_release.yml +1 -1
- data/.github/workflows/publish.yml +1 -1
- data/.github/workflows/release.yml +1 -1
- data/.github/workflows/test.yml +4 -6
- data/.github/workflows/test_integration.yml +1 -1
- data/.pre-commit-config.yaml +3 -12
- data/CHANGELOG.md +44 -0
- data/Gemfile +1 -0
- data/Makefile +1 -2
- data/README.md +13 -13
- data/datadog_api_client.gemspec +2 -0
- data/examples/v1/downtimes/CreateDowntime_1393233946.rb +3 -0
- data/examples/v1/downtimes/CreateDowntime_2908359488.rb +3 -0
- data/examples/v1/downtimes/CreateDowntime_3059354445.rb +3 -0
- data/examples/v1/events/ListEvents.rb +1 -1
- data/examples/v1/pagerduty-integration/DeletePagerDutyIntegrationService.rb +2 -2
- data/examples/v1/service-level-objectives/GetSLOHistory.rb +1 -1
- data/examples/v1/service-level-objectives/SearchSLO.rb +1 -1
- data/examples/v1/synthetics/CreateSyntheticsBrowserTest_2932742688.rb +1 -1
- data/examples/v1/synthetics/GetAPITestLatestResults.rb +1 -1
- data/examples/v1/synthetics/GetAPITestResult.rb +1 -1
- data/examples/v1/synthetics/GetBrowserTestLatestResults.rb +1 -1
- data/examples/v1/synthetics/GetBrowserTestResult.rb +1 -1
- data/examples/v1/usage-metering/GetDailyCustomReports.rb +1 -1
- data/examples/v1/usage-metering/GetHourlyUsageAttribution.rb +0 -3
- data/examples/v1/usage-metering/GetMonthlyCustomReports.rb +1 -1
- data/examples/v1/usage-metering/GetMonthlyUsageAttribution.rb +0 -3
- data/examples/v1/usage-metering/GetSpecifiedDailyCustomReports.rb +1 -1
- data/examples/v1/usage-metering/GetSpecifiedMonthlyCustomReports.rb +1 -1
- data/examples/v1/usage-metering/GetUsageAttribution.rb +1 -1
- data/examples/v1/usage-metering/GetUsageCIApp.rb +2 -5
- data/examples/v1/usage-metering/GetUsageCIApp_1064440884.rb +8 -0
- data/examples/v1/usage-metering/GetUsageCWS.rb +2 -5
- data/examples/v1/usage-metering/GetUsageCWS_736958514.rb +8 -0
- data/examples/v1/usage-metering/GetUsageDBM.rb +2 -5
- data/examples/v1/usage-metering/GetUsageDBM_3446806203.rb +8 -0
- data/examples/v1/usage-metering/GetUsageLambda.rb +2 -5
- data/examples/v1/usage-metering/GetUsageLambda_3132428705.rb +8 -0
- data/examples/v1/usage-metering/GetUsageLogs.rb +2 -5
- data/examples/v1/usage-metering/GetUsageLogsByIndex.rb +2 -5
- data/examples/v1/usage-metering/GetUsageLogsByIndex_1025184776.rb +8 -0
- data/examples/v1/usage-metering/GetUsageLogs_2562396405.rb +8 -0
- data/examples/v1/usage-metering/GetUsageNetworkFlows.rb +2 -5
- data/examples/v1/usage-metering/GetUsageNetworkFlows_1239422069.rb +8 -0
- data/examples/v1/usage-metering/GetUsageNetworkHosts.rb +2 -5
- data/examples/v1/usage-metering/GetUsageNetworkHosts_1249907835.rb +8 -0
- data/examples/v1/usage-metering/GetUsageOnlineArchive.rb +2 -5
- data/examples/v1/usage-metering/GetUsageOnlineArchive_1501172903.rb +8 -0
- data/examples/v1/usage-metering/GetUsageRumSessions.rb +2 -5
- data/examples/v1/usage-metering/GetUsageRumSessions_714937291.rb +8 -0
- data/examples/v1/usage-metering/GetUsageRumUnits.rb +2 -5
- data/examples/v1/usage-metering/GetUsageRumUnits_3959755399.rb +8 -0
- data/examples/v1/usage-metering/GetUsageSDS.rb +2 -5
- data/examples/v1/usage-metering/GetUsageSDS_271128478.rb +8 -0
- data/examples/v1/usage-metering/GetUsageSynthetics.rb +1 -1
- data/examples/v1/usage-metering/GetUsageSyntheticsAPI.rb +2 -5
- data/examples/v1/usage-metering/GetUsageSyntheticsAPI_4048033529.rb +8 -0
- data/examples/v1/usage-metering/GetUsageSyntheticsBrowser.rb +2 -5
- data/examples/v1/usage-metering/GetUsageSyntheticsBrowser_1704663299.rb +8 -0
- data/examples/v2/audit/ListAuditLogs_1275402458.rb +8 -0
- data/examples/v2/audit/SearchAuditLogs_3215529662.rb +22 -0
- data/examples/v2/events/ListEvents.rb +8 -0
- data/examples/v2/events/ListEvents_1527584014.rb +13 -0
- data/examples/v2/events/ListEvents_2663715109.rb +14 -0
- data/examples/v2/events/SearchEvents.rb +23 -0
- data/examples/v2/events/SearchEvents_3856995058.rb +25 -0
- data/examples/v2/incident-services/CreateIncidentService.rb +1 -1
- data/examples/v2/incident-services/DeleteIncidentService.rb +1 -1
- data/examples/v2/incident-services/GetIncidentService.rb +1 -1
- data/examples/v2/incident-services/ListIncidentServices.rb +1 -1
- data/examples/v2/incident-services/UpdateIncidentService.rb +1 -1
- data/examples/v2/incident-teams/CreateIncidentTeam.rb +1 -1
- data/examples/v2/incident-teams/DeleteIncidentTeam.rb +1 -1
- data/examples/v2/incident-teams/GetIncidentTeam.rb +1 -1
- data/examples/v2/incident-teams/ListIncidentTeams.rb +1 -1
- data/examples/v2/incident-teams/UpdateIncidentTeam.rb +1 -1
- data/examples/v2/incidents/CreateIncident.rb +1 -1
- data/examples/v2/incidents/DeleteIncident.rb +1 -1
- data/examples/v2/incidents/GetIncident.rb +1 -1
- data/examples/v2/incidents/ListIncidents.rb +1 -1
- data/examples/v2/incidents/ListIncidents_2665616954.rb +11 -0
- data/examples/v2/incidents/UpdateIncident.rb +1 -1
- data/examples/v2/incidents/UpdateIncident_1009194038.rb +1 -1
- data/examples/v2/incidents/UpdateIncident_3369341440.rb +1 -1
- data/examples/v2/logs/ListLogsGet_738202670.rb +8 -0
- data/examples/v2/logs/ListLogs_3138392594.rb +25 -0
- data/examples/v2/metrics/SubmitMetrics.rb +6 -0
- data/examples/v2/processes/ListProcesses_797840471.rb +8 -0
- data/examples/v2/rum/ListRUMEvents_2680821282.rb +8 -0
- data/examples/v2/rum/SearchRUMEvents_574690310.rb +21 -0
- data/examples/v2/security-monitoring/EditSecurityMonitoringSignalAssignee.rb +15 -0
- data/examples/v2/security-monitoring/EditSecurityMonitoringSignalIncidents.rb +15 -0
- data/examples/v2/security-monitoring/EditSecurityMonitoringSignalState.rb +14 -0
- data/examples/v2/security-monitoring/ListSecurityMonitoringSignals_3960412991.rb +8 -0
- data/examples/v2/security-monitoring/SearchSecurityMonitoringSignals_1309350146.rb +20 -0
- data/examples/v2/security-monitoring/UpdateSecurityMonitoringRule.rb +1 -0
- data/examples/v2/usage-metering/GetEstimatedCostByOrg.rb +5 -2
- data/examples/v2/usage-metering/GetEstimatedCostByOrg_2734954020.rb +11 -0
- data/examples/v2/usage-metering/GetEstimatedCostByOrg_3186693804.rb +11 -0
- data/examples/v2/usage-metering/GetUsageApplicationSecurityMonitoring.rb +2 -5
- data/examples/v2/usage-metering/GetUsageApplicationSecurityMonitoring_3959166796.rb +8 -0
- data/examples/v2/usage-metering/GetUsageLambdaTracedInvocations.rb +2 -5
- data/examples/v2/usage-metering/GetUsageLambdaTracedInvocations_1436752065.rb +8 -0
- data/examples/v2/usage-metering/GetUsageObservabilityPipelines.rb +2 -5
- data/examples/v2/usage-metering/GetUsageObservabilityPipelines_970725512.rb +8 -0
- data/lib/datadog_api_client/{v2/api_client.rb → api_client.rb} +63 -11
- data/lib/datadog_api_client/api_key_configuration.rb +1 -18
- data/lib/datadog_api_client/{v1/configuration.rb → configuration.rb} +84 -31
- data/lib/datadog_api_client/inflector.rb +1293 -0
- data/lib/datadog_api_client/models.rb +66 -0
- data/lib/datadog_api_client/v1/api/authentication_api.rb +3 -11
- data/lib/datadog_api_client/v1/api/aws_integration_api.rb +19 -91
- data/lib/datadog_api_client/v1/api/aws_logs_integration_api.rb +15 -71
- data/lib/datadog_api_client/v1/api/azure_integration_api.rb +11 -51
- data/lib/datadog_api_client/v1/api/dashboard_lists_api.rb +11 -51
- data/lib/datadog_api_client/v1/api/dashboards_api.rb +15 -71
- data/lib/datadog_api_client/v1/api/downtimes_api.rb +15 -71
- data/lib/datadog_api_client/v1/api/events_api.rb +9 -33
- data/lib/datadog_api_client/v1/api/gcp_integration_api.rb +9 -41
- data/lib/datadog_api_client/v1/api/hosts_api.rb +9 -41
- data/lib/datadog_api_client/v1/api/ip_ranges_api.rb +3 -11
- data/lib/datadog_api_client/v1/api/key_management_api.rb +21 -101
- data/lib/datadog_api_client/v1/api/logs_api.rb +5 -21
- data/lib/datadog_api_client/v1/api/logs_indexes_api.rb +13 -61
- data/lib/datadog_api_client/v1/api/logs_pipelines_api.rb +15 -71
- data/lib/datadog_api_client/v1/api/metrics_api.rb +15 -71
- data/lib/datadog_api_client/v1/api/monitors_api.rb +21 -101
- data/lib/datadog_api_client/v1/api/notebooks_api.rb +11 -51
- data/lib/datadog_api_client/v1/api/organizations_api.rb +13 -61
- data/lib/datadog_api_client/v1/api/pager_duty_integration_api.rb +9 -41
- data/lib/datadog_api_client/v1/api/security_monitoring_api.rb +8 -32
- data/lib/datadog_api_client/v1/api/service_checks_api.rb +3 -11
- data/lib/datadog_api_client/v1/api/service_level_objective_corrections_api.rb +11 -51
- data/lib/datadog_api_client/v1/api/service_level_objectives_api.rb +31 -99
- data/lib/datadog_api_client/v1/api/slack_integration_api.rb +11 -51
- data/lib/datadog_api_client/v1/api/snapshots_api.rb +3 -11
- data/lib/datadog_api_client/v1/api/synthetics_api.rb +55 -271
- data/lib/datadog_api_client/v1/api/tags_api.rb +11 -51
- data/lib/datadog_api_client/v1/api/usage_metering_api.rb +171 -418
- data/lib/datadog_api_client/v1/api/users_api.rb +11 -51
- data/lib/datadog_api_client/v1/api/webhooks_integration_api.rb +17 -81
- data/lib/datadog_api_client/v1/model_base.rb +2 -2
- data/lib/datadog_api_client/v1/models/distribution_point_item.rb +1 -1
- data/lib/datadog_api_client/v1/models/distribution_widget_histogram_request_query.rb +1 -1
- data/lib/datadog_api_client/v1/models/formula_and_function_query_definition.rb +1 -1
- data/lib/datadog_api_client/v1/models/hourly_usage_attribution_body.rb +5 -1
- data/lib/datadog_api_client/v1/models/hourly_usage_attribution_usage_type.rb +7 -0
- data/lib/datadog_api_client/v1/models/logs_processor.rb +1 -1
- data/lib/datadog_api_client/v1/models/monitor_formula_and_function_query_definition.rb +1 -1
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_body.rb +6 -2
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_supported_metrics.rb +14 -0
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_values.rb +21 -1
- data/lib/datadog_api_client/v1/models/notebook_cell_create_request_attributes.rb +1 -1
- data/lib/datadog_api_client/v1/models/notebook_cell_response_attributes.rb +1 -1
- data/lib/datadog_api_client/v1/models/notebook_cell_time.rb +1 -1
- data/lib/datadog_api_client/v1/models/notebook_cell_update_request_attributes.rb +1 -1
- data/lib/datadog_api_client/v1/models/notebook_global_time.rb +1 -1
- data/lib/datadog_api_client/v1/models/notebook_update_cell.rb +1 -1
- data/lib/datadog_api_client/v1/models/sunburst_widget_legend.rb +1 -1
- data/lib/datadog_api_client/v1/models/synthetics_assertion.rb +1 -1
- data/lib/datadog_api_client/v1/models/synthetics_basic_auth.rb +1 -1
- data/lib/datadog_api_client/v1/models/tree_map_color_by.rb +1 -1
- data/lib/datadog_api_client/v1/models/tree_map_group_by.rb +1 -1
- data/lib/datadog_api_client/v1/models/tree_map_size_by.rb +1 -1
- data/lib/datadog_api_client/v1/models/tree_map_widget_definition.rb +28 -6
- data/lib/datadog_api_client/v1/models/usage_attribution_body.rb +6 -2
- 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_attribution_values.rb +22 -2
- data/lib/datadog_api_client/v1/models/widget_definition.rb +1 -1
- data/lib/datadog_api_client/v2/api/audit_api.rb +11 -25
- data/lib/datadog_api_client/v2/api/authn_mappings_api.rb +11 -51
- data/lib/datadog_api_client/v2/api/cloud_workload_security_api.rb +13 -61
- data/lib/datadog_api_client/v2/api/dashboard_lists_api.rb +9 -41
- data/lib/datadog_api_client/v2/api/events_api.rb +228 -0
- data/lib/datadog_api_client/v2/api/incident_services_api.rb +36 -46
- data/lib/datadog_api_client/v2/api/incident_teams_api.rb +36 -46
- data/lib/datadog_api_client/v2/api/incidents_api.rb +39 -48
- data/lib/datadog_api_client/v2/api/key_management_api.rb +29 -141
- data/lib/datadog_api_client/v2/api/logs_api.rb +15 -45
- data/lib/datadog_api_client/v2/api/logs_archives_api.rb +21 -101
- data/lib/datadog_api_client/v2/api/logs_metrics_api.rb +11 -51
- data/lib/datadog_api_client/v2/api/metrics_api.rb +26 -112
- data/lib/datadog_api_client/v2/api/opsgenie_integration_api.rb +11 -51
- data/lib/datadog_api_client/v2/api/organizations_api.rb +3 -11
- data/lib/datadog_api_client/v2/api/processes_api.rb +6 -13
- data/lib/datadog_api_client/v2/api/roles_api.rb +27 -131
- data/lib/datadog_api_client/v2/api/rum_api.rb +13 -35
- data/lib/datadog_api_client/v2/api/security_monitoring_api.rb +247 -125
- data/lib/datadog_api_client/v2/api/service_accounts_api.rb +11 -51
- data/lib/datadog_api_client/v2/api/usage_metering_api.rb +132 -68
- data/lib/datadog_api_client/v2/api/users_api.rb +21 -101
- data/lib/datadog_api_client/v2/model_base.rb +2 -2
- data/lib/datadog_api_client/v2/models/api_key_response_included_item.rb +1 -1
- data/lib/datadog_api_client/v2/models/application_key_response_included_item.rb +1 -1
- data/lib/datadog_api_client/v2/models/authn_mapping_included.rb +1 -1
- data/lib/datadog_api_client/v2/models/event.rb +141 -0
- data/lib/datadog_api_client/v2/models/event_attributes.rb +305 -0
- data/lib/datadog_api_client/v2/models/event_priority.rb +27 -0
- data/lib/datadog_api_client/v2/models/event_response.rb +133 -0
- data/lib/datadog_api_client/v2/models/event_response_attributes.rb +133 -0
- data/lib/datadog_api_client/v2/models/event_status_type.rb +35 -0
- data/lib/datadog_api_client/v2/models/event_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/events_list_request.rb +142 -0
- data/lib/datadog_api_client/v2/models/events_list_response.rb +133 -0
- data/lib/datadog_api_client/v2/models/events_list_response_links.rb +112 -0
- data/lib/datadog_api_client/v2/models/events_query_filter.rb +137 -0
- data/lib/datadog_api_client/v2/models/events_query_options.rb +124 -0
- data/lib/datadog_api_client/v2/models/events_request_page.rb +134 -0
- data/lib/datadog_api_client/v2/models/events_response_metadata.rb +144 -0
- data/lib/datadog_api_client/v2/models/events_response_metadata_page.rb +112 -0
- data/lib/datadog_api_client/v2/models/events_sort.rb +27 -0
- data/lib/datadog_api_client/v2/models/events_warning.rb +131 -0
- data/lib/datadog_api_client/v2/models/hourly_usage.rb +133 -0
- data/lib/datadog_api_client/v2/models/hourly_usage_attributes.rb +163 -0
- data/lib/datadog_api_client/v2/models/hourly_usage_measurement.rb +122 -0
- data/lib/datadog_api_client/v2/models/hourly_usage_metadata.rb +111 -0
- data/lib/datadog_api_client/v2/models/hourly_usage_pagination.rb +112 -0
- data/lib/datadog_api_client/v2/models/hourly_usage_response.rb +123 -0
- data/lib/datadog_api_client/v2/models/incident_field_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/incident_response_included_item.rb +1 -1
- data/lib/datadog_api_client/v2/models/incident_service_included_items.rb +1 -1
- data/lib/datadog_api_client/v2/models/incident_team_included_items.rb +1 -1
- data/lib/datadog_api_client/v2/models/incident_timeline_cell_create_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/logs_aggregate_bucket_value.rb +1 -1
- data/lib/datadog_api_client/v2/models/logs_archive_create_request_destination.rb +1 -1
- data/lib/datadog_api_client/v2/models/logs_archive_destination.rb +1 -1
- data/lib/datadog_api_client/v2/models/logs_group_by_missing.rb +1 -1
- data/lib/datadog_api_client/v2/models/logs_group_by_total.rb +1 -1
- data/lib/datadog_api_client/v2/models/metric_intake_type.rb +1 -2
- data/lib/datadog_api_client/v2/models/metric_resource.rb +2 -2
- data/lib/datadog_api_client/v2/models/metric_series.rb +1 -1
- data/lib/datadog_api_client/v2/models/metric_volumes.rb +1 -1
- data/lib/datadog_api_client/v2/models/metrics_and_metric_tag_configurations.rb +1 -1
- data/lib/datadog_api_client/v2/models/monitor_type.rb +215 -0
- data/lib/datadog_api_client/v2/models/rum_aggregate_bucket_value.rb +1 -1
- data/lib/datadog_api_client/v2/models/rum_group_by_missing.rb +1 -1
- data/lib/datadog_api_client/v2/models/rum_group_by_total.rb +1 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_query.rb +13 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_query_create.rb +13 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_archive_reason.rb +29 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_assignee_update_attributes.rb +132 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_assignee_update_data.rb +122 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_assignee_update_request.rb +122 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_incidents_update_attributes.rb +134 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_incidents_update_data.rb +122 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_incidents_update_request.rb +122 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_state.rb +28 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_state_update_attributes.rb +152 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_state_update_data.rb +122 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_state_update_request.rb +122 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_triage_attributes.rb +248 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_triage_update_data.rb +111 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_triage_update_response.rb +122 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_triage_user.rb +152 -0
- data/lib/datadog_api_client/v2/models/user_response_included_item.rb +1 -1
- data/lib/datadog_api_client/version.rb +1 -1
- data/lib/datadog_api_client.rb +13 -5
- data/spec/{v1/api_client_spec.rb → api_client_spec.rb} +29 -29
- data/spec/{v1/configuration_spec.rb → configuration_spec.rb} +3 -3
- data/spec/spec_helper.rb +1 -3
- metadata +109 -22
- data/.dockerignore +0 -1
- data/.generator/src/generator/templates/api_error.j2 +0 -49
- data/examples/v2/usage-metering/GetEstimatedCostByOrg_1171921972.rb +0 -9
- data/examples/v2/usage-metering/GetEstimatedCostByOrg_627383212.rb +0 -9
- data/lib/datadog_api_client/v1/api_client.rb +0 -453
- data/lib/datadog_api_client/v1/api_error.rb +0 -60
- data/lib/datadog_api_client/v1.rb +0 -813
- data/lib/datadog_api_client/v2/api_error.rb +0 -60
- data/lib/datadog_api_client/v2/configuration.rb +0 -420
- data/lib/datadog_api_client/v2.rb +0 -555
- data/spec/v2/api_client_spec.rb +0 -210
- data/spec/v2/configuration_spec.rb +0 -45
@@ -290,6 +290,13 @@ components:
|
|
290
290
|
schema:
|
291
291
|
example: 00000000-0000-1234-0000-000000000000
|
292
292
|
type: string
|
293
|
+
SignalID:
|
294
|
+
description: The ID of the signal.
|
295
|
+
in: path
|
296
|
+
name: signal_id
|
297
|
+
required: true
|
298
|
+
schema:
|
299
|
+
type: string
|
293
300
|
UserID:
|
294
301
|
description: The ID of the user.
|
295
302
|
in: path
|
@@ -1503,6 +1510,340 @@ components:
|
|
1503
1510
|
- INTEGRATION_SCREENBOARD
|
1504
1511
|
- INTEGRATION_TIMEBOARD
|
1505
1512
|
- HOST_TIMEBOARD
|
1513
|
+
Event:
|
1514
|
+
description: The metadata associated with a request.
|
1515
|
+
properties:
|
1516
|
+
id:
|
1517
|
+
description: Event ID.
|
1518
|
+
example: '6509751066204996294'
|
1519
|
+
type: string
|
1520
|
+
name:
|
1521
|
+
description: The event name.
|
1522
|
+
type: string
|
1523
|
+
source_id:
|
1524
|
+
description: Event source ID.
|
1525
|
+
example: 36
|
1526
|
+
type: integer
|
1527
|
+
type:
|
1528
|
+
description: Event type.
|
1529
|
+
example: error_tracking_alert
|
1530
|
+
type: string
|
1531
|
+
type: object
|
1532
|
+
EventAttributes:
|
1533
|
+
description: Object description of attributes from your event.
|
1534
|
+
properties:
|
1535
|
+
aggregation_key:
|
1536
|
+
description: Aggregation key of the event.
|
1537
|
+
type: string
|
1538
|
+
date_happened:
|
1539
|
+
description: 'POSIX timestamp of the event. Must be sent as an integer (no
|
1540
|
+
quotation marks).
|
1541
|
+
|
1542
|
+
Limited to events no older than 18 hours.'
|
1543
|
+
format: int64
|
1544
|
+
type: integer
|
1545
|
+
device_name:
|
1546
|
+
description: A device name.
|
1547
|
+
type: string
|
1548
|
+
duration:
|
1549
|
+
description: The duration between the triggering of the event and its recovery
|
1550
|
+
in nanoseconds.
|
1551
|
+
format: int64
|
1552
|
+
type: integer
|
1553
|
+
event_object:
|
1554
|
+
description: The event title.
|
1555
|
+
example: Did you hear the news today?
|
1556
|
+
type: string
|
1557
|
+
evt:
|
1558
|
+
$ref: '#/components/schemas/Event'
|
1559
|
+
hostname:
|
1560
|
+
description: 'Host name to associate with the event.
|
1561
|
+
|
1562
|
+
Any tags associated with the host are also applied to this event.'
|
1563
|
+
type: string
|
1564
|
+
monitor:
|
1565
|
+
$ref: '#/components/schemas/MonitorType'
|
1566
|
+
monitor_groups:
|
1567
|
+
description: List of groups referred to in the event.
|
1568
|
+
items:
|
1569
|
+
description: Group referred to in the event.
|
1570
|
+
type: string
|
1571
|
+
nullable: true
|
1572
|
+
type: array
|
1573
|
+
monitor_id:
|
1574
|
+
description: ID of the monitor that triggered the event. When an event isn't
|
1575
|
+
related to a monitor, this field is empty.
|
1576
|
+
nullable: true
|
1577
|
+
type: integer
|
1578
|
+
priority:
|
1579
|
+
$ref: '#/components/schemas/EventPriority'
|
1580
|
+
related_event_id:
|
1581
|
+
description: Related event ID.
|
1582
|
+
type: integer
|
1583
|
+
service:
|
1584
|
+
description: Service that triggered the event.
|
1585
|
+
example: datadog-api
|
1586
|
+
type: string
|
1587
|
+
source_type_name:
|
1588
|
+
description: 'The type of event being posted.
|
1589
|
+
|
1590
|
+
For example, `nagios`, `hudson`, `jenkins`, `my_apps`, `chef`, `puppet`,
|
1591
|
+
`git` or `bitbucket`.
|
1592
|
+
|
1593
|
+
The list of standard source attribute values is [available here](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).'
|
1594
|
+
type: string
|
1595
|
+
sourcecategory:
|
1596
|
+
description: Identifier for the source of the event, such as a monitor alert,
|
1597
|
+
an externally-submitted event, or an integration.
|
1598
|
+
type: string
|
1599
|
+
status:
|
1600
|
+
$ref: '#/components/schemas/EventStatusType'
|
1601
|
+
tags:
|
1602
|
+
description: A list of tags to apply to the event.
|
1603
|
+
example:
|
1604
|
+
- environment:test
|
1605
|
+
items:
|
1606
|
+
description: A tag.
|
1607
|
+
type: string
|
1608
|
+
type: array
|
1609
|
+
timestamp:
|
1610
|
+
description: POSIX timestamp of your event in milliseconds.
|
1611
|
+
example: 1652274265000
|
1612
|
+
format: int64
|
1613
|
+
type: integer
|
1614
|
+
title:
|
1615
|
+
description: The event title.
|
1616
|
+
example: Oh boy!
|
1617
|
+
type: string
|
1618
|
+
type: object
|
1619
|
+
EventPriority:
|
1620
|
+
description: The priority of the event's monitor. For example, `normal` or `low`.
|
1621
|
+
enum:
|
1622
|
+
- normal
|
1623
|
+
- low
|
1624
|
+
example: normal
|
1625
|
+
nullable: true
|
1626
|
+
type: string
|
1627
|
+
x-enum-varnames:
|
1628
|
+
- NORMAL
|
1629
|
+
- LOW
|
1630
|
+
EventResponse:
|
1631
|
+
description: The object description of an event after being processed and stored
|
1632
|
+
by Datadog.
|
1633
|
+
properties:
|
1634
|
+
attributes:
|
1635
|
+
$ref: '#/components/schemas/EventResponseAttributes'
|
1636
|
+
id:
|
1637
|
+
description: the unique ID of the event.
|
1638
|
+
example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA
|
1639
|
+
type: string
|
1640
|
+
type:
|
1641
|
+
$ref: '#/components/schemas/EventType'
|
1642
|
+
type: object
|
1643
|
+
EventResponseAttributes:
|
1644
|
+
description: The object description of an event response attribute.
|
1645
|
+
properties:
|
1646
|
+
attributes:
|
1647
|
+
$ref: '#/components/schemas/EventAttributes'
|
1648
|
+
tags:
|
1649
|
+
description: An array of tags associated with the event.
|
1650
|
+
example:
|
1651
|
+
- team:A
|
1652
|
+
items:
|
1653
|
+
description: The tag associated with the event.
|
1654
|
+
type: string
|
1655
|
+
type: array
|
1656
|
+
timestamp:
|
1657
|
+
description: The timestamp of the event.
|
1658
|
+
example: '2019-01-02T09:42:36.320Z'
|
1659
|
+
format: date-time
|
1660
|
+
type: string
|
1661
|
+
type: object
|
1662
|
+
EventStatusType:
|
1663
|
+
description: 'If an alert event is enabled, its status is one of the following:
|
1664
|
+
|
1665
|
+
`failure`, `error`, `warning`, `info`, `success`, `user_update`,
|
1666
|
+
|
1667
|
+
`recommendation`, or `snapshot`.'
|
1668
|
+
enum:
|
1669
|
+
- failure
|
1670
|
+
- error
|
1671
|
+
- warning
|
1672
|
+
- info
|
1673
|
+
- success
|
1674
|
+
- user_update
|
1675
|
+
- recommendation
|
1676
|
+
- snapshot
|
1677
|
+
example: info
|
1678
|
+
type: string
|
1679
|
+
x-enum-varnames:
|
1680
|
+
- FAILURE
|
1681
|
+
- ERROR
|
1682
|
+
- WARNING
|
1683
|
+
- INFO
|
1684
|
+
- SUCCESS
|
1685
|
+
- USER_UPDATE
|
1686
|
+
- RECOMMENDATION
|
1687
|
+
- SNAPSHOT
|
1688
|
+
EventType:
|
1689
|
+
default: event
|
1690
|
+
description: Type of the event.
|
1691
|
+
enum:
|
1692
|
+
- event
|
1693
|
+
example: event
|
1694
|
+
type: string
|
1695
|
+
x-enum-varnames:
|
1696
|
+
- EVENT
|
1697
|
+
EventsListRequest:
|
1698
|
+
description: The object sent with the request to retrieve a list of events from
|
1699
|
+
your organization.
|
1700
|
+
properties:
|
1701
|
+
filter:
|
1702
|
+
$ref: '#/components/schemas/EventsQueryFilter'
|
1703
|
+
options:
|
1704
|
+
$ref: '#/components/schemas/EventsQueryOptions'
|
1705
|
+
page:
|
1706
|
+
$ref: '#/components/schemas/EventsRequestPage'
|
1707
|
+
sort:
|
1708
|
+
$ref: '#/components/schemas/EventsSort'
|
1709
|
+
type: object
|
1710
|
+
EventsListResponse:
|
1711
|
+
description: The response object with all events matching the request and pagination
|
1712
|
+
information.
|
1713
|
+
properties:
|
1714
|
+
data:
|
1715
|
+
description: An array of events matching the request.
|
1716
|
+
items:
|
1717
|
+
$ref: '#/components/schemas/EventResponse'
|
1718
|
+
type: array
|
1719
|
+
links:
|
1720
|
+
$ref: '#/components/schemas/EventsListResponseLinks'
|
1721
|
+
meta:
|
1722
|
+
$ref: '#/components/schemas/EventsResponseMetadata'
|
1723
|
+
type: object
|
1724
|
+
EventsListResponseLinks:
|
1725
|
+
description: Links attributes.
|
1726
|
+
properties:
|
1727
|
+
next:
|
1728
|
+
description: 'Link for the next set of results. Note that the request can
|
1729
|
+
also be made using the
|
1730
|
+
|
1731
|
+
POST endpoint.'
|
1732
|
+
example: https://app.datadoghq.com/api/v2/events?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
1733
|
+
type: string
|
1734
|
+
type: object
|
1735
|
+
EventsQueryFilter:
|
1736
|
+
description: The search and filter query settings.
|
1737
|
+
properties:
|
1738
|
+
from:
|
1739
|
+
default: now-15m
|
1740
|
+
description: The minimum time for the requested events. Supports date math
|
1741
|
+
and regular timestamps in milliseconds.
|
1742
|
+
example: now-15m
|
1743
|
+
type: string
|
1744
|
+
query:
|
1745
|
+
default: '*'
|
1746
|
+
description: The search query following the event search syntax.
|
1747
|
+
example: service:web* AND @http.status_code:[200 TO 299]
|
1748
|
+
type: string
|
1749
|
+
to:
|
1750
|
+
default: now
|
1751
|
+
description: The maximum time for the requested events. Supports date math
|
1752
|
+
and regular timestamps in milliseconds.
|
1753
|
+
example: now
|
1754
|
+
type: string
|
1755
|
+
type: object
|
1756
|
+
EventsQueryOptions:
|
1757
|
+
description: 'The global query options that are used. Either provide a timezone
|
1758
|
+
or a time offset but not both,
|
1759
|
+
|
1760
|
+
otherwise the query fails.'
|
1761
|
+
properties:
|
1762
|
+
timeOffset:
|
1763
|
+
description: The time offset to apply to the query in seconds.
|
1764
|
+
format: int64
|
1765
|
+
type: integer
|
1766
|
+
timezone:
|
1767
|
+
default: UTC
|
1768
|
+
description: 'The timezone can be specified as an offset, for example: `UTC+03:00`.'
|
1769
|
+
example: GMT
|
1770
|
+
type: string
|
1771
|
+
type: object
|
1772
|
+
EventsRequestPage:
|
1773
|
+
description: Pagination settings.
|
1774
|
+
properties:
|
1775
|
+
cursor:
|
1776
|
+
description: The returned paging point to use to get the next results.
|
1777
|
+
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
1778
|
+
type: string
|
1779
|
+
limit:
|
1780
|
+
default: 10
|
1781
|
+
description: The maximum number of logs in the response.
|
1782
|
+
example: 25
|
1783
|
+
format: int32
|
1784
|
+
maximum: 1000
|
1785
|
+
type: integer
|
1786
|
+
type: object
|
1787
|
+
EventsResponseMetadata:
|
1788
|
+
description: The metadata associated with a request.
|
1789
|
+
properties:
|
1790
|
+
elapsed:
|
1791
|
+
description: The time elapsed in milliseconds.
|
1792
|
+
example: 132
|
1793
|
+
format: int64
|
1794
|
+
type: integer
|
1795
|
+
page:
|
1796
|
+
$ref: '#/components/schemas/EventsResponseMetadataPage'
|
1797
|
+
request_id:
|
1798
|
+
description: The identifier of the request.
|
1799
|
+
example: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR
|
1800
|
+
type: string
|
1801
|
+
warnings:
|
1802
|
+
description: 'A list of warnings (non-fatal errors) encountered. Partial
|
1803
|
+
results might be returned if
|
1804
|
+
|
1805
|
+
warnings are present in the response.'
|
1806
|
+
items:
|
1807
|
+
$ref: '#/components/schemas/EventsWarning'
|
1808
|
+
type: array
|
1809
|
+
type: object
|
1810
|
+
EventsResponseMetadataPage:
|
1811
|
+
description: Pagination attributes.
|
1812
|
+
properties:
|
1813
|
+
after:
|
1814
|
+
description: 'The cursor to use to get the next results, if any. To make
|
1815
|
+
the next request, use the same
|
1816
|
+
|
1817
|
+
parameters with the addition of the `page[cursor]`.'
|
1818
|
+
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
1819
|
+
type: string
|
1820
|
+
type: object
|
1821
|
+
EventsSort:
|
1822
|
+
description: The sort parameters when querying events.
|
1823
|
+
enum:
|
1824
|
+
- timestamp
|
1825
|
+
- -timestamp
|
1826
|
+
type: string
|
1827
|
+
x-enum-varnames:
|
1828
|
+
- TIMESTAMP_ASCENDING
|
1829
|
+
- TIMESTAMP_DESCENDING
|
1830
|
+
EventsWarning:
|
1831
|
+
description: A warning message indicating something is wrong with the query.
|
1832
|
+
properties:
|
1833
|
+
code:
|
1834
|
+
description: A unique code for this type of warning.
|
1835
|
+
example: unknown_index
|
1836
|
+
type: string
|
1837
|
+
detail:
|
1838
|
+
description: A detailed explanation of this specific warning.
|
1839
|
+
example: 'indexes: foo, bar'
|
1840
|
+
type: string
|
1841
|
+
title:
|
1842
|
+
description: A short human-readable summary of the warning.
|
1843
|
+
example: One or several indexes are missing or invalid. Results hold data
|
1844
|
+
from the other indexes.
|
1845
|
+
type: string
|
1846
|
+
type: object
|
1506
1847
|
FullAPIKey:
|
1507
1848
|
description: Datadog API key.
|
1508
1849
|
properties:
|
@@ -1676,6 +2017,84 @@ components:
|
|
1676
2017
|
required:
|
1677
2018
|
- message
|
1678
2019
|
type: object
|
2020
|
+
HourlyUsage:
|
2021
|
+
description: Hourly usage for a product family for an org.
|
2022
|
+
properties:
|
2023
|
+
attributes:
|
2024
|
+
$ref: '#/components/schemas/HourlyUsageAttributes'
|
2025
|
+
id:
|
2026
|
+
description: Unique ID of the response.
|
2027
|
+
type: string
|
2028
|
+
type:
|
2029
|
+
$ref: '#/components/schemas/UsageTimeSeriesType'
|
2030
|
+
type: object
|
2031
|
+
HourlyUsageAttributes:
|
2032
|
+
description: Attributes of hourly usage for a product family for an org for
|
2033
|
+
a time period.
|
2034
|
+
properties:
|
2035
|
+
measurements:
|
2036
|
+
description: List of the measured usage values for the product family for
|
2037
|
+
the org for the time period.
|
2038
|
+
items:
|
2039
|
+
$ref: '#/components/schemas/HourlyUsageMeasurement'
|
2040
|
+
type: array
|
2041
|
+
org_name:
|
2042
|
+
description: The organization name.
|
2043
|
+
type: string
|
2044
|
+
product_family:
|
2045
|
+
description: The product for which usage is being reported.
|
2046
|
+
type: string
|
2047
|
+
public_id:
|
2048
|
+
description: The organization public ID.
|
2049
|
+
type: string
|
2050
|
+
region:
|
2051
|
+
description: The region of the Datadog instance that the organization belongs
|
2052
|
+
to.
|
2053
|
+
type: string
|
2054
|
+
timestamp:
|
2055
|
+
description: Datetime in ISO-8601 format, UTC. The hour for the usage.
|
2056
|
+
format: date-time
|
2057
|
+
type: string
|
2058
|
+
type: object
|
2059
|
+
HourlyUsageMeasurement:
|
2060
|
+
description: Usage amount for a given usage type.
|
2061
|
+
properties:
|
2062
|
+
usage_type:
|
2063
|
+
description: Type of usage.
|
2064
|
+
type: string
|
2065
|
+
value:
|
2066
|
+
description: Contains the number measured for the given usage_type during
|
2067
|
+
the hour.
|
2068
|
+
format: int64
|
2069
|
+
nullable: true
|
2070
|
+
type: integer
|
2071
|
+
type: object
|
2072
|
+
HourlyUsageMetadata:
|
2073
|
+
description: The object containing document metadata.
|
2074
|
+
properties:
|
2075
|
+
pagination:
|
2076
|
+
$ref: '#/components/schemas/HourlyUsagePagination'
|
2077
|
+
type: object
|
2078
|
+
HourlyUsagePagination:
|
2079
|
+
description: The metadata for the current pagination.
|
2080
|
+
properties:
|
2081
|
+
next_record_id:
|
2082
|
+
description: The cursor to get the next results (if any). To make the next
|
2083
|
+
request, use the same parameters and add `next_record_id`.
|
2084
|
+
nullable: true
|
2085
|
+
type: string
|
2086
|
+
type: object
|
2087
|
+
HourlyUsageResponse:
|
2088
|
+
description: Hourly usage response.
|
2089
|
+
properties:
|
2090
|
+
data:
|
2091
|
+
description: Response containing hourly usage.
|
2092
|
+
items:
|
2093
|
+
$ref: '#/components/schemas/HourlyUsage'
|
2094
|
+
type: array
|
2095
|
+
meta:
|
2096
|
+
$ref: '#/components/schemas/HourlyUsageMetadata'
|
2097
|
+
type: object
|
1679
2098
|
HourlyUsageType:
|
1680
2099
|
description: Usage type that is being measured.
|
1681
2100
|
enum:
|
@@ -4110,13 +4529,13 @@ components:
|
|
4110
4529
|
x-enum-varnames:
|
4111
4530
|
- METRIC_VOLUMES
|
4112
4531
|
MetricIntakeType:
|
4113
|
-
description: The type of metric.
|
4532
|
+
description: The type of metric. The available types are `0` (unspecified),
|
4533
|
+
`1` (count), `2` (rate), and `3` (gauge).
|
4114
4534
|
enum:
|
4115
4535
|
- 0
|
4116
4536
|
- 1
|
4117
4537
|
- 2
|
4118
4538
|
- 3
|
4119
|
-
- 15
|
4120
4539
|
format: int32
|
4121
4540
|
type: integer
|
4122
4541
|
x-enum-varnames:
|
@@ -4124,7 +4543,6 @@ components:
|
|
4124
4543
|
- COUNT
|
4125
4544
|
- RATE
|
4126
4545
|
- GAUGE
|
4127
|
-
- UNSPECIFIED_LEGACY
|
4128
4546
|
MetricMetadata:
|
4129
4547
|
description: Metadata for the metric.
|
4130
4548
|
properties:
|
@@ -4167,6 +4585,9 @@ components:
|
|
4167
4585
|
points:
|
4168
4586
|
- timestamp: 1475317847
|
4169
4587
|
value: 0.7
|
4588
|
+
resources:
|
4589
|
+
- name: dummyhost
|
4590
|
+
type: host
|
4170
4591
|
items:
|
4171
4592
|
$ref: '#/components/schemas/MetricSeries'
|
4172
4593
|
type: array
|
@@ -4194,12 +4615,15 @@ components:
|
|
4194
4615
|
type: object
|
4195
4616
|
MetricResource:
|
4196
4617
|
description: Metric resource.
|
4618
|
+
example:
|
4619
|
+
name: dummyhost
|
4620
|
+
type: host
|
4197
4621
|
properties:
|
4198
4622
|
name:
|
4199
|
-
description: The name of the
|
4623
|
+
description: The name of the resource.
|
4200
4624
|
type: string
|
4201
4625
|
type:
|
4202
|
-
description: The type of
|
4626
|
+
description: The type of the resource.
|
4203
4627
|
type: string
|
4204
4628
|
type: object
|
4205
4629
|
MetricSeries:
|
@@ -4495,6 +4919,54 @@ components:
|
|
4495
4919
|
type: array
|
4496
4920
|
readOnly: true
|
4497
4921
|
type: object
|
4922
|
+
MonitorType:
|
4923
|
+
description: Attributes from the monitor that triggered the event.
|
4924
|
+
nullable: true
|
4925
|
+
properties:
|
4926
|
+
created_at:
|
4927
|
+
description: The POSIX timestamp of the monitor's creation in nanoseconds.
|
4928
|
+
example: 1646318692000
|
4929
|
+
type: integer
|
4930
|
+
group_status:
|
4931
|
+
description: Monitor group status used when there is no `result_groups`.
|
4932
|
+
type: integer
|
4933
|
+
groups:
|
4934
|
+
description: Groups to which the monitor belongs.
|
4935
|
+
items:
|
4936
|
+
description: A group.
|
4937
|
+
type: string
|
4938
|
+
type: array
|
4939
|
+
id:
|
4940
|
+
description: The monitor ID.
|
4941
|
+
type: integer
|
4942
|
+
message:
|
4943
|
+
description: The monitor message.
|
4944
|
+
type: string
|
4945
|
+
modified:
|
4946
|
+
description: The monitor's last-modified timestamp.
|
4947
|
+
type: integer
|
4948
|
+
name:
|
4949
|
+
description: The monitor name.
|
4950
|
+
type: string
|
4951
|
+
query:
|
4952
|
+
description: The query that triggers the alert.
|
4953
|
+
type: string
|
4954
|
+
tags:
|
4955
|
+
description: A list of tags attached to the monitor.
|
4956
|
+
example:
|
4957
|
+
- environment:test
|
4958
|
+
items:
|
4959
|
+
description: A tag.
|
4960
|
+
type: string
|
4961
|
+
type: array
|
4962
|
+
templated_name:
|
4963
|
+
description: The templated name of the monitor before resolving any template
|
4964
|
+
variables.
|
4965
|
+
type: string
|
4966
|
+
type:
|
4967
|
+
description: The monitor type.
|
4968
|
+
type: string
|
4969
|
+
type: object
|
4498
4970
|
NullableRelationshipToUser:
|
4499
4971
|
description: Relationship to user.
|
4500
4972
|
properties:
|
@@ -6585,6 +7057,13 @@ components:
|
|
6585
7057
|
|
6586
7058
|
aggregations.'
|
6587
7059
|
type: string
|
7060
|
+
metrics:
|
7061
|
+
description: Group of target fields to aggregate over when using the new
|
7062
|
+
value aggregations.
|
7063
|
+
items:
|
7064
|
+
description: Field.
|
7065
|
+
type: string
|
7066
|
+
type: array
|
6588
7067
|
name:
|
6589
7068
|
description: Name of the query.
|
6590
7069
|
type: string
|
@@ -6631,6 +7110,13 @@ components:
|
|
6631
7110
|
|
6632
7111
|
aggregations.'
|
6633
7112
|
type: string
|
7113
|
+
metrics:
|
7114
|
+
description: Group of target fields to aggregate over when using the new
|
7115
|
+
value aggregations.
|
7116
|
+
items:
|
7117
|
+
description: Field.
|
7118
|
+
type: string
|
7119
|
+
type: array
|
6634
7120
|
name:
|
6635
7121
|
description: Name of the query.
|
6636
7122
|
type: string
|
@@ -6806,6 +7292,49 @@ components:
|
|
6806
7292
|
type:
|
6807
7293
|
$ref: '#/components/schemas/SecurityMonitoringSignalType'
|
6808
7294
|
type: object
|
7295
|
+
SecurityMonitoringSignalArchiveComment:
|
7296
|
+
description: Optional comment to display on archived signals.
|
7297
|
+
type: string
|
7298
|
+
SecurityMonitoringSignalArchiveReason:
|
7299
|
+
description: Reason a signal is archived.
|
7300
|
+
enum:
|
7301
|
+
- none
|
7302
|
+
- false_positive
|
7303
|
+
- testing_or_maintenance
|
7304
|
+
- other
|
7305
|
+
type: string
|
7306
|
+
x-enum-varnames:
|
7307
|
+
- NONE
|
7308
|
+
- FALSE_POSITIVE
|
7309
|
+
- TESTING_OR_MAINTENANCE
|
7310
|
+
- OTHER
|
7311
|
+
SecurityMonitoringSignalAssigneeUpdateAttributes:
|
7312
|
+
description: Attributes describing the new assignee of a security signal.
|
7313
|
+
properties:
|
7314
|
+
assignee:
|
7315
|
+
$ref: '#/components/schemas/SecurityMonitoringTriageUser'
|
7316
|
+
version:
|
7317
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalVersion'
|
7318
|
+
required:
|
7319
|
+
- assignee
|
7320
|
+
type: object
|
7321
|
+
SecurityMonitoringSignalAssigneeUpdateData:
|
7322
|
+
description: Data containing the patch for changing the assignee of a signal.
|
7323
|
+
properties:
|
7324
|
+
attributes:
|
7325
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalAssigneeUpdateAttributes'
|
7326
|
+
required:
|
7327
|
+
- attributes
|
7328
|
+
type: object
|
7329
|
+
SecurityMonitoringSignalAssigneeUpdateRequest:
|
7330
|
+
description: Request body for changing the assignee of a given security monitoring
|
7331
|
+
signal.
|
7332
|
+
properties:
|
7333
|
+
data:
|
7334
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalAssigneeUpdateData'
|
7335
|
+
required:
|
7336
|
+
- data
|
7337
|
+
type: object
|
6809
7338
|
SecurityMonitoringSignalAttributes:
|
6810
7339
|
description: 'The object containing all signal attributes and their
|
6811
7340
|
|
@@ -6843,6 +7372,44 @@ components:
|
|
6843
7372
|
format: date-time
|
6844
7373
|
type: string
|
6845
7374
|
type: object
|
7375
|
+
SecurityMonitoringSignalIncidentIds:
|
7376
|
+
description: Array of incidents that are associated with this signal.
|
7377
|
+
items:
|
7378
|
+
description: Public ID attribute of the incident that is associated with the
|
7379
|
+
signal.
|
7380
|
+
example: 2066
|
7381
|
+
format: int64
|
7382
|
+
type: integer
|
7383
|
+
type: array
|
7384
|
+
SecurityMonitoringSignalIncidentsUpdateAttributes:
|
7385
|
+
description: Attributes describing the new list of related signals for a security
|
7386
|
+
signal.
|
7387
|
+
properties:
|
7388
|
+
incident_ids:
|
7389
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalIncidentIds'
|
7390
|
+
version:
|
7391
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalVersion'
|
7392
|
+
required:
|
7393
|
+
- incident_ids
|
7394
|
+
type: object
|
7395
|
+
SecurityMonitoringSignalIncidentsUpdateData:
|
7396
|
+
description: Data containing the patch for changing the related incidents of
|
7397
|
+
a signal.
|
7398
|
+
properties:
|
7399
|
+
attributes:
|
7400
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalIncidentsUpdateAttributes'
|
7401
|
+
required:
|
7402
|
+
- attributes
|
7403
|
+
type: object
|
7404
|
+
SecurityMonitoringSignalIncidentsUpdateRequest:
|
7405
|
+
description: Request body for changing the related incidents of a given security
|
7406
|
+
monitoring signal.
|
7407
|
+
properties:
|
7408
|
+
data:
|
7409
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalIncidentsUpdateData'
|
7410
|
+
required:
|
7411
|
+
- data
|
7412
|
+
type: object
|
6846
7413
|
SecurityMonitoringSignalListRequest:
|
6847
7414
|
description: The request for a security signal list.
|
6848
7415
|
properties:
|
@@ -6887,6 +7454,96 @@ components:
|
|
6887
7454
|
maximum: 1000
|
6888
7455
|
type: integer
|
6889
7456
|
type: object
|
7457
|
+
SecurityMonitoringSignalState:
|
7458
|
+
description: The new triage state of the signal.
|
7459
|
+
enum:
|
7460
|
+
- open
|
7461
|
+
- archived
|
7462
|
+
- under_review
|
7463
|
+
type: string
|
7464
|
+
x-enum-varnames:
|
7465
|
+
- OPEN
|
7466
|
+
- ARCHIVED
|
7467
|
+
- UNDER_REVIEW
|
7468
|
+
SecurityMonitoringSignalStateUpdateAttributes:
|
7469
|
+
description: Attributes describing the change of state of a security signal.
|
7470
|
+
properties:
|
7471
|
+
archive_comment:
|
7472
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalArchiveComment'
|
7473
|
+
archive_reason:
|
7474
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalArchiveReason'
|
7475
|
+
state:
|
7476
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalState'
|
7477
|
+
version:
|
7478
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalVersion'
|
7479
|
+
required:
|
7480
|
+
- state
|
7481
|
+
type: object
|
7482
|
+
SecurityMonitoringSignalStateUpdateData:
|
7483
|
+
description: Data containing the patch for changing the state of a signal.
|
7484
|
+
properties:
|
7485
|
+
attributes:
|
7486
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalStateUpdateAttributes'
|
7487
|
+
required:
|
7488
|
+
- attributes
|
7489
|
+
type: object
|
7490
|
+
SecurityMonitoringSignalStateUpdateRequest:
|
7491
|
+
description: Request body for changing the state of a given security monitoring
|
7492
|
+
signal.
|
7493
|
+
properties:
|
7494
|
+
data:
|
7495
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalStateUpdateData'
|
7496
|
+
required:
|
7497
|
+
- data
|
7498
|
+
type: object
|
7499
|
+
SecurityMonitoringSignalTriageAttributes:
|
7500
|
+
description: Attributes describing a triage state update operation over a security
|
7501
|
+
signal.
|
7502
|
+
properties:
|
7503
|
+
archive_comment:
|
7504
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalArchiveComment'
|
7505
|
+
archive_comment_timestamp:
|
7506
|
+
description: Timestamp of the last edit to the comment.
|
7507
|
+
format: int64
|
7508
|
+
minimum: 0
|
7509
|
+
type: integer
|
7510
|
+
archive_comment_user:
|
7511
|
+
$ref: '#/components/schemas/SecurityMonitoringTriageUser'
|
7512
|
+
archive_reason:
|
7513
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalArchiveReason'
|
7514
|
+
assignee:
|
7515
|
+
$ref: '#/components/schemas/SecurityMonitoringTriageUser'
|
7516
|
+
incident_ids:
|
7517
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalIncidentIds'
|
7518
|
+
state:
|
7519
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalState'
|
7520
|
+
state_update_timestamp:
|
7521
|
+
description: Timestamp of the last update to the signal state.
|
7522
|
+
format: int64
|
7523
|
+
minimum: 0
|
7524
|
+
type: integer
|
7525
|
+
state_update_user:
|
7526
|
+
$ref: '#/components/schemas/SecurityMonitoringTriageUser'
|
7527
|
+
required:
|
7528
|
+
- assignee
|
7529
|
+
- state
|
7530
|
+
- incident_ids
|
7531
|
+
type: object
|
7532
|
+
SecurityMonitoringSignalTriageUpdateData:
|
7533
|
+
description: Data containing the updated triage attributes of the signal.
|
7534
|
+
properties:
|
7535
|
+
attributes:
|
7536
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalTriageAttributes'
|
7537
|
+
type: object
|
7538
|
+
SecurityMonitoringSignalTriageUpdateResponse:
|
7539
|
+
description: The response returned after all triage operations, containing the
|
7540
|
+
updated signal triage data.
|
7541
|
+
properties:
|
7542
|
+
data:
|
7543
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalTriageUpdateData'
|
7544
|
+
required:
|
7545
|
+
- data
|
7546
|
+
type: object
|
6890
7547
|
SecurityMonitoringSignalType:
|
6891
7548
|
default: signal
|
6892
7549
|
description: The type of event.
|
@@ -6896,6 +7553,11 @@ components:
|
|
6896
7553
|
type: string
|
6897
7554
|
x-enum-varnames:
|
6898
7555
|
- SIGNAL
|
7556
|
+
SecurityMonitoringSignalVersion:
|
7557
|
+
description: Version of the updated signal. If server side version is higher,
|
7558
|
+
update will be rejected.
|
7559
|
+
format: int64
|
7560
|
+
type: integer
|
6899
7561
|
SecurityMonitoringSignalsListResponse:
|
6900
7562
|
description: 'The response object with all security signals matching the request
|
6901
7563
|
|
@@ -6948,6 +7610,26 @@ components:
|
|
6948
7610
|
x-enum-varnames:
|
6949
7611
|
- TIMESTAMP_ASCENDING
|
6950
7612
|
- TIMESTAMP_DESCENDING
|
7613
|
+
SecurityMonitoringTriageUser:
|
7614
|
+
description: Object representing a given user entity.
|
7615
|
+
properties:
|
7616
|
+
handle:
|
7617
|
+
description: The handle for this user account.
|
7618
|
+
type: string
|
7619
|
+
id:
|
7620
|
+
description: Numerical ID assigned by Datadog to this user account.
|
7621
|
+
format: int64
|
7622
|
+
type: integer
|
7623
|
+
name:
|
7624
|
+
description: The name for this user account.
|
7625
|
+
type: string
|
7626
|
+
uuid:
|
7627
|
+
description: UUID assigned by Datadog to this user account.
|
7628
|
+
example: 773b045d-ccf8-4808-bd3b-955ef6a8c940
|
7629
|
+
type: string
|
7630
|
+
required:
|
7631
|
+
- uuid
|
7632
|
+
type: object
|
6951
7633
|
ServiceAccountCreateAttributes:
|
6952
7634
|
description: Attributes of the created user.
|
6953
7635
|
properties:
|
@@ -7360,7 +8042,6 @@ components:
|
|
7360
8042
|
incident_write: Create, view, and manage incidents in Datadog.
|
7361
8043
|
metrics_read: View custom metrics.
|
7362
8044
|
monitors_read: View monitors.
|
7363
|
-
monitors_write: Edit, mute, and delete individual monitors.
|
7364
8045
|
security_monitoring_filters_read: Read Security Filters.
|
7365
8046
|
security_monitoring_filters_write: Create, edit, and delete Security Filters.
|
7366
8047
|
security_monitoring_rules_read: Read Detection Rules.
|
@@ -8492,35 +9173,162 @@ paths:
|
|
8492
9173
|
content:
|
8493
9174
|
application/json:
|
8494
9175
|
schema:
|
8495
|
-
$ref: '#/components/schemas/DashboardListUpdateItemsResponse'
|
9176
|
+
$ref: '#/components/schemas/DashboardListUpdateItemsResponse'
|
9177
|
+
description: OK
|
9178
|
+
'400':
|
9179
|
+
content:
|
9180
|
+
application/json:
|
9181
|
+
schema:
|
9182
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
9183
|
+
description: Bad Request
|
9184
|
+
'403':
|
9185
|
+
content:
|
9186
|
+
application/json:
|
9187
|
+
schema:
|
9188
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
9189
|
+
description: Forbidden
|
9190
|
+
'404':
|
9191
|
+
content:
|
9192
|
+
application/json:
|
9193
|
+
schema:
|
9194
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
9195
|
+
description: Not Found
|
9196
|
+
'429':
|
9197
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
9198
|
+
summary: Update items of a dashboard list
|
9199
|
+
tags:
|
9200
|
+
- Dashboard Lists
|
9201
|
+
x-codegen-request-body-name: body
|
9202
|
+
x-menu-order: 3
|
9203
|
+
x-undo:
|
9204
|
+
type: safe
|
9205
|
+
/api/v2/events:
|
9206
|
+
get:
|
9207
|
+
description: 'List endpoint returns events that match an events search query.
|
9208
|
+
|
9209
|
+
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).
|
9210
|
+
|
9211
|
+
|
9212
|
+
Use this endpoint to see your latest events.'
|
9213
|
+
operationId: ListEvents
|
9214
|
+
parameters:
|
9215
|
+
- description: Search query following events syntax.
|
9216
|
+
in: query
|
9217
|
+
name: filter[query]
|
9218
|
+
required: false
|
9219
|
+
schema:
|
9220
|
+
type: string
|
9221
|
+
- description: Minimum timestamp for requested events.
|
9222
|
+
in: query
|
9223
|
+
name: filter[from]
|
9224
|
+
required: false
|
9225
|
+
schema:
|
9226
|
+
type: string
|
9227
|
+
- description: Maximum timestamp for requested events.
|
9228
|
+
in: query
|
9229
|
+
name: filter[to]
|
9230
|
+
required: false
|
9231
|
+
schema:
|
9232
|
+
type: string
|
9233
|
+
- description: Order of events in results.
|
9234
|
+
in: query
|
9235
|
+
name: sort
|
9236
|
+
required: false
|
9237
|
+
schema:
|
9238
|
+
$ref: '#/components/schemas/EventsSort'
|
9239
|
+
- description: List following results with a cursor provided in the previous
|
9240
|
+
query.
|
9241
|
+
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
9242
|
+
in: query
|
9243
|
+
name: page[cursor]
|
9244
|
+
required: false
|
9245
|
+
schema:
|
9246
|
+
type: string
|
9247
|
+
- description: Maximum number of events in the response.
|
9248
|
+
example: 25
|
9249
|
+
in: query
|
9250
|
+
name: page[limit]
|
9251
|
+
required: false
|
9252
|
+
schema:
|
9253
|
+
default: 10
|
9254
|
+
format: int32
|
9255
|
+
maximum: 1000
|
9256
|
+
type: integer
|
9257
|
+
responses:
|
9258
|
+
'200':
|
9259
|
+
content:
|
9260
|
+
application/json:
|
9261
|
+
schema:
|
9262
|
+
$ref: '#/components/schemas/EventsListResponse'
|
9263
|
+
description: OK
|
9264
|
+
'400':
|
9265
|
+
$ref: '#/components/responses/BadRequestResponse'
|
9266
|
+
'403':
|
9267
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
9268
|
+
'429':
|
9269
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
9270
|
+
security:
|
9271
|
+
- apiKeyAuth: []
|
9272
|
+
appKeyAuth: []
|
9273
|
+
- AuthZ:
|
9274
|
+
- events_read
|
9275
|
+
summary: Get a list of events
|
9276
|
+
tags:
|
9277
|
+
- Events
|
9278
|
+
x-menu-order: 1
|
9279
|
+
x-pagination:
|
9280
|
+
cursorParam: page[cursor]
|
9281
|
+
cursorPath: meta.page.after
|
9282
|
+
limitParam: page[limit]
|
9283
|
+
resultsPath: data
|
9284
|
+
x-undo:
|
9285
|
+
type: safe
|
9286
|
+
x-unstable: '**Note**: This endpoint is in private beta.
|
9287
|
+
|
9288
|
+
For access, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
9289
|
+
/api/v2/events/search:
|
9290
|
+
post:
|
9291
|
+
description: 'List endpoint returns events that match an events search query.
|
9292
|
+
|
9293
|
+
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).
|
9294
|
+
|
9295
|
+
|
9296
|
+
Use this endpoint to build complex events filtering and search.'
|
9297
|
+
operationId: SearchEvents
|
9298
|
+
requestBody:
|
9299
|
+
content:
|
9300
|
+
application/json:
|
9301
|
+
schema:
|
9302
|
+
$ref: '#/components/schemas/EventsListRequest'
|
9303
|
+
required: false
|
9304
|
+
responses:
|
9305
|
+
'200':
|
9306
|
+
content:
|
9307
|
+
application/json:
|
9308
|
+
schema:
|
9309
|
+
$ref: '#/components/schemas/EventsListResponse'
|
8496
9310
|
description: OK
|
8497
9311
|
'400':
|
8498
|
-
|
8499
|
-
application/json:
|
8500
|
-
schema:
|
8501
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
8502
|
-
description: Bad Request
|
9312
|
+
$ref: '#/components/responses/BadRequestResponse'
|
8503
9313
|
'403':
|
8504
|
-
|
8505
|
-
application/json:
|
8506
|
-
schema:
|
8507
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
8508
|
-
description: Forbidden
|
8509
|
-
'404':
|
8510
|
-
content:
|
8511
|
-
application/json:
|
8512
|
-
schema:
|
8513
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
8514
|
-
description: Not Found
|
9314
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
8515
9315
|
'429':
|
8516
9316
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
8517
|
-
summary:
|
9317
|
+
summary: Search events
|
8518
9318
|
tags:
|
8519
|
-
-
|
9319
|
+
- Events
|
8520
9320
|
x-codegen-request-body-name: body
|
8521
|
-
x-menu-order:
|
9321
|
+
x-menu-order: 2
|
9322
|
+
x-pagination:
|
9323
|
+
cursorParam: body.page.cursor
|
9324
|
+
cursorPath: meta.page.after
|
9325
|
+
limitParam: body.page.limit
|
9326
|
+
resultsPath: data
|
8522
9327
|
x-undo:
|
8523
9328
|
type: safe
|
9329
|
+
x-unstable: '**Note**: This endpoint is in private beta.
|
9330
|
+
|
9331
|
+
For access, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
8524
9332
|
/api/v2/incidents:
|
8525
9333
|
get:
|
8526
9334
|
description: Get all incidents for the user's organization.
|
@@ -10281,6 +11089,11 @@ paths:
|
|
10281
11089
|
schema:
|
10282
11090
|
$ref: '#/components/schemas/APIErrorResponse'
|
10283
11091
|
description: Too Many Requests
|
11092
|
+
security:
|
11093
|
+
- apiKeyAuth: []
|
11094
|
+
appKeyAuth: []
|
11095
|
+
- AuthZ:
|
11096
|
+
- metrics_read
|
10284
11097
|
summary: List tag configuration by name
|
10285
11098
|
tags:
|
10286
11099
|
- Metrics
|
@@ -12085,6 +12898,159 @@ paths:
|
|
12085
12898
|
resultsPath: data
|
12086
12899
|
x-undo:
|
12087
12900
|
type: safe
|
12901
|
+
/api/v2/security_monitoring/signals/{signal_id}/assignee:
|
12902
|
+
patch:
|
12903
|
+
description: Modify the triage assignee of a security signal.
|
12904
|
+
operationId: EditSecurityMonitoringSignalAssignee
|
12905
|
+
parameters:
|
12906
|
+
- $ref: '#/components/parameters/SignalID'
|
12907
|
+
requestBody:
|
12908
|
+
content:
|
12909
|
+
application/json:
|
12910
|
+
schema:
|
12911
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalAssigneeUpdateRequest'
|
12912
|
+
description: Attributes describing the signal update.
|
12913
|
+
required: true
|
12914
|
+
responses:
|
12915
|
+
'200':
|
12916
|
+
content:
|
12917
|
+
application/json:
|
12918
|
+
schema:
|
12919
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalTriageUpdateResponse'
|
12920
|
+
description: OK
|
12921
|
+
'400':
|
12922
|
+
content:
|
12923
|
+
application/json:
|
12924
|
+
schema:
|
12925
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
12926
|
+
description: Bad Request
|
12927
|
+
'403':
|
12928
|
+
content:
|
12929
|
+
application/json:
|
12930
|
+
schema:
|
12931
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
12932
|
+
description: Forbidden
|
12933
|
+
'404':
|
12934
|
+
content:
|
12935
|
+
application/json:
|
12936
|
+
schema:
|
12937
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
12938
|
+
description: Not Found
|
12939
|
+
'429':
|
12940
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
12941
|
+
security:
|
12942
|
+
- apiKeyAuth: []
|
12943
|
+
appKeyAuth: []
|
12944
|
+
- AuthZ:
|
12945
|
+
- security_monitoring_signals_write
|
12946
|
+
summary: Modify the triage assignee of a security signal
|
12947
|
+
tags:
|
12948
|
+
- Security Monitoring
|
12949
|
+
x-codegen-request-body-name: body
|
12950
|
+
x-undo:
|
12951
|
+
type: idempotent
|
12952
|
+
/api/v2/security_monitoring/signals/{signal_id}/incidents:
|
12953
|
+
patch:
|
12954
|
+
description: Change the related incidents for a security signal.
|
12955
|
+
operationId: EditSecurityMonitoringSignalIncidents
|
12956
|
+
parameters:
|
12957
|
+
- $ref: '#/components/parameters/SignalID'
|
12958
|
+
requestBody:
|
12959
|
+
content:
|
12960
|
+
application/json:
|
12961
|
+
schema:
|
12962
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalIncidentsUpdateRequest'
|
12963
|
+
description: Attributes describing the signal update.
|
12964
|
+
required: true
|
12965
|
+
responses:
|
12966
|
+
'200':
|
12967
|
+
content:
|
12968
|
+
application/json:
|
12969
|
+
schema:
|
12970
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalTriageUpdateResponse'
|
12971
|
+
description: OK
|
12972
|
+
'400':
|
12973
|
+
content:
|
12974
|
+
application/json:
|
12975
|
+
schema:
|
12976
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
12977
|
+
description: Bad Request
|
12978
|
+
'403':
|
12979
|
+
content:
|
12980
|
+
application/json:
|
12981
|
+
schema:
|
12982
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
12983
|
+
description: Forbidden
|
12984
|
+
'404':
|
12985
|
+
content:
|
12986
|
+
application/json:
|
12987
|
+
schema:
|
12988
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
12989
|
+
description: Not Found
|
12990
|
+
'429':
|
12991
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
12992
|
+
security:
|
12993
|
+
- apiKeyAuth: []
|
12994
|
+
appKeyAuth: []
|
12995
|
+
- AuthZ:
|
12996
|
+
- security_monitoring_signals_write
|
12997
|
+
summary: Change the related incidents of a security signal
|
12998
|
+
tags:
|
12999
|
+
- Security Monitoring
|
13000
|
+
x-codegen-request-body-name: body
|
13001
|
+
x-undo:
|
13002
|
+
type: idempotent
|
13003
|
+
/api/v2/security_monitoring/signals/{signal_id}/state:
|
13004
|
+
patch:
|
13005
|
+
description: Change the triage state of a security signal.
|
13006
|
+
operationId: EditSecurityMonitoringSignalState
|
13007
|
+
parameters:
|
13008
|
+
- $ref: '#/components/parameters/SignalID'
|
13009
|
+
requestBody:
|
13010
|
+
content:
|
13011
|
+
application/json:
|
13012
|
+
schema:
|
13013
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalStateUpdateRequest'
|
13014
|
+
description: Attributes describing the signal update.
|
13015
|
+
required: true
|
13016
|
+
responses:
|
13017
|
+
'200':
|
13018
|
+
content:
|
13019
|
+
application/json:
|
13020
|
+
schema:
|
13021
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalTriageUpdateResponse'
|
13022
|
+
description: OK
|
13023
|
+
'400':
|
13024
|
+
content:
|
13025
|
+
application/json:
|
13026
|
+
schema:
|
13027
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
13028
|
+
description: Bad Request
|
13029
|
+
'403':
|
13030
|
+
content:
|
13031
|
+
application/json:
|
13032
|
+
schema:
|
13033
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
13034
|
+
description: Forbidden
|
13035
|
+
'404':
|
13036
|
+
content:
|
13037
|
+
application/json:
|
13038
|
+
schema:
|
13039
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
13040
|
+
description: Not Found
|
13041
|
+
'429':
|
13042
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
13043
|
+
security:
|
13044
|
+
- apiKeyAuth: []
|
13045
|
+
appKeyAuth: []
|
13046
|
+
- AuthZ:
|
13047
|
+
- security_monitoring_signals_write
|
13048
|
+
summary: Change the triage state of a security signal
|
13049
|
+
tags:
|
13050
|
+
- Security Monitoring
|
13051
|
+
x-codegen-request-body-name: body
|
13052
|
+
x-undo:
|
13053
|
+
type: idempotent
|
12088
13054
|
/api/v2/series:
|
12089
13055
|
post:
|
12090
13056
|
description: "The metrics end-point allows you to post time-series data that
|
@@ -12094,7 +13060,7 @@ paths:
|
|
12094
13060
|
metrics directly to the Datadog API without using DogStatsD, expect:\n\n-
|
12095
13061
|
64 bits for the timestamp\n- 64 bits for the value\n- 20 bytes for the metric
|
12096
13062
|
names\n- 50 bytes for the timeseries\n- The full payload is approximately
|
12097
|
-
100 bytes."
|
13063
|
+
100 bytes.\n\nHost name is one of the resources in the Resources field."
|
12098
13064
|
operationId: SubmitMetrics
|
12099
13065
|
parameters:
|
12100
13066
|
- description: HTTP header used to compress the media-type.
|
@@ -12833,7 +13799,10 @@ paths:
|
|
12833
13799
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
12834
13800
|
/api/v2/usage/application_security:
|
12835
13801
|
get:
|
12836
|
-
description: Get hourly usage for
|
13802
|
+
description: 'Get hourly usage for application security .
|
13803
|
+
|
13804
|
+
**Note:** hourly usage data for all products is now available in the [Get
|
13805
|
+
hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)'
|
12837
13806
|
operationId: GetUsageApplicationSecurityMonitoring
|
12838
13807
|
parameters:
|
12839
13808
|
- description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
|
@@ -12884,10 +13853,10 @@ paths:
|
|
12884
13853
|
appKeyAuth: []
|
12885
13854
|
- AuthZ:
|
12886
13855
|
- usage_read
|
12887
|
-
summary: Get hourly usage for
|
13856
|
+
summary: Get hourly usage for application security
|
12888
13857
|
tags:
|
12889
13858
|
- Usage Metering
|
12890
|
-
x-menu-order:
|
13859
|
+
x-menu-order: 37
|
12891
13860
|
x-undo:
|
12892
13861
|
type: safe
|
12893
13862
|
/api/v2/usage/cost_by_org:
|
@@ -12945,17 +13914,28 @@ paths:
|
|
12945
13914
|
summary: Get cost across multi-org account
|
12946
13915
|
tags:
|
12947
13916
|
- Usage Metering
|
12948
|
-
x-menu-order:
|
13917
|
+
x-menu-order: 5
|
12949
13918
|
x-undo:
|
12950
13919
|
type: safe
|
12951
|
-
/api/v2/usage/
|
13920
|
+
/api/v2/usage/estimated_cost:
|
12952
13921
|
get:
|
12953
|
-
description: Get estimated cost across multi-org
|
13922
|
+
description: 'Get estimated cost across multi-org and single root-org accounts.
|
13923
|
+
|
13924
|
+
Estimated cost data is only available for the current month and previous month.
|
13925
|
+
To access historical costs prior to this, use the /cost_by_org endpoint.'
|
12954
13926
|
operationId: GetEstimatedCostByOrg
|
12955
13927
|
parameters:
|
13928
|
+
- description: String to specify whether cost is broken down at a parent-org
|
13929
|
+
level or at the sub-org level. Currently, only the 'sub-org' view is supported.
|
13930
|
+
in: query
|
13931
|
+
name: view
|
13932
|
+
required: true
|
13933
|
+
schema:
|
13934
|
+
type: string
|
12956
13935
|
- description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
|
12957
13936
|
for cost beginning this month. Either start_month or start_date should be
|
12958
|
-
specified, but not both.
|
13937
|
+
specified, but not both. (start_month cannot go beyond two months in the
|
13938
|
+
past)'
|
12959
13939
|
in: query
|
12960
13940
|
name: start_month
|
12961
13941
|
required: false
|
@@ -12972,7 +13952,8 @@ paths:
|
|
12972
13952
|
type: string
|
12973
13953
|
- description: 'Datetime in ISO-8601 format, UTC, precise to day: `[YYYY-MM-DD]`
|
12974
13954
|
for cost beginning this day. Either start_month or start_date should be
|
12975
|
-
specified, but not both.
|
13955
|
+
specified, but not both. (start_date cannot go beyond two months in the
|
13956
|
+
past)'
|
12976
13957
|
in: query
|
12977
13958
|
name: start_date
|
12978
13959
|
required: false
|
@@ -13017,15 +13998,136 @@ paths:
|
|
13017
13998
|
appKeyAuth: []
|
13018
13999
|
- AuthZ:
|
13019
14000
|
- usage_read
|
13020
|
-
summary: Get estimated cost across
|
14001
|
+
summary: Get estimated cost across your account
|
13021
14002
|
tags:
|
13022
14003
|
- Usage Metering
|
13023
14004
|
x-menu-order: 39
|
13024
14005
|
x-undo:
|
13025
14006
|
type: safe
|
14007
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
14008
|
+
|
14009
|
+
Only the sub-org view is available currently, the summary view will be released
|
14010
|
+
at a later date.'
|
14011
|
+
/api/v2/usage/hourly_usage:
|
14012
|
+
get:
|
14013
|
+
description: Get hourly usage by product family
|
14014
|
+
operationId: GetHourlyUsage
|
14015
|
+
parameters:
|
14016
|
+
- description: 'Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh]
|
14017
|
+
for usage beginning at this hour.'
|
14018
|
+
in: query
|
14019
|
+
name: filter[timestamp][start]
|
14020
|
+
required: true
|
14021
|
+
schema:
|
14022
|
+
format: date-time
|
14023
|
+
type: string
|
14024
|
+
- description: 'Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh]
|
14025
|
+
for usage ending **before** this hour.'
|
14026
|
+
in: query
|
14027
|
+
name: filter[timestamp][end]
|
14028
|
+
required: false
|
14029
|
+
schema:
|
14030
|
+
format: date-time
|
14031
|
+
type: string
|
14032
|
+
- description: 'Comma separated list of product families to retrieve. Available
|
14033
|
+
families are `all`, `analyzed_logs`,
|
14034
|
+
|
14035
|
+
`application_security`, `audit_logs`, `serverless`, `ci_app`, `cspm`, `custom_events`,
|
14036
|
+
`cws`, `dbm`, `fargate`,
|
14037
|
+
|
14038
|
+
`infra_hosts`, `incident_management`, `indexed_logs`, `indexed_spans`, `ingested_spans`,
|
14039
|
+
`iot`,
|
14040
|
+
|
14041
|
+
`lambda_traced_invocations`, `logs`, `network_flows`, `network_hosts`, `observability_pipelines`,
|
14042
|
+
|
14043
|
+
`online_archive`, `profiling`, `rum`, `rum_browser_sessions`, `rum_mobile_sessions`,
|
14044
|
+
`sds`, `snmp`,
|
14045
|
+
|
14046
|
+
`synthetics_api`, `synthetics_browser`, and `timeseries`.'
|
14047
|
+
in: query
|
14048
|
+
name: filter[product_families]
|
14049
|
+
required: true
|
14050
|
+
schema:
|
14051
|
+
type: string
|
14052
|
+
- description: Include child org usage in the response. Defaults to false.
|
14053
|
+
in: query
|
14054
|
+
name: filter[include_descendants]
|
14055
|
+
required: false
|
14056
|
+
schema:
|
14057
|
+
default: false
|
14058
|
+
type: boolean
|
14059
|
+
- description: 'Comma separated list of product family versions to use in the
|
14060
|
+
format `product_family:version`. For example,
|
14061
|
+
|
14062
|
+
`infra_hosts:1.0.0`. If this parameter is not used, the API will use the
|
14063
|
+
latest version of each requested
|
14064
|
+
|
14065
|
+
product family. Currently all families have one version `1.0.0`.'
|
14066
|
+
in: query
|
14067
|
+
name: filter[versions]
|
14068
|
+
required: false
|
14069
|
+
schema:
|
14070
|
+
type: string
|
14071
|
+
- description: Maximum number of results to return (between 1 and 500) - defaults
|
14072
|
+
to 500 if limit not specified.
|
14073
|
+
in: query
|
14074
|
+
name: page[limit]
|
14075
|
+
required: false
|
14076
|
+
schema:
|
14077
|
+
default: 500
|
14078
|
+
format: int32
|
14079
|
+
maximum: 500
|
14080
|
+
minimum: 1
|
14081
|
+
type: integer
|
14082
|
+
- description: List following results with a next_record_id provided in the
|
14083
|
+
previous query.
|
14084
|
+
in: query
|
14085
|
+
name: page[next_record_id]
|
14086
|
+
required: false
|
14087
|
+
schema:
|
14088
|
+
type: string
|
14089
|
+
responses:
|
14090
|
+
'200':
|
14091
|
+
content:
|
14092
|
+
application/json;datetime-format=rfc3339:
|
14093
|
+
schema:
|
14094
|
+
$ref: '#/components/schemas/HourlyUsageResponse'
|
14095
|
+
description: OK
|
14096
|
+
'400':
|
14097
|
+
content:
|
14098
|
+
application/json;datetime-format=rfc3339:
|
14099
|
+
schema:
|
14100
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
14101
|
+
description: Bad Request
|
14102
|
+
'403':
|
14103
|
+
content:
|
14104
|
+
application/json;datetime-format=rfc3339:
|
14105
|
+
schema:
|
14106
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
14107
|
+
description: Forbidden - User is not authorized
|
14108
|
+
'429':
|
14109
|
+
content:
|
14110
|
+
application/json;datetime-format=rfc3339:
|
14111
|
+
schema:
|
14112
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
14113
|
+
description: Too many requests
|
14114
|
+
security:
|
14115
|
+
- apiKeyAuth: []
|
14116
|
+
appKeyAuth: []
|
14117
|
+
- AuthZ:
|
14118
|
+
- usage_read
|
14119
|
+
summary: Get hourly usage by product family
|
14120
|
+
tags:
|
14121
|
+
- Usage Metering
|
14122
|
+
x-menu-order: 1
|
14123
|
+
x-undo:
|
14124
|
+
type: safe
|
13026
14125
|
/api/v2/usage/lambda_traced_invocations:
|
13027
14126
|
get:
|
13028
|
-
description: Get hourly usage for
|
14127
|
+
description: 'Get hourly usage for lambda traced invocations.
|
14128
|
+
|
14129
|
+
**Note:** hourly usage data for all products is now available in the [Get
|
14130
|
+
hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)'
|
13029
14131
|
operationId: GetUsageLambdaTracedInvocations
|
13030
14132
|
parameters:
|
13031
14133
|
- description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
|
@@ -13076,15 +14178,18 @@ paths:
|
|
13076
14178
|
appKeyAuth: []
|
13077
14179
|
- AuthZ:
|
13078
14180
|
- usage_read
|
13079
|
-
summary: Get hourly usage for
|
14181
|
+
summary: Get hourly usage for lambda traced invocations
|
13080
14182
|
tags:
|
13081
14183
|
- Usage Metering
|
13082
|
-
x-menu-order:
|
14184
|
+
x-menu-order: 36
|
13083
14185
|
x-undo:
|
13084
14186
|
type: safe
|
13085
14187
|
/api/v2/usage/observability_pipelines:
|
13086
14188
|
get:
|
13087
|
-
description: Get hourly usage for
|
14189
|
+
description: 'Get hourly usage for observability pipelines.
|
14190
|
+
|
14191
|
+
**Note:** hourly usage data for all products is now available in the [Get
|
14192
|
+
hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)'
|
13088
14193
|
operationId: GetUsageObservabilityPipelines
|
13089
14194
|
parameters:
|
13090
14195
|
- description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
|
@@ -13135,7 +14240,7 @@ paths:
|
|
13135
14240
|
appKeyAuth: []
|
13136
14241
|
- AuthZ:
|
13137
14242
|
- usage_read
|
13138
|
-
summary: Get hourly usage for
|
14243
|
+
summary: Get hourly usage for observability pipelines
|
13139
14244
|
tags:
|
13140
14245
|
- Usage Metering
|
13141
14246
|
x-menu-order: 38
|
@@ -13635,6 +14740,16 @@ tags:
|
|
13635
14740
|
|
13636
14741
|
organization.'
|
13637
14742
|
name: Dashboard Lists
|
14743
|
+
- description: 'The events service allows you to programmatically post events to the
|
14744
|
+
event stream
|
14745
|
+
|
14746
|
+
and fetch events from the event stream. Events are limited to 4000 characters.
|
14747
|
+
|
14748
|
+
If an event is sent out with a message containing more than 4000 characters, only
|
14749
|
+
the
|
14750
|
+
|
14751
|
+
first 4000 characters are displayed.'
|
14752
|
+
name: Events
|
13638
14753
|
- description: Create, update, delete, and retrieve services which can be associated
|
13639
14754
|
with incidents.
|
13640
14755
|
name: Incident Services
|