datadog_api_client 1.9.0 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.apigentools-info +4 -4
- data/.generator/schemas/v1/openapi.yaml +1486 -273
- data/.generator/schemas/v2/openapi.yaml +2348 -146
- data/.generator/src/generator/cli.py +57 -40
- data/.generator/src/generator/formatter.py +20 -1
- data/.generator/src/generator/openapi.py +15 -9
- data/.generator/src/generator/templates/api.j2 +14 -13
- data/.generator/src/generator/templates/api_client.j2 +64 -15
- data/.generator/src/generator/templates/configuration.j2 +12 -8
- data/.generator/src/generator/templates/example.j2 +1 -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_generic.j2 +42 -3
- 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 +16 -4
- 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 -8
- data/.pre-commit-config.yaml +3 -12
- data/CHANGELOG.md +91 -0
- data/Gemfile +1 -0
- data/Makefile +2 -3
- data/README.md +16 -0
- data/check-examples.sh +0 -2
- data/datadog_api_client.gemspec +2 -0
- data/examples/v1/aws-integration/UpdateAWSAccount.rb +8 -4
- data/examples/v1/dashboards/CreateDashboard_1442588603.rb +61 -0
- data/examples/v1/dashboards/CreateDashboard_252716965.rb +52 -0
- data/examples/v1/dashboards/CreateDashboard_3882428227.rb +60 -0
- data/examples/v1/downtimes/CreateDowntime_1393233946.rb +3 -0
- data/examples/v1/downtimes/CreateDowntime_2908359488.rb +4 -0
- data/examples/v1/downtimes/CreateDowntime_3059354445.rb +4 -0
- data/examples/v1/downtimes/UpdateDowntime.rb +1 -0
- data/examples/v1/events/ListEvents.rb +1 -1
- data/examples/v1/metrics/SubmitDistributionPoints.rb +22 -0
- data/examples/v1/metrics/SubmitDistributionPoints_3109558960.rb +25 -0
- data/examples/v1/monitors/CreateMonitor_1969035628.rb +52 -0
- data/examples/v1/monitors/CreateMonitor_2520912138.rb +22 -0
- data/examples/v1/organizations/DowngradeOrg.rb +5 -0
- data/examples/v1/organizations/UpdateOrg.rb +1 -0
- data/examples/v1/security-monitoring/AddSecurityMonitoringSignalToIncident.rb +9 -0
- data/examples/v1/security-monitoring/EditSecurityMonitoringSignalAssignee.rb +9 -0
- data/examples/v1/security-monitoring/EditSecurityMonitoringSignalState.rb +10 -0
- data/examples/v1/service-level-objective-corrections/CreateSLOCorrection.rb +0 -3
- data/examples/v1/service-level-objective-corrections/CreateSLOCorrection_1326388368.rb +0 -3
- data/examples/v1/service-level-objective-corrections/DeleteSLOCorrection.rb +0 -3
- data/examples/v1/service-level-objective-corrections/GetSLOCorrection.rb +0 -3
- data/examples/v1/service-level-objective-corrections/ListSLOCorrection.rb +0 -3
- data/examples/v1/service-level-objective-corrections/UpdateSLOCorrection.rb +0 -3
- data/examples/v1/service-level-objectives/GetSLOCorrections.rb +0 -3
- data/examples/v1/service-level-objectives/GetSLOHistory.rb +1 -1
- data/examples/v1/service-level-objectives/SearchSLO.rb +16 -0
- data/examples/v1/snapshots/GetGraphSnapshot.rb +2 -0
- data/examples/v1/synthetics/CreateSyntheticsAPITest.rb +8 -0
- data/examples/v1/synthetics/CreateSyntheticsAPITest_1402674167.rb +44 -0
- data/examples/v1/synthetics/CreateSyntheticsBrowserTest_2932742688.rb +67 -0
- 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/synthetics/UpdateBrowserTest.rb +8 -0
- data/examples/v1/usage-metering/GetDailyCustomReports.rb +1 -1
- data/examples/v1/usage-metering/GetHourlyUsageAttribution.rb +1 -4
- data/examples/v1/usage-metering/GetMonthlyCustomReports.rb +1 -1
- data/examples/v1/usage-metering/GetMonthlyUsageAttribution.rb +1 -4
- data/examples/v1/usage-metering/{GetMonthlyUsageAttribution_3738504447.rb → GetMonthlyUsageAttribution_3849653599.rb} +1 -1
- 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 +2 -2
- 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_3271366243.rb +9 -0
- 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/events/ListEvents.rb +8 -0
- data/examples/v2/events/ListEvents_2663715109.rb +14 -0
- data/examples/v2/events/SearchEvents.rb +23 -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/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/SubmitLog.rb +1 -0
- data/examples/v2/logs-archives/CreateLogsArchive.rb +1 -0
- data/examples/v2/logs-archives/UpdateLogsArchive.rb +1 -0
- data/examples/v2/metrics/CreateTagConfiguration.rb +0 -3
- data/examples/v2/metrics/DeleteTagConfiguration.rb +0 -3
- data/examples/v2/metrics/EstimateMetricsOutputSeries.rb +9 -0
- data/examples/v2/metrics/ListTagConfigurationByName.rb +0 -3
- data/examples/v2/metrics/ListTagConfigurations.rb +0 -3
- data/examples/v2/metrics/ListTagConfigurations_103226315.rb +0 -3
- data/examples/v2/metrics/ListTagConfigurations_1799362914.rb +0 -3
- data/examples/v2/metrics/SubmitMetrics.rb +26 -0
- data/examples/v2/metrics/UpdateTagConfiguration.rb +0 -3
- data/examples/v2/opsgenie-integration/CreateOpsgenieService.rb +16 -0
- data/examples/v2/opsgenie-integration/DeleteOpsgenieService.rb +8 -0
- data/examples/v2/opsgenie-integration/GetOpsgenieService.rb +8 -0
- data/examples/v2/opsgenie-integration/ListOpsgenieServices.rb +5 -0
- data/examples/v2/opsgenie-integration/UpdateOpsgenieService.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.rb +0 -3
- data/examples/v2/security-monitoring/SearchSecurityMonitoringSignals.rb +0 -3
- data/examples/v2/security-monitoring/UpdateSecurityMonitoringRule.rb +5 -0
- data/examples/v2/usage-metering/GetCostByOrg.rb +5 -0
- data/examples/v2/usage-metering/GetEstimatedCostByOrg.rb +8 -0
- 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 +5 -0
- data/examples/v2/usage-metering/GetUsageApplicationSecurityMonitoring_3959166796.rb +8 -0
- data/examples/v2/usage-metering/GetUsageLambdaTracedInvocations.rb +5 -0
- 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} +64 -15
- data/lib/datadog_api_client/api_key_configuration.rb +1 -18
- data/lib/datadog_api_client/{v1/configuration.rb → configuration.rb} +133 -35
- 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 +87 -62
- data/lib/datadog_api_client/v1/api/monitors_api.rb +90 -157
- data/lib/datadog_api_client/v1/api/notebooks_api.rb +11 -51
- data/lib/datadog_api_client/v1/api/organizations_api.rb +77 -52
- 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 +242 -0
- 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 +12 -52
- data/lib/datadog_api_client/v1/api/service_level_objectives_api.rb +100 -94
- data/lib/datadog_api_client/v1/api/slack_integration_api.rb +11 -51
- data/lib/datadog_api_client/v1/api/snapshots_api.rb +7 -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 +184 -427
- 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/add_signal_to_incident_request.rb +142 -0
- data/lib/datadog_api_client/v1/models/distribution_point_item.rb +63 -0
- data/lib/datadog_api_client/v1/models/distribution_points_content_encoding.rb +26 -0
- data/lib/datadog_api_client/v1/models/distribution_points_payload.rb +124 -0
- data/lib/datadog_api_client/v1/models/distribution_points_series.rb +179 -0
- data/lib/datadog_api_client/v1/models/distribution_points_type.rb +26 -0
- data/lib/datadog_api_client/v1/models/distribution_widget_histogram_request_query.rb +64 -0
- data/lib/datadog_api_client/v1/models/distribution_widget_histogram_request_type.rb +26 -0
- data/lib/datadog_api_client/v1/models/distribution_widget_request.rb +21 -1
- data/lib/datadog_api_client/v1/models/downtime.rb +11 -1
- data/lib/datadog_api_client/v1/models/downtime_child.rb +11 -1
- data/lib/datadog_api_client/v1/models/event.rb +1 -1
- data/lib/datadog_api_client/v1/models/formula_and_function_apm_resource_stat_name.rb +1 -0
- 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 +9 -0
- data/lib/datadog_api_client/v1/models/http_log_item.rb +29 -4
- data/lib/datadog_api_client/v1/models/ip_prefixes_synthetics_private_locations.rb +125 -0
- data/lib/datadog_api_client/v1/models/ip_ranges.rb +11 -1
- data/lib/datadog_api_client/v1/models/logs_category_processor.rb +1 -1
- data/lib/datadog_api_client/v1/models/logs_list_request.rb +1 -1
- data/lib/datadog_api_client/v1/models/logs_processor.rb +1 -1
- data/lib/datadog_api_client/v1/models/logs_sort.rb +1 -1
- 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_formula_and_function_query_definition.rb +1 -1
- data/lib/datadog_api_client/v1/models/monitor_group_search_response_counts.rb +2 -2
- data/lib/datadog_api_client/v1/models/{monitor_search_response_counts_tag_item.rb → monitor_search_count_item.rb} +3 -3
- data/lib/datadog_api_client/v1/models/monitor_search_response_counts.rb +4 -4
- data/lib/datadog_api_client/v1/models/monitor_type.rb +1 -0
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_body.rb +6 -2
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_response.rb +1 -1
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_supported_metrics.rb +18 -0
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_values.rb +61 -1
- data/lib/datadog_api_client/v1/models/notebook_cell_create_request.rb +146 -0
- data/lib/datadog_api_client/v1/models/notebook_cell_create_request_attributes.rb +68 -0
- 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/org_downgraded_response.rb +111 -0
- data/lib/datadog_api_client/v1/models/organization.rb +14 -4
- data/lib/datadog_api_client/v1/models/search_slo_response.rb +131 -0
- data/lib/datadog_api_client/v1/models/{monitor_group_search_response_counts_status_item.rb → search_slo_response_data.rb} +19 -19
- data/lib/datadog_api_client/v1/models/{monitor_group_search_response_counts_type_item.rb → search_slo_response_data_attributes.rb} +21 -19
- data/lib/datadog_api_client/v1/models/search_slo_response_data_attributes_facets.rb +197 -0
- data/lib/datadog_api_client/v1/models/{monitor_search_response_counts_type_item.rb → search_slo_response_data_attributes_facets_object_int.rb} +7 -7
- data/lib/datadog_api_client/v1/models/{monitor_search_response_counts_muted_item.rb → search_slo_response_data_attributes_facets_object_string.rb} +7 -7
- data/lib/datadog_api_client/v1/models/search_slo_response_links.rb +151 -0
- data/lib/datadog_api_client/v1/models/search_slo_response_meta.rb +111 -0
- data/lib/datadog_api_client/v1/models/search_slo_response_meta_page.rb +181 -0
- data/lib/datadog_api_client/v1/models/series.rb +2 -2
- data/lib/datadog_api_client/v1/models/service_level_objective.rb +3 -3
- data/lib/datadog_api_client/v1/models/service_level_objective_query.rb +1 -1
- data/lib/datadog_api_client/v1/models/service_level_objective_request.rb +3 -3
- data/lib/datadog_api_client/v1/models/signal_archive_reason.rb +29 -0
- data/lib/datadog_api_client/v1/models/signal_assignee_update_request.rb +132 -0
- data/lib/datadog_api_client/v1/models/signal_state_update_request.rb +152 -0
- data/lib/datadog_api_client/v1/models/signal_triage_state.rb +28 -0
- data/lib/datadog_api_client/v1/models/slo_correction_create_request_attributes.rb +1 -1
- data/lib/datadog_api_client/v1/models/slo_correction_response_attributes.rb +4 -4
- data/lib/datadog_api_client/v1/models/slo_correction_update_request_attributes.rb +1 -1
- data/lib/datadog_api_client/v1/models/slo_history_metrics.rb +1 -1
- data/lib/datadog_api_client/v1/models/slo_response_data.rb +1 -1
- data/lib/datadog_api_client/v1/models/successful_signal_update_response.rb +111 -0
- data/lib/datadog_api_client/v1/models/sunburst_widget_legend.rb +1 -1
- data/lib/datadog_api_client/v1/models/synthetics_api_test.rb +12 -1
- data/lib/datadog_api_client/v1/models/synthetics_assertion.rb +1 -1
- data/lib/datadog_api_client/v1/models/synthetics_assertion_type.rb +2 -0
- data/lib/datadog_api_client/v1/models/synthetics_basic_auth.rb +1 -1
- data/lib/datadog_api_client/v1/models/synthetics_browser_test.rb +11 -0
- data/lib/datadog_api_client/v1/models/synthetics_browser_test_rum_settings.rb +152 -0
- data/lib/datadog_api_client/v1/models/synthetics_core_web_vitals.rb +2 -2
- data/lib/datadog_api_client/v1/models/synthetics_test_ci_options.rb +111 -0
- data/lib/datadog_api_client/v1/models/synthetics_test_details.rb +1 -1
- data/lib/datadog_api_client/v1/models/synthetics_test_details_sub_type.rb +2 -1
- data/lib/datadog_api_client/v1/models/synthetics_test_options.rb +31 -1
- data/lib/datadog_api_client/v1/models/synthetics_test_request.rb +21 -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_response.rb +1 -1
- data/lib/datadog_api_client/v1/models/usage_attribution_sort.rb +6 -0
- data/lib/datadog_api_client/v1/models/usage_attribution_supported_metrics.rb +6 -0
- data/lib/datadog_api_client/v1/models/usage_attribution_values.rb +61 -1
- data/lib/datadog_api_client/v1/models/usage_billable_summary_keys.rb +474 -4
- data/lib/datadog_api_client/v1/models/usage_rum_sessions_hour.rb +18 -4
- data/lib/datadog_api_client/v1/models/usage_summary_date.rb +11 -1
- data/lib/datadog_api_client/v1/models/usage_summary_date_org.rb +11 -1
- data/lib/datadog_api_client/v1/models/usage_summary_response.rb +11 -1
- 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 -53
- data/lib/datadog_api_client/v2/api/cloud_workload_security_api.rb +14 -62
- 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 +179 -94
- data/lib/datadog_api_client/v2/api/opsgenie_integration_api.rb +355 -0
- 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 +382 -14
- 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.rb +1 -13
- data/lib/datadog_api_client/v2/models/authn_mapping_attributes.rb +1 -12
- data/lib/datadog_api_client/v2/models/authn_mapping_included.rb +1 -1
- data/lib/datadog_api_client/v2/models/authn_mapping_response.rb +16 -4
- data/lib/datadog_api_client/v2/models/authn_mappings_response.rb +13 -1
- data/lib/datadog_api_client/v2/models/chargeback_breakdown.rb +131 -0
- data/lib/datadog_api_client/v2/models/cost_by_org.rb +133 -0
- data/lib/datadog_api_client/v2/models/cost_by_org_attributes.rb +153 -0
- data/lib/datadog_api_client/v2/models/cost_by_org_response.rb +113 -0
- data/lib/datadog_api_client/v2/models/cost_by_org_type.rb +26 -0
- 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/hourly_usage_type.rb +2 -0
- data/lib/datadog_api_client/v2/models/http_log_item.rb +40 -4
- 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/intake_payload_accepted.rb +113 -0
- data/lib/datadog_api_client/v2/models/logs_aggregate_bucket_value.rb +1 -1
- data/lib/datadog_api_client/v2/models/logs_archive_attributes.rb +12 -1
- data/lib/datadog_api_client/v2/models/logs_archive_create_request_attributes.rb +12 -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_content_encoding.rb +26 -0
- data/lib/datadog_api_client/v2/models/metric_estimate.rb +133 -0
- data/lib/datadog_api_client/v2/models/metric_estimate_attributes.rb +133 -0
- data/lib/datadog_api_client/v2/models/metric_estimate_resource_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/metric_estimate_response.rb +111 -0
- data/lib/datadog_api_client/v2/models/metric_estimate_type.rb +28 -0
- data/lib/datadog_api_client/v2/models/metric_intake_type.rb +29 -0
- data/lib/datadog_api_client/v2/models/metric_metadata.rb +111 -0
- data/lib/datadog_api_client/v2/models/metric_origin.rb +170 -0
- data/lib/datadog_api_client/v2/models/metric_payload.rb +124 -0
- data/lib/datadog_api_client/v2/models/metric_point.rb +122 -0
- data/lib/datadog_api_client/{v1/models/monitor_search_response_counts_status_item.rb → v2/models/metric_resource.rb} +21 -21
- data/lib/datadog_api_client/v2/models/metric_series.rb +220 -0
- data/lib/datadog_api_client/v2/models/metric_tag_configuration_create_attributes.rb +0 -2
- data/lib/datadog_api_client/v2/models/metric_tag_configuration_update_attributes.rb +0 -2
- 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/opsgenie_service_create_attributes.rb +174 -0
- data/lib/datadog_api_client/v2/models/opsgenie_service_create_data.rb +145 -0
- data/lib/datadog_api_client/v2/models/opsgenie_service_create_request.rb +122 -0
- data/lib/datadog_api_client/v2/models/opsgenie_service_region_type.rb +28 -0
- data/lib/datadog_api_client/v2/models/opsgenie_service_response.rb +122 -0
- data/lib/datadog_api_client/v2/models/opsgenie_service_response_attributes.rb +132 -0
- data/lib/datadog_api_client/v2/models/opsgenie_service_response_data.rb +166 -0
- data/lib/datadog_api_client/v2/models/opsgenie_service_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/opsgenie_service_update_attributes.rb +142 -0
- data/lib/datadog_api_client/v2/models/opsgenie_service_update_data.rb +166 -0
- data/lib/datadog_api_client/v2/models/opsgenie_service_update_request.rb +122 -0
- data/lib/datadog_api_client/v2/models/opsgenie_services_response.rb +124 -0
- data/lib/datadog_api_client/v2/models/relationship_to_saml_assertion_attribute_data.rb +1 -5
- 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/saml_assertion_attribute.rb +1 -5
- 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_hardcoded_evaluator_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_new_value_options.rb +30 -4
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_new_value_options_learning_method.rb +27 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_new_value_options_learning_threshold.rb +27 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_options.rb +23 -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/usage_application_security_monitoring_response.rb +113 -0
- data/lib/datadog_api_client/v2/models/usage_lambda_traced_invocations_response.rb +113 -0
- data/lib/datadog_api_client/v2/models/user_response_included_item.rb +1 -1
- data/lib/datadog_api_client/v2.rb +77 -0
- data/lib/datadog_api_client/version.rb +1 -1
- data/lib/datadog_api_client.rb +11 -5
- data/spec/{v1/api_client_spec.rb → api_client_spec.rb} +32 -32
- data/spec/{v1/configuration_spec.rb → configuration_spec.rb} +3 -3
- data/spec/spec_helper.rb +1 -3
- metadata +191 -28
- data/.dockerignore +0 -1
- data/.generator/src/generator/templates/api_error.j2 +0 -49
- data/extract-code-blocks.awk +0 -81
- data/extract-code-blocks.sh +0 -3
- data/lib/datadog_api_client/v1/api_client.rb +0 -456
- data/lib/datadog_api_client/v1/api_error.rb +0 -60
- data/lib/datadog_api_client/v1.rb +0 -789
- data/lib/datadog_api_client/v2/api_error.rb +0 -60
- data/lib/datadog_api_client/v2/configuration.rb +0 -427
- data/spec/v2/api_client_spec.rb +0 -210
- data/spec/v2/configuration_spec.rb +0 -45
|
@@ -224,6 +224,13 @@ components:
|
|
|
224
224
|
required: true
|
|
225
225
|
schema:
|
|
226
226
|
type: string
|
|
227
|
+
OpsgenieServiceIDPathParameter:
|
|
228
|
+
description: The UUID of the service.
|
|
229
|
+
in: path
|
|
230
|
+
name: integration_service_id
|
|
231
|
+
required: true
|
|
232
|
+
schema:
|
|
233
|
+
type: string
|
|
227
234
|
PageNumber:
|
|
228
235
|
description: Specific page number to return.
|
|
229
236
|
in: query
|
|
@@ -283,6 +290,13 @@ components:
|
|
|
283
290
|
schema:
|
|
284
291
|
example: 00000000-0000-1234-0000-000000000000
|
|
285
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
|
|
286
300
|
UserID:
|
|
287
301
|
description: The ID of the user.
|
|
288
302
|
in: path
|
|
@@ -850,11 +864,6 @@ components:
|
|
|
850
864
|
description: ID of the AuthN Mapping.
|
|
851
865
|
example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d
|
|
852
866
|
type: string
|
|
853
|
-
included:
|
|
854
|
-
description: Included data in the AuthN Mapping response.
|
|
855
|
-
items:
|
|
856
|
-
$ref: '#/components/schemas/AuthNMappingIncluded'
|
|
857
|
-
type: array
|
|
858
867
|
relationships:
|
|
859
868
|
$ref: '#/components/schemas/AuthNMappingRelationships'
|
|
860
869
|
type:
|
|
@@ -888,10 +897,8 @@ components:
|
|
|
888
897
|
type: string
|
|
889
898
|
saml_assertion_attribute_id:
|
|
890
899
|
description: The ID of the SAML assertion attribute.
|
|
891
|
-
example: 0
|
|
892
|
-
|
|
893
|
-
maximum: 2147483647
|
|
894
|
-
type: integer
|
|
900
|
+
example: '0'
|
|
901
|
+
type: string
|
|
895
902
|
type: object
|
|
896
903
|
AuthNMappingCreateAttributes:
|
|
897
904
|
description: Key/Value pair of attributes used for create request.
|
|
@@ -953,6 +960,11 @@ components:
|
|
|
953
960
|
properties:
|
|
954
961
|
data:
|
|
955
962
|
$ref: '#/components/schemas/AuthNMapping'
|
|
963
|
+
included:
|
|
964
|
+
description: Included data in the AuthN Mapping response.
|
|
965
|
+
items:
|
|
966
|
+
$ref: '#/components/schemas/AuthNMappingIncluded'
|
|
967
|
+
type: array
|
|
956
968
|
type: object
|
|
957
969
|
AuthNMappingUpdateAttributes:
|
|
958
970
|
description: Key/Value pair of attributes used for update request.
|
|
@@ -1007,6 +1019,11 @@ components:
|
|
|
1007
1019
|
items:
|
|
1008
1020
|
$ref: '#/components/schemas/AuthNMapping'
|
|
1009
1021
|
type: array
|
|
1022
|
+
included:
|
|
1023
|
+
description: Included data in the AuthN Mapping response.
|
|
1024
|
+
items:
|
|
1025
|
+
$ref: '#/components/schemas/AuthNMappingIncluded'
|
|
1026
|
+
type: array
|
|
1010
1027
|
meta:
|
|
1011
1028
|
$ref: '#/components/schemas/ResponseMetaAttributes'
|
|
1012
1029
|
type: object
|
|
@@ -1048,6 +1065,23 @@ components:
|
|
|
1048
1065
|
type: string
|
|
1049
1066
|
x-enum-varnames:
|
|
1050
1067
|
- AUTHN_MAPPINGS
|
|
1068
|
+
ChargebackBreakdown:
|
|
1069
|
+
description: Charges breakdown.
|
|
1070
|
+
properties:
|
|
1071
|
+
charge_type:
|
|
1072
|
+
description: The type of charge for a particular product.
|
|
1073
|
+
example: on_demand
|
|
1074
|
+
type: string
|
|
1075
|
+
cost:
|
|
1076
|
+
description: The cost for a particular product and charge type during a
|
|
1077
|
+
given month.
|
|
1078
|
+
format: double
|
|
1079
|
+
type: number
|
|
1080
|
+
product_name:
|
|
1081
|
+
description: The product for which cost is being reported.
|
|
1082
|
+
example: infra_host
|
|
1083
|
+
type: string
|
|
1084
|
+
type: object
|
|
1051
1085
|
CloudWorkloadSecurityAgentRuleAttributes:
|
|
1052
1086
|
description: A Cloud Workload Security Agent rule returned by the API.
|
|
1053
1087
|
properties:
|
|
@@ -1242,6 +1276,58 @@ components:
|
|
|
1242
1276
|
x-enum-varnames:
|
|
1243
1277
|
- GZIP
|
|
1244
1278
|
- DEFLATE
|
|
1279
|
+
CostByOrg:
|
|
1280
|
+
description: Cost data.
|
|
1281
|
+
properties:
|
|
1282
|
+
attributes:
|
|
1283
|
+
$ref: '#/components/schemas/CostByOrgAttributes'
|
|
1284
|
+
id:
|
|
1285
|
+
description: Unique ID of the response.
|
|
1286
|
+
type: string
|
|
1287
|
+
type:
|
|
1288
|
+
$ref: '#/components/schemas/CostByOrgType'
|
|
1289
|
+
type: object
|
|
1290
|
+
CostByOrgAttributes:
|
|
1291
|
+
description: Cost attributes data.
|
|
1292
|
+
properties:
|
|
1293
|
+
charges:
|
|
1294
|
+
description: List of charges data reported for the requested month.
|
|
1295
|
+
items:
|
|
1296
|
+
$ref: '#/components/schemas/ChargebackBreakdown'
|
|
1297
|
+
type: array
|
|
1298
|
+
date:
|
|
1299
|
+
description: The month requested.
|
|
1300
|
+
format: date-time
|
|
1301
|
+
type: string
|
|
1302
|
+
org_name:
|
|
1303
|
+
description: The organization name.
|
|
1304
|
+
type: string
|
|
1305
|
+
public_id:
|
|
1306
|
+
description: The organization public ID.
|
|
1307
|
+
type: string
|
|
1308
|
+
total_cost:
|
|
1309
|
+
description: The total cost of products for the month.
|
|
1310
|
+
format: double
|
|
1311
|
+
type: number
|
|
1312
|
+
type: object
|
|
1313
|
+
CostByOrgResponse:
|
|
1314
|
+
description: Chargeback Summary response.
|
|
1315
|
+
properties:
|
|
1316
|
+
data:
|
|
1317
|
+
description: Response containing Chargeback Summary.
|
|
1318
|
+
items:
|
|
1319
|
+
$ref: '#/components/schemas/CostByOrg'
|
|
1320
|
+
type: array
|
|
1321
|
+
type: object
|
|
1322
|
+
CostByOrgType:
|
|
1323
|
+
default: cost_by_org
|
|
1324
|
+
description: Type of cost data.
|
|
1325
|
+
enum:
|
|
1326
|
+
- cost_by_org
|
|
1327
|
+
example: cost_by_org
|
|
1328
|
+
type: string
|
|
1329
|
+
x-enum-varnames:
|
|
1330
|
+
- COST_BY_ORG
|
|
1245
1331
|
Creator:
|
|
1246
1332
|
description: Creator of the object.
|
|
1247
1333
|
properties:
|
|
@@ -1424,6 +1510,340 @@ components:
|
|
|
1424
1510
|
- INTEGRATION_SCREENBOARD
|
|
1425
1511
|
- INTEGRATION_TIMEBOARD
|
|
1426
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
|
|
1427
1847
|
FullAPIKey:
|
|
1428
1848
|
description: Datadog API key.
|
|
1429
1849
|
properties:
|
|
@@ -1551,6 +1971,9 @@ components:
|
|
|
1551
1971
|
type: array
|
|
1552
1972
|
type: object
|
|
1553
1973
|
HTTPLogItem:
|
|
1974
|
+
additionalProperties:
|
|
1975
|
+
description: Additional log attributes.
|
|
1976
|
+
type: string
|
|
1554
1977
|
description: Logs that are sent over HTTP.
|
|
1555
1978
|
properties:
|
|
1556
1979
|
ddsource:
|
|
@@ -1592,16 +2015,98 @@ components:
|
|
|
1592
2015
|
example: payment
|
|
1593
2016
|
type: string
|
|
1594
2017
|
required:
|
|
1595
|
-
-
|
|
2018
|
+
- message
|
|
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'
|
|
1596
2097
|
type: object
|
|
1597
2098
|
HourlyUsageType:
|
|
1598
2099
|
description: Usage type that is being measured.
|
|
1599
2100
|
enum:
|
|
2101
|
+
- app_sec_host_count
|
|
1600
2102
|
- observability_pipelines_bytes_processed
|
|
2103
|
+
- lambda_traced_invocations_count
|
|
1601
2104
|
example: observability_pipelines_bytes_processed
|
|
1602
2105
|
type: string
|
|
1603
2106
|
x-enum-varnames:
|
|
2107
|
+
- APP_SEC_HOST_COUNT
|
|
1604
2108
|
- OBSERVABILITY_PIPELINES_BYTES_PROCESSSED
|
|
2109
|
+
- LAMBDA_TRACED_INVOCATIONS_COUNT
|
|
1605
2110
|
IdPMetadataFormData:
|
|
1606
2111
|
description: The form data submitted to upload IdP metadata
|
|
1607
2112
|
properties:
|
|
@@ -2523,6 +3028,16 @@ components:
|
|
|
2523
3028
|
required:
|
|
2524
3029
|
- data
|
|
2525
3030
|
type: object
|
|
3031
|
+
IntakePayloadAccepted:
|
|
3032
|
+
description: The payload accepted for intake.
|
|
3033
|
+
properties:
|
|
3034
|
+
errors:
|
|
3035
|
+
description: A list of errors.
|
|
3036
|
+
items:
|
|
3037
|
+
description: An empty error list.
|
|
3038
|
+
type: string
|
|
3039
|
+
type: array
|
|
3040
|
+
type: object
|
|
2526
3041
|
ListApplicationKeysResponse:
|
|
2527
3042
|
description: Response for a list of application keys.
|
|
2528
3043
|
properties:
|
|
@@ -2648,7 +3163,7 @@ components:
|
|
|
2648
3163
|
items:
|
|
2649
3164
|
$ref: '#/components/schemas/LogsAggregateBucketValueTimeseriesPoint'
|
|
2650
3165
|
type: array
|
|
2651
|
-
|
|
3166
|
+
x-generate-alias-as-model: true
|
|
2652
3167
|
LogsAggregateBucketValueTimeseriesPoint:
|
|
2653
3168
|
description: A timeseries point
|
|
2654
3169
|
properties:
|
|
@@ -2804,6 +3319,12 @@ components:
|
|
|
2804
3319
|
in the archive.
|
|
2805
3320
|
example: source:nginx
|
|
2806
3321
|
type: string
|
|
3322
|
+
rehydration_max_scan_size_in_gb:
|
|
3323
|
+
description: Maximum scan size for rehydration from this archive.
|
|
3324
|
+
example: 100
|
|
3325
|
+
format: int64
|
|
3326
|
+
nullable: true
|
|
3327
|
+
type: integer
|
|
2807
3328
|
rehydration_tags:
|
|
2808
3329
|
description: An array of tags to add to rehydrated logs from an archive.
|
|
2809
3330
|
example:
|
|
@@ -2848,6 +3369,12 @@ components:
|
|
|
2848
3369
|
in the archive.
|
|
2849
3370
|
example: source:nginx
|
|
2850
3371
|
type: string
|
|
3372
|
+
rehydration_max_scan_size_in_gb:
|
|
3373
|
+
description: Maximum scan size for rehydration from this archive.
|
|
3374
|
+
example: 100
|
|
3375
|
+
format: int64
|
|
3376
|
+
nullable: true
|
|
3377
|
+
type: integer
|
|
2851
3378
|
rehydration_tags:
|
|
2852
3379
|
description: An array of tags to add to rehydrated logs from an archive.
|
|
2853
3380
|
example:
|
|
@@ -3789,6 +4316,14 @@ components:
|
|
|
3789
4316
|
pattern: ^[A-Za-z][A-Za-z0-9\.\-\_:\/]*$
|
|
3790
4317
|
type: string
|
|
3791
4318
|
type: array
|
|
4319
|
+
MetricContentEncoding:
|
|
4320
|
+
default: deflate
|
|
4321
|
+
description: HTTP header used to compress the media-type.
|
|
4322
|
+
enum:
|
|
4323
|
+
- deflate
|
|
4324
|
+
type: string
|
|
4325
|
+
x-enum-varnames:
|
|
4326
|
+
- DEFLATE
|
|
3792
4327
|
MetricCustomAggregation:
|
|
3793
4328
|
description: A time and space aggregation combination for use in query.
|
|
3794
4329
|
example:
|
|
@@ -3902,6 +4437,63 @@ components:
|
|
|
3902
4437
|
type: string
|
|
3903
4438
|
x-enum-varnames:
|
|
3904
4439
|
- DISTINCT_METRIC_VOLUMES
|
|
4440
|
+
MetricEstimate:
|
|
4441
|
+
description: Object for a metric cardinality estimate.
|
|
4442
|
+
properties:
|
|
4443
|
+
attributes:
|
|
4444
|
+
$ref: '#/components/schemas/MetricEstimateAttributes'
|
|
4445
|
+
id:
|
|
4446
|
+
$ref: '#/components/schemas/MetricName'
|
|
4447
|
+
type:
|
|
4448
|
+
$ref: '#/components/schemas/MetricEstimateResourceType'
|
|
4449
|
+
type: object
|
|
4450
|
+
MetricEstimateAttributes:
|
|
4451
|
+
description: Object containing the definition of a metric estimate attribute.
|
|
4452
|
+
properties:
|
|
4453
|
+
estimate_type:
|
|
4454
|
+
$ref: '#/components/schemas/MetricEstimateType'
|
|
4455
|
+
estimated_at:
|
|
4456
|
+
description: Timestamp when the cardinality estimate was requested.
|
|
4457
|
+
example: '2022-04-27T09:48:37.463835Z'
|
|
4458
|
+
format: date-time
|
|
4459
|
+
type: string
|
|
4460
|
+
estimated_output_series:
|
|
4461
|
+
description: Estimated cardinality of the metric based on the queried configuration.
|
|
4462
|
+
example: 50
|
|
4463
|
+
format: int64
|
|
4464
|
+
type: integer
|
|
4465
|
+
type: object
|
|
4466
|
+
MetricEstimateResourceType:
|
|
4467
|
+
default: metric_cardinality_estimate
|
|
4468
|
+
description: The metric estimate resource type.
|
|
4469
|
+
enum:
|
|
4470
|
+
- metric_cardinality_estimate
|
|
4471
|
+
example: metric_cardinality_estimate
|
|
4472
|
+
type: string
|
|
4473
|
+
x-enum-varnames:
|
|
4474
|
+
- METRIC_CARDINALITY_ESTIMATE
|
|
4475
|
+
MetricEstimateResponse:
|
|
4476
|
+
description: Response object that includes metric cardinality estimates.
|
|
4477
|
+
properties:
|
|
4478
|
+
data:
|
|
4479
|
+
$ref: '#/components/schemas/MetricEstimate'
|
|
4480
|
+
type: object
|
|
4481
|
+
MetricEstimateType:
|
|
4482
|
+
default: count_or_gauge
|
|
4483
|
+
description: Estimate type based on the queried configuration. By default, `count_or_gauge`
|
|
4484
|
+
is returned. `distribution` is returned for distribution metrics without percentiles
|
|
4485
|
+
enabled. Lastly, `percentile` is returned if `filter[pct]=true` is queried
|
|
4486
|
+
with a distribution metric.
|
|
4487
|
+
enum:
|
|
4488
|
+
- count_or_gauge
|
|
4489
|
+
- distribution
|
|
4490
|
+
- percentile
|
|
4491
|
+
example: distribution
|
|
4492
|
+
type: string
|
|
4493
|
+
x-enum-varnames:
|
|
4494
|
+
- COUNT_OR_GAUGE
|
|
4495
|
+
- DISTRIBUTION
|
|
4496
|
+
- PERCENTILE
|
|
3905
4497
|
MetricIngestedIndexedVolume:
|
|
3906
4498
|
description: Object for a single metric's ingested and indexed volume.
|
|
3907
4499
|
properties:
|
|
@@ -3936,10 +4528,156 @@ components:
|
|
|
3936
4528
|
type: string
|
|
3937
4529
|
x-enum-varnames:
|
|
3938
4530
|
- METRIC_VOLUMES
|
|
4531
|
+
MetricIntakeType:
|
|
4532
|
+
description: The type of metric. The available types are `0` (unspecified),
|
|
4533
|
+
`1` (count), `2` (rate), and `3` (gauge).
|
|
4534
|
+
enum:
|
|
4535
|
+
- 0
|
|
4536
|
+
- 1
|
|
4537
|
+
- 2
|
|
4538
|
+
- 3
|
|
4539
|
+
format: int32
|
|
4540
|
+
type: integer
|
|
4541
|
+
x-enum-varnames:
|
|
4542
|
+
- UNSPECIFIED
|
|
4543
|
+
- COUNT
|
|
4544
|
+
- RATE
|
|
4545
|
+
- GAUGE
|
|
4546
|
+
MetricMetadata:
|
|
4547
|
+
description: Metadata for the metric.
|
|
4548
|
+
properties:
|
|
4549
|
+
origin:
|
|
4550
|
+
$ref: '#/components/schemas/MetricOrigin'
|
|
4551
|
+
type: object
|
|
3939
4552
|
MetricName:
|
|
3940
4553
|
description: The metric name for this resource.
|
|
3941
4554
|
example: test.metric.latency
|
|
3942
4555
|
type: string
|
|
4556
|
+
MetricOrigin:
|
|
4557
|
+
description: Metric origin information.
|
|
4558
|
+
properties:
|
|
4559
|
+
metric_type:
|
|
4560
|
+
default: 0
|
|
4561
|
+
description: The origin metric type code
|
|
4562
|
+
format: int32
|
|
4563
|
+
maximum: 1000
|
|
4564
|
+
type: integer
|
|
4565
|
+
product:
|
|
4566
|
+
default: 0
|
|
4567
|
+
description: The origin product code
|
|
4568
|
+
format: int32
|
|
4569
|
+
maximum: 1000
|
|
4570
|
+
type: integer
|
|
4571
|
+
service:
|
|
4572
|
+
default: 0
|
|
4573
|
+
description: The origin service code
|
|
4574
|
+
format: int32
|
|
4575
|
+
maximum: 1000
|
|
4576
|
+
type: integer
|
|
4577
|
+
type: object
|
|
4578
|
+
MetricPayload:
|
|
4579
|
+
description: The metrics' payload.
|
|
4580
|
+
properties:
|
|
4581
|
+
series:
|
|
4582
|
+
description: A list of time series to submit to Datadog.
|
|
4583
|
+
example:
|
|
4584
|
+
- metric: system.load.1
|
|
4585
|
+
points:
|
|
4586
|
+
- timestamp: 1475317847
|
|
4587
|
+
value: 0.7
|
|
4588
|
+
resources:
|
|
4589
|
+
- name: dummyhost
|
|
4590
|
+
type: host
|
|
4591
|
+
items:
|
|
4592
|
+
$ref: '#/components/schemas/MetricSeries'
|
|
4593
|
+
type: array
|
|
4594
|
+
required:
|
|
4595
|
+
- series
|
|
4596
|
+
type: object
|
|
4597
|
+
MetricPoint:
|
|
4598
|
+
description: A point object is of the form `{POSIX_timestamp, numeric_value}`.
|
|
4599
|
+
example:
|
|
4600
|
+
timestamp: 1575317847
|
|
4601
|
+
value: 0.5
|
|
4602
|
+
properties:
|
|
4603
|
+
timestamp:
|
|
4604
|
+
description: 'The timestamp should be in seconds and current.
|
|
4605
|
+
|
|
4606
|
+
Current is defined as not more than 10 minutes in the future or more than
|
|
4607
|
+
1 hour in the past.'
|
|
4608
|
+
format: int64
|
|
4609
|
+
type: integer
|
|
4610
|
+
value:
|
|
4611
|
+
description: The numeric value format should be a 64bit float gauge-type
|
|
4612
|
+
value.
|
|
4613
|
+
format: double
|
|
4614
|
+
type: number
|
|
4615
|
+
type: object
|
|
4616
|
+
MetricResource:
|
|
4617
|
+
description: Metric resource.
|
|
4618
|
+
example:
|
|
4619
|
+
name: dummyhost
|
|
4620
|
+
type: host
|
|
4621
|
+
properties:
|
|
4622
|
+
name:
|
|
4623
|
+
description: The name of the resource.
|
|
4624
|
+
type: string
|
|
4625
|
+
type:
|
|
4626
|
+
description: The type of the resource.
|
|
4627
|
+
type: string
|
|
4628
|
+
type: object
|
|
4629
|
+
MetricSeries:
|
|
4630
|
+
description: 'A metric to submit to Datadog.
|
|
4631
|
+
|
|
4632
|
+
See [Datadog metrics](https://docs.datadoghq.com/developers/metrics/#custom-metrics-properties).'
|
|
4633
|
+
properties:
|
|
4634
|
+
interval:
|
|
4635
|
+
description: If the type of the metric is rate or count, define the corresponding
|
|
4636
|
+
interval.
|
|
4637
|
+
example: 20
|
|
4638
|
+
format: int64
|
|
4639
|
+
type: integer
|
|
4640
|
+
metadata:
|
|
4641
|
+
$ref: '#/components/schemas/MetricMetadata'
|
|
4642
|
+
metric:
|
|
4643
|
+
description: The name of the timeseries.
|
|
4644
|
+
example: system.load.1
|
|
4645
|
+
type: string
|
|
4646
|
+
points:
|
|
4647
|
+
description: Points relating to a metric. All points must be objects with
|
|
4648
|
+
timestamp and a scalar value (cannot be a string). Timestamps should be
|
|
4649
|
+
in POSIX time in seconds, and cannot be more than ten minutes in the future
|
|
4650
|
+
or more than one hour in the past.
|
|
4651
|
+
items:
|
|
4652
|
+
$ref: '#/components/schemas/MetricPoint'
|
|
4653
|
+
type: array
|
|
4654
|
+
resources:
|
|
4655
|
+
description: A list of resources to associate with this metric.
|
|
4656
|
+
items:
|
|
4657
|
+
$ref: '#/components/schemas/MetricResource'
|
|
4658
|
+
type: array
|
|
4659
|
+
source_type_name:
|
|
4660
|
+
description: The source type name.
|
|
4661
|
+
example: datadog
|
|
4662
|
+
type: string
|
|
4663
|
+
tags:
|
|
4664
|
+
description: A list of tags associated with the metric.
|
|
4665
|
+
example:
|
|
4666
|
+
- environment:test
|
|
4667
|
+
items:
|
|
4668
|
+
description: Individual tags.
|
|
4669
|
+
type: string
|
|
4670
|
+
type: array
|
|
4671
|
+
type:
|
|
4672
|
+
$ref: '#/components/schemas/MetricIntakeType'
|
|
4673
|
+
unit:
|
|
4674
|
+
description: The unit of point value.
|
|
4675
|
+
example: second
|
|
4676
|
+
type: string
|
|
4677
|
+
required:
|
|
4678
|
+
- metric
|
|
4679
|
+
- points
|
|
4680
|
+
type: object
|
|
3943
4681
|
MetricTagConfiguration:
|
|
3944
4682
|
description: Object for a single metric tag configuration.
|
|
3945
4683
|
example:
|
|
@@ -4005,7 +4743,6 @@ components:
|
|
|
4005
4743
|
aggregations:
|
|
4006
4744
|
$ref: '#/components/schemas/MetricCustomAggregations'
|
|
4007
4745
|
include_percentiles:
|
|
4008
|
-
default: false
|
|
4009
4746
|
description: 'Toggle to include/exclude percentiles for a distribution metric.
|
|
4010
4747
|
|
|
4011
4748
|
Defaults to false. Can only be applied to metrics that have a `metric_type`
|
|
@@ -4097,7 +4834,6 @@ components:
|
|
|
4097
4834
|
aggregations:
|
|
4098
4835
|
$ref: '#/components/schemas/MetricCustomAggregations'
|
|
4099
4836
|
include_percentiles:
|
|
4100
|
-
default: false
|
|
4101
4837
|
description: 'Toggle to include/exclude percentiles for a distribution metric.
|
|
4102
4838
|
|
|
4103
4839
|
Defaults to false. Can only be applied to metrics that have a `metric_type`
|
|
@@ -4183,6 +4919,54 @@ components:
|
|
|
4183
4919
|
type: array
|
|
4184
4920
|
readOnly: true
|
|
4185
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
|
|
4186
4970
|
NullableRelationshipToUser:
|
|
4187
4971
|
description: Relationship to user.
|
|
4188
4972
|
properties:
|
|
@@ -4205,65 +4989,233 @@ components:
|
|
|
4205
4989
|
- id
|
|
4206
4990
|
- type
|
|
4207
4991
|
type: object
|
|
4208
|
-
|
|
4209
|
-
description:
|
|
4992
|
+
OpsgenieServiceCreateAttributes:
|
|
4993
|
+
description: The Opsgenie service attributes for a create request.
|
|
4210
4994
|
properties:
|
|
4211
|
-
|
|
4212
|
-
|
|
4213
|
-
|
|
4214
|
-
|
|
4995
|
+
custom_url:
|
|
4996
|
+
description: The custom URL for a custom region.
|
|
4997
|
+
example: https://example.com
|
|
4998
|
+
type: string
|
|
4999
|
+
name:
|
|
5000
|
+
description: The name for the Opsgenie service.
|
|
5001
|
+
example: fake-opsgenie-service-name
|
|
5002
|
+
type: string
|
|
5003
|
+
opsgenie_api_key:
|
|
5004
|
+
description: The Opsgenie API key for your Opsgenie service.
|
|
5005
|
+
example: 00000000-0000-0000-0000-000000000000
|
|
4215
5006
|
type: string
|
|
5007
|
+
region:
|
|
5008
|
+
$ref: '#/components/schemas/OpsgenieServiceRegionType'
|
|
5009
|
+
required:
|
|
5010
|
+
- name
|
|
5011
|
+
- opsgenie_api_key
|
|
5012
|
+
- region
|
|
5013
|
+
type: object
|
|
5014
|
+
OpsgenieServiceCreateData:
|
|
5015
|
+
description: Opsgenie service data for a create request.
|
|
5016
|
+
properties:
|
|
5017
|
+
attributes:
|
|
5018
|
+
$ref: '#/components/schemas/OpsgenieServiceCreateAttributes'
|
|
4216
5019
|
type:
|
|
4217
|
-
$ref: '#/components/schemas/
|
|
5020
|
+
$ref: '#/components/schemas/OpsgenieServiceType'
|
|
4218
5021
|
required:
|
|
4219
5022
|
- type
|
|
5023
|
+
- attributes
|
|
4220
5024
|
type: object
|
|
4221
|
-
|
|
4222
|
-
description:
|
|
5025
|
+
OpsgenieServiceCreateRequest:
|
|
5026
|
+
description: Create request for an Opsgenie service.
|
|
4223
5027
|
properties:
|
|
4224
|
-
|
|
4225
|
-
|
|
4226
|
-
|
|
4227
|
-
|
|
4228
|
-
description:
|
|
4229
|
-
description: Description of the organization.
|
|
4230
|
-
type: string
|
|
4231
|
-
disabled:
|
|
4232
|
-
description: Whether or not the organization is disabled.
|
|
4233
|
-
type: boolean
|
|
4234
|
-
modified_at:
|
|
4235
|
-
description: Time of last organization modification.
|
|
4236
|
-
format: date-time
|
|
4237
|
-
type: string
|
|
4238
|
-
name:
|
|
4239
|
-
description: Name of the organization.
|
|
4240
|
-
type: string
|
|
4241
|
-
public_id:
|
|
4242
|
-
description: Public ID of the organization.
|
|
4243
|
-
type: string
|
|
4244
|
-
sharing:
|
|
4245
|
-
description: Sharing type of the organization.
|
|
4246
|
-
type: string
|
|
4247
|
-
url:
|
|
4248
|
-
description: URL of the site that this organization exists at.
|
|
4249
|
-
type: string
|
|
5028
|
+
data:
|
|
5029
|
+
$ref: '#/components/schemas/OpsgenieServiceCreateData'
|
|
5030
|
+
required:
|
|
5031
|
+
- data
|
|
4250
5032
|
type: object
|
|
4251
|
-
|
|
4252
|
-
|
|
4253
|
-
description: Organizations resource type.
|
|
5033
|
+
OpsgenieServiceRegionType:
|
|
5034
|
+
description: The region for the Opsgenie service.
|
|
4254
5035
|
enum:
|
|
4255
|
-
-
|
|
4256
|
-
|
|
5036
|
+
- us
|
|
5037
|
+
- eu
|
|
5038
|
+
- custom
|
|
5039
|
+
example: us
|
|
4257
5040
|
type: string
|
|
4258
5041
|
x-enum-varnames:
|
|
4259
|
-
-
|
|
4260
|
-
|
|
4261
|
-
|
|
5042
|
+
- US
|
|
5043
|
+
- EU
|
|
5044
|
+
- CUSTOM
|
|
5045
|
+
OpsgenieServiceResponse:
|
|
5046
|
+
description: Response of an Opsgenie service.
|
|
4262
5047
|
properties:
|
|
4263
|
-
|
|
4264
|
-
|
|
4265
|
-
|
|
4266
|
-
|
|
5048
|
+
data:
|
|
5049
|
+
$ref: '#/components/schemas/OpsgenieServiceResponseData'
|
|
5050
|
+
required:
|
|
5051
|
+
- data
|
|
5052
|
+
type: object
|
|
5053
|
+
OpsgenieServiceResponseAttributes:
|
|
5054
|
+
description: The attributes from an Opsgenie service response.
|
|
5055
|
+
properties:
|
|
5056
|
+
custom_url:
|
|
5057
|
+
description: The custom URL for a custom region.
|
|
5058
|
+
example: null
|
|
5059
|
+
nullable: true
|
|
5060
|
+
type: string
|
|
5061
|
+
name:
|
|
5062
|
+
description: The name for the Opsgenie service.
|
|
5063
|
+
example: fake-opsgenie-service-name
|
|
5064
|
+
type: string
|
|
5065
|
+
region:
|
|
5066
|
+
$ref: '#/components/schemas/OpsgenieServiceRegionType'
|
|
5067
|
+
type: object
|
|
5068
|
+
OpsgenieServiceResponseData:
|
|
5069
|
+
description: Opsgenie service data from a response.
|
|
5070
|
+
properties:
|
|
5071
|
+
attributes:
|
|
5072
|
+
$ref: '#/components/schemas/OpsgenieServiceResponseAttributes'
|
|
5073
|
+
id:
|
|
5074
|
+
description: The ID of the Opsgenie service.
|
|
5075
|
+
example: 596da4af-0563-4097-90ff-07230c3f9db3
|
|
5076
|
+
type: string
|
|
5077
|
+
type:
|
|
5078
|
+
$ref: '#/components/schemas/OpsgenieServiceType'
|
|
5079
|
+
required:
|
|
5080
|
+
- id
|
|
5081
|
+
- type
|
|
5082
|
+
- attributes
|
|
5083
|
+
type: object
|
|
5084
|
+
OpsgenieServiceType:
|
|
5085
|
+
default: opsgenie-service
|
|
5086
|
+
description: Opsgenie service resource type.
|
|
5087
|
+
enum:
|
|
5088
|
+
- opsgenie-service
|
|
5089
|
+
example: opsgenie-service
|
|
5090
|
+
type: string
|
|
5091
|
+
x-enum-varnames:
|
|
5092
|
+
- OPSGENIE_SERVICE
|
|
5093
|
+
OpsgenieServiceUpdateAttributes:
|
|
5094
|
+
description: The Opsgenie service attributes for an update request.
|
|
5095
|
+
properties:
|
|
5096
|
+
custom_url:
|
|
5097
|
+
description: The custom URL for a custom region.
|
|
5098
|
+
example: https://example.com
|
|
5099
|
+
nullable: true
|
|
5100
|
+
type: string
|
|
5101
|
+
name:
|
|
5102
|
+
description: The name for the Opsgenie service.
|
|
5103
|
+
example: fake-opsgenie-service-name
|
|
5104
|
+
type: string
|
|
5105
|
+
opsgenie_api_key:
|
|
5106
|
+
description: The Opsgenie API key for your Opsgenie service.
|
|
5107
|
+
example: 00000000-0000-0000-0000-000000000000
|
|
5108
|
+
type: string
|
|
5109
|
+
region:
|
|
5110
|
+
$ref: '#/components/schemas/OpsgenieServiceRegionType'
|
|
5111
|
+
type: object
|
|
5112
|
+
OpsgenieServiceUpdateData:
|
|
5113
|
+
description: Opsgenie service for an update request.
|
|
5114
|
+
properties:
|
|
5115
|
+
attributes:
|
|
5116
|
+
$ref: '#/components/schemas/OpsgenieServiceUpdateAttributes'
|
|
5117
|
+
id:
|
|
5118
|
+
description: The ID of the Opsgenie service.
|
|
5119
|
+
example: 596da4af-0563-4097-90ff-07230c3f9db3
|
|
5120
|
+
type: string
|
|
5121
|
+
type:
|
|
5122
|
+
$ref: '#/components/schemas/OpsgenieServiceType'
|
|
5123
|
+
required:
|
|
5124
|
+
- id
|
|
5125
|
+
- type
|
|
5126
|
+
- attributes
|
|
5127
|
+
type: object
|
|
5128
|
+
OpsgenieServiceUpdateRequest:
|
|
5129
|
+
description: Update request for an Opsgenie service.
|
|
5130
|
+
properties:
|
|
5131
|
+
data:
|
|
5132
|
+
$ref: '#/components/schemas/OpsgenieServiceUpdateData'
|
|
5133
|
+
required:
|
|
5134
|
+
- data
|
|
5135
|
+
type: object
|
|
5136
|
+
OpsgenieServicesResponse:
|
|
5137
|
+
description: Response with a list of Opsgenie services.
|
|
5138
|
+
properties:
|
|
5139
|
+
data:
|
|
5140
|
+
description: An array of Opsgenie services.
|
|
5141
|
+
example:
|
|
5142
|
+
- attributes:
|
|
5143
|
+
custom_url: null
|
|
5144
|
+
name: fake-opsgenie-service-name
|
|
5145
|
+
region: us
|
|
5146
|
+
id: 596da4af-0563-4097-90ff-07230c3f9db3
|
|
5147
|
+
type: opsgenie-service
|
|
5148
|
+
- attributes:
|
|
5149
|
+
custom_url: null
|
|
5150
|
+
name: fake-opsgenie-service-name-2
|
|
5151
|
+
region: eu
|
|
5152
|
+
id: 0d2937f1-b561-44fa-914a-99910f848014
|
|
5153
|
+
type: opsgenie-service
|
|
5154
|
+
items:
|
|
5155
|
+
$ref: '#/components/schemas/OpsgenieServiceResponseData'
|
|
5156
|
+
type: array
|
|
5157
|
+
required:
|
|
5158
|
+
- data
|
|
5159
|
+
type: object
|
|
5160
|
+
Organization:
|
|
5161
|
+
description: Organization object.
|
|
5162
|
+
properties:
|
|
5163
|
+
attributes:
|
|
5164
|
+
$ref: '#/components/schemas/OrganizationAttributes'
|
|
5165
|
+
id:
|
|
5166
|
+
description: ID of the organization.
|
|
5167
|
+
type: string
|
|
5168
|
+
type:
|
|
5169
|
+
$ref: '#/components/schemas/OrganizationsType'
|
|
5170
|
+
required:
|
|
5171
|
+
- type
|
|
5172
|
+
type: object
|
|
5173
|
+
OrganizationAttributes:
|
|
5174
|
+
description: Attributes of the organization.
|
|
5175
|
+
properties:
|
|
5176
|
+
created_at:
|
|
5177
|
+
description: Creation time of the organization.
|
|
5178
|
+
format: date-time
|
|
5179
|
+
type: string
|
|
5180
|
+
description:
|
|
5181
|
+
description: Description of the organization.
|
|
5182
|
+
type: string
|
|
5183
|
+
disabled:
|
|
5184
|
+
description: Whether or not the organization is disabled.
|
|
5185
|
+
type: boolean
|
|
5186
|
+
modified_at:
|
|
5187
|
+
description: Time of last organization modification.
|
|
5188
|
+
format: date-time
|
|
5189
|
+
type: string
|
|
5190
|
+
name:
|
|
5191
|
+
description: Name of the organization.
|
|
5192
|
+
type: string
|
|
5193
|
+
public_id:
|
|
5194
|
+
description: Public ID of the organization.
|
|
5195
|
+
type: string
|
|
5196
|
+
sharing:
|
|
5197
|
+
description: Sharing type of the organization.
|
|
5198
|
+
type: string
|
|
5199
|
+
url:
|
|
5200
|
+
description: URL of the site that this organization exists at.
|
|
5201
|
+
type: string
|
|
5202
|
+
type: object
|
|
5203
|
+
OrganizationsType:
|
|
5204
|
+
default: orgs
|
|
5205
|
+
description: Organizations resource type.
|
|
5206
|
+
enum:
|
|
5207
|
+
- orgs
|
|
5208
|
+
example: orgs
|
|
5209
|
+
type: string
|
|
5210
|
+
x-enum-varnames:
|
|
5211
|
+
- ORGS
|
|
5212
|
+
Pagination:
|
|
5213
|
+
description: Pagination object.
|
|
5214
|
+
properties:
|
|
5215
|
+
total_count:
|
|
5216
|
+
description: Total count.
|
|
5217
|
+
format: int64
|
|
5218
|
+
type: integer
|
|
4267
5219
|
total_filtered_count:
|
|
4268
5220
|
description: Total count of elements matched by the filter.
|
|
4269
5221
|
format: int64
|
|
@@ -4538,7 +5490,7 @@ components:
|
|
|
4538
5490
|
items:
|
|
4539
5491
|
$ref: '#/components/schemas/RUMAggregateBucketValueTimeseriesPoint'
|
|
4540
5492
|
type: array
|
|
4541
|
-
|
|
5493
|
+
x-generate-alias-as-model: true
|
|
4542
5494
|
RUMAggregateBucketValueTimeseriesPoint:
|
|
4543
5495
|
description: A timeseries point.
|
|
4544
5496
|
properties:
|
|
@@ -5171,10 +6123,8 @@ components:
|
|
|
5171
6123
|
properties:
|
|
5172
6124
|
id:
|
|
5173
6125
|
description: The ID of the SAML assertion attribute.
|
|
5174
|
-
example: 0
|
|
5175
|
-
|
|
5176
|
-
maximum: 2147483647
|
|
5177
|
-
type: integer
|
|
6126
|
+
example: '0'
|
|
6127
|
+
type: string
|
|
5178
6128
|
type:
|
|
5179
6129
|
$ref: '#/components/schemas/SAMLAssertionAttributesType'
|
|
5180
6130
|
required:
|
|
@@ -5476,10 +6426,8 @@ components:
|
|
|
5476
6426
|
$ref: '#/components/schemas/SAMLAssertionAttributeAttributes'
|
|
5477
6427
|
id:
|
|
5478
6428
|
description: The ID of the SAML assertion attribute.
|
|
5479
|
-
example: 0
|
|
5480
|
-
|
|
5481
|
-
maximum: 2147483647
|
|
5482
|
-
type: integer
|
|
6429
|
+
example: '0'
|
|
6430
|
+
type: string
|
|
5483
6431
|
type:
|
|
5484
6432
|
$ref: '#/components/schemas/SAMLAssertionAttributesType'
|
|
5485
6433
|
required:
|
|
@@ -5866,6 +6814,17 @@ components:
|
|
|
5866
6814
|
- cases
|
|
5867
6815
|
- message
|
|
5868
6816
|
type: object
|
|
6817
|
+
SecurityMonitoringRuleDecreaseCriticalityBasedOnEnv:
|
|
6818
|
+
description: 'If true, signals in non-production environments have a lower severity
|
|
6819
|
+
than what is defined by the rule case, which can reduce signal noise.
|
|
6820
|
+
|
|
6821
|
+
The severity is decreased by one level: `CRITICAL` in production becomes `HIGH`
|
|
6822
|
+
in non-production, `HIGH` becomes `MEDIUM` and so on. `INFO` remains `INFO`.
|
|
6823
|
+
|
|
6824
|
+
The decrement is applied when the environment tag of the signal starts with
|
|
6825
|
+
`staging`, `test` or `dev`.'
|
|
6826
|
+
example: false
|
|
6827
|
+
type: boolean
|
|
5869
6828
|
SecurityMonitoringRuleDetectionMethod:
|
|
5870
6829
|
description: The detection method.
|
|
5871
6830
|
enum:
|
|
@@ -5873,12 +6832,14 @@ components:
|
|
|
5873
6832
|
- new_value
|
|
5874
6833
|
- anomaly_detection
|
|
5875
6834
|
- impossible_travel
|
|
6835
|
+
- hardcoded
|
|
5876
6836
|
type: string
|
|
5877
6837
|
x-enum-varnames:
|
|
5878
6838
|
- THRESHOLD
|
|
5879
6839
|
- NEW_VALUE
|
|
5880
6840
|
- ANOMALY_DETECTION
|
|
5881
6841
|
- IMPOSSIBLE_TRAVEL
|
|
6842
|
+
- HARDCODED
|
|
5882
6843
|
SecurityMonitoringRuleEvaluationWindow:
|
|
5883
6844
|
description: 'A time window is specified to match when at least one of the cases
|
|
5884
6845
|
matches true. This is a sliding window
|
|
@@ -5904,6 +6865,13 @@ components:
|
|
|
5904
6865
|
- THIRTY_MINUTES
|
|
5905
6866
|
- ONE_HOUR
|
|
5906
6867
|
- TWO_HOURS
|
|
6868
|
+
SecurityMonitoringRuleHardcodedEvaluatorType:
|
|
6869
|
+
description: Hardcoded evaluator type.
|
|
6870
|
+
enum:
|
|
6871
|
+
- log4shell
|
|
6872
|
+
type: string
|
|
6873
|
+
x-enum-varnames:
|
|
6874
|
+
- LOG4SHELL
|
|
5907
6875
|
SecurityMonitoringRuleImpossibleTravelOptions:
|
|
5908
6876
|
description: Options on impossible travel rules.
|
|
5909
6877
|
properties:
|
|
@@ -5984,6 +6952,10 @@ components:
|
|
|
5984
6952
|
$ref: '#/components/schemas/SecurityMonitoringRuleNewValueOptionsForgetAfter'
|
|
5985
6953
|
learningDuration:
|
|
5986
6954
|
$ref: '#/components/schemas/SecurityMonitoringRuleNewValueOptionsLearningDuration'
|
|
6955
|
+
learningMethod:
|
|
6956
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleNewValueOptionsLearningMethod'
|
|
6957
|
+
learningThreshold:
|
|
6958
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleNewValueOptionsLearningThreshold'
|
|
5987
6959
|
type: object
|
|
5988
6960
|
SecurityMonitoringRuleNewValueOptionsForgetAfter:
|
|
5989
6961
|
description: The duration in days after which a learned value is forgotten.
|
|
@@ -6004,6 +6976,7 @@ components:
|
|
|
6004
6976
|
- THREE_WEEKS
|
|
6005
6977
|
- FOUR_WEEKS
|
|
6006
6978
|
SecurityMonitoringRuleNewValueOptionsLearningDuration:
|
|
6979
|
+
default: 0
|
|
6007
6980
|
description: 'The duration in days during which values are learned, and after
|
|
6008
6981
|
which signals will be generated for values that
|
|
6009
6982
|
|
|
@@ -6019,13 +6992,40 @@ components:
|
|
|
6019
6992
|
- ZERO_DAYS
|
|
6020
6993
|
- ONE_DAY
|
|
6021
6994
|
- SEVEN_DAYS
|
|
6995
|
+
SecurityMonitoringRuleNewValueOptionsLearningMethod:
|
|
6996
|
+
default: duration
|
|
6997
|
+
description: The learning method used to determine when signals should be generated
|
|
6998
|
+
for values that weren't learned.
|
|
6999
|
+
enum:
|
|
7000
|
+
- duration
|
|
7001
|
+
- threshold
|
|
7002
|
+
type: string
|
|
7003
|
+
x-enum-varnames:
|
|
7004
|
+
- DURATION
|
|
7005
|
+
- THRESHOLD
|
|
7006
|
+
SecurityMonitoringRuleNewValueOptionsLearningThreshold:
|
|
7007
|
+
default: 0
|
|
7008
|
+
description: A number of occurrences after which signals will be generated for
|
|
7009
|
+
values that weren't learned.
|
|
7010
|
+
enum:
|
|
7011
|
+
- 0
|
|
7012
|
+
- 1
|
|
7013
|
+
format: int32
|
|
7014
|
+
type: integer
|
|
7015
|
+
x-enum-varnames:
|
|
7016
|
+
- ZERO_OCCURRENCES
|
|
7017
|
+
- ONE_OCCURRENCE
|
|
6022
7018
|
SecurityMonitoringRuleOptions:
|
|
6023
7019
|
description: Options on rules.
|
|
6024
7020
|
properties:
|
|
7021
|
+
decreaseCriticalityBasedOnEnv:
|
|
7022
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleDecreaseCriticalityBasedOnEnv'
|
|
6025
7023
|
detectionMethod:
|
|
6026
7024
|
$ref: '#/components/schemas/SecurityMonitoringRuleDetectionMethod'
|
|
6027
7025
|
evaluationWindow:
|
|
6028
7026
|
$ref: '#/components/schemas/SecurityMonitoringRuleEvaluationWindow'
|
|
7027
|
+
hardcodedEvaluatorType:
|
|
7028
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleHardcodedEvaluatorType'
|
|
6029
7029
|
impossibleTravelOptions:
|
|
6030
7030
|
$ref: '#/components/schemas/SecurityMonitoringRuleImpossibleTravelOptions'
|
|
6031
7031
|
keepAlive:
|
|
@@ -6057,6 +7057,13 @@ components:
|
|
|
6057
7057
|
|
|
6058
7058
|
aggregations.'
|
|
6059
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
|
|
6060
7067
|
name:
|
|
6061
7068
|
description: Name of the query.
|
|
6062
7069
|
type: string
|
|
@@ -6103,6 +7110,13 @@ components:
|
|
|
6103
7110
|
|
|
6104
7111
|
aggregations.'
|
|
6105
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
|
|
6106
7120
|
name:
|
|
6107
7121
|
description: Name of the query.
|
|
6108
7122
|
type: string
|
|
@@ -6278,6 +7292,49 @@ components:
|
|
|
6278
7292
|
type:
|
|
6279
7293
|
$ref: '#/components/schemas/SecurityMonitoringSignalType'
|
|
6280
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
|
|
6281
7338
|
SecurityMonitoringSignalAttributes:
|
|
6282
7339
|
description: 'The object containing all signal attributes and their
|
|
6283
7340
|
|
|
@@ -6315,6 +7372,44 @@ components:
|
|
|
6315
7372
|
format: date-time
|
|
6316
7373
|
type: string
|
|
6317
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
|
|
6318
7413
|
SecurityMonitoringSignalListRequest:
|
|
6319
7414
|
description: The request for a security signal list.
|
|
6320
7415
|
properties:
|
|
@@ -6359,6 +7454,96 @@ components:
|
|
|
6359
7454
|
maximum: 1000
|
|
6360
7455
|
type: integer
|
|
6361
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
|
|
6362
7547
|
SecurityMonitoringSignalType:
|
|
6363
7548
|
default: signal
|
|
6364
7549
|
description: The type of event.
|
|
@@ -6368,6 +7553,11 @@ components:
|
|
|
6368
7553
|
type: string
|
|
6369
7554
|
x-enum-varnames:
|
|
6370
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
|
|
6371
7561
|
SecurityMonitoringSignalsListResponse:
|
|
6372
7562
|
description: 'The response object with all security signals matching the request
|
|
6373
7563
|
|
|
@@ -6420,6 +7610,26 @@ components:
|
|
|
6420
7610
|
x-enum-varnames:
|
|
6421
7611
|
- TIMESTAMP_ASCENDING
|
|
6422
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
|
|
6423
7633
|
ServiceAccountCreateAttributes:
|
|
6424
7634
|
description: Attributes of the created user.
|
|
6425
7635
|
properties:
|
|
@@ -6462,6 +7672,15 @@ components:
|
|
|
6462
7672
|
required:
|
|
6463
7673
|
- data
|
|
6464
7674
|
type: object
|
|
7675
|
+
UsageApplicationSecurityMonitoringResponse:
|
|
7676
|
+
description: Application Security Monitoring usage response.
|
|
7677
|
+
properties:
|
|
7678
|
+
data:
|
|
7679
|
+
description: Response containing Application Security Monitoring usage.
|
|
7680
|
+
items:
|
|
7681
|
+
$ref: '#/components/schemas/UsageDataObject'
|
|
7682
|
+
type: array
|
|
7683
|
+
type: object
|
|
6465
7684
|
UsageAttributesObject:
|
|
6466
7685
|
description: Usage attributes data.
|
|
6467
7686
|
properties:
|
|
@@ -6493,6 +7712,15 @@ components:
|
|
|
6493
7712
|
type:
|
|
6494
7713
|
$ref: '#/components/schemas/UsageTimeSeriesType'
|
|
6495
7714
|
type: object
|
|
7715
|
+
UsageLambdaTracedInvocationsResponse:
|
|
7716
|
+
description: Lambda Traced Invocations usage response.
|
|
7717
|
+
properties:
|
|
7718
|
+
data:
|
|
7719
|
+
description: Response containing Lambda Traced Invocations usage.
|
|
7720
|
+
items:
|
|
7721
|
+
$ref: '#/components/schemas/UsageDataObject'
|
|
7722
|
+
type: array
|
|
7723
|
+
type: object
|
|
6496
7724
|
UsageObservabilityPipelinesResponse:
|
|
6497
7725
|
description: Observability Pipelines usage response.
|
|
6498
7726
|
properties:
|
|
@@ -6806,7 +8034,6 @@ components:
|
|
|
6806
8034
|
authorizationCode:
|
|
6807
8035
|
authorizationUrl: /oauth2/v1/authorize
|
|
6808
8036
|
scopes:
|
|
6809
|
-
dashboards_public_share: Share dashboards externally.
|
|
6810
8037
|
dashboards_read: View dashboards.
|
|
6811
8038
|
dashboards_write: Create and change dashboards.
|
|
6812
8039
|
events_read: Read Events data.
|
|
@@ -6814,6 +8041,7 @@ components:
|
|
|
6814
8041
|
incident_settings_write: Configure Incidents settings.
|
|
6815
8042
|
incident_write: Create, view, and manage incidents in Datadog.
|
|
6816
8043
|
metrics_read: View custom metrics.
|
|
8044
|
+
monitors_read: View monitors.
|
|
6817
8045
|
security_monitoring_filters_read: Read Security Filters.
|
|
6818
8046
|
security_monitoring_filters_write: Create, edit, and delete Security Filters.
|
|
6819
8047
|
security_monitoring_rules_read: Read Detection Rules.
|
|
@@ -7333,14 +8561,6 @@ paths:
|
|
|
7333
8561
|
required: false
|
|
7334
8562
|
schema:
|
|
7335
8563
|
$ref: '#/components/schemas/AuthNMappingsSort'
|
|
7336
|
-
- description: Include additional information in the response.
|
|
7337
|
-
in: query
|
|
7338
|
-
name: include
|
|
7339
|
-
required: false
|
|
7340
|
-
schema:
|
|
7341
|
-
items:
|
|
7342
|
-
type: string
|
|
7343
|
-
type: array
|
|
7344
8564
|
- description: Filter all mappings by the given string.
|
|
7345
8565
|
in: query
|
|
7346
8566
|
name: filter
|
|
@@ -7982,12 +9202,139 @@ paths:
|
|
|
7982
9202
|
x-menu-order: 3
|
|
7983
9203
|
x-undo:
|
|
7984
9204
|
type: safe
|
|
7985
|
-
/api/v2/
|
|
9205
|
+
/api/v2/events:
|
|
7986
9206
|
get:
|
|
7987
|
-
description:
|
|
7988
|
-
|
|
7989
|
-
|
|
7990
|
-
|
|
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'
|
|
9310
|
+
description: OK
|
|
9311
|
+
'400':
|
|
9312
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
9313
|
+
'403':
|
|
9314
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
9315
|
+
'429':
|
|
9316
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
9317
|
+
summary: Search events
|
|
9318
|
+
tags:
|
|
9319
|
+
- Events
|
|
9320
|
+
x-codegen-request-body-name: body
|
|
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
|
|
9327
|
+
x-undo:
|
|
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/).'
|
|
9332
|
+
/api/v2/incidents:
|
|
9333
|
+
get:
|
|
9334
|
+
description: Get all incidents for the user's organization.
|
|
9335
|
+
operationId: ListIncidents
|
|
9336
|
+
parameters:
|
|
9337
|
+
- $ref: '#/components/parameters/IncidentIncludeQueryParameter'
|
|
7991
9338
|
- $ref: '#/components/parameters/PageSize'
|
|
7992
9339
|
- $ref: '#/components/parameters/PageOffset'
|
|
7993
9340
|
responses:
|
|
@@ -8190,6 +9537,159 @@ paths:
|
|
|
8190
9537
|
x-unstable: '**Note**: This endpoint is in public beta.
|
|
8191
9538
|
|
|
8192
9539
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
9540
|
+
/api/v2/integration/opsgenie/services:
|
|
9541
|
+
get:
|
|
9542
|
+
description: Get a list of all services from the Datadog Opsgenie integration.
|
|
9543
|
+
operationId: ListOpsgenieServices
|
|
9544
|
+
responses:
|
|
9545
|
+
'200':
|
|
9546
|
+
content:
|
|
9547
|
+
application/json:
|
|
9548
|
+
schema:
|
|
9549
|
+
$ref: '#/components/schemas/OpsgenieServicesResponse'
|
|
9550
|
+
description: OK
|
|
9551
|
+
'403':
|
|
9552
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
9553
|
+
'429':
|
|
9554
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
9555
|
+
summary: Get all service objects
|
|
9556
|
+
tags:
|
|
9557
|
+
- Opsgenie Integration
|
|
9558
|
+
x-menu-order: 1
|
|
9559
|
+
x-undo:
|
|
9560
|
+
type: safe
|
|
9561
|
+
post:
|
|
9562
|
+
description: Create a new service object in the Opsgenie integration.
|
|
9563
|
+
operationId: CreateOpsgenieService
|
|
9564
|
+
requestBody:
|
|
9565
|
+
content:
|
|
9566
|
+
application/json:
|
|
9567
|
+
schema:
|
|
9568
|
+
$ref: '#/components/schemas/OpsgenieServiceCreateRequest'
|
|
9569
|
+
description: Opsgenie service payload
|
|
9570
|
+
required: true
|
|
9571
|
+
responses:
|
|
9572
|
+
'201':
|
|
9573
|
+
content:
|
|
9574
|
+
application/json:
|
|
9575
|
+
schema:
|
|
9576
|
+
$ref: '#/components/schemas/OpsgenieServiceResponse'
|
|
9577
|
+
description: CREATED
|
|
9578
|
+
'400':
|
|
9579
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
9580
|
+
'403':
|
|
9581
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
9582
|
+
'409':
|
|
9583
|
+
$ref: '#/components/responses/ConflictResponse'
|
|
9584
|
+
'429':
|
|
9585
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
9586
|
+
summary: Create a new service object
|
|
9587
|
+
tags:
|
|
9588
|
+
- Opsgenie Integration
|
|
9589
|
+
x-codegen-request-body-name: body
|
|
9590
|
+
x-given:
|
|
9591
|
+
opsgenie_service:
|
|
9592
|
+
parameters:
|
|
9593
|
+
- name: body
|
|
9594
|
+
value: "{\n \"data\": {\n \"attributes\": {\n \"name\": \"{{
|
|
9595
|
+
unique }}\",\n \"opsgenie_api_key\": \"00000000-0000-0000-0000-000000000000\",\n
|
|
9596
|
+
\ \"region\": \"us\"\n },\n \"type\": \"opsgenie-service\"\n
|
|
9597
|
+
\ }\n}"
|
|
9598
|
+
step: there is a valid "opsgenie_service" in the system
|
|
9599
|
+
x-menu-order: 2
|
|
9600
|
+
x-undo:
|
|
9601
|
+
operationId: DeleteOpsgenieService
|
|
9602
|
+
parameters:
|
|
9603
|
+
- name: integration_service_id
|
|
9604
|
+
source: data.id
|
|
9605
|
+
type: unsafe
|
|
9606
|
+
/api/v2/integration/opsgenie/services/{integration_service_id}:
|
|
9607
|
+
delete:
|
|
9608
|
+
description: Delete a single service object in the Datadog Opsgenie integration.
|
|
9609
|
+
operationId: DeleteOpsgenieService
|
|
9610
|
+
parameters:
|
|
9611
|
+
- $ref: '#/components/parameters/OpsgenieServiceIDPathParameter'
|
|
9612
|
+
responses:
|
|
9613
|
+
'204':
|
|
9614
|
+
description: OK
|
|
9615
|
+
'400':
|
|
9616
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
9617
|
+
'403':
|
|
9618
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
9619
|
+
'404':
|
|
9620
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
9621
|
+
'429':
|
|
9622
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
9623
|
+
summary: Delete a single service object
|
|
9624
|
+
tags:
|
|
9625
|
+
- Opsgenie Integration
|
|
9626
|
+
x-menu-order: 5
|
|
9627
|
+
x-undo:
|
|
9628
|
+
type: idempotent
|
|
9629
|
+
get:
|
|
9630
|
+
description: Get a single service from the Datadog Opsgenie integration.
|
|
9631
|
+
operationId: GetOpsgenieService
|
|
9632
|
+
parameters:
|
|
9633
|
+
- $ref: '#/components/parameters/OpsgenieServiceIDPathParameter'
|
|
9634
|
+
responses:
|
|
9635
|
+
'200':
|
|
9636
|
+
content:
|
|
9637
|
+
application/json:
|
|
9638
|
+
schema:
|
|
9639
|
+
$ref: '#/components/schemas/OpsgenieServiceResponse'
|
|
9640
|
+
description: OK
|
|
9641
|
+
'400':
|
|
9642
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
9643
|
+
'403':
|
|
9644
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
9645
|
+
'404':
|
|
9646
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
9647
|
+
'409':
|
|
9648
|
+
$ref: '#/components/responses/ConflictResponse'
|
|
9649
|
+
'429':
|
|
9650
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
9651
|
+
summary: Get a single service object
|
|
9652
|
+
tags:
|
|
9653
|
+
- Opsgenie Integration
|
|
9654
|
+
x-menu-order: 3
|
|
9655
|
+
x-undo:
|
|
9656
|
+
type: safe
|
|
9657
|
+
patch:
|
|
9658
|
+
description: Update a single service object in the Datadog Opsgenie integration.
|
|
9659
|
+
operationId: UpdateOpsgenieService
|
|
9660
|
+
parameters:
|
|
9661
|
+
- $ref: '#/components/parameters/OpsgenieServiceIDPathParameter'
|
|
9662
|
+
requestBody:
|
|
9663
|
+
content:
|
|
9664
|
+
application/json:
|
|
9665
|
+
schema:
|
|
9666
|
+
$ref: '#/components/schemas/OpsgenieServiceUpdateRequest'
|
|
9667
|
+
description: Opsgenie service payload.
|
|
9668
|
+
required: true
|
|
9669
|
+
responses:
|
|
9670
|
+
'200':
|
|
9671
|
+
content:
|
|
9672
|
+
application/json:
|
|
9673
|
+
schema:
|
|
9674
|
+
$ref: '#/components/schemas/OpsgenieServiceResponse'
|
|
9675
|
+
description: OK
|
|
9676
|
+
'400':
|
|
9677
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
9678
|
+
'403':
|
|
9679
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
9680
|
+
'404':
|
|
9681
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
9682
|
+
'409':
|
|
9683
|
+
$ref: '#/components/responses/ConflictResponse'
|
|
9684
|
+
'429':
|
|
9685
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
9686
|
+
summary: Update a single service object
|
|
9687
|
+
tags:
|
|
9688
|
+
- Opsgenie Integration
|
|
9689
|
+
x-codegen-request-body-name: body
|
|
9690
|
+
x-menu-order: 4
|
|
9691
|
+
x-undo:
|
|
9692
|
+
type: idempotent
|
|
8193
9693
|
/api/v2/logs:
|
|
8194
9694
|
post:
|
|
8195
9695
|
description: 'Send your logs to your Datadog platform over HTTP. Limits per
|
|
@@ -9253,10 +10753,6 @@ paths:
|
|
|
9253
10753
|
x-menu-order: 5
|
|
9254
10754
|
x-undo:
|
|
9255
10755
|
type: safe
|
|
9256
|
-
x-unstable: "**Note: Use of this endpoint for count/gauge/rate metric types
|
|
9257
|
-
is only accessible for Metrics without Limits™ beta customers.\nIf you\u2019re
|
|
9258
|
-
interested in Metrics without Limits™, please contact your Customer
|
|
9259
|
-
Success Manager.**"
|
|
9260
10756
|
/api/v2/metrics/config/bulk-tags:
|
|
9261
10757
|
delete:
|
|
9262
10758
|
description: 'Delete all custom lists of queryable tag keys for a set of existing
|
|
@@ -9427,24 +10923,125 @@ paths:
|
|
|
9427
10923
|
x-menu-order: 6
|
|
9428
10924
|
x-undo:
|
|
9429
10925
|
type: safe
|
|
9430
|
-
/api/v2/metrics/{metric_name}/
|
|
9431
|
-
|
|
9432
|
-
description:
|
|
9433
|
-
|
|
9434
|
-
|
|
9435
|
-
operationId:
|
|
10926
|
+
/api/v2/metrics/{metric_name}/estimate:
|
|
10927
|
+
get:
|
|
10928
|
+
description: Returns the estimated cardinality for a metric with a given tag,
|
|
10929
|
+
percentile and number of aggregations configuration using Metrics without
|
|
10930
|
+
Limits™.
|
|
10931
|
+
operationId: EstimateMetricsOutputSeries
|
|
9436
10932
|
parameters:
|
|
9437
10933
|
- $ref: '#/components/parameters/MetricName'
|
|
10934
|
+
- description: Filtered tag keys that the metric is configured to query with.
|
|
10935
|
+
example: app,host
|
|
10936
|
+
in: query
|
|
10937
|
+
name: filter[groups]
|
|
10938
|
+
required: false
|
|
10939
|
+
schema:
|
|
10940
|
+
type: string
|
|
10941
|
+
- description: The number of hours of look back (from now) to estimate cardinality
|
|
10942
|
+
with.
|
|
10943
|
+
example: 49
|
|
10944
|
+
in: query
|
|
10945
|
+
name: filter[hours_ago]
|
|
10946
|
+
required: false
|
|
10947
|
+
schema:
|
|
10948
|
+
type: integer
|
|
10949
|
+
- description: The number of aggregations that a `count`, `rate`, or `gauge`
|
|
10950
|
+
metric is configured to use. Max number of aggregation combos is 9.
|
|
10951
|
+
example: 1
|
|
10952
|
+
in: query
|
|
10953
|
+
name: filter[num_aggregations]
|
|
10954
|
+
required: false
|
|
10955
|
+
schema:
|
|
10956
|
+
type: integer
|
|
10957
|
+
- description: A boolean, for distribution metrics only, to estimate cardinality
|
|
10958
|
+
if the metric includes additional percentile aggregators.
|
|
10959
|
+
example: true
|
|
10960
|
+
in: query
|
|
10961
|
+
name: filter[pct]
|
|
10962
|
+
required: false
|
|
10963
|
+
schema:
|
|
10964
|
+
type: boolean
|
|
10965
|
+
- description: A window, in hours, from the look back to estimate cardinality
|
|
10966
|
+
with.
|
|
10967
|
+
example: 6
|
|
10968
|
+
in: query
|
|
10969
|
+
name: filter[timespan_h]
|
|
10970
|
+
required: false
|
|
10971
|
+
schema:
|
|
10972
|
+
type: integer
|
|
9438
10973
|
responses:
|
|
9439
|
-
'
|
|
9440
|
-
description: No Content
|
|
9441
|
-
'403':
|
|
10974
|
+
'200':
|
|
9442
10975
|
content:
|
|
9443
10976
|
application/json:
|
|
9444
10977
|
schema:
|
|
9445
|
-
$ref: '#/components/schemas/
|
|
9446
|
-
description:
|
|
9447
|
-
'
|
|
10978
|
+
$ref: '#/components/schemas/MetricEstimateResponse'
|
|
10979
|
+
description: Success
|
|
10980
|
+
'400':
|
|
10981
|
+
content:
|
|
10982
|
+
application/json:
|
|
10983
|
+
schema:
|
|
10984
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
10985
|
+
description: API error response.
|
|
10986
|
+
'403':
|
|
10987
|
+
content:
|
|
10988
|
+
application/json:
|
|
10989
|
+
schema:
|
|
10990
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
10991
|
+
description: API error response.
|
|
10992
|
+
'404':
|
|
10993
|
+
content:
|
|
10994
|
+
application/json:
|
|
10995
|
+
schema:
|
|
10996
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
10997
|
+
description: API error response.
|
|
10998
|
+
'429':
|
|
10999
|
+
content:
|
|
11000
|
+
application/json:
|
|
11001
|
+
schema:
|
|
11002
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
11003
|
+
description: Too Many Requests
|
|
11004
|
+
security:
|
|
11005
|
+
- apiKeyAuth: []
|
|
11006
|
+
appKeyAuth: []
|
|
11007
|
+
- AuthZ: []
|
|
11008
|
+
summary: Tag Configuration Cardinality Estimator
|
|
11009
|
+
tags:
|
|
11010
|
+
- Metrics
|
|
11011
|
+
x-dd-ownership:
|
|
11012
|
+
notification_configuration:
|
|
11013
|
+
manual_escalation_policy: '[Points Aggregation] Primary'
|
|
11014
|
+
prod_high_urgency: '@pagerduty-Points-Aggregation @slack-points-aggr-ops'
|
|
11015
|
+
prod_low_urgency: '@slack-points-aggr-ops'
|
|
11016
|
+
slack_support_channel: '#points-aggregation'
|
|
11017
|
+
staging_high_urgency: '@slack-points-aggr-stg-ops'
|
|
11018
|
+
staging_low_urgency: '@slack-points-aggr-stg-ops'
|
|
11019
|
+
team: points-aggregation
|
|
11020
|
+
team_escalation: '[Points Aggregation] Primary'
|
|
11021
|
+
x-menu-order: 10
|
|
11022
|
+
x-permission:
|
|
11023
|
+
operator: OPEN
|
|
11024
|
+
permissions: []
|
|
11025
|
+
x-undo:
|
|
11026
|
+
type: safe
|
|
11027
|
+
/api/v2/metrics/{metric_name}/tags:
|
|
11028
|
+
delete:
|
|
11029
|
+
description: 'Deletes a metric''s tag configuration. Can only be used with application
|
|
11030
|
+
|
|
11031
|
+
keys from users with the `Manage Tags for Metrics` permission.'
|
|
11032
|
+
operationId: DeleteTagConfiguration
|
|
11033
|
+
parameters:
|
|
11034
|
+
- $ref: '#/components/parameters/MetricName'
|
|
11035
|
+
responses:
|
|
11036
|
+
'204':
|
|
11037
|
+
description: No Content
|
|
11038
|
+
'403':
|
|
11039
|
+
content:
|
|
11040
|
+
application/json:
|
|
11041
|
+
schema:
|
|
11042
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
11043
|
+
description: Forbidden
|
|
11044
|
+
'404':
|
|
9448
11045
|
content:
|
|
9449
11046
|
application/json:
|
|
9450
11047
|
schema:
|
|
@@ -9462,10 +11059,6 @@ paths:
|
|
|
9462
11059
|
x-menu-order: 4
|
|
9463
11060
|
x-undo:
|
|
9464
11061
|
type: idempotent
|
|
9465
|
-
x-unstable: "**Note: Use of this endpoint for count/gauge/rate metric types
|
|
9466
|
-
is only accessible for Metrics without Limits™ beta customers.\nIf you\u2019re
|
|
9467
|
-
interested in Metrics without Limits™, please contact your Customer
|
|
9468
|
-
Success Manager.**"
|
|
9469
11062
|
get:
|
|
9470
11063
|
description: Returns the tag configuration for the given metric name.
|
|
9471
11064
|
operationId: ListTagConfigurationByName
|
|
@@ -9496,16 +11089,17 @@ paths:
|
|
|
9496
11089
|
schema:
|
|
9497
11090
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
9498
11091
|
description: Too Many Requests
|
|
11092
|
+
security:
|
|
11093
|
+
- apiKeyAuth: []
|
|
11094
|
+
appKeyAuth: []
|
|
11095
|
+
- AuthZ:
|
|
11096
|
+
- metrics_read
|
|
9499
11097
|
summary: List tag configuration by name
|
|
9500
11098
|
tags:
|
|
9501
11099
|
- Metrics
|
|
9502
11100
|
x-menu-order: 2
|
|
9503
11101
|
x-undo:
|
|
9504
11102
|
type: safe
|
|
9505
|
-
x-unstable: "**Note: Use of this endpoint for count/gauge/rate metric types
|
|
9506
|
-
is only accessible for Metrics without Limits™ beta customers.\nIf you\u2019re
|
|
9507
|
-
interested in Metrics without Limits™, please contact your Customer
|
|
9508
|
-
Success Manager.**"
|
|
9509
11103
|
patch:
|
|
9510
11104
|
description: 'Update the tag configuration of a metric or percentile aggregations
|
|
9511
11105
|
of a distribution metric or custom aggregations
|
|
@@ -9561,10 +11155,6 @@ paths:
|
|
|
9561
11155
|
x-menu-order: 3
|
|
9562
11156
|
x-undo:
|
|
9563
11157
|
type: idempotent
|
|
9564
|
-
x-unstable: "**Note: Use of this endpoint for count/gauge/rate metric types
|
|
9565
|
-
is only accessible for Metrics without Limits™ beta customers.\nIf you\u2019re
|
|
9566
|
-
interested in Metrics without Limits™, please contact your Customer
|
|
9567
|
-
Success Manager.**"
|
|
9568
11158
|
post:
|
|
9569
11159
|
description: 'Create and define a list of queryable tag keys for an existing
|
|
9570
11160
|
count/gauge/rate/distribution metric.
|
|
@@ -9638,21 +11228,11 @@ paths:
|
|
|
9638
11228
|
- name: metric_name
|
|
9639
11229
|
source: data.id
|
|
9640
11230
|
type: unsafe
|
|
9641
|
-
x-unstable: "**Note: Use of this endpoint for count/gauge/rate metric types
|
|
9642
|
-
is only accessible for Metrics without Limits™ beta customers.\nIf you\u2019re
|
|
9643
|
-
interested in Metrics without Limits™, please contact your Customer
|
|
9644
|
-
Success Manager.**"
|
|
9645
11231
|
/api/v2/metrics/{metric_name}/volumes:
|
|
9646
11232
|
get:
|
|
9647
11233
|
description: 'View distinct metrics volumes for the given metric name.
|
|
9648
11234
|
|
|
9649
11235
|
|
|
9650
|
-
Custom distribution metrics will return both ingested and indexed custom metric
|
|
9651
|
-
volumes.
|
|
9652
|
-
|
|
9653
|
-
For Metrics without Limits™ beta customers, all metrics will return
|
|
9654
|
-
both ingested/indexed volumes.
|
|
9655
|
-
|
|
9656
11236
|
Custom metrics generated in-app from other products will return `null` for
|
|
9657
11237
|
ingested volumes.'
|
|
9658
11238
|
operationId: ListVolumesByMetricName
|
|
@@ -10673,11 +12253,6 @@ paths:
|
|
|
10673
12253
|
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
10674
12254
|
'429':
|
|
10675
12255
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
10676
|
-
security:
|
|
10677
|
-
- apiKeyAuth: []
|
|
10678
|
-
appKeyAuth: []
|
|
10679
|
-
- AuthZ:
|
|
10680
|
-
- security_monitoring_rules_read
|
|
10681
12256
|
summary: Get the latest Cloud Workload Security policy
|
|
10682
12257
|
tags:
|
|
10683
12258
|
- Cloud Workload Security
|
|
@@ -11279,9 +12854,6 @@ paths:
|
|
|
11279
12854
|
resultsPath: data
|
|
11280
12855
|
x-undo:
|
|
11281
12856
|
type: safe
|
|
11282
|
-
x-unstable: '**Note**: This endpoint is in public beta.
|
|
11283
|
-
|
|
11284
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
11285
12857
|
/api/v2/security_monitoring/signals/search:
|
|
11286
12858
|
post:
|
|
11287
12859
|
description: 'Returns security signals that match a search query.
|
|
@@ -11326,9 +12898,233 @@ paths:
|
|
|
11326
12898
|
resultsPath: data
|
|
11327
12899
|
x-undo:
|
|
11328
12900
|
type: safe
|
|
11329
|
-
|
|
11330
|
-
|
|
11331
|
-
|
|
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
|
|
13054
|
+
/api/v2/series:
|
|
13055
|
+
post:
|
|
13056
|
+
description: "The metrics end-point allows you to post time-series data that
|
|
13057
|
+
can be graphed on Datadog\u2019s dashboards.\nThe maximum payload size is
|
|
13058
|
+
500 kilobytes (512000 bytes). Compressed payloads must have a decompressed
|
|
13059
|
+
size of less than 5 megabytes (5242880 bytes).\n\nIf you\u2019re submitting
|
|
13060
|
+
metrics directly to the Datadog API without using DogStatsD, expect:\n\n-
|
|
13061
|
+
64 bits for the timestamp\n- 64 bits for the value\n- 20 bytes for the metric
|
|
13062
|
+
names\n- 50 bytes for the timeseries\n- The full payload is approximately
|
|
13063
|
+
100 bytes.\n\nHost name is one of the resources in the Resources field."
|
|
13064
|
+
operationId: SubmitMetrics
|
|
13065
|
+
parameters:
|
|
13066
|
+
- description: HTTP header used to compress the media-type.
|
|
13067
|
+
in: header
|
|
13068
|
+
name: Content-Encoding
|
|
13069
|
+
required: false
|
|
13070
|
+
schema:
|
|
13071
|
+
$ref: '#/components/schemas/MetricContentEncoding'
|
|
13072
|
+
requestBody:
|
|
13073
|
+
content:
|
|
13074
|
+
application/json:
|
|
13075
|
+
examples:
|
|
13076
|
+
dynamic-points:
|
|
13077
|
+
description: "Post time-series data that can be graphed on Datadog\u2019s
|
|
13078
|
+
dashboards."
|
|
13079
|
+
externalValue: examples/metrics/dynamic-points.json.sh
|
|
13080
|
+
summary: Dynamic Points
|
|
13081
|
+
x-variables:
|
|
13082
|
+
NOW: $(date +%s)
|
|
13083
|
+
schema:
|
|
13084
|
+
$ref: '#/components/schemas/MetricPayload'
|
|
13085
|
+
required: true
|
|
13086
|
+
responses:
|
|
13087
|
+
'202':
|
|
13088
|
+
content:
|
|
13089
|
+
application/json:
|
|
13090
|
+
schema:
|
|
13091
|
+
$ref: '#/components/schemas/IntakePayloadAccepted'
|
|
13092
|
+
description: Payload accepted
|
|
13093
|
+
'400':
|
|
13094
|
+
content:
|
|
13095
|
+
application/json:
|
|
13096
|
+
schema:
|
|
13097
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
13098
|
+
description: Bad Request
|
|
13099
|
+
'403':
|
|
13100
|
+
content:
|
|
13101
|
+
application/json:
|
|
13102
|
+
schema:
|
|
13103
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
13104
|
+
description: Authentication error
|
|
13105
|
+
'408':
|
|
13106
|
+
content:
|
|
13107
|
+
application/json:
|
|
13108
|
+
schema:
|
|
13109
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
13110
|
+
description: Request timeout
|
|
13111
|
+
'413':
|
|
13112
|
+
content:
|
|
13113
|
+
application/json:
|
|
13114
|
+
schema:
|
|
13115
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
13116
|
+
description: Payload too large
|
|
13117
|
+
'429':
|
|
13118
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
13119
|
+
security:
|
|
13120
|
+
- apiKeyAuth: []
|
|
13121
|
+
summary: Submit metrics
|
|
13122
|
+
tags:
|
|
13123
|
+
- Metrics
|
|
13124
|
+
x-codegen-request-body-name: body
|
|
13125
|
+
x-menu-order: 1
|
|
13126
|
+
x-undo:
|
|
13127
|
+
type: safe
|
|
11332
13128
|
/api/v2/service_accounts:
|
|
11333
13129
|
post:
|
|
11334
13130
|
description: Create a service account for your organization.
|
|
@@ -12001,10 +13797,13 @@ paths:
|
|
|
12001
13797
|
x-unstable: '**Note**: This endpoint is in public beta.
|
|
12002
13798
|
|
|
12003
13799
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
12004
|
-
/api/v2/usage/
|
|
13800
|
+
/api/v2/usage/application_security:
|
|
12005
13801
|
get:
|
|
12006
|
-
description: Get hourly usage for
|
|
12007
|
-
|
|
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)'
|
|
13806
|
+
operationId: GetUsageApplicationSecurityMonitoring
|
|
12008
13807
|
parameters:
|
|
12009
13808
|
- description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
|
|
12010
13809
|
for usage beginning at this hour.'
|
|
@@ -12029,7 +13828,7 @@ paths:
|
|
|
12029
13828
|
content:
|
|
12030
13829
|
application/json;datetime-format=rfc3339:
|
|
12031
13830
|
schema:
|
|
12032
|
-
$ref: '#/components/schemas/
|
|
13831
|
+
$ref: '#/components/schemas/UsageApplicationSecurityMonitoringResponse'
|
|
12033
13832
|
description: OK
|
|
12034
13833
|
'400':
|
|
12035
13834
|
content:
|
|
@@ -12054,20 +13853,407 @@ paths:
|
|
|
12054
13853
|
appKeyAuth: []
|
|
12055
13854
|
- AuthZ:
|
|
12056
13855
|
- usage_read
|
|
12057
|
-
summary: Get hourly usage for
|
|
13856
|
+
summary: Get hourly usage for application security
|
|
12058
13857
|
tags:
|
|
12059
13858
|
- Usage Metering
|
|
12060
|
-
x-menu-order:
|
|
13859
|
+
x-menu-order: 37
|
|
12061
13860
|
x-undo:
|
|
12062
13861
|
type: safe
|
|
12063
|
-
/api/v2/
|
|
12064
|
-
|
|
12065
|
-
description:
|
|
12066
|
-
|
|
12067
|
-
|
|
12068
|
-
|
|
12069
|
-
|
|
12070
|
-
|
|
13862
|
+
/api/v2/usage/cost_by_org:
|
|
13863
|
+
get:
|
|
13864
|
+
description: Get cost across multi-org account. Cost by org data for a given
|
|
13865
|
+
month becomes available no later than the 16th of the following month.
|
|
13866
|
+
operationId: GetCostByOrg
|
|
13867
|
+
parameters:
|
|
13868
|
+
- description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
|
|
13869
|
+
for cost beginning this month.'
|
|
13870
|
+
in: query
|
|
13871
|
+
name: start_month
|
|
13872
|
+
required: true
|
|
13873
|
+
schema:
|
|
13874
|
+
format: date-time
|
|
13875
|
+
type: string
|
|
13876
|
+
- description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
|
|
13877
|
+
for cost ending this month.'
|
|
13878
|
+
in: query
|
|
13879
|
+
name: end_month
|
|
13880
|
+
required: false
|
|
13881
|
+
schema:
|
|
13882
|
+
format: date-time
|
|
13883
|
+
type: string
|
|
13884
|
+
responses:
|
|
13885
|
+
'200':
|
|
13886
|
+
content:
|
|
13887
|
+
application/json;datetime-format=rfc3339:
|
|
13888
|
+
schema:
|
|
13889
|
+
$ref: '#/components/schemas/CostByOrgResponse'
|
|
13890
|
+
description: OK
|
|
13891
|
+
'400':
|
|
13892
|
+
content:
|
|
13893
|
+
application/json;datetime-format=rfc3339:
|
|
13894
|
+
schema:
|
|
13895
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
13896
|
+
description: Bad Request
|
|
13897
|
+
'403':
|
|
13898
|
+
content:
|
|
13899
|
+
application/json;datetime-format=rfc3339:
|
|
13900
|
+
schema:
|
|
13901
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
13902
|
+
description: Forbidden - User is not authorized
|
|
13903
|
+
'429':
|
|
13904
|
+
content:
|
|
13905
|
+
application/json;datetime-format=rfc3339:
|
|
13906
|
+
schema:
|
|
13907
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
13908
|
+
description: Too many requests
|
|
13909
|
+
security:
|
|
13910
|
+
- apiKeyAuth: []
|
|
13911
|
+
appKeyAuth: []
|
|
13912
|
+
- AuthZ:
|
|
13913
|
+
- usage_read
|
|
13914
|
+
summary: Get cost across multi-org account
|
|
13915
|
+
tags:
|
|
13916
|
+
- Usage Metering
|
|
13917
|
+
x-menu-order: 5
|
|
13918
|
+
x-undo:
|
|
13919
|
+
type: safe
|
|
13920
|
+
/api/v2/usage/estimated_cost:
|
|
13921
|
+
get:
|
|
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.'
|
|
13926
|
+
operationId: GetEstimatedCostByOrg
|
|
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
|
|
13935
|
+
- description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
|
|
13936
|
+
for cost beginning this month. Either start_month or start_date should be
|
|
13937
|
+
specified, but not both. (start_month cannot go beyond two months in the
|
|
13938
|
+
past)'
|
|
13939
|
+
in: query
|
|
13940
|
+
name: start_month
|
|
13941
|
+
required: false
|
|
13942
|
+
schema:
|
|
13943
|
+
format: date-time
|
|
13944
|
+
type: string
|
|
13945
|
+
- description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
|
|
13946
|
+
for cost ending this month.'
|
|
13947
|
+
in: query
|
|
13948
|
+
name: end_month
|
|
13949
|
+
required: false
|
|
13950
|
+
schema:
|
|
13951
|
+
format: date-time
|
|
13952
|
+
type: string
|
|
13953
|
+
- description: 'Datetime in ISO-8601 format, UTC, precise to day: `[YYYY-MM-DD]`
|
|
13954
|
+
for cost beginning this day. Either start_month or start_date should be
|
|
13955
|
+
specified, but not both. (start_date cannot go beyond two months in the
|
|
13956
|
+
past)'
|
|
13957
|
+
in: query
|
|
13958
|
+
name: start_date
|
|
13959
|
+
required: false
|
|
13960
|
+
schema:
|
|
13961
|
+
format: date-time
|
|
13962
|
+
type: string
|
|
13963
|
+
- description: 'Datetime in ISO-8601 format, UTC, precise to day: `[YYYY-MM-DD]`
|
|
13964
|
+
for cost ending this day.'
|
|
13965
|
+
in: query
|
|
13966
|
+
name: end_date
|
|
13967
|
+
required: false
|
|
13968
|
+
schema:
|
|
13969
|
+
format: date-time
|
|
13970
|
+
type: string
|
|
13971
|
+
responses:
|
|
13972
|
+
'200':
|
|
13973
|
+
content:
|
|
13974
|
+
application/json;datetime-format=rfc3339:
|
|
13975
|
+
schema:
|
|
13976
|
+
$ref: '#/components/schemas/CostByOrgResponse'
|
|
13977
|
+
description: OK
|
|
13978
|
+
'400':
|
|
13979
|
+
content:
|
|
13980
|
+
application/json;datetime-format=rfc3339:
|
|
13981
|
+
schema:
|
|
13982
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
13983
|
+
description: Bad Request
|
|
13984
|
+
'403':
|
|
13985
|
+
content:
|
|
13986
|
+
application/json;datetime-format=rfc3339:
|
|
13987
|
+
schema:
|
|
13988
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
13989
|
+
description: Forbidden - User is not authorized
|
|
13990
|
+
'429':
|
|
13991
|
+
content:
|
|
13992
|
+
application/json;datetime-format=rfc3339:
|
|
13993
|
+
schema:
|
|
13994
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
13995
|
+
description: Too many requests
|
|
13996
|
+
security:
|
|
13997
|
+
- apiKeyAuth: []
|
|
13998
|
+
appKeyAuth: []
|
|
13999
|
+
- AuthZ:
|
|
14000
|
+
- usage_read
|
|
14001
|
+
summary: Get estimated cost across your account
|
|
14002
|
+
tags:
|
|
14003
|
+
- Usage Metering
|
|
14004
|
+
x-menu-order: 39
|
|
14005
|
+
x-undo:
|
|
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
|
|
14125
|
+
/api/v2/usage/lambda_traced_invocations:
|
|
14126
|
+
get:
|
|
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)'
|
|
14131
|
+
operationId: GetUsageLambdaTracedInvocations
|
|
14132
|
+
parameters:
|
|
14133
|
+
- description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
|
|
14134
|
+
for usage beginning at this hour.'
|
|
14135
|
+
in: query
|
|
14136
|
+
name: start_hr
|
|
14137
|
+
required: true
|
|
14138
|
+
schema:
|
|
14139
|
+
format: date-time
|
|
14140
|
+
type: string
|
|
14141
|
+
- description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
|
|
14142
|
+
for usage ending
|
|
14143
|
+
|
|
14144
|
+
**before** this hour.'
|
|
14145
|
+
in: query
|
|
14146
|
+
name: end_hr
|
|
14147
|
+
required: false
|
|
14148
|
+
schema:
|
|
14149
|
+
format: date-time
|
|
14150
|
+
type: string
|
|
14151
|
+
responses:
|
|
14152
|
+
'200':
|
|
14153
|
+
content:
|
|
14154
|
+
application/json;datetime-format=rfc3339:
|
|
14155
|
+
schema:
|
|
14156
|
+
$ref: '#/components/schemas/UsageLambdaTracedInvocationsResponse'
|
|
14157
|
+
description: OK
|
|
14158
|
+
'400':
|
|
14159
|
+
content:
|
|
14160
|
+
application/json;datetime-format=rfc3339:
|
|
14161
|
+
schema:
|
|
14162
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
14163
|
+
description: Bad Request
|
|
14164
|
+
'403':
|
|
14165
|
+
content:
|
|
14166
|
+
application/json;datetime-format=rfc3339:
|
|
14167
|
+
schema:
|
|
14168
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
14169
|
+
description: Forbidden - User is not authorized
|
|
14170
|
+
'429':
|
|
14171
|
+
content:
|
|
14172
|
+
application/json;datetime-format=rfc3339:
|
|
14173
|
+
schema:
|
|
14174
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
14175
|
+
description: Too many requests
|
|
14176
|
+
security:
|
|
14177
|
+
- apiKeyAuth: []
|
|
14178
|
+
appKeyAuth: []
|
|
14179
|
+
- AuthZ:
|
|
14180
|
+
- usage_read
|
|
14181
|
+
summary: Get hourly usage for lambda traced invocations
|
|
14182
|
+
tags:
|
|
14183
|
+
- Usage Metering
|
|
14184
|
+
x-menu-order: 36
|
|
14185
|
+
x-undo:
|
|
14186
|
+
type: safe
|
|
14187
|
+
/api/v2/usage/observability_pipelines:
|
|
14188
|
+
get:
|
|
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)'
|
|
14193
|
+
operationId: GetUsageObservabilityPipelines
|
|
14194
|
+
parameters:
|
|
14195
|
+
- description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
|
|
14196
|
+
for usage beginning at this hour.'
|
|
14197
|
+
in: query
|
|
14198
|
+
name: start_hr
|
|
14199
|
+
required: true
|
|
14200
|
+
schema:
|
|
14201
|
+
format: date-time
|
|
14202
|
+
type: string
|
|
14203
|
+
- description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
|
|
14204
|
+
for usage ending
|
|
14205
|
+
|
|
14206
|
+
**before** this hour.'
|
|
14207
|
+
in: query
|
|
14208
|
+
name: end_hr
|
|
14209
|
+
required: false
|
|
14210
|
+
schema:
|
|
14211
|
+
format: date-time
|
|
14212
|
+
type: string
|
|
14213
|
+
responses:
|
|
14214
|
+
'200':
|
|
14215
|
+
content:
|
|
14216
|
+
application/json;datetime-format=rfc3339:
|
|
14217
|
+
schema:
|
|
14218
|
+
$ref: '#/components/schemas/UsageObservabilityPipelinesResponse'
|
|
14219
|
+
description: OK
|
|
14220
|
+
'400':
|
|
14221
|
+
content:
|
|
14222
|
+
application/json;datetime-format=rfc3339:
|
|
14223
|
+
schema:
|
|
14224
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
14225
|
+
description: Bad Request
|
|
14226
|
+
'403':
|
|
14227
|
+
content:
|
|
14228
|
+
application/json;datetime-format=rfc3339:
|
|
14229
|
+
schema:
|
|
14230
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
14231
|
+
description: Forbidden - User is not authorized
|
|
14232
|
+
'429':
|
|
14233
|
+
content:
|
|
14234
|
+
application/json;datetime-format=rfc3339:
|
|
14235
|
+
schema:
|
|
14236
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
14237
|
+
description: Too many requests
|
|
14238
|
+
security:
|
|
14239
|
+
- apiKeyAuth: []
|
|
14240
|
+
appKeyAuth: []
|
|
14241
|
+
- AuthZ:
|
|
14242
|
+
- usage_read
|
|
14243
|
+
summary: Get hourly usage for observability pipelines
|
|
14244
|
+
tags:
|
|
14245
|
+
- Usage Metering
|
|
14246
|
+
x-menu-order: 38
|
|
14247
|
+
x-undo:
|
|
14248
|
+
type: safe
|
|
14249
|
+
/api/v2/user_invitations:
|
|
14250
|
+
post:
|
|
14251
|
+
description: Sends emails to one or more users inviting them to join the organization.
|
|
14252
|
+
operationId: SendInvitations
|
|
14253
|
+
requestBody:
|
|
14254
|
+
content:
|
|
14255
|
+
application/json:
|
|
14256
|
+
schema:
|
|
12071
14257
|
$ref: '#/components/schemas/UserInvitationsRequest'
|
|
12072
14258
|
required: true
|
|
12073
14259
|
responses:
|
|
@@ -12554,6 +14740,16 @@ tags:
|
|
|
12554
14740
|
|
|
12555
14741
|
organization.'
|
|
12556
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
|
|
12557
14753
|
- description: Create, update, delete, and retrieve services which can be associated
|
|
12558
14754
|
with incidents.
|
|
12559
14755
|
name: Incident Services
|
|
@@ -12600,6 +14796,12 @@ tags:
|
|
|
12600
14796
|
that set number.\n\nThe Post, Patch, and Delete `manage_tags` API methods can
|
|
12601
14797
|
only be performed by\na user who has the `Manage Tags for Metrics` permission."
|
|
12602
14798
|
name: Metrics
|
|
14799
|
+
- description: 'Configure your [Datadog Opsgenie integration](https://docs.datadoghq.com/integrations/opsgenie/)
|
|
14800
|
+
|
|
14801
|
+
directly through the Datadog API.'
|
|
14802
|
+
externalDocs:
|
|
14803
|
+
url: https://docs.datadoghq.com/api/latest/opsgenie-integration
|
|
14804
|
+
name: Opsgenie Integration
|
|
12603
14805
|
- description: Create, edit, and manage your organizations. Read more about [multi-org
|
|
12604
14806
|
accounts](https://docs.datadoghq.com/account_management/multi_organization).
|
|
12605
14807
|
externalDocs:
|