datadog_api_client 2.11.0 → 2.13.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 +6 -6
- data/.generator/conftest.py +7 -0
- data/.generator/poetry.lock +104 -133
- data/.generator/pyproject.toml +7 -7
- data/.generator/schemas/v1/openapi.yaml +217 -60
- data/.generator/schemas/v2/openapi.yaml +3356 -447
- data/.generator/src/generator/formatter.py +14 -3
- data/.generator/src/generator/openapi.py +4 -2
- data/.generator/src/generator/templates/api.j2 +1 -1
- data/.generator/src/generator/templates/model_base.j2 +7 -0
- data/.generator/src/generator/templates/model_generic.j2 +34 -2
- data/.github/workflows/test_integration.yml +7 -1
- data/CHANGELOG.md +61 -0
- data/examples/v1/dashboards/CreateDashboard_1284514532.rb +43 -0
- data/examples/v1/dashboards/CreateDashboard_2261785072.rb +47 -0
- data/examples/v1/dashboards/CreateDashboard_3513586382.rb +74 -0
- data/examples/v1/dashboards/CreateDashboard_3562282606.rb +1 -0
- data/examples/v1/downtimes/ListMonitorDowntimes.rb +1 -1
- data/examples/v1/organizations/UpdateOrg.rb +1 -1
- data/examples/v1/synthetics/GetSyntheticsDefaultLocations.rb +5 -0
- data/examples/v1/synthetics/GetSyntheticsDefaultLocations_746853380.rb +5 -0
- data/examples/v1/users/CreateUser.rb +1 -1
- data/examples/v1/users/CreateUser_266604071.rb +13 -0
- data/examples/v1/users/UpdateUser.rb +1 -1
- data/examples/v2/ci-visibility-pipelines/CreateCIAppPipelineEvent.rb +28 -0
- data/examples/v2/ci-visibility-pipelines/CreateCIAppPipelineEvent_129899466.rb +29 -0
- data/examples/v2/confluent-cloud/CreateConfluentAccount.rb +1 -0
- data/examples/v2/confluent-cloud/CreateConfluentResource.rb +1 -0
- data/examples/v2/confluent-cloud/UpdateConfluentResource.rb +1 -0
- data/examples/v2/downtimes/CancelDowntime.rb +11 -0
- data/examples/v2/downtimes/CreateDowntime.rb +26 -0
- data/examples/v2/downtimes/GetDowntime.rb +11 -0
- data/examples/v2/downtimes/ListDowntimes.rb +8 -0
- data/examples/v2/downtimes/ListMonitorDowntimes.rb +8 -0
- data/examples/v2/downtimes/ListMonitorDowntimes_128979780.rb +8 -0
- data/examples/v2/downtimes/UpdateDowntime.rb +21 -0
- data/examples/v2/gcp-integration/CreateGCPSTSAccount.rb +1 -1
- data/examples/v2/gcp-integration/UpdateGCPSTSAccount.rb +9 -4
- data/examples/v2/logs/ListLogsGet_2034110533.rb +3 -1
- data/examples/v2/metrics/ListActiveMetricConfigurations.rb +1 -1
- data/examples/v2/metrics/ListVolumesByMetricName.rb +1 -1
- data/examples/v2/security-monitoring/CreateSecurityMonitoringRule_1092490364.rb +10 -0
- data/examples/v2/security-monitoring/UpdateFinding.rb +23 -0
- data/examples/v2/spans/AggregateSpans.rb +25 -0
- data/examples/v2/spans/ListSpans.rb +25 -0
- data/examples/v2/spans/ListSpansGet.rb +5 -0
- data/examples/v2/spans/ListSpansGet_1130763422.rb +8 -0
- data/examples/v2/spans/ListSpans_3495563906.rb +25 -0
- data/lib/datadog_api_client/configuration.rb +7 -52
- data/lib/datadog_api_client/inflector.rb +122 -0
- data/lib/datadog_api_client/v1/api/downtimes_api.rb +2 -2
- data/lib/datadog_api_client/v1/api/gcp_integration_api.rb +16 -4
- data/lib/datadog_api_client/v1/api/monitors_api.rb +14 -0
- data/lib/datadog_api_client/v1/api/synthetics_api.rb +60 -0
- data/lib/datadog_api_client/v1/model_base.rb +7 -0
- data/lib/datadog_api_client/v1/models/api_key_list_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/api_key_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/application_key_list_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/application_key_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/authentication_validation_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/aws_account.rb +0 -7
- data/lib/datadog_api_client/v1/models/aws_account_create_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/aws_account_delete_request.rb +0 -7
- data/lib/datadog_api_client/v1/models/aws_account_list_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/aws_logs_async_error.rb +0 -7
- data/lib/datadog_api_client/v1/models/aws_logs_async_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/aws_logs_lambda.rb +0 -7
- data/lib/datadog_api_client/v1/models/aws_logs_list_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/aws_logs_list_services_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/aws_tag_filter.rb +0 -7
- data/lib/datadog_api_client/v1/models/aws_tag_filter_create_request.rb +0 -7
- data/lib/datadog_api_client/v1/models/aws_tag_filter_delete_request.rb +0 -7
- data/lib/datadog_api_client/v1/models/aws_tag_filter_list_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/azure_account.rb +0 -7
- data/lib/datadog_api_client/v1/models/canceled_downtimes_ids.rb +0 -7
- data/lib/datadog_api_client/v1/models/change_widget_request.rb +1 -8
- data/lib/datadog_api_client/v1/models/check_can_delete_monitor_response_data.rb +0 -7
- data/lib/datadog_api_client/v1/models/check_can_delete_slo_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/check_can_delete_slo_response_data.rb +0 -7
- data/lib/datadog_api_client/v1/models/creator.rb +0 -7
- data/lib/datadog_api_client/v1/models/dashboard_delete_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/dashboard_global_time.rb +0 -7
- data/lib/datadog_api_client/v1/models/dashboard_list_delete_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/dashboard_list_list_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/dashboard_summary.rb +0 -7
- data/lib/datadog_api_client/v1/models/dashboard_summary_definition.rb +0 -7
- data/lib/datadog_api_client/v1/models/dashboard_template_variable_preset.rb +0 -7
- data/lib/datadog_api_client/v1/models/delete_shared_dashboard_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/deleted_monitor.rb +0 -7
- data/lib/datadog_api_client/v1/models/distribution_widget_request.rb +0 -7
- data/lib/datadog_api_client/v1/models/distribution_widget_x_axis.rb +0 -7
- data/lib/datadog_api_client/v1/models/distribution_widget_y_axis.rb +0 -7
- data/lib/datadog_api_client/v1/models/event_create_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/event_list_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/event_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/formula_and_function_cloud_cost_data_source.rb +26 -0
- data/lib/datadog_api_client/v1/models/formula_and_function_cloud_cost_query_definition.rb +150 -0
- data/lib/datadog_api_client/v1/models/formula_and_function_query_definition.rb +2 -1
- data/lib/datadog_api_client/v1/models/formula_and_function_response_format.rb +2 -1
- data/lib/datadog_api_client/v1/models/formula_and_function_slo_query_definition.rb +11 -1
- data/lib/datadog_api_client/v1/models/gcp_account.rb +0 -7
- data/lib/datadog_api_client/v1/models/geomap_widget_request.rb +24 -9
- data/lib/datadog_api_client/v1/models/graph_snapshot.rb +0 -7
- data/lib/datadog_api_client/v1/models/heat_map_widget_request.rb +0 -7
- data/lib/datadog_api_client/v1/models/host.rb +0 -7
- data/lib/datadog_api_client/v1/models/host_list_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/host_map_request.rb +0 -7
- data/lib/datadog_api_client/v1/models/host_map_widget_definition_requests.rb +0 -7
- data/lib/datadog_api_client/v1/models/host_map_widget_definition_style.rb +0 -7
- data/lib/datadog_api_client/v1/models/host_meta.rb +0 -7
- data/lib/datadog_api_client/v1/models/host_meta_install_method.rb +0 -7
- data/lib/datadog_api_client/v1/models/host_metrics.rb +0 -7
- data/lib/datadog_api_client/v1/models/host_mute_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/host_mute_settings.rb +0 -7
- data/lib/datadog_api_client/v1/models/host_tags.rb +0 -7
- data/lib/datadog_api_client/v1/models/host_totals.rb +0 -7
- data/lib/datadog_api_client/v1/models/hourly_usage_attribution_body.rb +0 -7
- data/lib/datadog_api_client/v1/models/hourly_usage_attribution_metadata.rb +0 -7
- data/lib/datadog_api_client/v1/models/hourly_usage_attribution_pagination.rb +0 -7
- data/lib/datadog_api_client/v1/models/hourly_usage_attribution_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/intake_payload_accepted.rb +0 -7
- data/lib/datadog_api_client/v1/models/ip_prefixes_agents.rb +0 -7
- data/lib/datadog_api_client/v1/models/ip_prefixes_api.rb +0 -7
- data/lib/datadog_api_client/v1/models/ip_prefixes_apm.rb +0 -7
- data/lib/datadog_api_client/v1/models/ip_prefixes_logs.rb +0 -7
- data/lib/datadog_api_client/v1/models/ip_prefixes_orchestrator.rb +0 -7
- data/lib/datadog_api_client/v1/models/ip_prefixes_process.rb +0 -7
- data/lib/datadog_api_client/v1/models/ip_prefixes_remote_configuration.rb +94 -0
- data/lib/datadog_api_client/v1/models/ip_prefixes_synthetics.rb +0 -7
- data/lib/datadog_api_client/v1/models/ip_prefixes_synthetics_private_locations.rb +0 -7
- data/lib/datadog_api_client/v1/models/ip_prefixes_webhooks.rb +0 -7
- data/lib/datadog_api_client/v1/models/ip_ranges.rb +11 -8
- data/lib/datadog_api_client/v1/models/log.rb +0 -7
- data/lib/datadog_api_client/v1/models/log_content.rb +0 -7
- data/lib/datadog_api_client/v1/models/log_query_definition.rb +0 -7
- data/lib/datadog_api_client/v1/models/logs_api_error.rb +0 -7
- data/lib/datadog_api_client/v1/models/logs_api_error_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/logs_by_retention.rb +0 -7
- data/lib/datadog_api_client/v1/models/logs_by_retention_monthly_usage.rb +0 -7
- data/lib/datadog_api_client/v1/models/logs_by_retention_org_usage.rb +0 -7
- data/lib/datadog_api_client/v1/models/logs_by_retention_orgs.rb +0 -7
- data/lib/datadog_api_client/v1/models/logs_category_processor_category.rb +0 -7
- data/lib/datadog_api_client/v1/models/logs_filter.rb +0 -7
- data/lib/datadog_api_client/v1/models/logs_index_list_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/logs_list_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/logs_retention_agg_sum_usage.rb +0 -7
- data/lib/datadog_api_client/v1/models/logs_retention_sum_usage.rb +0 -7
- data/lib/datadog_api_client/v1/models/metric_metadata.rb +0 -7
- data/lib/datadog_api_client/v1/models/metric_search_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/metric_search_response_results.rb +0 -7
- data/lib/datadog_api_client/v1/models/metrics_list_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/metrics_query_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/metrics_query_unit.rb +0 -7
- data/lib/datadog_api_client/v1/models/monitor_group_search_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/monitor_group_search_response_counts.rb +0 -7
- data/lib/datadog_api_client/v1/models/monitor_group_search_result.rb +0 -7
- data/lib/datadog_api_client/v1/models/monitor_options_aggregation.rb +0 -7
- data/lib/datadog_api_client/v1/models/monitor_options_scheduling_options.rb +0 -7
- data/lib/datadog_api_client/v1/models/monitor_search_count_item.rb +0 -7
- data/lib/datadog_api_client/v1/models/monitor_search_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/monitor_search_response_counts.rb +0 -7
- data/lib/datadog_api_client/v1/models/monitor_search_response_metadata.rb +0 -7
- data/lib/datadog_api_client/v1/models/monitor_search_result.rb +0 -7
- data/lib/datadog_api_client/v1/models/monitor_search_result_notification.rb +0 -7
- data/lib/datadog_api_client/v1/models/monitor_state.rb +0 -7
- data/lib/datadog_api_client/v1/models/monitor_state_group.rb +0 -7
- data/lib/datadog_api_client/v1/models/monitor_threshold_window_options.rb +0 -7
- data/lib/datadog_api_client/v1/models/monitor_thresholds.rb +0 -7
- data/lib/datadog_api_client/v1/models/monitor_type.rb +1 -0
- data/lib/datadog_api_client/v1/models/monitor_update_request.rb +1 -0
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_body.rb +0 -7
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_metadata.rb +0 -7
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_pagination.rb +0 -7
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_values.rb +0 -7
- data/lib/datadog_api_client/v1/models/notebook_author.rb +0 -7
- data/lib/datadog_api_client/v1/models/notebook_metadata.rb +0 -7
- data/lib/datadog_api_client/v1/models/notebook_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/notebooks_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/notebooks_response_meta.rb +0 -7
- data/lib/datadog_api_client/v1/models/notebooks_response_page.rb +0 -7
- data/lib/datadog_api_client/v1/models/org_downgraded_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/organization_billing.rb +0 -7
- data/lib/datadog_api_client/v1/models/organization_create_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/organization_list_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/organization_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/organization_settings.rb +8 -7
- data/lib/datadog_api_client/v1/models/organization_settings_saml.rb +0 -7
- data/lib/datadog_api_client/v1/models/organization_settings_saml_autocreate_users_domains.rb +0 -7
- data/lib/datadog_api_client/v1/models/organization_settings_saml_idp_initiated_login.rb +0 -7
- data/lib/datadog_api_client/v1/models/organization_settings_saml_strict_mode.rb +0 -7
- data/lib/datadog_api_client/v1/models/organization_subscription.rb +0 -7
- data/lib/datadog_api_client/v1/models/pagination.rb +0 -7
- data/lib/datadog_api_client/v1/models/query_value_widget_request.rb +1 -8
- data/lib/datadog_api_client/v1/models/response_meta_attributes.rb +0 -7
- data/lib/datadog_api_client/v1/models/scatter_plot_request.rb +0 -7
- data/lib/datadog_api_client/v1/models/scatter_plot_widget_definition_requests.rb +0 -7
- data/lib/datadog_api_client/v1/models/scatterplot_table_request.rb +1 -8
- data/lib/datadog_api_client/v1/models/search_service_level_objective.rb +0 -7
- data/lib/datadog_api_client/v1/models/search_service_level_objective_attributes.rb +0 -7
- data/lib/datadog_api_client/v1/models/search_service_level_objective_data.rb +0 -7
- data/lib/datadog_api_client/v1/models/search_slo_query.rb +0 -7
- data/lib/datadog_api_client/v1/models/search_slo_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/search_slo_response_data.rb +0 -7
- data/lib/datadog_api_client/v1/models/search_slo_response_data_attributes.rb +0 -7
- data/lib/datadog_api_client/v1/models/search_slo_response_data_attributes_facets.rb +0 -7
- data/lib/datadog_api_client/v1/models/search_slo_response_data_attributes_facets_object_int.rb +0 -7
- data/lib/datadog_api_client/v1/models/search_slo_response_data_attributes_facets_object_string.rb +0 -7
- data/lib/datadog_api_client/v1/models/search_slo_response_links.rb +0 -7
- data/lib/datadog_api_client/v1/models/search_slo_response_meta.rb +0 -7
- data/lib/datadog_api_client/v1/models/search_slo_response_meta_page.rb +0 -7
- data/lib/datadog_api_client/v1/models/selectable_template_variable_items.rb +0 -7
- data/lib/datadog_api_client/v1/models/shared_dashboard_author.rb +0 -7
- data/lib/datadog_api_client/v1/models/shared_dashboard_invites_data_object_attributes.rb +0 -7
- data/lib/datadog_api_client/v1/models/shared_dashboard_invites_meta.rb +0 -7
- data/lib/datadog_api_client/v1/models/shared_dashboard_invites_meta_page.rb +0 -7
- data/lib/datadog_api_client/v1/models/shared_dashboard_update_request.rb +0 -7
- data/lib/datadog_api_client/v1/models/shared_dashboard_update_request_global_time.rb +0 -7
- data/lib/datadog_api_client/v1/models/slack_integration_channel.rb +0 -7
- data/lib/datadog_api_client/v1/models/slack_integration_channel_display.rb +0 -7
- data/lib/datadog_api_client/v1/models/slo_bulk_delete_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/slo_bulk_delete_response_data.rb +0 -7
- data/lib/datadog_api_client/v1/models/slo_correction.rb +0 -7
- data/lib/datadog_api_client/v1/models/slo_correction_create_request.rb +0 -7
- data/lib/datadog_api_client/v1/models/slo_correction_list_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/slo_correction_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/slo_correction_response_attributes.rb +0 -7
- data/lib/datadog_api_client/v1/models/slo_correction_response_attributes_modifier.rb +0 -7
- data/lib/datadog_api_client/v1/models/slo_correction_update_data.rb +0 -7
- data/lib/datadog_api_client/v1/models/slo_correction_update_request.rb +0 -7
- data/lib/datadog_api_client/v1/models/slo_correction_update_request_attributes.rb +0 -7
- data/lib/datadog_api_client/v1/models/slo_creator.rb +0 -7
- data/lib/datadog_api_client/v1/models/slo_delete_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/slo_history_metrics_series_metadata.rb +0 -7
- data/lib/datadog_api_client/v1/models/slo_history_metrics_series_metadata_unit.rb +0 -7
- data/lib/datadog_api_client/v1/models/slo_history_monitor.rb +0 -7
- data/lib/datadog_api_client/v1/models/slo_history_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/slo_history_response_data.rb +0 -7
- data/lib/datadog_api_client/v1/models/slo_history_response_error.rb +0 -7
- data/lib/datadog_api_client/v1/models/slo_history_sli_data.rb +0 -7
- data/lib/datadog_api_client/v1/models/slo_list_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/slo_list_response_metadata.rb +0 -7
- data/lib/datadog_api_client/v1/models/slo_list_response_metadata_page.rb +0 -7
- data/lib/datadog_api_client/v1/models/slo_overall_statuses.rb +0 -7
- data/lib/datadog_api_client/v1/models/slo_raw_error_budget_remaining.rb +0 -7
- data/lib/datadog_api_client/v1/models/slo_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/slo_response_data.rb +0 -7
- data/lib/datadog_api_client/v1/models/slo_status.rb +0 -7
- data/lib/datadog_api_client/v1/models/successful_signal_update_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/sunburst_widget_request.rb +1 -8
- data/lib/datadog_api_client/v1/models/synthetics_api_test_config.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_api_test_result_data.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_api_test_result_failure.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_api_test_result_full.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_api_test_result_short.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_api_test_result_short_result.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_assertion_json_path_target_target.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_assertion_operator.rb +1 -0
- data/lib/datadog_api_client/v1/models/synthetics_assertion_x_path_target_target.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_batch_details.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_batch_details_data.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_batch_result.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_browser_test_result_data.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_browser_test_result_failure.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_browser_test_result_full.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_browser_test_result_short.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_browser_test_result_short_result.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_ci_batch_metadata.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_ci_batch_metadata_ci.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_ci_batch_metadata_git.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_ci_batch_metadata_pipeline.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_ci_batch_metadata_provider.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_ci_test_body.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_core_web_vitals.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_delete_tests_payload.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_delete_tests_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_deleted_test.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_get_api_test_latest_results_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_get_browser_test_latest_results_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_global_variable_attributes.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_global_variable_options.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_global_variable_value.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_list_global_variables_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_list_tests_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_location.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_locations.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_parsing_options.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_private_location_creation_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_private_location_creation_response_result_encryption.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_private_location_metadata.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_private_location_secrets.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_private_location_secrets_authentication.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_private_location_secrets_config_decryption.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_ssl_certificate.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_ssl_certificate_issuer.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_ssl_certificate_subject.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_step.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_step_detail.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_test_ci_options.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_test_config.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_test_details.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_test_options_retry.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_test_options_scheduling.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_test_request_certificate.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_test_request_certificate_item.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_timing.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_trigger_ci_test_location.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_trigger_ci_test_run_result.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_trigger_ci_tests_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/synthetics_update_test_pause_status_payload.rb +0 -7
- data/lib/datadog_api_client/v1/models/table_widget_request.rb +1 -8
- data/lib/datadog_api_client/v1/models/tag_to_hosts.rb +0 -7
- data/lib/datadog_api_client/v1/models/timeseries_widget_request.rb +1 -8
- data/lib/datadog_api_client/v1/models/toplist_widget_request.rb +1 -1
- data/lib/datadog_api_client/v1/models/topology_request.rb +0 -7
- data/lib/datadog_api_client/v1/models/tree_map_widget_request.rb +1 -8
- data/lib/datadog_api_client/v1/models/usage_analyzed_logs_hour.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_analyzed_logs_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_attribution_aggregates_body.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_attribution_body.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_attribution_metadata.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_attribution_pagination.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_attribution_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_attribution_values.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_audit_logs_hour.rb +8 -7
- data/lib/datadog_api_client/v1/models/usage_audit_logs_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_billable_summary_body.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_billable_summary_hour.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_billable_summary_keys.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_billable_summary_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_ci_visibility_hour.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_ci_visibility_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_cloud_security_posture_management_hour.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_cloud_security_posture_management_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_custom_reports_attributes.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_custom_reports_data.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_custom_reports_meta.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_custom_reports_page.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_custom_reports_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_cws_hour.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_cws_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_dbm_hour.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_dbm_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_fargate_hour.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_fargate_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_host_hour.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_hosts_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_incident_management_hour.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_incident_management_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_indexed_spans_hour.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_indexed_spans_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_ingested_spans_hour.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_ingested_spans_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_iot_hour.rb +8 -7
- data/lib/datadog_api_client/v1/models/usage_iot_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_lambda_hour.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_lambda_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_logs_by_index_hour.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_logs_by_index_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_logs_by_retention_hour.rb +1 -7
- data/lib/datadog_api_client/v1/models/usage_logs_by_retention_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_logs_hour.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_logs_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_network_flows_hour.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_network_flows_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_network_hosts_hour.rb +8 -7
- data/lib/datadog_api_client/v1/models/usage_network_hosts_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_online_archive_hour.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_online_archive_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_profiling_hour.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_profiling_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_rum_sessions_hour.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_rum_sessions_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_rum_units_hour.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_rum_units_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_sds_hour.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_sds_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_snmp_hour.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_snmp_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_specified_custom_reports_attributes.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_specified_custom_reports_data.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_specified_custom_reports_meta.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_specified_custom_reports_page.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_specified_custom_reports_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_summary_date.rb +32 -9
- data/lib/datadog_api_client/v1/models/usage_summary_date_org.rb +32 -9
- data/lib/datadog_api_client/v1/models/usage_summary_response.rb +32 -9
- data/lib/datadog_api_client/v1/models/usage_synthetics_api_hour.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_synthetics_api_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_synthetics_browser_hour.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_synthetics_browser_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_synthetics_hour.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_synthetics_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_timeseries_hour.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_timeseries_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_top_avg_metrics_hour.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_top_avg_metrics_metadata.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_top_avg_metrics_pagination.rb +0 -7
- data/lib/datadog_api_client/v1/models/usage_top_avg_metrics_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/user.rb +8 -7
- data/lib/datadog_api_client/v1/models/user_disable_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/user_list_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/user_response.rb +0 -7
- data/lib/datadog_api_client/v1/models/webhooks_integration_custom_variable_update_request.rb +0 -7
- data/lib/datadog_api_client/v1/models/webhooks_integration_update_request.rb +0 -7
- data/lib/datadog_api_client/v1/models/widget_axis.rb +5 -12
- data/lib/datadog_api_client/v1/models/widget_custom_link.rb +0 -7
- data/lib/datadog_api_client/v1/models/widget_display_type.rb +1 -0
- data/lib/datadog_api_client/v1/models/widget_formula_limit.rb +0 -7
- data/lib/datadog_api_client/v1/models/widget_formula_style.rb +0 -7
- data/lib/datadog_api_client/v1/models/widget_request_style.rb +0 -7
- data/lib/datadog_api_client/v1/models/widget_style.rb +0 -7
- data/lib/datadog_api_client/v1/models/widget_time.rb +0 -7
- data/lib/datadog_api_client/v2/api/authn_mappings_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/ci_visibility_pipelines_api.rb +73 -2
- data/lib/datadog_api_client/v2/api/ci_visibility_tests_api.rb +2 -2
- data/lib/datadog_api_client/v2/api/downtimes_api.rb +462 -0
- data/lib/datadog_api_client/v2/api/incident_services_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/incident_teams_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/incidents_api.rb +2 -2
- data/lib/datadog_api_client/v2/api/key_management_api.rb +3 -3
- data/lib/datadog_api_client/v2/api/logs_api.rb +2 -2
- data/lib/datadog_api_client/v2/api/metrics_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/roles_api.rb +2 -2
- data/lib/datadog_api_client/v2/api/rum_api.rb +2 -2
- data/lib/datadog_api_client/v2/api/security_monitoring_api.rb +82 -1
- data/lib/datadog_api_client/v2/api/service_accounts_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/service_definition_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/spans_api.rb +294 -0
- data/lib/datadog_api_client/v2/api/teams_api.rb +2 -2
- data/lib/datadog_api_client/v2/api/users_api.rb +1 -1
- data/lib/datadog_api_client/v2/model_base.rb +7 -0
- data/lib/datadog_api_client/v2/models/api_key_relationships.rb +0 -7
- data/lib/datadog_api_client/v2/models/api_key_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/api_keys_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/application_key_relationships.rb +0 -7
- data/lib/datadog_api_client/v2/models/application_key_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/application_key_update_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/audit_logs_event.rb +0 -7
- data/lib/datadog_api_client/v2/models/audit_logs_event_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/audit_logs_events_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/audit_logs_query_filter.rb +0 -7
- data/lib/datadog_api_client/v2/models/audit_logs_query_options.rb +0 -7
- data/lib/datadog_api_client/v2/models/audit_logs_response_links.rb +0 -7
- data/lib/datadog_api_client/v2/models/audit_logs_response_metadata.rb +0 -7
- data/lib/datadog_api_client/v2/models/audit_logs_response_page.rb +0 -7
- data/lib/datadog_api_client/v2/models/audit_logs_search_events_request.rb +0 -7
- data/lib/datadog_api_client/v2/models/audit_logs_warning.rb +0 -7
- data/lib/datadog_api_client/v2/models/authn_mapping_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/authn_mapping_create_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/authn_mapping_create_relationships.rb +0 -7
- data/lib/datadog_api_client/v2/models/authn_mapping_relationships.rb +0 -7
- data/lib/datadog_api_client/v2/models/authn_mapping_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/authn_mapping_update_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/authn_mapping_update_relationships.rb +0 -7
- data/lib/datadog_api_client/v2/models/authn_mappings_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/chargeback_breakdown.rb +0 -7
- data/lib/datadog_api_client/v2/models/ci_app_aggregate_bucket_value_timeseries_point.rb +0 -7
- data/lib/datadog_api_client/v2/models/ci_app_aggregate_sort.rb +0 -7
- data/lib/datadog_api_client/v2/models/ci_app_ci_error.rb +149 -0
- data/lib/datadog_api_client/v2/models/ci_app_ci_error_domain.rb +28 -0
- data/lib/datadog_api_client/v2/models/ci_app_create_pipeline_event_request.rb +80 -0
- data/lib/datadog_api_client/v2/models/ci_app_create_pipeline_event_request_attributes.rb +118 -0
- data/lib/datadog_api_client/v2/models/ci_app_create_pipeline_event_request_attributes_resource.rb +65 -0
- data/lib/datadog_api_client/v2/models/ci_app_create_pipeline_event_request_data.rb +90 -0
- data/lib/datadog_api_client/v2/models/ci_app_create_pipeline_event_request_data_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/ci_app_event_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/ci_app_git_info.rb +253 -0
- data/lib/datadog_api_client/v2/models/ci_app_host_info.rb +112 -0
- data/lib/datadog_api_client/v2/models/ci_app_pipeline_event.rb +0 -7
- data/lib/datadog_api_client/v2/models/ci_app_pipeline_event_job.rb +401 -0
- data/lib/datadog_api_client/v2/models/ci_app_pipeline_event_job_level.rb +26 -0
- data/lib/datadog_api_client/v2/models/ci_app_pipeline_event_job_status.rb +29 -0
- data/lib/datadog_api_client/v2/models/ci_app_pipeline_event_parent_pipeline.rb +108 -0
- data/lib/datadog_api_client/v2/models/ci_app_pipeline_event_pipeline.rb +402 -0
- data/lib/datadog_api_client/v2/models/ci_app_pipeline_event_pipeline_level.rb +26 -0
- data/lib/datadog_api_client/v2/models/ci_app_pipeline_event_pipeline_status.rb +30 -0
- data/lib/datadog_api_client/v2/models/ci_app_pipeline_event_previous_pipeline.rb +108 -0
- data/lib/datadog_api_client/v2/models/ci_app_pipeline_event_stage.rb +358 -0
- data/lib/datadog_api_client/v2/models/ci_app_pipeline_event_stage_level.rb +26 -0
- data/lib/datadog_api_client/v2/models/ci_app_pipeline_event_stage_status.rb +29 -0
- data/lib/datadog_api_client/v2/models/ci_app_pipeline_event_step.rb +378 -0
- data/lib/datadog_api_client/v2/models/ci_app_pipeline_event_step_level.rb +26 -0
- data/lib/datadog_api_client/v2/models/ci_app_pipeline_event_step_status.rb +27 -0
- data/lib/datadog_api_client/v2/models/ci_app_pipeline_event_type_name.rb +1 -1
- data/lib/datadog_api_client/v2/models/ci_app_pipeline_events_request.rb +0 -7
- data/lib/datadog_api_client/v2/models/ci_app_pipeline_events_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/ci_app_pipelines_aggregate_request.rb +0 -7
- data/lib/datadog_api_client/v2/models/ci_app_pipelines_aggregation_buckets_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/ci_app_pipelines_analytics_aggregate_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/ci_app_pipelines_bucket_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/ci_app_pipelines_query_filter.rb +0 -7
- data/lib/datadog_api_client/v2/models/ci_app_query_options.rb +0 -7
- data/lib/datadog_api_client/v2/models/ci_app_response_links.rb +0 -7
- data/lib/datadog_api_client/v2/models/ci_app_response_metadata.rb +0 -7
- data/lib/datadog_api_client/v2/models/ci_app_response_metadata_with_pagination.rb +0 -7
- data/lib/datadog_api_client/v2/models/ci_app_response_page.rb +0 -7
- data/lib/datadog_api_client/v2/models/ci_app_test_event.rb +0 -7
- data/lib/datadog_api_client/v2/models/ci_app_test_event_type_name.rb +1 -1
- data/lib/datadog_api_client/v2/models/ci_app_test_events_request.rb +0 -7
- data/lib/datadog_api_client/v2/models/ci_app_test_events_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/ci_app_tests_aggregate_request.rb +0 -7
- data/lib/datadog_api_client/v2/models/ci_app_tests_aggregation_buckets_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/ci_app_tests_analytics_aggregate_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/ci_app_tests_bucket_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/ci_app_tests_query_filter.rb +0 -7
- data/lib/datadog_api_client/v2/models/ci_app_warning.rb +0 -7
- data/lib/datadog_api_client/v2/models/cloud_configuration_compliance_rule_options.rb +0 -7
- data/lib/datadog_api_client/v2/models/cloud_configuration_rule_compliance_signal_options.rb +0 -7
- data/lib/datadog_api_client/v2/models/cloud_configuration_rule_create_payload.rb +13 -1
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_attributes.rb +41 -8
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_creator_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_data.rb +0 -7
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_update_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_updater_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rules_list_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/cloudflare_account_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/cloudflare_account_update_request_data.rb +0 -7
- data/lib/datadog_api_client/v2/models/cloudflare_accounts_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/confluent_account_resource_attributes.rb +11 -1
- data/lib/datadog_api_client/v2/models/confluent_account_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/confluent_accounts_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/confluent_resource_request_attributes.rb +11 -1
- data/lib/datadog_api_client/v2/models/confluent_resource_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/confluent_resource_response_attributes.rb +21 -1
- data/lib/datadog_api_client/v2/models/confluent_resources_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/cost_by_org.rb +0 -7
- data/lib/datadog_api_client/v2/models/cost_by_org_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/cost_by_org_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/creator.rb +0 -7
- data/lib/datadog_api_client/v2/models/dashboard_list_add_items_request.rb +0 -7
- data/lib/datadog_api_client/v2/models/dashboard_list_add_items_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/dashboard_list_delete_items_request.rb +0 -7
- data/lib/datadog_api_client/v2/models/dashboard_list_delete_items_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/dashboard_list_item.rb +12 -1
- data/lib/datadog_api_client/v2/models/dashboard_list_update_items_request.rb +0 -7
- data/lib/datadog_api_client/v2/models/dashboard_list_update_items_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/data_scalar_column.rb +0 -7
- data/lib/datadog_api_client/v2/models/detailed_finding.rb +0 -7
- data/lib/datadog_api_client/v2/models/downtime_create_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/downtime_create_request_attributes.rb +194 -0
- data/lib/datadog_api_client/v2/models/downtime_create_request_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/downtime_included_monitor_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/downtime_meta.rb +80 -0
- data/lib/datadog_api_client/v2/models/downtime_meta_page.rb +80 -0
- data/lib/datadog_api_client/v2/models/downtime_monitor_identifier.rb +63 -0
- data/lib/datadog_api_client/v2/models/downtime_monitor_identifier_id.rb +98 -0
- data/lib/datadog_api_client/v2/models/downtime_monitor_identifier_tags.rb +107 -0
- data/lib/datadog_api_client/v2/models/downtime_monitor_included_attributes.rb +80 -0
- data/lib/datadog_api_client/v2/models/downtime_monitor_included_item.rb +100 -0
- data/lib/datadog_api_client/v2/models/downtime_notify_end_state_actions.rb +27 -0
- data/lib/datadog_api_client/v2/models/downtime_notify_end_state_types.rb +28 -0
- data/lib/datadog_api_client/v2/models/downtime_relationships.rb +90 -0
- data/lib/datadog_api_client/v2/models/downtime_relationships_created_by.rb +88 -0
- data/lib/datadog_api_client/v2/models/downtime_relationships_created_by_data.rb +90 -0
- data/lib/datadog_api_client/v2/models/downtime_relationships_monitor.rb +88 -0
- data/lib/datadog_api_client/v2/models/downtime_relationships_monitor_data.rb +90 -0
- data/lib/datadog_api_client/v2/models/downtime_resource_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/downtime_response.rb +95 -0
- data/lib/datadog_api_client/v2/models/downtime_response_attributes.rb +208 -0
- data/lib/datadog_api_client/v2/models/downtime_response_data.rb +110 -0
- data/lib/datadog_api_client/v2/models/downtime_response_included_item.rb +63 -0
- data/lib/datadog_api_client/v2/models/downtime_schedule_create_request.rb +63 -0
- data/lib/datadog_api_client/v2/models/downtime_schedule_current_downtime_response.rb +100 -0
- data/lib/datadog_api_client/v2/models/downtime_schedule_one_time_create_update_request.rb +101 -0
- data/lib/datadog_api_client/v2/models/downtime_schedule_one_time_response.rb +98 -0
- data/lib/datadog_api_client/v2/models/downtime_schedule_recurrence_create_update_request.rb +143 -0
- data/lib/datadog_api_client/v2/models/downtime_schedule_recurrence_response.rb +106 -0
- data/lib/datadog_api_client/v2/models/downtime_schedule_recurrences_create_request.rb +110 -0
- data/lib/datadog_api_client/v2/models/downtime_schedule_recurrences_response.rb +131 -0
- data/lib/datadog_api_client/v2/models/downtime_schedule_recurrences_update_request.rb +92 -0
- data/lib/datadog_api_client/v2/models/downtime_schedule_response.rb +65 -0
- data/lib/datadog_api_client/v2/models/downtime_schedule_update_request.rb +63 -0
- data/lib/datadog_api_client/v2/models/downtime_status.rb +29 -0
- data/lib/datadog_api_client/v2/models/downtime_update_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/downtime_update_request_attributes.rb +165 -0
- data/lib/datadog_api_client/v2/models/downtime_update_request_data.rb +140 -0
- data/lib/datadog_api_client/v2/models/event.rb +0 -7
- data/lib/datadog_api_client/v2/models/event_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/event_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/event_response_attributes.rb +11 -8
- data/lib/datadog_api_client/v2/models/events_group_by_sort.rb +1 -1
- data/lib/datadog_api_client/v2/models/events_list_request.rb +0 -7
- data/lib/datadog_api_client/v2/models/events_list_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/events_list_response_links.rb +0 -7
- data/lib/datadog_api_client/v2/models/events_query_filter.rb +0 -7
- data/lib/datadog_api_client/v2/models/events_query_options.rb +0 -7
- data/lib/datadog_api_client/v2/models/events_response_metadata.rb +11 -8
- data/lib/datadog_api_client/v2/models/events_response_metadata_page.rb +0 -7
- data/lib/datadog_api_client/v2/models/events_search.rb +0 -7
- data/lib/datadog_api_client/v2/models/events_warning.rb +0 -7
- data/lib/datadog_api_client/v2/models/fastly_account_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/fastly_account_update_request_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/fastly_account_update_request_data.rb +0 -7
- data/lib/datadog_api_client/v2/models/fastly_accounts_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/fastly_service_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/fastly_service_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/fastly_services_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/finding.rb +1 -8
- data/lib/datadog_api_client/v2/models/finding_mute.rb +5 -12
- data/lib/datadog_api_client/v2/models/finding_mute_reason.rb +5 -2
- data/lib/datadog_api_client/v2/models/finding_rule.rb +0 -7
- data/lib/datadog_api_client/v2/models/full_api_key.rb +0 -7
- data/lib/datadog_api_client/v2/models/full_application_key.rb +0 -7
- data/lib/datadog_api_client/v2/models/gcp_service_account_meta.rb +0 -7
- data/lib/datadog_api_client/v2/models/gcpsts_delegate_account.rb +0 -7
- data/lib/datadog_api_client/v2/models/gcpsts_delegate_account_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/gcpsts_delegate_account_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/gcpsts_service_account.rb +0 -7
- data/lib/datadog_api_client/v2/models/gcpsts_service_account_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/gcpsts_service_account_create_request.rb +0 -7
- data/lib/datadog_api_client/v2/models/gcpsts_service_account_data.rb +0 -7
- data/lib/datadog_api_client/v2/models/gcpsts_service_account_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/gcpsts_service_account_update_request.rb +0 -7
- data/lib/datadog_api_client/v2/models/gcpsts_service_account_update_request_data.rb +0 -7
- data/lib/datadog_api_client/v2/models/gcpsts_service_accounts_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/group_scalar_column.rb +0 -7
- data/lib/datadog_api_client/v2/models/hourly_usage.rb +0 -7
- data/lib/datadog_api_client/v2/models/hourly_usage_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/hourly_usage_measurement.rb +0 -7
- data/lib/datadog_api_client/v2/models/hourly_usage_metadata.rb +0 -7
- data/lib/datadog_api_client/v2/models/hourly_usage_pagination.rb +0 -7
- data/lib/datadog_api_client/v2/models/hourly_usage_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/http_log_error.rb +0 -7
- data/lib/datadog_api_client/v2/models/http_log_errors.rb +0 -7
- data/lib/datadog_api_client/v2/models/httpci_app_error.rb +100 -0
- data/lib/datadog_api_client/v2/models/httpci_app_errors.rb +82 -0
- data/lib/datadog_api_client/v2/models/idp_metadata_form_data.rb +0 -7
- data/lib/datadog_api_client/v2/models/incident_attachment_relationships.rb +0 -7
- data/lib/datadog_api_client/v2/models/incident_field_attributes_multiple_value.rb +0 -7
- data/lib/datadog_api_client/v2/models/incident_field_attributes_single_value.rb +0 -7
- data/lib/datadog_api_client/v2/models/incident_notification_handle.rb +0 -7
- data/lib/datadog_api_client/v2/models/incident_response_meta.rb +0 -7
- data/lib/datadog_api_client/v2/models/incident_response_meta_pagination.rb +0 -7
- data/lib/datadog_api_client/v2/models/incident_response_relationships.rb +0 -7
- data/lib/datadog_api_client/v2/models/incident_search_response_data.rb +0 -7
- data/lib/datadog_api_client/v2/models/incident_search_response_facets_data.rb +0 -7
- data/lib/datadog_api_client/v2/models/incident_search_response_meta.rb +0 -7
- data/lib/datadog_api_client/v2/models/incident_search_response_numeric_facet_data_aggregates.rb +0 -7
- data/lib/datadog_api_client/v2/models/incident_service_relationships.rb +0 -7
- data/lib/datadog_api_client/v2/models/incident_service_response_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/incident_team_relationships.rb +0 -7
- data/lib/datadog_api_client/v2/models/incident_team_response_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/incident_team_response_data.rb +0 -7
- data/lib/datadog_api_client/v2/models/incident_timeline_cell_markdown_create_attributes_content.rb +0 -7
- data/lib/datadog_api_client/v2/models/incident_update_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/incident_update_relationships.rb +0 -7
- data/lib/datadog_api_client/v2/models/intake_payload_accepted.rb +0 -7
- data/lib/datadog_api_client/v2/models/ip_allowlist_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/ip_allowlist_entry_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/ip_allowlist_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/jsonapi_error_item.rb +100 -0
- data/lib/datadog_api_client/v2/models/jsonapi_error_response.rb +100 -0
- data/lib/datadog_api_client/v2/models/list_application_keys_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/list_downtimes_response.rb +104 -0
- data/lib/datadog_api_client/v2/models/list_findings_page.rb +0 -7
- data/lib/datadog_api_client/v2/models/log.rb +0 -7
- data/lib/datadog_api_client/v2/models/log_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/logs_aggregate_bucket.rb +0 -7
- data/lib/datadog_api_client/v2/models/logs_aggregate_bucket_value_timeseries_point.rb +0 -7
- data/lib/datadog_api_client/v2/models/logs_aggregate_request.rb +0 -7
- data/lib/datadog_api_client/v2/models/logs_aggregate_request_page.rb +0 -7
- data/lib/datadog_api_client/v2/models/logs_aggregate_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/logs_aggregate_response_data.rb +0 -7
- data/lib/datadog_api_client/v2/models/logs_aggregate_sort.rb +0 -7
- data/lib/datadog_api_client/v2/models/logs_archive.rb +0 -7
- data/lib/datadog_api_client/v2/models/logs_archive_create_request.rb +0 -7
- data/lib/datadog_api_client/v2/models/logs_archive_order.rb +0 -7
- data/lib/datadog_api_client/v2/models/logs_archives.rb +0 -7
- data/lib/datadog_api_client/v2/models/logs_list_request.rb +0 -7
- data/lib/datadog_api_client/v2/models/logs_list_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/logs_list_response_links.rb +0 -7
- data/lib/datadog_api_client/v2/models/logs_metric_filter.rb +0 -7
- data/lib/datadog_api_client/v2/models/logs_metric_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/logs_metric_response_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/logs_metric_response_compute.rb +0 -7
- data/lib/datadog_api_client/v2/models/logs_metric_response_data.rb +0 -7
- data/lib/datadog_api_client/v2/models/logs_metric_response_filter.rb +0 -7
- data/lib/datadog_api_client/v2/models/logs_metric_response_group_by.rb +0 -7
- data/lib/datadog_api_client/v2/models/logs_metric_update_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/logs_metric_update_compute.rb +0 -7
- data/lib/datadog_api_client/v2/models/logs_metrics_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/logs_query_filter.rb +0 -7
- data/lib/datadog_api_client/v2/models/logs_query_options.rb +0 -7
- data/lib/datadog_api_client/v2/models/logs_response_metadata.rb +0 -7
- data/lib/datadog_api_client/v2/models/logs_response_metadata_page.rb +0 -7
- data/lib/datadog_api_client/v2/models/logs_warning.rb +0 -7
- data/lib/datadog_api_client/v2/models/metric.rb +0 -7
- data/lib/datadog_api_client/v2/models/metric_all_tags.rb +0 -7
- data/lib/datadog_api_client/v2/models/metric_all_tags_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/metric_all_tags_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/metric_bulk_tag_config_create_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/metric_bulk_tag_config_delete_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/metric_bulk_tag_config_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/metric_bulk_tag_config_status_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/metric_distinct_volume.rb +0 -7
- data/lib/datadog_api_client/v2/models/metric_distinct_volume_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/metric_estimate.rb +0 -7
- data/lib/datadog_api_client/v2/models/metric_estimate_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/metric_estimate_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/metric_ingested_indexed_volume.rb +0 -7
- data/lib/datadog_api_client/v2/models/metric_ingested_indexed_volume_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/metric_metadata.rb +0 -7
- data/lib/datadog_api_client/v2/models/metric_point.rb +0 -7
- data/lib/datadog_api_client/v2/models/metric_resource.rb +0 -7
- data/lib/datadog_api_client/v2/models/metric_suggested_tags_and_aggregations.rb +0 -7
- data/lib/datadog_api_client/v2/models/metric_suggested_tags_and_aggregations_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/metric_suggested_tags_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/metric_tag_configuration.rb +0 -7
- data/lib/datadog_api_client/v2/models/metric_tag_configuration_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/metric_tag_configuration_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/metric_tag_configuration_update_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/metric_volumes_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/metrics_aggregator.rb +1 -1
- data/lib/datadog_api_client/v2/models/metrics_and_metric_tag_configurations_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/metrics_scalar_query.rb +1 -1
- data/lib/datadog_api_client/v2/models/monitor_config_policy_attribute_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/monitor_config_policy_list_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/monitor_config_policy_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/monitor_config_policy_response_data.rb +0 -7
- data/lib/datadog_api_client/v2/models/monitor_downtime_match_resource_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/monitor_downtime_match_response.rb +92 -0
- data/lib/datadog_api_client/v2/models/monitor_downtime_match_response_attributes.rb +120 -0
- data/lib/datadog_api_client/v2/models/monitor_downtime_match_response_data.rb +108 -0
- data/lib/datadog_api_client/v2/models/mute_finding_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/mute_finding_request_attributes.rb +98 -0
- data/lib/datadog_api_client/v2/models/mute_finding_request_data.rb +140 -0
- data/lib/datadog_api_client/v2/models/mute_finding_request_properties.rb +141 -0
- data/lib/datadog_api_client/v2/models/mute_finding_response.rb +98 -0
- data/lib/datadog_api_client/v2/models/mute_finding_response_attributes.rb +191 -0
- data/lib/datadog_api_client/v2/models/mute_finding_response_data.rb +100 -0
- data/lib/datadog_api_client/v2/models/mute_finding_response_properties.rb +114 -0
- data/lib/datadog_api_client/v2/models/nullable_relationship_to_user.rb +0 -7
- data/lib/datadog_api_client/v2/models/on_demand_concurrency_cap.rb +0 -7
- data/lib/datadog_api_client/v2/models/on_demand_concurrency_cap_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/on_demand_concurrency_cap_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/opsgenie_service_response_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/opsgenie_service_update_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/organization_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/pagination.rb +0 -7
- data/lib/datadog_api_client/v2/models/partial_api_key.rb +0 -7
- data/lib/datadog_api_client/v2/models/partial_application_key.rb +0 -7
- data/lib/datadog_api_client/v2/models/partial_application_key_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/permission_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/permissions_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/process_summaries_meta.rb +0 -7
- data/lib/datadog_api_client/v2/models/process_summaries_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/process_summary.rb +0 -7
- data/lib/datadog_api_client/v2/models/process_summary_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/relationship_to_permission.rb +0 -7
- data/lib/datadog_api_client/v2/models/relationship_to_permission_data.rb +0 -7
- data/lib/datadog_api_client/v2/models/relationship_to_permissions.rb +0 -7
- data/lib/datadog_api_client/v2/models/relationship_to_role.rb +0 -7
- data/lib/datadog_api_client/v2/models/relationship_to_role_data.rb +0 -7
- data/lib/datadog_api_client/v2/models/relationship_to_roles.rb +0 -7
- data/lib/datadog_api_client/v2/models/relationship_to_team_links.rb +0 -7
- data/lib/datadog_api_client/v2/models/relationship_to_user_team_permission.rb +0 -7
- data/lib/datadog_api_client/v2/models/response_meta_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/restriction_policy_binding.rb +2 -1
- data/lib/datadog_api_client/v2/models/role_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/role_create_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/role_relationships.rb +0 -7
- data/lib/datadog_api_client/v2/models/role_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/role_response_relationships.rb +0 -7
- data/lib/datadog_api_client/v2/models/role_update_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/role_update_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/roles_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/rum_aggregate_bucket_value_timeseries_point.rb +0 -7
- data/lib/datadog_api_client/v2/models/rum_aggregate_request.rb +0 -7
- data/lib/datadog_api_client/v2/models/rum_aggregate_sort.rb +0 -7
- data/lib/datadog_api_client/v2/models/rum_aggregation_buckets_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/rum_analytics_aggregate_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/rum_application_list.rb +11 -1
- data/lib/datadog_api_client/v2/models/rum_application_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/rum_application_update_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/rum_applications_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/rum_bucket_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/rum_event.rb +0 -7
- data/lib/datadog_api_client/v2/models/rum_event_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/rum_events_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/rum_query_filter.rb +0 -7
- data/lib/datadog_api_client/v2/models/rum_query_options.rb +0 -7
- data/lib/datadog_api_client/v2/models/rum_response_links.rb +0 -7
- data/lib/datadog_api_client/v2/models/rum_response_metadata.rb +0 -7
- data/lib/datadog_api_client/v2/models/rum_response_page.rb +0 -7
- data/lib/datadog_api_client/v2/models/rum_search_events_request.rb +0 -7
- data/lib/datadog_api_client/v2/models/rum_warning.rb +0 -7
- data/lib/datadog_api_client/v2/models/saml_assertion_attribute_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/scalar_formula_query_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/scalar_formula_response_atrributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/scalar_meta.rb +0 -7
- data/lib/datadog_api_client/v2/models/scalar_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/security_filter.rb +0 -7
- data/lib/datadog_api_client/v2/models/security_filter_exclusion_filter_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/security_filter_meta.rb +0 -7
- data/lib/datadog_api_client/v2/models/security_filter_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/security_filters_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/security_monitoring_filter.rb +0 -7
- data/lib/datadog_api_client/v2/models/security_monitoring_list_rules_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_case.rb +0 -7
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_impossible_travel_options.rb +0 -7
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_new_value_options.rb +0 -7
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_options.rb +0 -7
- data/lib/datadog_api_client/v2/models/security_monitoring_signal.rb +0 -7
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_list_request.rb +0 -7
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_list_request_filter.rb +0 -7
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_rule_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_triage_update_data.rb +0 -7
- data/lib/datadog_api_client/v2/models/security_monitoring_signals_list_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/security_monitoring_signals_list_response_links.rb +0 -7
- data/lib/datadog_api_client/v2/models/security_monitoring_signals_list_response_meta.rb +0 -7
- data/lib/datadog_api_client/v2/models/security_monitoring_signals_list_response_meta_page.rb +0 -7
- data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_configuration.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_configuration_data.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_configuration_relationships.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_create_group_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_create_rule_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_filter.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_get_config_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_get_config_response_data.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_group.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_group_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_group_create_request.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_group_data.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_group_delete_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_group_included_item.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_group_item.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_group_list.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_group_relationships.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_group_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_group_update.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_group_update_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_reorder_config.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_reorder_groups_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_rule.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_rule_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_rule_data.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_rule_delete_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_rule_included_item.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_rule_relationships.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_rule_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_rule_update.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_rule_update_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_standard_pattern.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_standard_pattern_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_standard_pattern_data.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_standard_patterns_response_data.rb +0 -7
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_standard_patterns_response_item.rb +0 -7
- data/lib/datadog_api_client/v2/models/service_definition_create_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/service_definition_data.rb +11 -8
- data/lib/datadog_api_client/v2/models/service_definition_data_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/service_definition_get_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/service_definition_meta.rb +35 -10
- data/lib/datadog_api_client/v2/models/service_definition_meta_warnings.rb +100 -0
- data/lib/datadog_api_client/v2/models/service_definition_v1_contact.rb +0 -7
- data/lib/datadog_api_client/v2/models/service_definition_v1_integrations.rb +0 -7
- data/lib/datadog_api_client/v2/models/service_definition_v1_org.rb +0 -7
- data/lib/datadog_api_client/v2/models/service_definition_v2_dot1_integrations.rb +0 -7
- data/lib/datadog_api_client/v2/models/service_definition_v2_dot1_pagerduty.rb +0 -7
- data/lib/datadog_api_client/v2/models/service_definition_v2_integrations.rb +0 -7
- data/lib/datadog_api_client/v2/models/service_definitions_list_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/span.rb +100 -0
- data/lib/datadog_api_client/v2/models/spans_aggregate_bucket.rb +100 -0
- data/lib/datadog_api_client/v2/models/spans_aggregate_bucket_attributes.rb +100 -0
- data/lib/datadog_api_client/v2/models/spans_aggregate_bucket_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/spans_aggregate_bucket_value.rb +64 -0
- data/lib/datadog_api_client/v2/models/spans_aggregate_bucket_value_timeseries_point.rb +90 -0
- data/lib/datadog_api_client/v2/models/spans_aggregate_data.rb +90 -0
- data/lib/datadog_api_client/v2/models/spans_aggregate_request.rb +80 -0
- data/lib/datadog_api_client/v2/models/spans_aggregate_request_attributes.rb +115 -0
- data/lib/datadog_api_client/v2/models/spans_aggregate_request_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/spans_aggregate_response.rb +92 -0
- data/lib/datadog_api_client/v2/models/spans_aggregate_response_metadata.rb +113 -0
- data/lib/datadog_api_client/v2/models/spans_aggregate_response_status.rb +27 -0
- data/lib/datadog_api_client/v2/models/spans_aggregate_sort.rb +110 -0
- data/lib/datadog_api_client/v2/models/spans_aggregate_sort_type.rb +27 -0
- data/lib/datadog_api_client/v2/models/spans_aggregation_function.rb +37 -0
- data/lib/datadog_api_client/v2/models/spans_attributes.rb +244 -0
- data/lib/datadog_api_client/v2/models/spans_compute.rb +129 -0
- data/lib/datadog_api_client/v2/models/spans_compute_type.rb +27 -0
- data/lib/datadog_api_client/v2/models/spans_group_by.rb +149 -0
- data/lib/datadog_api_client/v2/models/spans_group_by_histogram.rb +143 -0
- data/lib/datadog_api_client/v2/models/spans_group_by_missing.rb +63 -0
- data/lib/datadog_api_client/v2/models/spans_group_by_total.rb +64 -0
- data/lib/datadog_api_client/v2/models/spans_list_request.rb +80 -0
- data/lib/datadog_api_client/v2/models/spans_list_request_attributes.rb +111 -0
- data/lib/datadog_api_client/v2/models/spans_list_request_data.rb +90 -0
- data/lib/datadog_api_client/v2/models/spans_list_request_page.rb +108 -0
- data/lib/datadog_api_client/v2/models/spans_list_request_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/spans_list_response.rb +102 -0
- data/lib/datadog_api_client/v2/models/spans_list_response_links.rb +81 -0
- data/lib/datadog_api_client/v2/models/spans_list_response_metadata.rb +123 -0
- data/lib/datadog_api_client/v2/models/spans_metric_filter.rb +0 -7
- data/lib/datadog_api_client/v2/models/spans_metric_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/spans_metric_response_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/spans_metric_response_compute.rb +0 -7
- data/lib/datadog_api_client/v2/models/spans_metric_response_data.rb +0 -7
- data/lib/datadog_api_client/v2/models/spans_metric_response_filter.rb +0 -7
- data/lib/datadog_api_client/v2/models/spans_metric_response_group_by.rb +0 -7
- data/lib/datadog_api_client/v2/models/spans_metric_update_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/spans_metric_update_compute.rb +0 -7
- data/lib/datadog_api_client/v2/models/spans_metrics_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/spans_query_filter.rb +100 -0
- data/lib/datadog_api_client/v2/models/spans_query_options.rb +91 -0
- data/lib/datadog_api_client/v2/models/spans_response_metadata_page.rb +81 -0
- data/lib/datadog_api_client/v2/models/spans_sort.rb +27 -0
- data/lib/datadog_api_client/v2/models/spans_sort_order.rb +27 -0
- data/lib/datadog_api_client/v2/models/spans_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/spans_warning.rb +100 -0
- data/lib/datadog_api_client/v2/models/team_attributes.rb +6 -6
- data/lib/datadog_api_client/v2/models/team_create_relationships.rb +0 -7
- data/lib/datadog_api_client/v2/models/team_link_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/team_links_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/team_permission_setting_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/team_permission_setting_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/team_permission_setting_update_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/team_permission_settings_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/team_relationships.rb +0 -7
- data/lib/datadog_api_client/v2/models/team_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/team_update_attributes.rb +6 -6
- data/lib/datadog_api_client/v2/models/team_update_relationships.rb +0 -7
- data/lib/datadog_api_client/v2/models/teams_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/timeseries_formula_query_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/timeseries_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/timeseries_response_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/unit.rb +0 -7
- data/lib/datadog_api_client/v2/models/usage_application_security_monitoring_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/usage_attributes_object.rb +0 -7
- data/lib/datadog_api_client/v2/models/usage_data_object.rb +0 -7
- data/lib/datadog_api_client/v2/models/usage_lambda_traced_invocations_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/usage_observability_pipelines_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/usage_time_series_object.rb +0 -7
- data/lib/datadog_api_client/v2/models/user.rb +0 -7
- data/lib/datadog_api_client/v2/models/user_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/user_invitation_data_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/user_invitation_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/user_invitation_response_data.rb +11 -8
- data/lib/datadog_api_client/v2/models/user_invitations_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/user_relationships.rb +0 -7
- data/lib/datadog_api_client/v2/models/user_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/user_response_relationships.rb +0 -7
- data/lib/datadog_api_client/v2/models/user_team_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/user_team_permission_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/user_team_relationships.rb +0 -7
- data/lib/datadog_api_client/v2/models/user_team_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/user_teams_response.rb +0 -7
- data/lib/datadog_api_client/v2/models/user_update_attributes.rb +0 -7
- data/lib/datadog_api_client/v2/models/users_response.rb +0 -7
- data/lib/datadog_api_client/version.rb +1 -1
- metadata +145 -2
|
@@ -359,7 +359,7 @@ components:
|
|
|
359
359
|
format: int64
|
|
360
360
|
type: integer
|
|
361
361
|
PageSize:
|
|
362
|
-
description: Size for a given page. The maximum allowed value is
|
|
362
|
+
description: Size for a given page. The maximum allowed value is 100.
|
|
363
363
|
in: query
|
|
364
364
|
name: page[size]
|
|
365
365
|
required: false
|
|
@@ -477,6 +477,31 @@ components:
|
|
|
477
477
|
schema:
|
|
478
478
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
479
479
|
description: Conflict
|
|
480
|
+
FindingsBadRequestResponse:
|
|
481
|
+
content:
|
|
482
|
+
application/json:
|
|
483
|
+
schema:
|
|
484
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
|
485
|
+
description: 'Bad Request: The server cannot process the request due to invalid
|
|
486
|
+
syntax in the request.'
|
|
487
|
+
FindingsForbiddenResponse:
|
|
488
|
+
content:
|
|
489
|
+
application/json:
|
|
490
|
+
schema:
|
|
491
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
|
492
|
+
description: 'Forbidden: Access denied'
|
|
493
|
+
FindingsNotFoundResponse:
|
|
494
|
+
content:
|
|
495
|
+
application/json:
|
|
496
|
+
schema:
|
|
497
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
|
498
|
+
description: 'Not Found: The requested finding cannot be found.'
|
|
499
|
+
FindingsTooManyRequestsResponse:
|
|
500
|
+
content:
|
|
501
|
+
application/json:
|
|
502
|
+
schema:
|
|
503
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
|
504
|
+
description: 'Too many requests: The rate limit set by the API has been exceeded.'
|
|
480
505
|
ForbiddenResponse:
|
|
481
506
|
content:
|
|
482
507
|
application/json:
|
|
@@ -495,6 +520,30 @@ components:
|
|
|
495
520
|
schema:
|
|
496
521
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
497
522
|
description: Not Found
|
|
523
|
+
SpansBadRequestResponse:
|
|
524
|
+
content:
|
|
525
|
+
application/json:
|
|
526
|
+
schema:
|
|
527
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
|
528
|
+
description: Bad Request.
|
|
529
|
+
SpansForbiddenResponse:
|
|
530
|
+
content:
|
|
531
|
+
application/json:
|
|
532
|
+
schema:
|
|
533
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
|
534
|
+
description: 'Forbidden: Access denied.'
|
|
535
|
+
SpansTooManyRequestsResponse:
|
|
536
|
+
content:
|
|
537
|
+
application/json:
|
|
538
|
+
schema:
|
|
539
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
|
540
|
+
description: 'Too many requests: The rate limit set by the API has been exceeded.'
|
|
541
|
+
SpansUnprocessableEntityResponse:
|
|
542
|
+
content:
|
|
543
|
+
application/json:
|
|
544
|
+
schema:
|
|
545
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
|
546
|
+
description: Unprocessable Entity.
|
|
498
547
|
TooManyRequestsResponse:
|
|
499
548
|
content:
|
|
500
549
|
application/json:
|
|
@@ -1315,6 +1364,39 @@ components:
|
|
|
1315
1364
|
- EARLIEST
|
|
1316
1365
|
- MOST_FREQUENT
|
|
1317
1366
|
- DELTA
|
|
1367
|
+
CIAppCIError:
|
|
1368
|
+
description: Contains information of the CI error.
|
|
1369
|
+
nullable: true
|
|
1370
|
+
properties:
|
|
1371
|
+
domain:
|
|
1372
|
+
$ref: '#/components/schemas/CIAppCIErrorDomain'
|
|
1373
|
+
message:
|
|
1374
|
+
description: Error message.
|
|
1375
|
+
maxLength: 5000
|
|
1376
|
+
nullable: true
|
|
1377
|
+
type: string
|
|
1378
|
+
stack:
|
|
1379
|
+
description: The stack trace of the reported errors.
|
|
1380
|
+
nullable: true
|
|
1381
|
+
type: string
|
|
1382
|
+
type:
|
|
1383
|
+
description: Short description of the error type.
|
|
1384
|
+
maxLength: 100
|
|
1385
|
+
nullable: true
|
|
1386
|
+
type: string
|
|
1387
|
+
type: object
|
|
1388
|
+
CIAppCIErrorDomain:
|
|
1389
|
+
description: Error category used to differentiate between issues related to
|
|
1390
|
+
the developer or provider environments.
|
|
1391
|
+
enum:
|
|
1392
|
+
- provider
|
|
1393
|
+
- user
|
|
1394
|
+
- unknown
|
|
1395
|
+
type: string
|
|
1396
|
+
x-enum-varnames:
|
|
1397
|
+
- PROVIDER
|
|
1398
|
+
- USER
|
|
1399
|
+
- UNKNOWN
|
|
1318
1400
|
CIAppCompute:
|
|
1319
1401
|
description: A compute rule to compute metrics or timeseries.
|
|
1320
1402
|
properties:
|
|
@@ -1351,6 +1433,52 @@ components:
|
|
|
1351
1433
|
description: A map of the metric name to value for regular compute, or a list
|
|
1352
1434
|
of values for a timeseries.
|
|
1353
1435
|
type: object
|
|
1436
|
+
CIAppCreatePipelineEventRequest:
|
|
1437
|
+
description: Request object.
|
|
1438
|
+
properties:
|
|
1439
|
+
data:
|
|
1440
|
+
$ref: '#/components/schemas/CIAppCreatePipelineEventRequestData'
|
|
1441
|
+
type: object
|
|
1442
|
+
CIAppCreatePipelineEventRequestAttributes:
|
|
1443
|
+
description: Attributes of the pipeline event to create.
|
|
1444
|
+
properties:
|
|
1445
|
+
env:
|
|
1446
|
+
description: The Datadog environment.
|
|
1447
|
+
type: string
|
|
1448
|
+
resource:
|
|
1449
|
+
$ref: '#/components/schemas/CIAppCreatePipelineEventRequestAttributesResource'
|
|
1450
|
+
service:
|
|
1451
|
+
description: If the CI provider is SaaS, use this to differentiate between
|
|
1452
|
+
instances.
|
|
1453
|
+
type: string
|
|
1454
|
+
required:
|
|
1455
|
+
- resource
|
|
1456
|
+
type: object
|
|
1457
|
+
CIAppCreatePipelineEventRequestAttributesResource:
|
|
1458
|
+
description: Details of the CI pipeline event.
|
|
1459
|
+
example: Details TBD
|
|
1460
|
+
oneOf:
|
|
1461
|
+
- $ref: '#/components/schemas/CIAppPipelineEventPipeline'
|
|
1462
|
+
- $ref: '#/components/schemas/CIAppPipelineEventStage'
|
|
1463
|
+
- $ref: '#/components/schemas/CIAppPipelineEventJob'
|
|
1464
|
+
- $ref: '#/components/schemas/CIAppPipelineEventStep'
|
|
1465
|
+
CIAppCreatePipelineEventRequestData:
|
|
1466
|
+
description: Data of the pipeline event to create.
|
|
1467
|
+
properties:
|
|
1468
|
+
attributes:
|
|
1469
|
+
$ref: '#/components/schemas/CIAppCreatePipelineEventRequestAttributes'
|
|
1470
|
+
type:
|
|
1471
|
+
$ref: '#/components/schemas/CIAppCreatePipelineEventRequestDataType'
|
|
1472
|
+
type: object
|
|
1473
|
+
CIAppCreatePipelineEventRequestDataType:
|
|
1474
|
+
default: cipipeline_resource_request
|
|
1475
|
+
description: Type of the event.
|
|
1476
|
+
enum:
|
|
1477
|
+
- cipipeline_resource_request
|
|
1478
|
+
example: cipipeline_resource_request
|
|
1479
|
+
type: string
|
|
1480
|
+
x-enum-varnames:
|
|
1481
|
+
- CIPIPELINE_RESOURCE_REQUEST
|
|
1354
1482
|
CIAppEventAttributes:
|
|
1355
1483
|
description: JSON object containing all event attributes and their associated
|
|
1356
1484
|
values.
|
|
@@ -1377,6 +1505,77 @@ components:
|
|
|
1377
1505
|
timestamp:
|
|
1378
1506
|
$ref: '#/components/schemas/TimestampEventAttribute'
|
|
1379
1507
|
type: object
|
|
1508
|
+
CIAppGitInfo:
|
|
1509
|
+
description: 'If pipelines are triggered due to actions to a Git repository,
|
|
1510
|
+
then all payloads must contain this.
|
|
1511
|
+
|
|
1512
|
+
Note that either `tag` or `branch` has to be provided, but not both.'
|
|
1513
|
+
nullable: true
|
|
1514
|
+
properties:
|
|
1515
|
+
author_email:
|
|
1516
|
+
description: The commit author email.
|
|
1517
|
+
example: author@example.com
|
|
1518
|
+
format: email
|
|
1519
|
+
type: string
|
|
1520
|
+
author_name:
|
|
1521
|
+
description: The commit author name.
|
|
1522
|
+
example: John Doe
|
|
1523
|
+
nullable: true
|
|
1524
|
+
type: string
|
|
1525
|
+
author_time:
|
|
1526
|
+
description: The commit author timestamp in RFC3339 format.
|
|
1527
|
+
example: '2023-05-31T15:30:00Z'
|
|
1528
|
+
nullable: true
|
|
1529
|
+
type: string
|
|
1530
|
+
branch:
|
|
1531
|
+
description: The branch name (if a tag use the tag parameter).
|
|
1532
|
+
example: feature-1
|
|
1533
|
+
nullable: true
|
|
1534
|
+
type: string
|
|
1535
|
+
commit_time:
|
|
1536
|
+
description: The commit timestamp in RFC3339 format.
|
|
1537
|
+
example: '2023-05-31T15:30:00Z'
|
|
1538
|
+
nullable: true
|
|
1539
|
+
type: string
|
|
1540
|
+
committer_email:
|
|
1541
|
+
description: The committer email.
|
|
1542
|
+
example: committer@example.com
|
|
1543
|
+
format: email
|
|
1544
|
+
nullable: true
|
|
1545
|
+
type: string
|
|
1546
|
+
committer_name:
|
|
1547
|
+
description: The committer name.
|
|
1548
|
+
nullable: true
|
|
1549
|
+
type: string
|
|
1550
|
+
default_branch:
|
|
1551
|
+
description: The Git repository's default branch.
|
|
1552
|
+
example: main
|
|
1553
|
+
nullable: true
|
|
1554
|
+
type: string
|
|
1555
|
+
message:
|
|
1556
|
+
description: The commit message.
|
|
1557
|
+
example: Instrumenting tests with CI Visibility.
|
|
1558
|
+
nullable: true
|
|
1559
|
+
type: string
|
|
1560
|
+
repository_url:
|
|
1561
|
+
description: The URL of the repository.
|
|
1562
|
+
example: https://github.com/username/repository
|
|
1563
|
+
type: string
|
|
1564
|
+
sha:
|
|
1565
|
+
description: The git commit SHA.
|
|
1566
|
+
example: da39a3ee5e6b4b0d3255bfef95601890afd80709
|
|
1567
|
+
pattern: ^[a-fA-F0-9]{40}$
|
|
1568
|
+
type: string
|
|
1569
|
+
tag:
|
|
1570
|
+
description: The tag name (if a branch use the branch parameter).
|
|
1571
|
+
example: v1.0.0
|
|
1572
|
+
nullable: true
|
|
1573
|
+
type: string
|
|
1574
|
+
required:
|
|
1575
|
+
- repository_url
|
|
1576
|
+
- sha
|
|
1577
|
+
- author_email
|
|
1578
|
+
type: object
|
|
1380
1579
|
CIAppGroupByHistogram:
|
|
1381
1580
|
description: 'Used to perform a histogram computation (only for measure facets).
|
|
1382
1581
|
|
|
@@ -1436,6 +1635,31 @@ components:
|
|
|
1436
1635
|
CIAppGroupByTotalString:
|
|
1437
1636
|
description: A string to use as the key value for the total bucket.
|
|
1438
1637
|
type: string
|
|
1638
|
+
CIAppHostInfo:
|
|
1639
|
+
description: Contains information of the host running the pipeline, stage, job,
|
|
1640
|
+
or step.
|
|
1641
|
+
nullable: true
|
|
1642
|
+
properties:
|
|
1643
|
+
hostname:
|
|
1644
|
+
description: FQDN of the host.
|
|
1645
|
+
example: www.example.com
|
|
1646
|
+
type: string
|
|
1647
|
+
labels:
|
|
1648
|
+
description: A list of labels used to select or identify the node.
|
|
1649
|
+
example:
|
|
1650
|
+
- ubuntu-18.04
|
|
1651
|
+
- n2.large
|
|
1652
|
+
items:
|
|
1653
|
+
type: string
|
|
1654
|
+
type: array
|
|
1655
|
+
name:
|
|
1656
|
+
description: Name for the host.
|
|
1657
|
+
type: string
|
|
1658
|
+
workspace:
|
|
1659
|
+
description: The path where the code is checked out.
|
|
1660
|
+
example: /home/workspace/code/my-repo
|
|
1661
|
+
type: string
|
|
1662
|
+
type: object
|
|
1439
1663
|
CIAppPipelineEvent:
|
|
1440
1664
|
description: Object description of a pipeline event after being processed and
|
|
1441
1665
|
stored by Datadog.
|
|
@@ -1449,68 +1673,555 @@ components:
|
|
|
1449
1673
|
type:
|
|
1450
1674
|
$ref: '#/components/schemas/CIAppPipelineEventTypeName'
|
|
1451
1675
|
type: object
|
|
1452
|
-
|
|
1453
|
-
description:
|
|
1676
|
+
CIAppPipelineEventJob:
|
|
1677
|
+
description: Details of a CI job.
|
|
1678
|
+
properties:
|
|
1679
|
+
dependencies:
|
|
1680
|
+
description: A list of job IDs that this job depends on.
|
|
1681
|
+
example:
|
|
1682
|
+
- f7e6a006-a029-46c3-b0cc-742c9d7d363b
|
|
1683
|
+
- c8a69849-3c3b-4721-8b33-3e8ec2df1ebe
|
|
1684
|
+
items:
|
|
1685
|
+
description: A list of job IDs.
|
|
1686
|
+
type: string
|
|
1687
|
+
nullable: true
|
|
1688
|
+
type: array
|
|
1689
|
+
end:
|
|
1690
|
+
description: Time when the job run finished. The time format must be RFC3339.
|
|
1691
|
+
example: '2023-05-31T15:30:00Z'
|
|
1692
|
+
format: date-time
|
|
1693
|
+
type: string
|
|
1694
|
+
error:
|
|
1695
|
+
$ref: '#/components/schemas/CIAppCIError'
|
|
1696
|
+
git:
|
|
1697
|
+
$ref: '#/components/schemas/CIAppGitInfo'
|
|
1698
|
+
id:
|
|
1699
|
+
description: The UUID for the job. It has to be unique within each pipeline
|
|
1700
|
+
execution.
|
|
1701
|
+
example: c865bad4-de82-44b8-ade7-2c987528eb54
|
|
1702
|
+
type: string
|
|
1703
|
+
level:
|
|
1704
|
+
$ref: '#/components/schemas/CIAppPipelineEventJobLevel'
|
|
1705
|
+
metrics:
|
|
1706
|
+
$ref: '#/components/schemas/CIAppPipelineEventMetrics'
|
|
1707
|
+
name:
|
|
1708
|
+
description: The name for the job.
|
|
1709
|
+
example: test
|
|
1710
|
+
type: string
|
|
1711
|
+
node:
|
|
1712
|
+
$ref: '#/components/schemas/CIAppHostInfo'
|
|
1713
|
+
parameters:
|
|
1714
|
+
$ref: '#/components/schemas/CIAppPipelineEventParameters'
|
|
1715
|
+
pipeline_name:
|
|
1716
|
+
description: The parent pipeline name.
|
|
1717
|
+
example: Build
|
|
1718
|
+
type: string
|
|
1719
|
+
pipeline_unique_id:
|
|
1720
|
+
description: The parent pipeline UUID.
|
|
1721
|
+
example: 76b572af-a078-42b2-a08a-cc28f98b944f
|
|
1722
|
+
type: string
|
|
1723
|
+
queue_time:
|
|
1724
|
+
description: The queue time in milliseconds, if applicable.
|
|
1725
|
+
example: 1004
|
|
1726
|
+
format: int64
|
|
1727
|
+
minimum: 0
|
|
1728
|
+
nullable: true
|
|
1729
|
+
type: integer
|
|
1730
|
+
stage_id:
|
|
1731
|
+
description: The parent stage UUID (if applicable).
|
|
1732
|
+
nullable: true
|
|
1733
|
+
type: string
|
|
1734
|
+
stage_name:
|
|
1735
|
+
description: The parent stage name (if applicable).
|
|
1736
|
+
nullable: true
|
|
1737
|
+
type: string
|
|
1738
|
+
start:
|
|
1739
|
+
description: Time when the job run instance started (it should not include
|
|
1740
|
+
any queue time). The time format must be RFC3339.
|
|
1741
|
+
example: '2023-05-31T15:30:00Z'
|
|
1742
|
+
format: date-time
|
|
1743
|
+
type: string
|
|
1744
|
+
status:
|
|
1745
|
+
$ref: '#/components/schemas/CIAppPipelineEventJobStatus'
|
|
1746
|
+
tags:
|
|
1747
|
+
$ref: '#/components/schemas/CIAppPipelineEventTags'
|
|
1748
|
+
url:
|
|
1749
|
+
description: The URL to look at the job in the CI provider UI.
|
|
1750
|
+
example: https://ci-platform.com/job/your-job-name/build/123
|
|
1751
|
+
type: string
|
|
1752
|
+
required:
|
|
1753
|
+
- level
|
|
1754
|
+
- id
|
|
1755
|
+
- name
|
|
1756
|
+
- pipeline_unique_id
|
|
1757
|
+
- pipeline_name
|
|
1758
|
+
- start
|
|
1759
|
+
- end
|
|
1760
|
+
- status
|
|
1761
|
+
- url
|
|
1762
|
+
- git
|
|
1763
|
+
type: object
|
|
1764
|
+
CIAppPipelineEventJobLevel:
|
|
1765
|
+
default: job
|
|
1766
|
+
description: Used to distinguish between pipelines, stages, jobs, and steps.
|
|
1454
1767
|
enum:
|
|
1455
|
-
-
|
|
1456
|
-
example:
|
|
1768
|
+
- job
|
|
1769
|
+
example: job
|
|
1457
1770
|
type: string
|
|
1458
1771
|
x-enum-varnames:
|
|
1459
|
-
-
|
|
1460
|
-
|
|
1461
|
-
description: The
|
|
1772
|
+
- JOB
|
|
1773
|
+
CIAppPipelineEventJobStatus:
|
|
1774
|
+
description: The final status of the job.
|
|
1775
|
+
enum:
|
|
1776
|
+
- success
|
|
1777
|
+
- error
|
|
1778
|
+
- canceled
|
|
1779
|
+
- skipped
|
|
1780
|
+
example: success
|
|
1781
|
+
type: string
|
|
1782
|
+
x-enum-varnames:
|
|
1783
|
+
- SUCCESS
|
|
1784
|
+
- ERROR
|
|
1785
|
+
- CANCELED
|
|
1786
|
+
- SKIPPED
|
|
1787
|
+
CIAppPipelineEventMetrics:
|
|
1788
|
+
description: A list of user-defined metrics. The metrics must follow the `key:value`
|
|
1789
|
+
pattern and the value must be numeric.
|
|
1790
|
+
example:
|
|
1791
|
+
- bundle_size:370
|
|
1792
|
+
- build_time:50021
|
|
1793
|
+
items:
|
|
1794
|
+
description: Metrics in the form of `key:value`. The value needs to be numeric.
|
|
1795
|
+
type: string
|
|
1796
|
+
nullable: true
|
|
1797
|
+
type: array
|
|
1798
|
+
CIAppPipelineEventParameters:
|
|
1799
|
+
additionalProperties:
|
|
1800
|
+
type: string
|
|
1801
|
+
description: A map of key-value parameters or environment variables that were
|
|
1802
|
+
defined for the pipeline.
|
|
1803
|
+
example:
|
|
1804
|
+
LOG_LEVEL: debug
|
|
1805
|
+
nullable: true
|
|
1806
|
+
type: object
|
|
1807
|
+
CIAppPipelineEventParentPipeline:
|
|
1808
|
+
description: If the pipeline is triggered as child of another pipeline, this
|
|
1809
|
+
should contain the details of the parent pipeline.
|
|
1810
|
+
nullable: true
|
|
1462
1811
|
properties:
|
|
1463
|
-
|
|
1464
|
-
|
|
1465
|
-
|
|
1466
|
-
|
|
1467
|
-
|
|
1468
|
-
|
|
1469
|
-
|
|
1470
|
-
|
|
1812
|
+
id:
|
|
1813
|
+
description: UUID of a pipeline.
|
|
1814
|
+
example: 93bfeb70-af47-424d-908a-948d3f08e37f
|
|
1815
|
+
type: string
|
|
1816
|
+
url:
|
|
1817
|
+
description: The URL to look at the pipeline in the CI provider UI.
|
|
1818
|
+
example: https://ci-platform.com/pipelines/123456789
|
|
1819
|
+
type: string
|
|
1820
|
+
required:
|
|
1821
|
+
- id
|
|
1471
1822
|
type: object
|
|
1472
|
-
|
|
1473
|
-
description:
|
|
1474
|
-
pagination information.
|
|
1823
|
+
CIAppPipelineEventPipeline:
|
|
1824
|
+
description: Details of the top level pipeline, build, or workflow of your CI.
|
|
1475
1825
|
properties:
|
|
1476
|
-
|
|
1477
|
-
description:
|
|
1478
|
-
|
|
1479
|
-
|
|
1480
|
-
|
|
1481
|
-
|
|
1482
|
-
|
|
1483
|
-
|
|
1484
|
-
|
|
1826
|
+
end:
|
|
1827
|
+
description: Time when the pipeline run finished. It cannot be older than
|
|
1828
|
+
18 hours in the past from the current time. The time format must be RFC3339.
|
|
1829
|
+
example: '2023-05-31T15:30:00Z'
|
|
1830
|
+
format: date-time
|
|
1831
|
+
type: string
|
|
1832
|
+
error:
|
|
1833
|
+
$ref: '#/components/schemas/CIAppCIError'
|
|
1834
|
+
git:
|
|
1835
|
+
$ref: '#/components/schemas/CIAppGitInfo'
|
|
1836
|
+
is_manual:
|
|
1837
|
+
description: Whether or not the pipeline was triggered manually by the user.
|
|
1838
|
+
example: false
|
|
1839
|
+
nullable: true
|
|
1840
|
+
type: boolean
|
|
1841
|
+
is_resumed:
|
|
1842
|
+
description: Whether or not the pipeline was resumed after being blocked.
|
|
1843
|
+
example: false
|
|
1844
|
+
nullable: true
|
|
1845
|
+
type: boolean
|
|
1846
|
+
level:
|
|
1847
|
+
$ref: '#/components/schemas/CIAppPipelineEventPipelineLevel'
|
|
1848
|
+
metrics:
|
|
1849
|
+
$ref: '#/components/schemas/CIAppPipelineEventMetrics'
|
|
1850
|
+
name:
|
|
1851
|
+
description: Name of the pipeline. All pipeline runs for the builds should
|
|
1852
|
+
have the same name.
|
|
1853
|
+
example: Deploy to AWS
|
|
1854
|
+
type: string
|
|
1855
|
+
node:
|
|
1856
|
+
$ref: '#/components/schemas/CIAppHostInfo'
|
|
1857
|
+
parameters:
|
|
1858
|
+
$ref: '#/components/schemas/CIAppPipelineEventParameters'
|
|
1859
|
+
parent_pipeline:
|
|
1860
|
+
$ref: '#/components/schemas/CIAppPipelineEventParentPipeline'
|
|
1861
|
+
partial_retry:
|
|
1862
|
+
description: 'Whether or not the pipeline was a partial retry of a previous
|
|
1863
|
+
attempt. A partial retry is one
|
|
1864
|
+
|
|
1865
|
+
which only runs a subset of the original jobs.'
|
|
1866
|
+
example: false
|
|
1867
|
+
type: boolean
|
|
1868
|
+
pipeline_id:
|
|
1869
|
+
description: 'Any ID used in the provider to identify the pipeline run even
|
|
1870
|
+
if it is not unique across retries.
|
|
1871
|
+
|
|
1872
|
+
If the `pipeline_id` is unique, then both `unique_id` and `pipeline_id`
|
|
1873
|
+
can be set to the same value.'
|
|
1874
|
+
example: '#023'
|
|
1875
|
+
type: string
|
|
1876
|
+
previous_attempt:
|
|
1877
|
+
$ref: '#/components/schemas/CIAppPipelineEventPreviousPipeline'
|
|
1878
|
+
queue_time:
|
|
1879
|
+
description: The queue time in milliseconds, if applicable.
|
|
1880
|
+
example: 1004
|
|
1881
|
+
format: int64
|
|
1882
|
+
minimum: 0
|
|
1883
|
+
nullable: true
|
|
1884
|
+
type: integer
|
|
1885
|
+
start:
|
|
1886
|
+
description: Time when the pipeline run started (it should not include any
|
|
1887
|
+
queue time). The time format must be RFC3339.
|
|
1888
|
+
example: '2023-05-31T15:30:00Z'
|
|
1889
|
+
format: date-time
|
|
1890
|
+
type: string
|
|
1891
|
+
status:
|
|
1892
|
+
$ref: '#/components/schemas/CIAppPipelineEventPipelineStatus'
|
|
1893
|
+
tags:
|
|
1894
|
+
$ref: '#/components/schemas/CIAppPipelineEventTags'
|
|
1895
|
+
unique_id:
|
|
1896
|
+
description: 'UUID of the pipeline run. The ID has to be unique across retries
|
|
1897
|
+
and pipelines,
|
|
1898
|
+
|
|
1899
|
+
including partial retries.'
|
|
1900
|
+
example: 3eacb6f3-ff04-4e10-8a9c-46e6d054024a
|
|
1901
|
+
type: string
|
|
1902
|
+
url:
|
|
1903
|
+
description: The URL to look at the pipeline in the CI provider UI.
|
|
1904
|
+
example: https://my-ci-provider.example/pipelines/my-pipeline/run/1
|
|
1905
|
+
type: string
|
|
1906
|
+
required:
|
|
1907
|
+
- level
|
|
1908
|
+
- unique_id
|
|
1909
|
+
- name
|
|
1910
|
+
- url
|
|
1911
|
+
- start
|
|
1912
|
+
- end
|
|
1913
|
+
- status
|
|
1914
|
+
- partial_retry
|
|
1915
|
+
- git
|
|
1485
1916
|
type: object
|
|
1486
|
-
|
|
1487
|
-
|
|
1488
|
-
|
|
1917
|
+
CIAppPipelineEventPipelineLevel:
|
|
1918
|
+
default: pipeline
|
|
1919
|
+
description: Used to distinguish between pipelines, stages, jobs, and steps.
|
|
1920
|
+
enum:
|
|
1921
|
+
- pipeline
|
|
1922
|
+
example: pipeline
|
|
1923
|
+
type: string
|
|
1924
|
+
x-enum-varnames:
|
|
1925
|
+
- PIPELINE
|
|
1926
|
+
CIAppPipelineEventPipelineStatus:
|
|
1927
|
+
description: The final status of the pipeline.
|
|
1928
|
+
enum:
|
|
1929
|
+
- success
|
|
1930
|
+
- error
|
|
1931
|
+
- canceled
|
|
1932
|
+
- skipped
|
|
1933
|
+
- blocked
|
|
1934
|
+
example: success
|
|
1935
|
+
type: string
|
|
1936
|
+
x-enum-varnames:
|
|
1937
|
+
- SUCCESS
|
|
1938
|
+
- ERROR
|
|
1939
|
+
- CANCELED
|
|
1940
|
+
- SKIPPED
|
|
1941
|
+
- BLOCKED
|
|
1942
|
+
CIAppPipelineEventPreviousPipeline:
|
|
1943
|
+
description: If the pipeline is a retry, this should contain the details of
|
|
1944
|
+
the previous attempt.
|
|
1945
|
+
nullable: true
|
|
1489
1946
|
properties:
|
|
1490
|
-
|
|
1491
|
-
description:
|
|
1492
|
-
|
|
1493
|
-
|
|
1494
|
-
|
|
1495
|
-
|
|
1496
|
-
|
|
1497
|
-
|
|
1498
|
-
|
|
1499
|
-
|
|
1500
|
-
items:
|
|
1501
|
-
$ref: '#/components/schemas/CIAppPipelinesGroupBy'
|
|
1502
|
-
type: array
|
|
1503
|
-
options:
|
|
1504
|
-
$ref: '#/components/schemas/CIAppQueryOptions'
|
|
1947
|
+
id:
|
|
1948
|
+
description: UUID of a pipeline.
|
|
1949
|
+
example: 93bfeb70-af47-424d-908a-948d3f08e37f
|
|
1950
|
+
type: string
|
|
1951
|
+
url:
|
|
1952
|
+
description: The URL to look at the pipeline in the CI provider UI.
|
|
1953
|
+
example: https://ci-platform.com/pipelines/123456789
|
|
1954
|
+
type: string
|
|
1955
|
+
required:
|
|
1956
|
+
- id
|
|
1505
1957
|
type: object
|
|
1506
|
-
|
|
1507
|
-
description:
|
|
1958
|
+
CIAppPipelineEventStage:
|
|
1959
|
+
description: Details of a CI stage.
|
|
1508
1960
|
properties:
|
|
1509
|
-
|
|
1510
|
-
description:
|
|
1961
|
+
dependencies:
|
|
1962
|
+
description: A list of stage IDs that this stage depends on.
|
|
1963
|
+
example:
|
|
1964
|
+
- f7e6a006-a029-46c3-b0cc-742c9d7d363b
|
|
1965
|
+
- c8a69849-3c3b-4721-8b33-3e8ec2df1ebe
|
|
1511
1966
|
items:
|
|
1512
|
-
|
|
1513
|
-
|
|
1967
|
+
description: A list of stage IDs.
|
|
1968
|
+
type: string
|
|
1969
|
+
nullable: true
|
|
1970
|
+
type: array
|
|
1971
|
+
end:
|
|
1972
|
+
description: Time when the stage run finished. The time format must be RFC3339.
|
|
1973
|
+
example: '2023-05-31T15:30:00Z'
|
|
1974
|
+
format: date-time
|
|
1975
|
+
type: string
|
|
1976
|
+
error:
|
|
1977
|
+
$ref: '#/components/schemas/CIAppCIError'
|
|
1978
|
+
git:
|
|
1979
|
+
$ref: '#/components/schemas/CIAppGitInfo'
|
|
1980
|
+
id:
|
|
1981
|
+
description: UUID for the stage. It has to be unique at least in the pipeline
|
|
1982
|
+
scope.
|
|
1983
|
+
example: 562bdbbb-7cab-48c8-851c-b24ca14628bf
|
|
1984
|
+
type: string
|
|
1985
|
+
level:
|
|
1986
|
+
$ref: '#/components/schemas/CIAppPipelineEventStageLevel'
|
|
1987
|
+
metrics:
|
|
1988
|
+
$ref: '#/components/schemas/CIAppPipelineEventMetrics'
|
|
1989
|
+
name:
|
|
1990
|
+
description: The name for the stage.
|
|
1991
|
+
example: build
|
|
1992
|
+
type: string
|
|
1993
|
+
node:
|
|
1994
|
+
$ref: '#/components/schemas/CIAppHostInfo'
|
|
1995
|
+
parameters:
|
|
1996
|
+
$ref: '#/components/schemas/CIAppPipelineEventParameters'
|
|
1997
|
+
pipeline_name:
|
|
1998
|
+
description: The parent pipeline name.
|
|
1999
|
+
example: Build
|
|
2000
|
+
type: string
|
|
2001
|
+
pipeline_unique_id:
|
|
2002
|
+
description: The parent pipeline UUID.
|
|
2003
|
+
example: 76b572af-a078-42b2-a08a-cc28f98b944f
|
|
2004
|
+
type: string
|
|
2005
|
+
queue_time:
|
|
2006
|
+
description: The queue time in milliseconds, if applicable.
|
|
2007
|
+
example: 1004
|
|
2008
|
+
format: int64
|
|
2009
|
+
minimum: 0
|
|
2010
|
+
nullable: true
|
|
2011
|
+
type: integer
|
|
2012
|
+
start:
|
|
2013
|
+
description: Time when the stage run started (it should not include any
|
|
2014
|
+
queue time). The time format must be RFC3339.
|
|
2015
|
+
example: '2023-05-31T15:30:00Z'
|
|
2016
|
+
format: date-time
|
|
2017
|
+
type: string
|
|
2018
|
+
status:
|
|
2019
|
+
$ref: '#/components/schemas/CIAppPipelineEventStageStatus'
|
|
2020
|
+
tags:
|
|
2021
|
+
$ref: '#/components/schemas/CIAppPipelineEventTags'
|
|
2022
|
+
required:
|
|
2023
|
+
- level
|
|
2024
|
+
- id
|
|
2025
|
+
- name
|
|
2026
|
+
- pipeline_unique_id
|
|
2027
|
+
- pipeline_name
|
|
2028
|
+
- start
|
|
2029
|
+
- end
|
|
2030
|
+
- status
|
|
2031
|
+
- git
|
|
2032
|
+
type: object
|
|
2033
|
+
CIAppPipelineEventStageLevel:
|
|
2034
|
+
default: stage
|
|
2035
|
+
description: Used to distinguish between pipelines, stages, jobs and steps.
|
|
2036
|
+
enum:
|
|
2037
|
+
- stage
|
|
2038
|
+
example: stage
|
|
2039
|
+
type: string
|
|
2040
|
+
x-enum-varnames:
|
|
2041
|
+
- STAGE
|
|
2042
|
+
CIAppPipelineEventStageStatus:
|
|
2043
|
+
description: The final status of the stage.
|
|
2044
|
+
enum:
|
|
2045
|
+
- success
|
|
2046
|
+
- error
|
|
2047
|
+
- canceled
|
|
2048
|
+
- skipped
|
|
2049
|
+
example: success
|
|
2050
|
+
type: string
|
|
2051
|
+
x-enum-varnames:
|
|
2052
|
+
- SUCCESS
|
|
2053
|
+
- ERROR
|
|
2054
|
+
- CANCELED
|
|
2055
|
+
- SKIPPED
|
|
2056
|
+
CIAppPipelineEventStep:
|
|
2057
|
+
description: Details of a CI step.
|
|
2058
|
+
properties:
|
|
2059
|
+
end:
|
|
2060
|
+
description: Time when the step run finished. The time format must be RFC3339.
|
|
2061
|
+
example: '2023-05-31T15:30:00Z'
|
|
2062
|
+
format: date-time
|
|
2063
|
+
type: string
|
|
2064
|
+
error:
|
|
2065
|
+
$ref: '#/components/schemas/CIAppCIError'
|
|
2066
|
+
git:
|
|
2067
|
+
$ref: '#/components/schemas/CIAppGitInfo'
|
|
2068
|
+
id:
|
|
2069
|
+
description: UUID for the step. It has to be unique within each pipeline
|
|
2070
|
+
execution.
|
|
2071
|
+
example: c2d517a8-4f3a-4b41-b4ae-69df0c864c79
|
|
2072
|
+
type: string
|
|
2073
|
+
job_id:
|
|
2074
|
+
description: The parent job UUID (if applicable).
|
|
2075
|
+
nullable: true
|
|
2076
|
+
type: string
|
|
2077
|
+
job_name:
|
|
2078
|
+
description: The parent job name (if applicable).
|
|
2079
|
+
nullable: true
|
|
2080
|
+
type: string
|
|
2081
|
+
level:
|
|
2082
|
+
$ref: '#/components/schemas/CIAppPipelineEventStepLevel'
|
|
2083
|
+
metrics:
|
|
2084
|
+
$ref: '#/components/schemas/CIAppPipelineEventMetrics'
|
|
2085
|
+
name:
|
|
2086
|
+
description: The name for the step.
|
|
2087
|
+
example: test-server
|
|
2088
|
+
type: string
|
|
2089
|
+
node:
|
|
2090
|
+
$ref: '#/components/schemas/CIAppHostInfo'
|
|
2091
|
+
parameters:
|
|
2092
|
+
$ref: '#/components/schemas/CIAppPipelineEventParameters'
|
|
2093
|
+
pipeline_name:
|
|
2094
|
+
description: The parent pipeline name.
|
|
2095
|
+
example: Build
|
|
2096
|
+
type: string
|
|
2097
|
+
pipeline_unique_id:
|
|
2098
|
+
description: The parent pipeline UUID.
|
|
2099
|
+
example: 76b572af-a078-42b2-a08a-cc28f98b944f
|
|
2100
|
+
type: string
|
|
2101
|
+
stage_id:
|
|
2102
|
+
description: The parent stage UUID (if applicable).
|
|
2103
|
+
nullable: true
|
|
2104
|
+
type: string
|
|
2105
|
+
stage_name:
|
|
2106
|
+
description: The parent stage name (if applicable).
|
|
2107
|
+
nullable: true
|
|
2108
|
+
type: string
|
|
2109
|
+
start:
|
|
2110
|
+
description: Time when the step run started. The time format must be RFC3339.
|
|
2111
|
+
example: '2023-05-31T15:30:00Z'
|
|
2112
|
+
format: date-time
|
|
2113
|
+
type: string
|
|
2114
|
+
status:
|
|
2115
|
+
$ref: '#/components/schemas/CIAppPipelineEventStepStatus'
|
|
2116
|
+
tags:
|
|
2117
|
+
$ref: '#/components/schemas/CIAppPipelineEventTags'
|
|
2118
|
+
url:
|
|
2119
|
+
description: The URL to look at the step in the CI provider UI.
|
|
2120
|
+
nullable: true
|
|
2121
|
+
type: string
|
|
2122
|
+
required:
|
|
2123
|
+
- level
|
|
2124
|
+
- id
|
|
2125
|
+
- name
|
|
2126
|
+
- pipeline_unique_id
|
|
2127
|
+
- pipeline_name
|
|
2128
|
+
- start
|
|
2129
|
+
- end
|
|
2130
|
+
- status
|
|
2131
|
+
- git
|
|
2132
|
+
type: object
|
|
2133
|
+
CIAppPipelineEventStepLevel:
|
|
2134
|
+
default: step
|
|
2135
|
+
description: Used to distinguish between pipelines, stages, jobs and steps.
|
|
2136
|
+
enum:
|
|
2137
|
+
- step
|
|
2138
|
+
example: step
|
|
2139
|
+
type: string
|
|
2140
|
+
x-enum-varnames:
|
|
2141
|
+
- STEP
|
|
2142
|
+
CIAppPipelineEventStepStatus:
|
|
2143
|
+
description: The final status of the step.
|
|
2144
|
+
enum:
|
|
2145
|
+
- success
|
|
2146
|
+
- error
|
|
2147
|
+
example: success
|
|
2148
|
+
type: string
|
|
2149
|
+
x-enum-varnames:
|
|
2150
|
+
- SUCCESS
|
|
2151
|
+
- ERROR
|
|
2152
|
+
CIAppPipelineEventTags:
|
|
2153
|
+
description: A list of user-defined tags. The tags must follow the `key:value`
|
|
2154
|
+
pattern.
|
|
2155
|
+
example:
|
|
2156
|
+
- team:backend
|
|
2157
|
+
- type:deployment
|
|
2158
|
+
items:
|
|
2159
|
+
description: Tags in the form of `key:value`.
|
|
2160
|
+
type: string
|
|
2161
|
+
nullable: true
|
|
2162
|
+
type: array
|
|
2163
|
+
CIAppPipelineEventTypeName:
|
|
2164
|
+
description: Type of the event.
|
|
2165
|
+
enum:
|
|
2166
|
+
- cipipeline
|
|
2167
|
+
example: cipipeline
|
|
2168
|
+
type: string
|
|
2169
|
+
x-enum-varnames:
|
|
2170
|
+
- CIPIPELINE
|
|
2171
|
+
CIAppPipelineEventsRequest:
|
|
2172
|
+
description: The request for a pipelines search.
|
|
2173
|
+
properties:
|
|
2174
|
+
filter:
|
|
2175
|
+
$ref: '#/components/schemas/CIAppPipelinesQueryFilter'
|
|
2176
|
+
options:
|
|
2177
|
+
$ref: '#/components/schemas/CIAppQueryOptions'
|
|
2178
|
+
page:
|
|
2179
|
+
$ref: '#/components/schemas/CIAppQueryPageOptions'
|
|
2180
|
+
sort:
|
|
2181
|
+
$ref: '#/components/schemas/CIAppSort'
|
|
2182
|
+
type: object
|
|
2183
|
+
CIAppPipelineEventsResponse:
|
|
2184
|
+
description: Response object with all pipeline events matching the request and
|
|
2185
|
+
pagination information.
|
|
2186
|
+
properties:
|
|
2187
|
+
data:
|
|
2188
|
+
description: Array of events matching the request.
|
|
2189
|
+
items:
|
|
2190
|
+
$ref: '#/components/schemas/CIAppPipelineEvent'
|
|
2191
|
+
type: array
|
|
2192
|
+
links:
|
|
2193
|
+
$ref: '#/components/schemas/CIAppResponseLinks'
|
|
2194
|
+
meta:
|
|
2195
|
+
$ref: '#/components/schemas/CIAppResponseMetadataWithPagination'
|
|
2196
|
+
type: object
|
|
2197
|
+
CIAppPipelinesAggregateRequest:
|
|
2198
|
+
description: The object sent with the request to retrieve aggregation buckets
|
|
2199
|
+
of pipeline events from your organization.
|
|
2200
|
+
properties:
|
|
2201
|
+
compute:
|
|
2202
|
+
description: The list of metrics or timeseries to compute for the retrieved
|
|
2203
|
+
buckets.
|
|
2204
|
+
items:
|
|
2205
|
+
$ref: '#/components/schemas/CIAppCompute'
|
|
2206
|
+
type: array
|
|
2207
|
+
filter:
|
|
2208
|
+
$ref: '#/components/schemas/CIAppPipelinesQueryFilter'
|
|
2209
|
+
group_by:
|
|
2210
|
+
description: The rules for the group-by.
|
|
2211
|
+
items:
|
|
2212
|
+
$ref: '#/components/schemas/CIAppPipelinesGroupBy'
|
|
2213
|
+
type: array
|
|
2214
|
+
options:
|
|
2215
|
+
$ref: '#/components/schemas/CIAppQueryOptions'
|
|
2216
|
+
type: object
|
|
2217
|
+
CIAppPipelinesAggregationBucketsResponse:
|
|
2218
|
+
description: The query results.
|
|
2219
|
+
properties:
|
|
2220
|
+
buckets:
|
|
2221
|
+
description: The list of matching buckets, one item per bucket.
|
|
2222
|
+
items:
|
|
2223
|
+
$ref: '#/components/schemas/CIAppPipelinesBucketResponse'
|
|
2224
|
+
type: array
|
|
1514
2225
|
type: object
|
|
1515
2226
|
CIAppPipelinesAnalyticsAggregateResponse:
|
|
1516
2227
|
description: The response object for the pipeline events aggregate API endpoint.
|
|
@@ -1729,7 +2440,7 @@ components:
|
|
|
1729
2440
|
example: citest
|
|
1730
2441
|
type: string
|
|
1731
2442
|
x-enum-varnames:
|
|
1732
|
-
-
|
|
2443
|
+
- CITEST
|
|
1733
2444
|
CIAppTestEventsRequest:
|
|
1734
2445
|
description: The request for a tests search.
|
|
1735
2446
|
properties:
|
|
@@ -1985,6 +2696,12 @@ components:
|
|
|
1985
2696
|
type: array
|
|
1986
2697
|
complianceSignalOptions:
|
|
1987
2698
|
$ref: '#/components/schemas/CloudConfigurationRuleComplianceSignalOptions'
|
|
2699
|
+
filters:
|
|
2700
|
+
description: Additional queries to filter matched events before they are
|
|
2701
|
+
processed.
|
|
2702
|
+
items:
|
|
2703
|
+
$ref: '#/components/schemas/SecurityMonitoringFilter'
|
|
2704
|
+
type: array
|
|
1988
2705
|
isEnabled:
|
|
1989
2706
|
description: Whether the rule is enabled.
|
|
1990
2707
|
example: true
|
|
@@ -2045,10 +2762,17 @@ components:
|
|
|
2045
2762
|
CloudWorkloadSecurityAgentRuleAttributes:
|
|
2046
2763
|
description: A Cloud Workload Security Agent rule returned by the API.
|
|
2047
2764
|
properties:
|
|
2765
|
+
agentConstraint:
|
|
2766
|
+
description: The version of the agent.
|
|
2767
|
+
type: string
|
|
2048
2768
|
category:
|
|
2049
2769
|
description: The category of the Agent rule.
|
|
2050
2770
|
example: Process Activity
|
|
2051
2771
|
type: string
|
|
2772
|
+
creationAuthorUuId:
|
|
2773
|
+
description: The ID of the user who created the rule.
|
|
2774
|
+
example: e51c9744-d158-11ec-ad23-da7ad0900002
|
|
2775
|
+
type: string
|
|
2052
2776
|
creationDate:
|
|
2053
2777
|
description: When the Agent rule was created, timestamp in milliseconds.
|
|
2054
2778
|
example: 1624366480320
|
|
@@ -2076,6 +2800,15 @@ components:
|
|
|
2076
2800
|
description: The name of the Agent rule.
|
|
2077
2801
|
example: my_agent_rule
|
|
2078
2802
|
type: string
|
|
2803
|
+
updateAuthorUuId:
|
|
2804
|
+
description: The ID of the user who updated the rule.
|
|
2805
|
+
example: e51c9744-d158-11ec-ad23-da7ad0900002
|
|
2806
|
+
type: string
|
|
2807
|
+
updateDate:
|
|
2808
|
+
description: Timestamp in milliseconds when the Agent rule was last updated.
|
|
2809
|
+
example: 1624366480320
|
|
2810
|
+
format: int64
|
|
2811
|
+
type: integer
|
|
2079
2812
|
updatedAt:
|
|
2080
2813
|
description: When the Agent rule was last updated, timestamp in milliseconds.
|
|
2081
2814
|
example: 1624366480320
|
|
@@ -2405,6 +3138,12 @@ components:
|
|
|
2405
3138
|
ConfluentAccountResourceAttributes:
|
|
2406
3139
|
description: Attributes object for updating a Confluent resource.
|
|
2407
3140
|
properties:
|
|
3141
|
+
enable_custom_metrics:
|
|
3142
|
+
default: false
|
|
3143
|
+
description: Enable the `custom.consumer_lag_offset` metric, which contains
|
|
3144
|
+
extra metric tags.
|
|
3145
|
+
example: false
|
|
3146
|
+
type: boolean
|
|
2408
3147
|
id:
|
|
2409
3148
|
description: The ID associated with a Confluent resource.
|
|
2410
3149
|
example: resource-id-123
|
|
@@ -2545,6 +3284,12 @@ components:
|
|
|
2545
3284
|
ConfluentResourceRequestAttributes:
|
|
2546
3285
|
description: Attributes object for updating a Confluent resource.
|
|
2547
3286
|
properties:
|
|
3287
|
+
enable_custom_metrics:
|
|
3288
|
+
default: false
|
|
3289
|
+
description: Enable the `custom.consumer_lag_offset` metric, which contains
|
|
3290
|
+
extra metric tags.
|
|
3291
|
+
example: false
|
|
3292
|
+
type: boolean
|
|
2548
3293
|
resource_type:
|
|
2549
3294
|
description: The resource type of the Resource. Can be `kafka`, `connector`,
|
|
2550
3295
|
`ksql`, or `schema_registry`.
|
|
@@ -2587,6 +3332,16 @@ components:
|
|
|
2587
3332
|
ConfluentResourceResponseAttributes:
|
|
2588
3333
|
description: Model representation of a Confluent Cloud resource.
|
|
2589
3334
|
properties:
|
|
3335
|
+
enable_custom_metrics:
|
|
3336
|
+
default: false
|
|
3337
|
+
description: Enable the `custom.consumer_lag_offset` metric, which contains
|
|
3338
|
+
extra metric tags.
|
|
3339
|
+
example: false
|
|
3340
|
+
type: boolean
|
|
3341
|
+
id:
|
|
3342
|
+
description: The ID associated with the Confluent resource.
|
|
3343
|
+
example: resource_id_abc123
|
|
3344
|
+
type: string
|
|
2590
3345
|
resource_type:
|
|
2591
3346
|
description: The resource type of the Resource. Can be `kafka`, `connector`,
|
|
2592
3347
|
`ksql`, or `schema_registry`.
|
|
@@ -2774,6 +3529,11 @@ components:
|
|
|
2774
3529
|
description: ID of the dashboard.
|
|
2775
3530
|
example: q5j-nti-fv6
|
|
2776
3531
|
type: string
|
|
3532
|
+
integration_id:
|
|
3533
|
+
description: The short name of the integration.
|
|
3534
|
+
nullable: true
|
|
3535
|
+
readOnly: true
|
|
3536
|
+
type: string
|
|
2777
3537
|
is_favorite:
|
|
2778
3538
|
description: Whether or not the dashboard is in the favorites.
|
|
2779
3539
|
readOnly: true
|
|
@@ -2973,71 +3733,649 @@ components:
|
|
|
2973
3733
|
type: string
|
|
2974
3734
|
x-enum-varnames:
|
|
2975
3735
|
- DETAILED_FINDING
|
|
2976
|
-
|
|
2977
|
-
description:
|
|
3736
|
+
DowntimeCreateRequest:
|
|
3737
|
+
description: Request for creating a downtime.
|
|
2978
3738
|
properties:
|
|
2979
|
-
|
|
2980
|
-
|
|
2981
|
-
|
|
2982
|
-
|
|
2983
|
-
name:
|
|
2984
|
-
description: The event name.
|
|
2985
|
-
type: string
|
|
2986
|
-
source_id:
|
|
2987
|
-
description: Event source ID.
|
|
2988
|
-
example: 36
|
|
2989
|
-
format: int64
|
|
2990
|
-
type: integer
|
|
2991
|
-
type:
|
|
2992
|
-
description: Event type.
|
|
2993
|
-
example: error_tracking_alert
|
|
2994
|
-
type: string
|
|
3739
|
+
data:
|
|
3740
|
+
$ref: '#/components/schemas/DowntimeCreateRequestData'
|
|
3741
|
+
required:
|
|
3742
|
+
- data
|
|
2995
3743
|
type: object
|
|
2996
|
-
|
|
2997
|
-
description:
|
|
3744
|
+
DowntimeCreateRequestAttributes:
|
|
3745
|
+
description: Downtime details.
|
|
2998
3746
|
properties:
|
|
2999
|
-
|
|
3000
|
-
|
|
3001
|
-
|
|
3002
|
-
|
|
3003
|
-
|
|
3004
|
-
|
|
3747
|
+
display_timezone:
|
|
3748
|
+
$ref: '#/components/schemas/DowntimeDisplayTimezone'
|
|
3749
|
+
message:
|
|
3750
|
+
$ref: '#/components/schemas/DowntimeMessage'
|
|
3751
|
+
monitor_identifier:
|
|
3752
|
+
$ref: '#/components/schemas/DowntimeMonitorIdentifier'
|
|
3753
|
+
mute_first_recovery_notification:
|
|
3754
|
+
$ref: '#/components/schemas/DowntimeMuteFirstRecoveryNotification'
|
|
3755
|
+
notify_end_states:
|
|
3756
|
+
$ref: '#/components/schemas/DowntimeNotifyEndStates'
|
|
3757
|
+
notify_end_types:
|
|
3758
|
+
$ref: '#/components/schemas/DowntimeNotifyEndTypes'
|
|
3759
|
+
schedule:
|
|
3760
|
+
$ref: '#/components/schemas/DowntimeScheduleCreateRequest'
|
|
3761
|
+
scope:
|
|
3762
|
+
$ref: '#/components/schemas/DowntimeScope'
|
|
3763
|
+
required:
|
|
3764
|
+
- scope
|
|
3765
|
+
- monitor_identifier
|
|
3766
|
+
type: object
|
|
3767
|
+
DowntimeCreateRequestData:
|
|
3768
|
+
description: Object to create a downtime.
|
|
3769
|
+
properties:
|
|
3770
|
+
attributes:
|
|
3771
|
+
$ref: '#/components/schemas/DowntimeCreateRequestAttributes'
|
|
3772
|
+
type:
|
|
3773
|
+
$ref: '#/components/schemas/DowntimeResourceType'
|
|
3774
|
+
required:
|
|
3775
|
+
- type
|
|
3776
|
+
- attributes
|
|
3777
|
+
type: object
|
|
3778
|
+
DowntimeDisplayTimezone:
|
|
3779
|
+
default: UTC
|
|
3780
|
+
description: 'The timezone in which to display the downtime''s start and end
|
|
3781
|
+
times in Datadog applications. This is not used
|
|
3005
3782
|
|
|
3006
|
-
|
|
3783
|
+
as an offset for scheduling.'
|
|
3784
|
+
example: America/New_York
|
|
3785
|
+
nullable: true
|
|
3786
|
+
type: string
|
|
3787
|
+
DowntimeIncludedMonitorType:
|
|
3788
|
+
default: monitors
|
|
3789
|
+
description: Monitor resource type.
|
|
3790
|
+
enum:
|
|
3791
|
+
- monitors
|
|
3792
|
+
example: monitors
|
|
3793
|
+
type: string
|
|
3794
|
+
x-enum-varnames:
|
|
3795
|
+
- MONITORS
|
|
3796
|
+
DowntimeMessage:
|
|
3797
|
+
description: 'A message to include with notifications for this downtime. Email
|
|
3798
|
+
notifications can be sent to specific users
|
|
3799
|
+
|
|
3800
|
+
by using the same `@username` notation as events.'
|
|
3801
|
+
example: Message about the downtime
|
|
3802
|
+
nullable: true
|
|
3803
|
+
type: string
|
|
3804
|
+
DowntimeMeta:
|
|
3805
|
+
description: Pagination metadata returned by the API.
|
|
3806
|
+
properties:
|
|
3807
|
+
page:
|
|
3808
|
+
$ref: '#/components/schemas/DowntimeMetaPage'
|
|
3809
|
+
type: object
|
|
3810
|
+
DowntimeMetaPage:
|
|
3811
|
+
description: Object containing the total filtered count.
|
|
3812
|
+
properties:
|
|
3813
|
+
total_filtered_count:
|
|
3814
|
+
description: Total count of elements matched by the filter.
|
|
3007
3815
|
format: int64
|
|
3008
3816
|
type: integer
|
|
3009
|
-
|
|
3010
|
-
|
|
3011
|
-
|
|
3012
|
-
|
|
3013
|
-
|
|
3014
|
-
|
|
3817
|
+
type: object
|
|
3818
|
+
DowntimeMonitorIdentifier:
|
|
3819
|
+
description: Monitor identifier for the downtime.
|
|
3820
|
+
oneOf:
|
|
3821
|
+
- $ref: '#/components/schemas/DowntimeMonitorIdentifierId'
|
|
3822
|
+
- $ref: '#/components/schemas/DowntimeMonitorIdentifierTags'
|
|
3823
|
+
type: object
|
|
3824
|
+
DowntimeMonitorIdentifierId:
|
|
3825
|
+
additionalProperties: {}
|
|
3826
|
+
description: Object of the monitor identifier.
|
|
3827
|
+
properties:
|
|
3828
|
+
monitor_id:
|
|
3829
|
+
description: ID of the monitor to prevent notifications.
|
|
3830
|
+
example: 123
|
|
3015
3831
|
format: int64
|
|
3016
3832
|
type: integer
|
|
3017
|
-
|
|
3018
|
-
|
|
3019
|
-
|
|
3020
|
-
|
|
3021
|
-
|
|
3022
|
-
|
|
3023
|
-
|
|
3024
|
-
|
|
3833
|
+
required:
|
|
3834
|
+
- monitor_id
|
|
3835
|
+
type: object
|
|
3836
|
+
DowntimeMonitorIdentifierTags:
|
|
3837
|
+
additionalProperties: {}
|
|
3838
|
+
description: Object of the monitor tags.
|
|
3839
|
+
properties:
|
|
3840
|
+
monitor_tags:
|
|
3841
|
+
description: 'A list of monitor tags. For example, tags that are applied
|
|
3842
|
+
directly to monitors,
|
|
3025
3843
|
|
|
3026
|
-
|
|
3027
|
-
|
|
3028
|
-
|
|
3029
|
-
|
|
3030
|
-
|
|
3031
|
-
|
|
3844
|
+
not tags that are used in monitor queries (which are filtered by the scope
|
|
3845
|
+
parameter), to which the downtime applies.
|
|
3846
|
+
|
|
3847
|
+
The resulting downtime applies to monitors that match **all** provided
|
|
3848
|
+
monitor tags. Setting `monitor_tags`
|
|
3849
|
+
|
|
3850
|
+
to `[*]` configures the downtime to mute all monitors for the given scope.'
|
|
3851
|
+
example:
|
|
3852
|
+
- service:postgres
|
|
3853
|
+
- team:frontend
|
|
3032
3854
|
items:
|
|
3033
|
-
description:
|
|
3855
|
+
description: A list of monitor tags.
|
|
3856
|
+
example: service:postgres
|
|
3034
3857
|
type: string
|
|
3035
|
-
|
|
3858
|
+
minItems: 1
|
|
3036
3859
|
type: array
|
|
3037
|
-
|
|
3038
|
-
|
|
3039
|
-
|
|
3040
|
-
|
|
3860
|
+
required:
|
|
3861
|
+
- monitor_tags
|
|
3862
|
+
type: object
|
|
3863
|
+
DowntimeMonitorIncludedAttributes:
|
|
3864
|
+
description: Attributes of the monitor identified by the downtime.
|
|
3865
|
+
properties:
|
|
3866
|
+
name:
|
|
3867
|
+
description: The name of the monitor identified by the downtime.
|
|
3868
|
+
example: A monitor name
|
|
3869
|
+
type: string
|
|
3870
|
+
type: object
|
|
3871
|
+
DowntimeMonitorIncludedItem:
|
|
3872
|
+
description: Information about the monitor identified by the downtime.
|
|
3873
|
+
properties:
|
|
3874
|
+
attributes:
|
|
3875
|
+
$ref: '#/components/schemas/DowntimeMonitorIncludedAttributes'
|
|
3876
|
+
id:
|
|
3877
|
+
description: ID of the monitor identified by the downtime.
|
|
3878
|
+
example: 12345
|
|
3879
|
+
format: int64
|
|
3880
|
+
type: integer
|
|
3881
|
+
type:
|
|
3882
|
+
$ref: '#/components/schemas/DowntimeIncludedMonitorType'
|
|
3883
|
+
type: object
|
|
3884
|
+
DowntimeMuteFirstRecoveryNotification:
|
|
3885
|
+
description: If the first recovery notification during a downtime should be
|
|
3886
|
+
muted.
|
|
3887
|
+
example: false
|
|
3888
|
+
type: boolean
|
|
3889
|
+
DowntimeNotifyEndStateActions:
|
|
3890
|
+
description: Action that will trigger a monitor notification if the downtime
|
|
3891
|
+
is in the `notify_end_types` state.
|
|
3892
|
+
enum:
|
|
3893
|
+
- canceled
|
|
3894
|
+
- expired
|
|
3895
|
+
example: canceled
|
|
3896
|
+
type: string
|
|
3897
|
+
x-enum-varnames:
|
|
3898
|
+
- CANCELED
|
|
3899
|
+
- EXPIRED
|
|
3900
|
+
DowntimeNotifyEndStateTypes:
|
|
3901
|
+
description: State that will trigger a monitor notification when the `notify_end_types`
|
|
3902
|
+
action occurs.
|
|
3903
|
+
enum:
|
|
3904
|
+
- alert
|
|
3905
|
+
- no data
|
|
3906
|
+
- warn
|
|
3907
|
+
example: alert
|
|
3908
|
+
type: string
|
|
3909
|
+
x-enum-varnames:
|
|
3910
|
+
- ALERT
|
|
3911
|
+
- NO_DATA
|
|
3912
|
+
- WARN
|
|
3913
|
+
DowntimeNotifyEndStates:
|
|
3914
|
+
description: States that will trigger a monitor notification when the `notify_end_types`
|
|
3915
|
+
action occurs.
|
|
3916
|
+
example:
|
|
3917
|
+
- alert
|
|
3918
|
+
- warn
|
|
3919
|
+
items:
|
|
3920
|
+
$ref: '#/components/schemas/DowntimeNotifyEndStateTypes'
|
|
3921
|
+
type: array
|
|
3922
|
+
DowntimeNotifyEndTypes:
|
|
3923
|
+
description: Actions that will trigger a monitor notification if the downtime
|
|
3924
|
+
is in the `notify_end_types` state.
|
|
3925
|
+
example:
|
|
3926
|
+
- canceled
|
|
3927
|
+
- expired
|
|
3928
|
+
items:
|
|
3929
|
+
$ref: '#/components/schemas/DowntimeNotifyEndStateActions'
|
|
3930
|
+
type: array
|
|
3931
|
+
DowntimeRelationships:
|
|
3932
|
+
description: All relationships associated with downtime.
|
|
3933
|
+
properties:
|
|
3934
|
+
created_by:
|
|
3935
|
+
$ref: '#/components/schemas/DowntimeRelationshipsCreatedBy'
|
|
3936
|
+
monitor:
|
|
3937
|
+
$ref: '#/components/schemas/DowntimeRelationshipsMonitor'
|
|
3938
|
+
type: object
|
|
3939
|
+
DowntimeRelationshipsCreatedBy:
|
|
3940
|
+
description: The user who created the downtime.
|
|
3941
|
+
properties:
|
|
3942
|
+
data:
|
|
3943
|
+
$ref: '#/components/schemas/DowntimeRelationshipsCreatedByData'
|
|
3944
|
+
type: object
|
|
3945
|
+
DowntimeRelationshipsCreatedByData:
|
|
3946
|
+
description: Data for the user who created the downtime.
|
|
3947
|
+
nullable: true
|
|
3948
|
+
properties:
|
|
3949
|
+
id:
|
|
3950
|
+
description: User ID of the downtime creator.
|
|
3951
|
+
example: 00000000-0000-1234-0000-000000000000
|
|
3952
|
+
type: string
|
|
3953
|
+
type:
|
|
3954
|
+
$ref: '#/components/schemas/UsersType'
|
|
3955
|
+
type: object
|
|
3956
|
+
DowntimeRelationshipsMonitor:
|
|
3957
|
+
description: The monitor identified by the downtime.
|
|
3958
|
+
properties:
|
|
3959
|
+
data:
|
|
3960
|
+
$ref: '#/components/schemas/DowntimeRelationshipsMonitorData'
|
|
3961
|
+
type: object
|
|
3962
|
+
DowntimeRelationshipsMonitorData:
|
|
3963
|
+
description: Data for the monitor.
|
|
3964
|
+
nullable: true
|
|
3965
|
+
properties:
|
|
3966
|
+
id:
|
|
3967
|
+
description: Monitor ID of the downtime.
|
|
3968
|
+
example: 12345
|
|
3969
|
+
format: int64
|
|
3970
|
+
type: integer
|
|
3971
|
+
type:
|
|
3972
|
+
$ref: '#/components/schemas/DowntimeIncludedMonitorType'
|
|
3973
|
+
type: object
|
|
3974
|
+
DowntimeResourceType:
|
|
3975
|
+
default: downtime
|
|
3976
|
+
description: Downtime resource type.
|
|
3977
|
+
enum:
|
|
3978
|
+
- downtime
|
|
3979
|
+
example: downtime
|
|
3980
|
+
type: string
|
|
3981
|
+
x-enum-varnames:
|
|
3982
|
+
- DOWNTIME
|
|
3983
|
+
DowntimeResponse:
|
|
3984
|
+
description: 'Downtiming gives you greater control over monitor notifications
|
|
3985
|
+
by
|
|
3986
|
+
|
|
3987
|
+
allowing you to globally exclude scopes from alerting.
|
|
3988
|
+
|
|
3989
|
+
Downtime settings, which can be scheduled with start and end times,
|
|
3990
|
+
|
|
3991
|
+
prevent all alerting related to specified Datadog tags.'
|
|
3992
|
+
properties:
|
|
3993
|
+
data:
|
|
3994
|
+
$ref: '#/components/schemas/DowntimeResponseData'
|
|
3995
|
+
included:
|
|
3996
|
+
description: Array of objects related to the downtime that the user requested.
|
|
3997
|
+
items:
|
|
3998
|
+
$ref: '#/components/schemas/DowntimeResponseIncludedItem'
|
|
3999
|
+
type: array
|
|
4000
|
+
type: object
|
|
4001
|
+
DowntimeResponseAttributes:
|
|
4002
|
+
description: Downtime details.
|
|
4003
|
+
properties:
|
|
4004
|
+
canceled:
|
|
4005
|
+
description: Time that the downtime was canceled.
|
|
4006
|
+
example: 2020-01-02T03:04:05.282979+0000
|
|
4007
|
+
format: date-time
|
|
4008
|
+
nullable: true
|
|
4009
|
+
type: string
|
|
4010
|
+
created:
|
|
4011
|
+
description: Creation time of the downtime.
|
|
4012
|
+
example: 2020-01-02T03:04:05.282979+0000
|
|
4013
|
+
format: date-time
|
|
4014
|
+
type: string
|
|
4015
|
+
display_timezone:
|
|
4016
|
+
$ref: '#/components/schemas/DowntimeDisplayTimezone'
|
|
4017
|
+
message:
|
|
4018
|
+
$ref: '#/components/schemas/DowntimeMessage'
|
|
4019
|
+
modified:
|
|
4020
|
+
description: Time that the downtime was last modified.
|
|
4021
|
+
example: 2020-01-02T03:04:05.282979+0000
|
|
4022
|
+
format: date-time
|
|
4023
|
+
type: string
|
|
4024
|
+
monitor_identifier:
|
|
4025
|
+
$ref: '#/components/schemas/DowntimeMonitorIdentifier'
|
|
4026
|
+
mute_first_recovery_notification:
|
|
4027
|
+
$ref: '#/components/schemas/DowntimeMuteFirstRecoveryNotification'
|
|
4028
|
+
notify_end_states:
|
|
4029
|
+
$ref: '#/components/schemas/DowntimeNotifyEndStates'
|
|
4030
|
+
notify_end_types:
|
|
4031
|
+
$ref: '#/components/schemas/DowntimeNotifyEndTypes'
|
|
4032
|
+
schedule:
|
|
4033
|
+
$ref: '#/components/schemas/DowntimeScheduleResponse'
|
|
4034
|
+
scope:
|
|
4035
|
+
$ref: '#/components/schemas/DowntimeScope'
|
|
4036
|
+
status:
|
|
4037
|
+
$ref: '#/components/schemas/DowntimeStatus'
|
|
4038
|
+
type: object
|
|
4039
|
+
DowntimeResponseData:
|
|
4040
|
+
description: Downtime data.
|
|
4041
|
+
properties:
|
|
4042
|
+
attributes:
|
|
4043
|
+
$ref: '#/components/schemas/DowntimeResponseAttributes'
|
|
4044
|
+
id:
|
|
4045
|
+
description: The downtime ID.
|
|
4046
|
+
example: 00000000-0000-1234-0000-000000000000
|
|
4047
|
+
type: string
|
|
4048
|
+
relationships:
|
|
4049
|
+
$ref: '#/components/schemas/DowntimeRelationships'
|
|
4050
|
+
type:
|
|
4051
|
+
$ref: '#/components/schemas/DowntimeResourceType'
|
|
4052
|
+
type: object
|
|
4053
|
+
DowntimeResponseIncludedItem:
|
|
4054
|
+
description: An object related to a downtime.
|
|
4055
|
+
oneOf:
|
|
4056
|
+
- $ref: '#/components/schemas/User'
|
|
4057
|
+
- $ref: '#/components/schemas/DowntimeMonitorIncludedItem'
|
|
4058
|
+
type: object
|
|
4059
|
+
DowntimeScheduleCreateRequest:
|
|
4060
|
+
description: Schedule for the downtime.
|
|
4061
|
+
oneOf:
|
|
4062
|
+
- $ref: '#/components/schemas/DowntimeScheduleRecurrencesCreateRequest'
|
|
4063
|
+
- $ref: '#/components/schemas/DowntimeScheduleOneTimeCreateUpdateRequest'
|
|
4064
|
+
type: object
|
|
4065
|
+
DowntimeScheduleCurrentDowntimeResponse:
|
|
4066
|
+
description: 'The most recent actual start and end dates for a recurring downtime.
|
|
4067
|
+
For a canceled downtime,
|
|
4068
|
+
|
|
4069
|
+
this is the previously occurring downtime. For active downtimes, this is the
|
|
4070
|
+
ongoing downtime, and for scheduled
|
|
4071
|
+
|
|
4072
|
+
downtimes it is the upcoming downtime.'
|
|
4073
|
+
properties:
|
|
4074
|
+
end:
|
|
4075
|
+
description: The end of the current downtime.
|
|
4076
|
+
example: 2020-01-02 03:04:00+00:00
|
|
4077
|
+
format: date-time
|
|
4078
|
+
nullable: true
|
|
4079
|
+
type: string
|
|
4080
|
+
start:
|
|
4081
|
+
description: The start of the current downtime.
|
|
4082
|
+
example: 2020-01-02 03:04:00+00:00
|
|
4083
|
+
format: date-time
|
|
4084
|
+
type: string
|
|
4085
|
+
type: object
|
|
4086
|
+
DowntimeScheduleOneTimeCreateUpdateRequest:
|
|
4087
|
+
additionalProperties: {}
|
|
4088
|
+
description: A one-time downtime definition.
|
|
4089
|
+
properties:
|
|
4090
|
+
end:
|
|
4091
|
+
description: 'ISO-8601 Datetime to end the downtime. Must include a UTC
|
|
4092
|
+
offset of zero. If not provided, the
|
|
4093
|
+
|
|
4094
|
+
downtime continues forever.'
|
|
4095
|
+
example: 2020-01-02 03:04:00+00:00
|
|
4096
|
+
format: date-time
|
|
4097
|
+
nullable: true
|
|
4098
|
+
type: string
|
|
4099
|
+
start:
|
|
4100
|
+
description: 'ISO-8601 Datetime to start the downtime. Must include a UTC
|
|
4101
|
+
offset of zero. If not provided, the
|
|
4102
|
+
|
|
4103
|
+
downtime starts the moment it is created.'
|
|
4104
|
+
example: 2020-01-02 03:04:00+00:00
|
|
4105
|
+
format: date-time
|
|
4106
|
+
nullable: true
|
|
4107
|
+
type: string
|
|
4108
|
+
type: object
|
|
4109
|
+
DowntimeScheduleOneTimeResponse:
|
|
4110
|
+
description: A one-time downtime definition.
|
|
4111
|
+
properties:
|
|
4112
|
+
end:
|
|
4113
|
+
description: ISO-8601 Datetime to end the downtime.
|
|
4114
|
+
example: 2020-01-02 03:04:00+00:00
|
|
4115
|
+
format: date-time
|
|
4116
|
+
nullable: true
|
|
4117
|
+
type: string
|
|
4118
|
+
start:
|
|
4119
|
+
description: ISO-8601 Datetime to start the downtime.
|
|
4120
|
+
example: 2020-01-02 03:04:00+00:00
|
|
4121
|
+
format: date-time
|
|
4122
|
+
type: string
|
|
4123
|
+
type: object
|
|
4124
|
+
DowntimeScheduleRecurrenceCreateUpdateRequest:
|
|
4125
|
+
additionalProperties: {}
|
|
4126
|
+
description: An object defining the recurrence of the downtime.
|
|
4127
|
+
properties:
|
|
4128
|
+
duration:
|
|
4129
|
+
$ref: '#/components/schemas/DowntimeScheduleRecurrenceDuration'
|
|
4130
|
+
rrule:
|
|
4131
|
+
$ref: '#/components/schemas/DowntimeScheduleRecurrenceRrule'
|
|
4132
|
+
start:
|
|
4133
|
+
description: 'ISO-8601 Datetime to start the downtime. Must not include
|
|
4134
|
+
a UTC offset. If not provided, the
|
|
4135
|
+
|
|
4136
|
+
downtime starts the moment it is created.'
|
|
4137
|
+
example: 2020-01-02T03:04
|
|
4138
|
+
nullable: true
|
|
4139
|
+
type: string
|
|
4140
|
+
required:
|
|
4141
|
+
- duration
|
|
4142
|
+
- rrule
|
|
4143
|
+
type: object
|
|
4144
|
+
DowntimeScheduleRecurrenceDuration:
|
|
4145
|
+
description: The length of the downtime. Must begin with an integer and end
|
|
4146
|
+
with one of 'm', 'h', d', or 'w'.
|
|
4147
|
+
example: 123d
|
|
4148
|
+
type: string
|
|
4149
|
+
DowntimeScheduleRecurrenceResponse:
|
|
4150
|
+
description: An RRULE-based recurring downtime.
|
|
4151
|
+
properties:
|
|
4152
|
+
duration:
|
|
4153
|
+
$ref: '#/components/schemas/DowntimeScheduleRecurrenceDuration'
|
|
4154
|
+
rrule:
|
|
4155
|
+
$ref: '#/components/schemas/DowntimeScheduleRecurrenceRrule'
|
|
4156
|
+
start:
|
|
4157
|
+
description: 'ISO-8601 Datetime to start the downtime. Must not include
|
|
4158
|
+
a UTC offset. If not provided, the
|
|
4159
|
+
|
|
4160
|
+
downtime starts the moment it is created.'
|
|
4161
|
+
example: 2020-01-02T03:04
|
|
4162
|
+
type: string
|
|
4163
|
+
type: object
|
|
4164
|
+
DowntimeScheduleRecurrenceRrule:
|
|
4165
|
+
description: 'The `RRULE` standard for defining recurring events.
|
|
4166
|
+
|
|
4167
|
+
For example, to have a recurring event on the first day of each month, set
|
|
4168
|
+
the type to `rrule` and set the `FREQ` to `MONTHLY` and `BYMONTHDAY` to `1`.
|
|
4169
|
+
|
|
4170
|
+
Most common `rrule` options from the [iCalendar Spec](https://tools.ietf.org/html/rfc5545)
|
|
4171
|
+
are supported.
|
|
4172
|
+
|
|
4173
|
+
|
|
4174
|
+
**Note**: Attributes specifying the duration in `RRULE` are not supported
|
|
4175
|
+
(for example, `DTSTART`, `DTEND`, `DURATION`).
|
|
4176
|
+
|
|
4177
|
+
More examples available in this [downtime guide](https://docs.datadoghq.com/monitors/guide/suppress-alert-with-downtimes/?tab=api).'
|
|
4178
|
+
example: FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1
|
|
4179
|
+
type: string
|
|
4180
|
+
DowntimeScheduleRecurrencesCreateRequest:
|
|
4181
|
+
description: A recurring downtime schedule definition.
|
|
4182
|
+
properties:
|
|
4183
|
+
recurrences:
|
|
4184
|
+
description: A list of downtime recurrences.
|
|
4185
|
+
items:
|
|
4186
|
+
$ref: '#/components/schemas/DowntimeScheduleRecurrenceCreateUpdateRequest'
|
|
4187
|
+
type: array
|
|
4188
|
+
timezone:
|
|
4189
|
+
default: UTC
|
|
4190
|
+
description: The timezone in which to schedule the downtime.
|
|
4191
|
+
example: America/New_York
|
|
4192
|
+
type: string
|
|
4193
|
+
required:
|
|
4194
|
+
- recurrences
|
|
4195
|
+
type: object
|
|
4196
|
+
DowntimeScheduleRecurrencesResponse:
|
|
4197
|
+
description: A recurring downtime schedule definition.
|
|
4198
|
+
properties:
|
|
4199
|
+
current_downtime:
|
|
4200
|
+
$ref: '#/components/schemas/DowntimeScheduleCurrentDowntimeResponse'
|
|
4201
|
+
recurrences:
|
|
4202
|
+
description: A list of downtime recurrences.
|
|
4203
|
+
items:
|
|
4204
|
+
$ref: '#/components/schemas/DowntimeScheduleRecurrenceResponse'
|
|
4205
|
+
maxItems: 5
|
|
4206
|
+
minItems: 1
|
|
4207
|
+
type: array
|
|
4208
|
+
timezone:
|
|
4209
|
+
default: UTC
|
|
4210
|
+
description: 'The timezone in which to schedule the downtime. This affects
|
|
4211
|
+
recurring start and end dates.
|
|
4212
|
+
|
|
4213
|
+
Must match `display_timezone`.'
|
|
4214
|
+
example: America/New_York
|
|
4215
|
+
type: string
|
|
4216
|
+
required:
|
|
4217
|
+
- recurrences
|
|
4218
|
+
type: object
|
|
4219
|
+
DowntimeScheduleRecurrencesUpdateRequest:
|
|
4220
|
+
description: A recurring downtime schedule definition.
|
|
4221
|
+
properties:
|
|
4222
|
+
recurrences:
|
|
4223
|
+
description: A list of downtime recurrences.
|
|
4224
|
+
items:
|
|
4225
|
+
$ref: '#/components/schemas/DowntimeScheduleRecurrenceCreateUpdateRequest'
|
|
4226
|
+
type: array
|
|
4227
|
+
timezone:
|
|
4228
|
+
default: UTC
|
|
4229
|
+
description: The timezone in which to schedule the downtime.
|
|
4230
|
+
example: America/New_York
|
|
4231
|
+
type: string
|
|
4232
|
+
type: object
|
|
4233
|
+
DowntimeScheduleResponse:
|
|
4234
|
+
description: 'The schedule that defines when the monitor starts, stops, and
|
|
4235
|
+
recurs. There are two types of schedules:
|
|
4236
|
+
|
|
4237
|
+
one-time and recurring. Recurring schedules may have up to five RRULE-based
|
|
4238
|
+
recurrences. If no schedules are
|
|
4239
|
+
|
|
4240
|
+
provided, the downtime will begin immediately and never end.'
|
|
4241
|
+
oneOf:
|
|
4242
|
+
- $ref: '#/components/schemas/DowntimeScheduleRecurrencesResponse'
|
|
4243
|
+
- $ref: '#/components/schemas/DowntimeScheduleOneTimeResponse'
|
|
4244
|
+
type: object
|
|
4245
|
+
DowntimeScheduleUpdateRequest:
|
|
4246
|
+
description: Schedule for the downtime.
|
|
4247
|
+
oneOf:
|
|
4248
|
+
- $ref: '#/components/schemas/DowntimeScheduleRecurrencesUpdateRequest'
|
|
4249
|
+
- $ref: '#/components/schemas/DowntimeScheduleOneTimeCreateUpdateRequest'
|
|
4250
|
+
type: object
|
|
4251
|
+
DowntimeScope:
|
|
4252
|
+
description: The scope to which the downtime applies. Must follow the [common
|
|
4253
|
+
search syntax](https://docs.datadoghq.com/logs/explorer/search_syntax/).
|
|
4254
|
+
example: env:(staging OR prod) AND datacenter:us-east-1
|
|
4255
|
+
type: string
|
|
4256
|
+
DowntimeStatus:
|
|
4257
|
+
description: The current status of the downtime.
|
|
4258
|
+
enum:
|
|
4259
|
+
- active
|
|
4260
|
+
- canceled
|
|
4261
|
+
- ended
|
|
4262
|
+
- scheduled
|
|
4263
|
+
example: active
|
|
4264
|
+
type: string
|
|
4265
|
+
x-enum-varnames:
|
|
4266
|
+
- ACTIVE
|
|
4267
|
+
- CANCELED
|
|
4268
|
+
- ENDED
|
|
4269
|
+
- SCHEDULED
|
|
4270
|
+
DowntimeUpdateRequest:
|
|
4271
|
+
description: Request for editing a downtime.
|
|
4272
|
+
properties:
|
|
4273
|
+
data:
|
|
4274
|
+
$ref: '#/components/schemas/DowntimeUpdateRequestData'
|
|
4275
|
+
required:
|
|
4276
|
+
- data
|
|
4277
|
+
type: object
|
|
4278
|
+
DowntimeUpdateRequestAttributes:
|
|
4279
|
+
description: Attributes of the downtime to update.
|
|
4280
|
+
properties:
|
|
4281
|
+
display_timezone:
|
|
4282
|
+
$ref: '#/components/schemas/DowntimeDisplayTimezone'
|
|
4283
|
+
message:
|
|
4284
|
+
$ref: '#/components/schemas/DowntimeMessage'
|
|
4285
|
+
monitor_identifier:
|
|
4286
|
+
$ref: '#/components/schemas/DowntimeMonitorIdentifier'
|
|
4287
|
+
mute_first_recovery_notification:
|
|
4288
|
+
$ref: '#/components/schemas/DowntimeMuteFirstRecoveryNotification'
|
|
4289
|
+
notify_end_states:
|
|
4290
|
+
$ref: '#/components/schemas/DowntimeNotifyEndStates'
|
|
4291
|
+
notify_end_types:
|
|
4292
|
+
$ref: '#/components/schemas/DowntimeNotifyEndTypes'
|
|
4293
|
+
schedule:
|
|
4294
|
+
$ref: '#/components/schemas/DowntimeScheduleUpdateRequest'
|
|
4295
|
+
scope:
|
|
4296
|
+
$ref: '#/components/schemas/DowntimeScope'
|
|
4297
|
+
type: object
|
|
4298
|
+
DowntimeUpdateRequestData:
|
|
4299
|
+
description: Object to update a downtime.
|
|
4300
|
+
properties:
|
|
4301
|
+
attributes:
|
|
4302
|
+
$ref: '#/components/schemas/DowntimeUpdateRequestAttributes'
|
|
4303
|
+
id:
|
|
4304
|
+
description: ID of this downtime.
|
|
4305
|
+
example: 00000000-0000-1234-0000-000000000000
|
|
4306
|
+
type: string
|
|
4307
|
+
type:
|
|
4308
|
+
$ref: '#/components/schemas/DowntimeResourceType'
|
|
4309
|
+
required:
|
|
4310
|
+
- id
|
|
4311
|
+
- type
|
|
4312
|
+
- attributes
|
|
4313
|
+
type: object
|
|
4314
|
+
Event:
|
|
4315
|
+
description: The metadata associated with a request.
|
|
4316
|
+
properties:
|
|
4317
|
+
id:
|
|
4318
|
+
description: Event ID.
|
|
4319
|
+
example: '6509751066204996294'
|
|
4320
|
+
type: string
|
|
4321
|
+
name:
|
|
4322
|
+
description: The event name.
|
|
4323
|
+
type: string
|
|
4324
|
+
source_id:
|
|
4325
|
+
description: Event source ID.
|
|
4326
|
+
example: 36
|
|
4327
|
+
format: int64
|
|
4328
|
+
type: integer
|
|
4329
|
+
type:
|
|
4330
|
+
description: Event type.
|
|
4331
|
+
example: error_tracking_alert
|
|
4332
|
+
type: string
|
|
4333
|
+
type: object
|
|
4334
|
+
EventAttributes:
|
|
4335
|
+
description: Object description of attributes from your event.
|
|
4336
|
+
properties:
|
|
4337
|
+
aggregation_key:
|
|
4338
|
+
description: Aggregation key of the event.
|
|
4339
|
+
type: string
|
|
4340
|
+
date_happened:
|
|
4341
|
+
description: 'POSIX timestamp of the event. Must be sent as an integer (no
|
|
4342
|
+
quotation marks).
|
|
4343
|
+
|
|
4344
|
+
Limited to events no older than 18 hours.'
|
|
4345
|
+
format: int64
|
|
4346
|
+
type: integer
|
|
4347
|
+
device_name:
|
|
4348
|
+
description: A device name.
|
|
4349
|
+
type: string
|
|
4350
|
+
duration:
|
|
4351
|
+
description: The duration between the triggering of the event and its recovery
|
|
4352
|
+
in nanoseconds.
|
|
4353
|
+
format: int64
|
|
4354
|
+
type: integer
|
|
4355
|
+
event_object:
|
|
4356
|
+
description: The event title.
|
|
4357
|
+
example: Did you hear the news today?
|
|
4358
|
+
type: string
|
|
4359
|
+
evt:
|
|
4360
|
+
$ref: '#/components/schemas/Event'
|
|
4361
|
+
hostname:
|
|
4362
|
+
description: 'Host name to associate with the event.
|
|
4363
|
+
|
|
4364
|
+
Any tags associated with the host are also applied to this event.'
|
|
4365
|
+
type: string
|
|
4366
|
+
monitor:
|
|
4367
|
+
$ref: '#/components/schemas/MonitorType'
|
|
4368
|
+
monitor_groups:
|
|
4369
|
+
description: List of groups referred to in the event.
|
|
4370
|
+
items:
|
|
4371
|
+
description: Group referred to in the event.
|
|
4372
|
+
type: string
|
|
4373
|
+
nullable: true
|
|
4374
|
+
type: array
|
|
4375
|
+
monitor_id:
|
|
4376
|
+
description: ID of the monitor that triggered the event. When an event isn't
|
|
4377
|
+
related to a monitor, this field is empty.
|
|
4378
|
+
format: int64
|
|
3041
4379
|
nullable: true
|
|
3042
4380
|
type: integer
|
|
3043
4381
|
priority:
|
|
@@ -3111,6 +4449,9 @@ components:
|
|
|
3111
4449
|
properties:
|
|
3112
4450
|
attributes:
|
|
3113
4451
|
$ref: '#/components/schemas/EventAttributes'
|
|
4452
|
+
message:
|
|
4453
|
+
description: The message of the event.
|
|
4454
|
+
type: string
|
|
3114
4455
|
tags:
|
|
3115
4456
|
description: An array of tags associated with the event.
|
|
3116
4457
|
example:
|
|
@@ -3240,8 +4581,8 @@ components:
|
|
|
3240
4581
|
aggregation:
|
|
3241
4582
|
$ref: '#/components/schemas/EventsAggregation'
|
|
3242
4583
|
metric:
|
|
3243
|
-
description:
|
|
3244
|
-
sort order of a query's results.
|
|
4584
|
+
description: The metric's calculated value which should be used to define
|
|
4585
|
+
the sort order of a query's results.
|
|
3245
4586
|
example: '@duration'
|
|
3246
4587
|
type: string
|
|
3247
4588
|
order:
|
|
@@ -3361,6 +4702,10 @@ components:
|
|
|
3361
4702
|
description: The identifier of the request.
|
|
3362
4703
|
example: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR
|
|
3363
4704
|
type: string
|
|
4705
|
+
status:
|
|
4706
|
+
description: The request status.
|
|
4707
|
+
example: done
|
|
4708
|
+
type: string
|
|
3364
4709
|
warnings:
|
|
3365
4710
|
description: 'A list of warnings (non-fatal errors) encountered. Partial
|
|
3366
4711
|
results might be returned if
|
|
@@ -3674,7 +5019,7 @@ components:
|
|
|
3674
5019
|
type: array
|
|
3675
5020
|
type: object
|
|
3676
5021
|
Finding:
|
|
3677
|
-
description: A single finding without message and resource configuration.
|
|
5022
|
+
description: A single finding without the message and resource configuration.
|
|
3678
5023
|
properties:
|
|
3679
5024
|
attributes:
|
|
3680
5025
|
$ref: '#/components/schemas/FindingAttributes'
|
|
@@ -3732,16 +5077,16 @@ components:
|
|
|
3732
5077
|
properties:
|
|
3733
5078
|
description:
|
|
3734
5079
|
description: Additional information about the reason why this finding is
|
|
3735
|
-
muted.
|
|
5080
|
+
muted or unmuted.
|
|
3736
5081
|
example: To be resolved later
|
|
3737
5082
|
type: string
|
|
3738
5083
|
expiration_date:
|
|
3739
|
-
description: The
|
|
5084
|
+
description: The expiration date of the mute or unmute action (Unix ms).
|
|
3740
5085
|
example: 1778721573794
|
|
3741
5086
|
format: int64
|
|
3742
5087
|
type: integer
|
|
3743
5088
|
muted:
|
|
3744
|
-
description: Whether this finding is muted.
|
|
5089
|
+
description: Whether this finding is muted or unmuted.
|
|
3745
5090
|
example: true
|
|
3746
5091
|
type: boolean
|
|
3747
5092
|
reason:
|
|
@@ -3752,23 +5097,29 @@ components:
|
|
|
3752
5097
|
format: int64
|
|
3753
5098
|
type: integer
|
|
3754
5099
|
uuid:
|
|
3755
|
-
description: The ID of the user who muted this finding.
|
|
5100
|
+
description: The ID of the user who muted or unmuted this finding.
|
|
3756
5101
|
example: e51c9744-d158-11ec-ad23-da7ad0900002
|
|
3757
5102
|
type: string
|
|
3758
5103
|
type: object
|
|
3759
5104
|
FindingMuteReason:
|
|
3760
|
-
description: The reason why this finding is muted.
|
|
5105
|
+
description: The reason why this finding is muted or unmuted.
|
|
3761
5106
|
enum:
|
|
3762
|
-
- ACCEPTED_RISK
|
|
3763
5107
|
- PENDING_FIX
|
|
3764
5108
|
- FALSE_POSITIVE
|
|
5109
|
+
- ACCEPTED_RISK
|
|
5110
|
+
- NO_PENDING_FIX
|
|
5111
|
+
- HUMAN_ERROR
|
|
5112
|
+
- NO_LONGER_ACCEPTED_RISK
|
|
3765
5113
|
- OTHER
|
|
3766
5114
|
example: ACCEPTED_RISK
|
|
3767
5115
|
type: string
|
|
3768
5116
|
x-enum-varnames:
|
|
3769
|
-
- ACCEPTED_RISK
|
|
3770
5117
|
- PENDING_FIX
|
|
3771
5118
|
- FALSE_POSITIVE
|
|
5119
|
+
- ACCEPTED_RISK
|
|
5120
|
+
- NO_PENDING_FIX
|
|
5121
|
+
- HUMAN_ERROR
|
|
5122
|
+
- NO_LONGER_ACCEPTED_RISK
|
|
3772
5123
|
- OTHER
|
|
3773
5124
|
FindingResource:
|
|
3774
5125
|
description: The resource name of this finding.
|
|
@@ -4134,6 +5485,31 @@ components:
|
|
|
4134
5485
|
example: env:production
|
|
4135
5486
|
type: string
|
|
4136
5487
|
type: array
|
|
5488
|
+
HTTPCIAppError:
|
|
5489
|
+
description: List of errors.
|
|
5490
|
+
properties:
|
|
5491
|
+
detail:
|
|
5492
|
+
description: Error message.
|
|
5493
|
+
example: Malformed payload
|
|
5494
|
+
type: string
|
|
5495
|
+
status:
|
|
5496
|
+
description: Error code.
|
|
5497
|
+
example: '400'
|
|
5498
|
+
type: string
|
|
5499
|
+
title:
|
|
5500
|
+
description: Error title.
|
|
5501
|
+
example: Bad Request
|
|
5502
|
+
type: string
|
|
5503
|
+
type: object
|
|
5504
|
+
HTTPCIAppErrors:
|
|
5505
|
+
description: Errors occurred.
|
|
5506
|
+
properties:
|
|
5507
|
+
errors:
|
|
5508
|
+
description: Structured errors.
|
|
5509
|
+
items:
|
|
5510
|
+
$ref: '#/components/schemas/HTTPCIAppError'
|
|
5511
|
+
type: array
|
|
5512
|
+
type: object
|
|
4137
5513
|
HTTPLog:
|
|
4138
5514
|
description: Structured log message.
|
|
4139
5515
|
items:
|
|
@@ -6097,6 +7473,34 @@ components:
|
|
|
6097
7473
|
type: string
|
|
6098
7474
|
type: array
|
|
6099
7475
|
type: object
|
|
7476
|
+
JSONAPIErrorItem:
|
|
7477
|
+
description: API error response body
|
|
7478
|
+
properties:
|
|
7479
|
+
detail:
|
|
7480
|
+
description: A human-readable explanation specific to this occurrence of
|
|
7481
|
+
the error.
|
|
7482
|
+
example: Missing required attribute in body
|
|
7483
|
+
type: string
|
|
7484
|
+
status:
|
|
7485
|
+
description: Status code of the response.
|
|
7486
|
+
example: '400'
|
|
7487
|
+
type: string
|
|
7488
|
+
title:
|
|
7489
|
+
description: Short human-readable summary of the error.
|
|
7490
|
+
example: Bad Request
|
|
7491
|
+
type: string
|
|
7492
|
+
type: object
|
|
7493
|
+
JSONAPIErrorResponse:
|
|
7494
|
+
description: API error response.
|
|
7495
|
+
properties:
|
|
7496
|
+
errors:
|
|
7497
|
+
description: A list of errors.
|
|
7498
|
+
items:
|
|
7499
|
+
$ref: '#/components/schemas/JSONAPIErrorItem'
|
|
7500
|
+
type: array
|
|
7501
|
+
required:
|
|
7502
|
+
- errors
|
|
7503
|
+
type: object
|
|
6100
7504
|
JiraIntegrationMetadata:
|
|
6101
7505
|
description: Incident integration metadata for the Jira integration.
|
|
6102
7506
|
properties:
|
|
@@ -6150,6 +7554,22 @@ components:
|
|
|
6150
7554
|
$ref: '#/components/schemas/ApplicationKeyResponseIncludedItem'
|
|
6151
7555
|
type: array
|
|
6152
7556
|
type: object
|
|
7557
|
+
ListDowntimesResponse:
|
|
7558
|
+
description: Response for retrieving all downtimes.
|
|
7559
|
+
properties:
|
|
7560
|
+
data:
|
|
7561
|
+
description: An array of downtimes.
|
|
7562
|
+
items:
|
|
7563
|
+
$ref: '#/components/schemas/DowntimeResponseData'
|
|
7564
|
+
type: array
|
|
7565
|
+
included:
|
|
7566
|
+
description: Array of objects related to the downtimes.
|
|
7567
|
+
items:
|
|
7568
|
+
$ref: '#/components/schemas/DowntimeResponseIncludedItem'
|
|
7569
|
+
type: array
|
|
7570
|
+
meta:
|
|
7571
|
+
$ref: '#/components/schemas/DowntimeMeta'
|
|
7572
|
+
type: object
|
|
6153
7573
|
ListFindingsData:
|
|
6154
7574
|
description: Array of findings.
|
|
6155
7575
|
items:
|
|
@@ -8157,7 +9577,8 @@ components:
|
|
|
8157
9577
|
type: object
|
|
8158
9578
|
MetricsAggregator:
|
|
8159
9579
|
default: avg
|
|
8160
|
-
description: The type of aggregation that can be performed on metrics
|
|
9580
|
+
description: The type of aggregation that can be performed on metrics-based
|
|
9581
|
+
queries.
|
|
8161
9582
|
enum:
|
|
8162
9583
|
- avg
|
|
8163
9584
|
- min
|
|
@@ -8418,6 +9839,66 @@ components:
|
|
|
8418
9839
|
type: string
|
|
8419
9840
|
x-enum-varnames:
|
|
8420
9841
|
- TAG
|
|
9842
|
+
MonitorDowntimeMatchResourceType:
|
|
9843
|
+
default: downtime_match
|
|
9844
|
+
description: Monitor Downtime Match resource type.
|
|
9845
|
+
enum:
|
|
9846
|
+
- downtime_match
|
|
9847
|
+
example: downtime_match
|
|
9848
|
+
type: string
|
|
9849
|
+
x-enum-varnames:
|
|
9850
|
+
- DOWNTIME_MATCH
|
|
9851
|
+
MonitorDowntimeMatchResponse:
|
|
9852
|
+
description: Response for retrieving all downtime matches for a monitor.
|
|
9853
|
+
properties:
|
|
9854
|
+
data:
|
|
9855
|
+
description: An array of downtime matches.
|
|
9856
|
+
items:
|
|
9857
|
+
$ref: '#/components/schemas/MonitorDowntimeMatchResponseData'
|
|
9858
|
+
type: array
|
|
9859
|
+
meta:
|
|
9860
|
+
$ref: '#/components/schemas/DowntimeMeta'
|
|
9861
|
+
type: object
|
|
9862
|
+
MonitorDowntimeMatchResponseAttributes:
|
|
9863
|
+
description: Downtime match details.
|
|
9864
|
+
properties:
|
|
9865
|
+
end:
|
|
9866
|
+
description: The end of the downtime.
|
|
9867
|
+
example: 2020-01-02 03:04:00+00:00
|
|
9868
|
+
format: date-time
|
|
9869
|
+
nullable: true
|
|
9870
|
+
type: string
|
|
9871
|
+
groups:
|
|
9872
|
+
description: An array of groups associated with the downtime.
|
|
9873
|
+
example:
|
|
9874
|
+
- service:postgres
|
|
9875
|
+
- team:frontend
|
|
9876
|
+
items:
|
|
9877
|
+
description: An array of groups.
|
|
9878
|
+
example: service:postgres
|
|
9879
|
+
type: string
|
|
9880
|
+
type: array
|
|
9881
|
+
scope:
|
|
9882
|
+
$ref: '#/components/schemas/DowntimeScope'
|
|
9883
|
+
start:
|
|
9884
|
+
description: The start of the downtime.
|
|
9885
|
+
example: 2020-01-02 03:04:00+00:00
|
|
9886
|
+
format: date-time
|
|
9887
|
+
type: string
|
|
9888
|
+
type: object
|
|
9889
|
+
MonitorDowntimeMatchResponseData:
|
|
9890
|
+
description: A downtime match.
|
|
9891
|
+
properties:
|
|
9892
|
+
attributes:
|
|
9893
|
+
$ref: '#/components/schemas/MonitorDowntimeMatchResponseAttributes'
|
|
9894
|
+
id:
|
|
9895
|
+
description: The downtime ID.
|
|
9896
|
+
example: 00000000-0000-1234-0000-000000000000
|
|
9897
|
+
nullable: true
|
|
9898
|
+
type: string
|
|
9899
|
+
type:
|
|
9900
|
+
$ref: '#/components/schemas/MonitorDowntimeMatchResourceType'
|
|
9901
|
+
type: object
|
|
8421
9902
|
MonitorType:
|
|
8422
9903
|
description: Attributes from the monitor that triggered the event.
|
|
8423
9904
|
nullable: true
|
|
@@ -8449,27 +9930,160 @@ components:
|
|
|
8449
9930
|
description: The monitor's last-modified timestamp.
|
|
8450
9931
|
format: int64
|
|
8451
9932
|
type: integer
|
|
8452
|
-
name:
|
|
8453
|
-
description: The monitor name.
|
|
8454
|
-
type: string
|
|
8455
|
-
query:
|
|
8456
|
-
description: The query that triggers the alert.
|
|
8457
|
-
type: string
|
|
9933
|
+
name:
|
|
9934
|
+
description: The monitor name.
|
|
9935
|
+
type: string
|
|
9936
|
+
query:
|
|
9937
|
+
description: The query that triggers the alert.
|
|
9938
|
+
type: string
|
|
9939
|
+
tags:
|
|
9940
|
+
description: A list of tags attached to the monitor.
|
|
9941
|
+
example:
|
|
9942
|
+
- environment:test
|
|
9943
|
+
items:
|
|
9944
|
+
description: A tag.
|
|
9945
|
+
type: string
|
|
9946
|
+
type: array
|
|
9947
|
+
templated_name:
|
|
9948
|
+
description: The templated name of the monitor before resolving any template
|
|
9949
|
+
variables.
|
|
9950
|
+
type: string
|
|
9951
|
+
type:
|
|
9952
|
+
description: The monitor type.
|
|
9953
|
+
type: string
|
|
9954
|
+
type: object
|
|
9955
|
+
MuteFindingRequest:
|
|
9956
|
+
description: The new mute finding request.
|
|
9957
|
+
properties:
|
|
9958
|
+
data:
|
|
9959
|
+
$ref: '#/components/schemas/MuteFindingRequestData'
|
|
9960
|
+
required:
|
|
9961
|
+
- data
|
|
9962
|
+
type: object
|
|
9963
|
+
MuteFindingRequestAttributes:
|
|
9964
|
+
additionalProperties: false
|
|
9965
|
+
description: The mute properties to be updated.
|
|
9966
|
+
properties:
|
|
9967
|
+
mute:
|
|
9968
|
+
$ref: '#/components/schemas/MuteFindingRequestProperties'
|
|
9969
|
+
required:
|
|
9970
|
+
- mute
|
|
9971
|
+
type: object
|
|
9972
|
+
MuteFindingRequestData:
|
|
9973
|
+
description: Data object containing the new mute properties of the finding.
|
|
9974
|
+
properties:
|
|
9975
|
+
attributes:
|
|
9976
|
+
$ref: '#/components/schemas/MuteFindingRequestAttributes'
|
|
9977
|
+
id:
|
|
9978
|
+
$ref: '#/components/schemas/FindingID'
|
|
9979
|
+
type:
|
|
9980
|
+
$ref: '#/components/schemas/FindingType'
|
|
9981
|
+
required:
|
|
9982
|
+
- id
|
|
9983
|
+
- type
|
|
9984
|
+
- attributes
|
|
9985
|
+
type: object
|
|
9986
|
+
MuteFindingRequestProperties:
|
|
9987
|
+
additionalProperties: false
|
|
9988
|
+
description: Object containing the new mute properties of the finding.
|
|
9989
|
+
properties:
|
|
9990
|
+
description:
|
|
9991
|
+
description: Additional information about the reason why this finding is
|
|
9992
|
+
muted or unmuted. This field has a maximum limit of 280 characters.
|
|
9993
|
+
example: To be resolved later
|
|
9994
|
+
type: string
|
|
9995
|
+
expiration_date:
|
|
9996
|
+
description: 'The expiration date of the mute or unmute action (Unix ms).
|
|
9997
|
+
It must be set to a value greater than the current timestamp.
|
|
9998
|
+
|
|
9999
|
+
If this field is not provided, the finding will be muted or unmuted indefinitely,
|
|
10000
|
+
which is equivalent to setting the expiration date to 9999999999999.
|
|
10001
|
+
|
|
10002
|
+
'
|
|
10003
|
+
example: 1778721573794
|
|
10004
|
+
format: int64
|
|
10005
|
+
type: integer
|
|
10006
|
+
muted:
|
|
10007
|
+
description: Whether this finding is muted or unmuted.
|
|
10008
|
+
example: true
|
|
10009
|
+
type: boolean
|
|
10010
|
+
reason:
|
|
10011
|
+
$ref: '#/components/schemas/FindingMuteReason'
|
|
10012
|
+
required:
|
|
10013
|
+
- muted
|
|
10014
|
+
- reason
|
|
10015
|
+
type: object
|
|
10016
|
+
MuteFindingResponse:
|
|
10017
|
+
description: The expected response schema.
|
|
10018
|
+
properties:
|
|
10019
|
+
data:
|
|
10020
|
+
$ref: '#/components/schemas/MuteFindingResponseData'
|
|
10021
|
+
required:
|
|
10022
|
+
- data
|
|
10023
|
+
type: object
|
|
10024
|
+
MuteFindingResponseAttributes:
|
|
10025
|
+
description: The JSON:API attributes of the finding.
|
|
10026
|
+
properties:
|
|
10027
|
+
evaluation:
|
|
10028
|
+
$ref: '#/components/schemas/FindingEvaluation'
|
|
10029
|
+
evaluation_changed_at:
|
|
10030
|
+
$ref: '#/components/schemas/FindingEvaluationChangedAt'
|
|
10031
|
+
mute:
|
|
10032
|
+
$ref: '#/components/schemas/MuteFindingResponseProperties'
|
|
10033
|
+
resource:
|
|
10034
|
+
$ref: '#/components/schemas/FindingResource'
|
|
10035
|
+
resource_discovery_date:
|
|
10036
|
+
$ref: '#/components/schemas/FindingResourceDiscoveryDate'
|
|
10037
|
+
resource_type:
|
|
10038
|
+
$ref: '#/components/schemas/FindingResourceType'
|
|
10039
|
+
rule:
|
|
10040
|
+
$ref: '#/components/schemas/FindingRule'
|
|
10041
|
+
status:
|
|
10042
|
+
$ref: '#/components/schemas/FindingStatus'
|
|
8458
10043
|
tags:
|
|
8459
|
-
|
|
8460
|
-
|
|
8461
|
-
|
|
8462
|
-
|
|
8463
|
-
|
|
8464
|
-
|
|
8465
|
-
|
|
8466
|
-
|
|
8467
|
-
|
|
8468
|
-
variables.
|
|
8469
|
-
type: string
|
|
10044
|
+
$ref: '#/components/schemas/FindingTags'
|
|
10045
|
+
type: object
|
|
10046
|
+
MuteFindingResponseData:
|
|
10047
|
+
description: Data object containing the updated finding.
|
|
10048
|
+
properties:
|
|
10049
|
+
attributes:
|
|
10050
|
+
$ref: '#/components/schemas/MuteFindingResponseAttributes'
|
|
10051
|
+
id:
|
|
10052
|
+
$ref: '#/components/schemas/FindingID'
|
|
8470
10053
|
type:
|
|
8471
|
-
|
|
10054
|
+
$ref: '#/components/schemas/FindingType'
|
|
10055
|
+
type: object
|
|
10056
|
+
MuteFindingResponseProperties:
|
|
10057
|
+
additionalProperties: false
|
|
10058
|
+
description: Information about the mute status of this finding.
|
|
10059
|
+
properties:
|
|
10060
|
+
description:
|
|
10061
|
+
description: 'Additional information about the reason why this finding is
|
|
10062
|
+
muted or unmuted.
|
|
10063
|
+
|
|
10064
|
+
This attribute will not be included in the response if the description
|
|
10065
|
+
is not provided in the request body.
|
|
10066
|
+
|
|
10067
|
+
'
|
|
10068
|
+
example: To be resolved later
|
|
8472
10069
|
type: string
|
|
10070
|
+
expiration_date:
|
|
10071
|
+
description: 'The expiration date of the mute or unmute action.
|
|
10072
|
+
|
|
10073
|
+
If the expiration date is not provided in the request body, this attribute
|
|
10074
|
+
will not be included in the response and the finding will be muted or
|
|
10075
|
+
unmuted indefinitely.
|
|
10076
|
+
|
|
10077
|
+
'
|
|
10078
|
+
example: 1778721573794
|
|
10079
|
+
format: int64
|
|
10080
|
+
type: integer
|
|
10081
|
+
muted:
|
|
10082
|
+
description: Whether this finding is muted or unmuted.
|
|
10083
|
+
example: true
|
|
10084
|
+
type: boolean
|
|
10085
|
+
reason:
|
|
10086
|
+
$ref: '#/components/schemas/FindingMuteReason'
|
|
8473
10087
|
type: object
|
|
8474
10088
|
NullableRelationshipToUser:
|
|
8475
10089
|
description: Relationship to user.
|
|
@@ -9264,6 +10878,10 @@ components:
|
|
|
9264
10878
|
properties:
|
|
9265
10879
|
attributes:
|
|
9266
10880
|
$ref: '#/components/schemas/RUMApplicationListAttributes'
|
|
10881
|
+
id:
|
|
10882
|
+
description: RUM application ID.
|
|
10883
|
+
example: abcd1234-0000-0000-abcd-1234abcd5678
|
|
10884
|
+
type: string
|
|
9267
10885
|
type:
|
|
9268
10886
|
$ref: '#/components/schemas/RUMApplicationListType'
|
|
9269
10887
|
required:
|
|
@@ -10099,19 +11717,23 @@ components:
|
|
|
10099
11717
|
description: 'An array of principals. A principal is a subject or group
|
|
10100
11718
|
of subjects.
|
|
10101
11719
|
|
|
10102
|
-
Each principal is formatted as `type:id`. Supported types: `role`
|
|
10103
|
-
`org`.
|
|
11720
|
+
Each principal is formatted as `type:id`. Supported types: `role`, `team`
|
|
11721
|
+
(beta), `user` (beta), and `org`.
|
|
11722
|
+
|
|
11723
|
+
The org ID can be obtained through the api/v2/current_user API.
|
|
10104
11724
|
|
|
10105
|
-
The
|
|
11725
|
+
The user principal type accepts service account IDs.'
|
|
10106
11726
|
example:
|
|
10107
11727
|
- role:00000000-0000-1111-0000-000000000000
|
|
10108
11728
|
items:
|
|
10109
11729
|
description: 'Subject or group of subjects. Each principal is formatted
|
|
10110
11730
|
as `type:id`.
|
|
10111
11731
|
|
|
10112
|
-
Supported types: `role` and `org`.
|
|
11732
|
+
Supported types: `role`, `team` (beta), `user` (beta), and `org`.
|
|
10113
11733
|
|
|
10114
|
-
The org ID can be obtained through the api/v2/current_user API.
|
|
11734
|
+
The org ID can be obtained through the api/v2/current_user API.
|
|
11735
|
+
|
|
11736
|
+
The user principal type accepts service account IDs.'
|
|
10115
11737
|
type: string
|
|
10116
11738
|
type: array
|
|
10117
11739
|
relation:
|
|
@@ -12601,6 +14223,9 @@ components:
|
|
|
12601
14223
|
properties:
|
|
12602
14224
|
attributes:
|
|
12603
14225
|
$ref: '#/components/schemas/ServiceDefinitionDataAttributes'
|
|
14226
|
+
id:
|
|
14227
|
+
description: Service definition id.
|
|
14228
|
+
type: string
|
|
12604
14229
|
type:
|
|
12605
14230
|
description: Service definition type.
|
|
12606
14231
|
type: string
|
|
@@ -12634,6 +14259,30 @@ components:
|
|
|
12634
14259
|
last-modified-time:
|
|
12635
14260
|
description: Last modified time of the service definition.
|
|
12636
14261
|
type: string
|
|
14262
|
+
origin:
|
|
14263
|
+
description: User defined origin of the service definition.
|
|
14264
|
+
type: string
|
|
14265
|
+
origin-detail:
|
|
14266
|
+
description: User defined origin's detail of the service definition.
|
|
14267
|
+
type: string
|
|
14268
|
+
warnings:
|
|
14269
|
+
description: A list of schema validation warnings.
|
|
14270
|
+
items:
|
|
14271
|
+
$ref: '#/components/schemas/ServiceDefinitionMetaWarnings'
|
|
14272
|
+
type: array
|
|
14273
|
+
type: object
|
|
14274
|
+
ServiceDefinitionMetaWarnings:
|
|
14275
|
+
description: Schema validation warnings.
|
|
14276
|
+
properties:
|
|
14277
|
+
instance-location:
|
|
14278
|
+
description: The warning instance location.
|
|
14279
|
+
type: string
|
|
14280
|
+
keyword-location:
|
|
14281
|
+
description: The warning keyword location.
|
|
14282
|
+
type: string
|
|
14283
|
+
message:
|
|
14284
|
+
description: The warning message.
|
|
14285
|
+
type: string
|
|
12637
14286
|
type: object
|
|
12638
14287
|
ServiceDefinitionRaw:
|
|
12639
14288
|
description: Service Definition in raw JSON/YAML representation.
|
|
@@ -13002,12 +14651,169 @@ components:
|
|
|
13002
14651
|
description: Link name.
|
|
13003
14652
|
example: Runbook
|
|
13004
14653
|
type: string
|
|
13005
|
-
provider:
|
|
13006
|
-
description: Link provider.
|
|
13007
|
-
example: Github
|
|
13008
|
-
type: string
|
|
14654
|
+
provider:
|
|
14655
|
+
description: Link provider.
|
|
14656
|
+
example: Github
|
|
14657
|
+
type: string
|
|
14658
|
+
type:
|
|
14659
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot1LinkType'
|
|
14660
|
+
url:
|
|
14661
|
+
description: Link URL.
|
|
14662
|
+
example: https://my-runbook
|
|
14663
|
+
type: string
|
|
14664
|
+
required:
|
|
14665
|
+
- name
|
|
14666
|
+
- type
|
|
14667
|
+
- url
|
|
14668
|
+
type: object
|
|
14669
|
+
ServiceDefinitionV2Dot1LinkType:
|
|
14670
|
+
description: Link type.
|
|
14671
|
+
enum:
|
|
14672
|
+
- doc
|
|
14673
|
+
- repo
|
|
14674
|
+
- runbook
|
|
14675
|
+
- dashboard
|
|
14676
|
+
- other
|
|
14677
|
+
example: runbook
|
|
14678
|
+
type: string
|
|
14679
|
+
x-enum-varnames:
|
|
14680
|
+
- DOC
|
|
14681
|
+
- REPO
|
|
14682
|
+
- RUNBOOK
|
|
14683
|
+
- DASHBOARD
|
|
14684
|
+
- OTHER
|
|
14685
|
+
ServiceDefinitionV2Dot1MSTeams:
|
|
14686
|
+
description: Service owner's Microsoft Teams.
|
|
14687
|
+
properties:
|
|
14688
|
+
contact:
|
|
14689
|
+
description: Contact value.
|
|
14690
|
+
example: https://teams.microsoft.com/myteam
|
|
14691
|
+
type: string
|
|
14692
|
+
name:
|
|
14693
|
+
description: Contact Microsoft Teams.
|
|
14694
|
+
example: My team channel
|
|
14695
|
+
type: string
|
|
14696
|
+
type:
|
|
14697
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot1MSTeamsType'
|
|
14698
|
+
required:
|
|
14699
|
+
- type
|
|
14700
|
+
- contact
|
|
14701
|
+
type: object
|
|
14702
|
+
ServiceDefinitionV2Dot1MSTeamsType:
|
|
14703
|
+
description: Contact type.
|
|
14704
|
+
enum:
|
|
14705
|
+
- microsoft-teams
|
|
14706
|
+
example: microsoft-teams
|
|
14707
|
+
type: string
|
|
14708
|
+
x-enum-varnames:
|
|
14709
|
+
- MICROSOFT_TEAMS
|
|
14710
|
+
ServiceDefinitionV2Dot1Opsgenie:
|
|
14711
|
+
description: Opsgenie integration for the service.
|
|
14712
|
+
properties:
|
|
14713
|
+
region:
|
|
14714
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot1OpsgenieRegion'
|
|
14715
|
+
service-url:
|
|
14716
|
+
description: Opsgenie service url.
|
|
14717
|
+
example: https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000
|
|
14718
|
+
type: string
|
|
14719
|
+
required:
|
|
14720
|
+
- service-url
|
|
14721
|
+
type: object
|
|
14722
|
+
ServiceDefinitionV2Dot1OpsgenieRegion:
|
|
14723
|
+
description: Opsgenie instance region.
|
|
14724
|
+
enum:
|
|
14725
|
+
- US
|
|
14726
|
+
- EU
|
|
14727
|
+
example: US
|
|
14728
|
+
type: string
|
|
14729
|
+
x-enum-varnames:
|
|
14730
|
+
- US
|
|
14731
|
+
- EU
|
|
14732
|
+
ServiceDefinitionV2Dot1Pagerduty:
|
|
14733
|
+
description: PagerDuty integration for the service.
|
|
14734
|
+
properties:
|
|
14735
|
+
service-url:
|
|
14736
|
+
description: PagerDuty service url.
|
|
14737
|
+
example: https://my-org.pagerduty.com/service-directory/PMyService
|
|
14738
|
+
type: string
|
|
14739
|
+
type: object
|
|
14740
|
+
ServiceDefinitionV2Dot1Slack:
|
|
14741
|
+
description: Service owner's Slack channel.
|
|
14742
|
+
properties:
|
|
14743
|
+
contact:
|
|
14744
|
+
description: Slack Channel.
|
|
14745
|
+
example: https://yourcompany.slack.com/archives/channel123
|
|
14746
|
+
type: string
|
|
14747
|
+
name:
|
|
14748
|
+
description: Contact Slack.
|
|
14749
|
+
example: Team Slack
|
|
14750
|
+
type: string
|
|
14751
|
+
type:
|
|
14752
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot1SlackType'
|
|
14753
|
+
required:
|
|
14754
|
+
- type
|
|
14755
|
+
- contact
|
|
14756
|
+
type: object
|
|
14757
|
+
ServiceDefinitionV2Dot1SlackType:
|
|
14758
|
+
description: Contact type.
|
|
14759
|
+
enum:
|
|
14760
|
+
- slack
|
|
14761
|
+
example: slack
|
|
14762
|
+
type: string
|
|
14763
|
+
x-enum-varnames:
|
|
14764
|
+
- SLACK
|
|
14765
|
+
ServiceDefinitionV2Dot1Version:
|
|
14766
|
+
default: v2.1
|
|
14767
|
+
description: Schema version being used.
|
|
14768
|
+
enum:
|
|
14769
|
+
- v2.1
|
|
14770
|
+
example: v2.1
|
|
14771
|
+
type: string
|
|
14772
|
+
x-enum-varnames:
|
|
14773
|
+
- V2_1
|
|
14774
|
+
ServiceDefinitionV2Email:
|
|
14775
|
+
description: Service owner's email.
|
|
14776
|
+
properties:
|
|
14777
|
+
contact:
|
|
14778
|
+
description: Contact value.
|
|
14779
|
+
example: contact@datadoghq.com
|
|
14780
|
+
format: email
|
|
14781
|
+
type: string
|
|
14782
|
+
name:
|
|
14783
|
+
description: Contact email.
|
|
14784
|
+
example: Team Email
|
|
14785
|
+
type: string
|
|
14786
|
+
type:
|
|
14787
|
+
$ref: '#/components/schemas/ServiceDefinitionV2EmailType'
|
|
14788
|
+
required:
|
|
14789
|
+
- type
|
|
14790
|
+
- contact
|
|
14791
|
+
type: object
|
|
14792
|
+
ServiceDefinitionV2EmailType:
|
|
14793
|
+
description: Contact type.
|
|
14794
|
+
enum:
|
|
14795
|
+
- email
|
|
14796
|
+
example: email
|
|
14797
|
+
type: string
|
|
14798
|
+
x-enum-varnames:
|
|
14799
|
+
- EMAIL
|
|
14800
|
+
ServiceDefinitionV2Integrations:
|
|
14801
|
+
description: Third party integrations that Datadog supports.
|
|
14802
|
+
properties:
|
|
14803
|
+
opsgenie:
|
|
14804
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Opsgenie'
|
|
14805
|
+
pagerduty:
|
|
14806
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Pagerduty'
|
|
14807
|
+
type: object
|
|
14808
|
+
ServiceDefinitionV2Link:
|
|
14809
|
+
description: Service's external links.
|
|
14810
|
+
properties:
|
|
14811
|
+
name:
|
|
14812
|
+
description: Link name.
|
|
14813
|
+
example: Runbook
|
|
14814
|
+
type: string
|
|
13009
14815
|
type:
|
|
13010
|
-
$ref: '#/components/schemas/
|
|
14816
|
+
$ref: '#/components/schemas/ServiceDefinitionV2LinkType'
|
|
13011
14817
|
url:
|
|
13012
14818
|
description: Link URL.
|
|
13013
14819
|
example: https://my-runbook
|
|
@@ -13017,23 +14823,31 @@ components:
|
|
|
13017
14823
|
- type
|
|
13018
14824
|
- url
|
|
13019
14825
|
type: object
|
|
13020
|
-
|
|
14826
|
+
ServiceDefinitionV2LinkType:
|
|
13021
14827
|
description: Link type.
|
|
13022
14828
|
enum:
|
|
13023
14829
|
- doc
|
|
13024
|
-
-
|
|
14830
|
+
- wiki
|
|
13025
14831
|
- runbook
|
|
14832
|
+
- url
|
|
14833
|
+
- repo
|
|
13026
14834
|
- dashboard
|
|
13027
|
-
-
|
|
14835
|
+
- oncall
|
|
14836
|
+
- code
|
|
14837
|
+
- link
|
|
13028
14838
|
example: runbook
|
|
13029
14839
|
type: string
|
|
13030
14840
|
x-enum-varnames:
|
|
13031
14841
|
- DOC
|
|
13032
|
-
-
|
|
14842
|
+
- WIKI
|
|
13033
14843
|
- RUNBOOK
|
|
14844
|
+
- URL
|
|
14845
|
+
- REPO
|
|
13034
14846
|
- DASHBOARD
|
|
13035
|
-
-
|
|
13036
|
-
|
|
14847
|
+
- ONCALL
|
|
14848
|
+
- CODE
|
|
14849
|
+
- LINK
|
|
14850
|
+
ServiceDefinitionV2MSTeams:
|
|
13037
14851
|
description: Service owner's Microsoft Teams.
|
|
13038
14852
|
properties:
|
|
13039
14853
|
contact:
|
|
@@ -13045,12 +14859,12 @@ components:
|
|
|
13045
14859
|
example: My team channel
|
|
13046
14860
|
type: string
|
|
13047
14861
|
type:
|
|
13048
|
-
$ref: '#/components/schemas/
|
|
14862
|
+
$ref: '#/components/schemas/ServiceDefinitionV2MSTeamsType'
|
|
13049
14863
|
required:
|
|
13050
14864
|
- type
|
|
13051
14865
|
- contact
|
|
13052
14866
|
type: object
|
|
13053
|
-
|
|
14867
|
+
ServiceDefinitionV2MSTeamsType:
|
|
13054
14868
|
description: Contact type.
|
|
13055
14869
|
enum:
|
|
13056
14870
|
- microsoft-teams
|
|
@@ -13058,11 +14872,11 @@ components:
|
|
|
13058
14872
|
type: string
|
|
13059
14873
|
x-enum-varnames:
|
|
13060
14874
|
- MICROSOFT_TEAMS
|
|
13061
|
-
|
|
14875
|
+
ServiceDefinitionV2Opsgenie:
|
|
13062
14876
|
description: Opsgenie integration for the service.
|
|
13063
14877
|
properties:
|
|
13064
14878
|
region:
|
|
13065
|
-
$ref: '#/components/schemas/
|
|
14879
|
+
$ref: '#/components/schemas/ServiceDefinitionV2OpsgenieRegion'
|
|
13066
14880
|
service-url:
|
|
13067
14881
|
description: Opsgenie service url.
|
|
13068
14882
|
example: https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000
|
|
@@ -13070,7 +14884,7 @@ components:
|
|
|
13070
14884
|
required:
|
|
13071
14885
|
- service-url
|
|
13072
14886
|
type: object
|
|
13073
|
-
|
|
14887
|
+
ServiceDefinitionV2OpsgenieRegion:
|
|
13074
14888
|
description: Opsgenie instance region.
|
|
13075
14889
|
enum:
|
|
13076
14890
|
- US
|
|
@@ -13078,280 +14892,646 @@ components:
|
|
|
13078
14892
|
example: US
|
|
13079
14893
|
type: string
|
|
13080
14894
|
x-enum-varnames:
|
|
13081
|
-
- US
|
|
13082
|
-
- EU
|
|
13083
|
-
|
|
13084
|
-
description: PagerDuty
|
|
13085
|
-
|
|
13086
|
-
|
|
13087
|
-
|
|
13088
|
-
|
|
13089
|
-
|
|
13090
|
-
|
|
13091
|
-
|
|
13092
|
-
|
|
14895
|
+
- US
|
|
14896
|
+
- EU
|
|
14897
|
+
ServiceDefinitionV2Pagerduty:
|
|
14898
|
+
description: PagerDuty service URL for the service.
|
|
14899
|
+
example: https://my-org.pagerduty.com/service-directory/PMyService
|
|
14900
|
+
type: string
|
|
14901
|
+
ServiceDefinitionV2Repo:
|
|
14902
|
+
description: Service code repositories.
|
|
14903
|
+
properties:
|
|
14904
|
+
name:
|
|
14905
|
+
description: Repository name.
|
|
14906
|
+
example: Source Code
|
|
14907
|
+
type: string
|
|
14908
|
+
provider:
|
|
14909
|
+
description: Repository provider.
|
|
14910
|
+
example: GitHub
|
|
14911
|
+
type: string
|
|
14912
|
+
url:
|
|
14913
|
+
description: Repository URL.
|
|
14914
|
+
example: https://github.com/DataDog/schema
|
|
14915
|
+
type: string
|
|
14916
|
+
required:
|
|
14917
|
+
- name
|
|
14918
|
+
- url
|
|
14919
|
+
type: object
|
|
14920
|
+
ServiceDefinitionV2Slack:
|
|
14921
|
+
description: Service owner's Slack channel.
|
|
14922
|
+
properties:
|
|
14923
|
+
contact:
|
|
14924
|
+
description: Slack Channel.
|
|
14925
|
+
example: https://yourcompany.slack.com/archives/channel123
|
|
14926
|
+
type: string
|
|
14927
|
+
name:
|
|
14928
|
+
description: Contact Slack.
|
|
14929
|
+
example: Team Slack
|
|
14930
|
+
type: string
|
|
14931
|
+
type:
|
|
14932
|
+
$ref: '#/components/schemas/ServiceDefinitionV2SlackType'
|
|
14933
|
+
required:
|
|
14934
|
+
- type
|
|
14935
|
+
- contact
|
|
14936
|
+
type: object
|
|
14937
|
+
ServiceDefinitionV2SlackType:
|
|
14938
|
+
description: Contact type.
|
|
14939
|
+
enum:
|
|
14940
|
+
- slack
|
|
14941
|
+
example: slack
|
|
14942
|
+
type: string
|
|
14943
|
+
x-enum-varnames:
|
|
14944
|
+
- SLACK
|
|
14945
|
+
ServiceDefinitionV2Version:
|
|
14946
|
+
default: v2
|
|
14947
|
+
description: Schema version being used.
|
|
14948
|
+
enum:
|
|
14949
|
+
- v2
|
|
14950
|
+
example: v2
|
|
14951
|
+
type: string
|
|
14952
|
+
x-enum-varnames:
|
|
14953
|
+
- V2
|
|
14954
|
+
ServiceDefinitionsCreateRequest:
|
|
14955
|
+
description: Create service definitions request.
|
|
14956
|
+
oneOf:
|
|
14957
|
+
- $ref: '#/components/schemas/ServiceDefinitionV2Dot1'
|
|
14958
|
+
- $ref: '#/components/schemas/ServiceDefinitionV2'
|
|
14959
|
+
- $ref: '#/components/schemas/ServiceDefinitionRaw'
|
|
14960
|
+
ServiceDefinitionsListResponse:
|
|
14961
|
+
description: Create service definitions response.
|
|
14962
|
+
properties:
|
|
14963
|
+
data:
|
|
14964
|
+
description: Data representing service definitions.
|
|
14965
|
+
items:
|
|
14966
|
+
$ref: '#/components/schemas/ServiceDefinitionData'
|
|
14967
|
+
type: array
|
|
14968
|
+
type: object
|
|
14969
|
+
SlackIntegrationMetadata:
|
|
14970
|
+
description: Incident integration metadata for the Slack integration.
|
|
14971
|
+
properties:
|
|
14972
|
+
channels:
|
|
14973
|
+
description: Array of Slack channels in this integration metadata.
|
|
14974
|
+
example: []
|
|
14975
|
+
items:
|
|
14976
|
+
$ref: '#/components/schemas/SlackIntegrationMetadataChannelItem'
|
|
14977
|
+
type: array
|
|
14978
|
+
required:
|
|
14979
|
+
- channels
|
|
14980
|
+
type: object
|
|
14981
|
+
SlackIntegrationMetadataChannelItem:
|
|
14982
|
+
description: Item in the Slack integration metadata channel array.
|
|
14983
|
+
properties:
|
|
14984
|
+
channel_id:
|
|
14985
|
+
description: Slack channel ID.
|
|
14986
|
+
example: C0123456789
|
|
14987
|
+
type: string
|
|
14988
|
+
channel_name:
|
|
14989
|
+
description: Name of the Slack channel.
|
|
14990
|
+
example: '#example-channel-name'
|
|
14991
|
+
type: string
|
|
14992
|
+
redirect_url:
|
|
14993
|
+
description: URL redirecting to the Slack channel.
|
|
14994
|
+
example: https://slack.com/app_redirect?channel=C0123456789&team=T01234567
|
|
14995
|
+
type: string
|
|
14996
|
+
team_id:
|
|
14997
|
+
description: Slack team ID.
|
|
14998
|
+
example: T01234567
|
|
14999
|
+
type: string
|
|
15000
|
+
required:
|
|
15001
|
+
- channel_id
|
|
15002
|
+
- channel_name
|
|
15003
|
+
- redirect_url
|
|
15004
|
+
type: object
|
|
15005
|
+
Span:
|
|
15006
|
+
description: Object description of a spans after being processed and stored
|
|
15007
|
+
by Datadog.
|
|
15008
|
+
properties:
|
|
15009
|
+
attributes:
|
|
15010
|
+
$ref: '#/components/schemas/SpansAttributes'
|
|
15011
|
+
id:
|
|
15012
|
+
description: Unique ID of the Span.
|
|
15013
|
+
example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA
|
|
15014
|
+
type: string
|
|
15015
|
+
type:
|
|
15016
|
+
$ref: '#/components/schemas/SpansType'
|
|
15017
|
+
type: object
|
|
15018
|
+
SpansAggregateBucket:
|
|
15019
|
+
description: Spans aggregate.
|
|
15020
|
+
properties:
|
|
15021
|
+
attributes:
|
|
15022
|
+
$ref: '#/components/schemas/SpansAggregateBucketAttributes'
|
|
15023
|
+
id:
|
|
15024
|
+
description: ID of the spans aggregate.
|
|
15025
|
+
type: string
|
|
15026
|
+
type:
|
|
15027
|
+
$ref: '#/components/schemas/SpansAggregateBucketType'
|
|
15028
|
+
type: object
|
|
15029
|
+
SpansAggregateBucketAttributes:
|
|
15030
|
+
description: A bucket values.
|
|
15031
|
+
properties:
|
|
15032
|
+
by:
|
|
15033
|
+
additionalProperties:
|
|
15034
|
+
description: The values for each group by.
|
|
15035
|
+
description: The key, value pairs for each group by.
|
|
15036
|
+
example:
|
|
15037
|
+
'@state': success
|
|
15038
|
+
'@version': abc
|
|
15039
|
+
type: object
|
|
15040
|
+
compute:
|
|
15041
|
+
description: The compute data.
|
|
15042
|
+
type: object
|
|
15043
|
+
computes:
|
|
15044
|
+
additionalProperties:
|
|
15045
|
+
$ref: '#/components/schemas/SpansAggregateBucketValue'
|
|
15046
|
+
description: A map of the metric name -> value for regular compute or list
|
|
15047
|
+
of values for a timeseries.
|
|
15048
|
+
type: object
|
|
15049
|
+
type: object
|
|
15050
|
+
SpansAggregateBucketType:
|
|
15051
|
+
description: The spans aggregate bucket type.
|
|
15052
|
+
enum:
|
|
15053
|
+
- bucket
|
|
15054
|
+
example: bucket
|
|
15055
|
+
type: string
|
|
15056
|
+
x-enum-varnames:
|
|
15057
|
+
- BUCKET
|
|
15058
|
+
SpansAggregateBucketValue:
|
|
15059
|
+
description: A bucket value, can be either a timeseries or a single value.
|
|
15060
|
+
oneOf:
|
|
15061
|
+
- $ref: '#/components/schemas/SpansAggregateBucketValueSingleString'
|
|
15062
|
+
- $ref: '#/components/schemas/SpansAggregateBucketValueSingleNumber'
|
|
15063
|
+
- $ref: '#/components/schemas/SpansAggregateBucketValueTimeseries'
|
|
15064
|
+
SpansAggregateBucketValueSingleNumber:
|
|
15065
|
+
description: A single number value.
|
|
15066
|
+
format: double
|
|
15067
|
+
type: number
|
|
15068
|
+
SpansAggregateBucketValueSingleString:
|
|
15069
|
+
description: A single string value.
|
|
15070
|
+
type: string
|
|
15071
|
+
SpansAggregateBucketValueTimeseries:
|
|
15072
|
+
description: A timeseries array.
|
|
15073
|
+
items:
|
|
15074
|
+
$ref: '#/components/schemas/SpansAggregateBucketValueTimeseriesPoint'
|
|
15075
|
+
type: array
|
|
15076
|
+
x-generate-alias-as-model: true
|
|
15077
|
+
SpansAggregateBucketValueTimeseriesPoint:
|
|
15078
|
+
description: A timeseries point.
|
|
15079
|
+
properties:
|
|
15080
|
+
time:
|
|
15081
|
+
description: The time value for this point.
|
|
15082
|
+
example: '2023-06-08T11:55:00Z'
|
|
15083
|
+
type: string
|
|
15084
|
+
value:
|
|
15085
|
+
description: The value for this point.
|
|
15086
|
+
example: 19
|
|
15087
|
+
format: double
|
|
15088
|
+
type: number
|
|
15089
|
+
type: object
|
|
15090
|
+
SpansAggregateData:
|
|
15091
|
+
description: The object containing the query content.
|
|
15092
|
+
properties:
|
|
15093
|
+
attributes:
|
|
15094
|
+
$ref: '#/components/schemas/SpansAggregateRequestAttributes'
|
|
15095
|
+
type:
|
|
15096
|
+
$ref: '#/components/schemas/SpansAggregateRequestType'
|
|
15097
|
+
type: object
|
|
15098
|
+
SpansAggregateRequest:
|
|
15099
|
+
description: The object sent with the request to retrieve a list of aggregated
|
|
15100
|
+
spans from your organization.
|
|
15101
|
+
properties:
|
|
15102
|
+
data:
|
|
15103
|
+
$ref: '#/components/schemas/SpansAggregateData'
|
|
15104
|
+
type: object
|
|
15105
|
+
SpansAggregateRequestAttributes:
|
|
15106
|
+
description: The object containing all the query parameters.
|
|
15107
|
+
properties:
|
|
15108
|
+
compute:
|
|
15109
|
+
description: The list of metrics or timeseries to compute for the retrieved
|
|
15110
|
+
buckets.
|
|
15111
|
+
items:
|
|
15112
|
+
$ref: '#/components/schemas/SpansCompute'
|
|
15113
|
+
type: array
|
|
15114
|
+
filter:
|
|
15115
|
+
$ref: '#/components/schemas/SpansQueryFilter'
|
|
15116
|
+
group_by:
|
|
15117
|
+
description: The rules for the group by.
|
|
15118
|
+
items:
|
|
15119
|
+
$ref: '#/components/schemas/SpansGroupBy'
|
|
15120
|
+
type: array
|
|
15121
|
+
options:
|
|
15122
|
+
$ref: '#/components/schemas/SpansQueryOptions'
|
|
15123
|
+
type: object
|
|
15124
|
+
SpansAggregateRequestType:
|
|
15125
|
+
default: aggregate_request
|
|
15126
|
+
description: The type of resource. The value should always be aggregate_request.
|
|
15127
|
+
enum:
|
|
15128
|
+
- aggregate_request
|
|
15129
|
+
example: aggregate_request
|
|
15130
|
+
type: string
|
|
15131
|
+
x-enum-varnames:
|
|
15132
|
+
- AGGREGATE_REQUEST
|
|
15133
|
+
SpansAggregateResponse:
|
|
15134
|
+
description: The response object for the spans aggregate API endpoint.
|
|
15135
|
+
properties:
|
|
15136
|
+
data:
|
|
15137
|
+
description: The list of matching buckets, one item per bucket.
|
|
15138
|
+
items:
|
|
15139
|
+
$ref: '#/components/schemas/SpansAggregateBucket'
|
|
15140
|
+
type: array
|
|
15141
|
+
meta:
|
|
15142
|
+
$ref: '#/components/schemas/SpansAggregateResponseMetadata'
|
|
15143
|
+
type: object
|
|
15144
|
+
SpansAggregateResponseMetadata:
|
|
15145
|
+
description: The metadata associated with a request.
|
|
15146
|
+
properties:
|
|
15147
|
+
elapsed:
|
|
15148
|
+
description: The time elapsed in milliseconds.
|
|
15149
|
+
example: 132
|
|
15150
|
+
format: int64
|
|
15151
|
+
type: integer
|
|
15152
|
+
request_id:
|
|
15153
|
+
description: The identifier of the request.
|
|
15154
|
+
example: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR
|
|
15155
|
+
type: string
|
|
15156
|
+
status:
|
|
15157
|
+
$ref: '#/components/schemas/SpansAggregateResponseStatus'
|
|
15158
|
+
warnings:
|
|
15159
|
+
description: 'A list of warnings (non fatal errors) encountered, partial
|
|
15160
|
+
results might be returned if
|
|
15161
|
+
|
|
15162
|
+
warnings are present in the response.'
|
|
15163
|
+
items:
|
|
15164
|
+
$ref: '#/components/schemas/SpansWarning'
|
|
15165
|
+
type: array
|
|
15166
|
+
type: object
|
|
15167
|
+
SpansAggregateResponseStatus:
|
|
15168
|
+
description: The status of the response.
|
|
15169
|
+
enum:
|
|
15170
|
+
- done
|
|
15171
|
+
- timeout
|
|
15172
|
+
example: done
|
|
15173
|
+
type: string
|
|
15174
|
+
x-enum-varnames:
|
|
15175
|
+
- DONE
|
|
15176
|
+
- TIMEOUT
|
|
15177
|
+
SpansAggregateSort:
|
|
15178
|
+
description: A sort rule.
|
|
15179
|
+
example:
|
|
15180
|
+
aggregation: count
|
|
15181
|
+
order: asc
|
|
13093
15182
|
properties:
|
|
13094
|
-
|
|
13095
|
-
|
|
13096
|
-
|
|
13097
|
-
|
|
13098
|
-
|
|
13099
|
-
description: Contact Slack.
|
|
13100
|
-
example: Team Slack
|
|
15183
|
+
aggregation:
|
|
15184
|
+
$ref: '#/components/schemas/SpansAggregationFunction'
|
|
15185
|
+
metric:
|
|
15186
|
+
description: The metric to sort by (only used for `type=measure`).
|
|
15187
|
+
example: '@duration'
|
|
13101
15188
|
type: string
|
|
15189
|
+
order:
|
|
15190
|
+
$ref: '#/components/schemas/SpansSortOrder'
|
|
13102
15191
|
type:
|
|
13103
|
-
$ref: '#/components/schemas/
|
|
13104
|
-
required:
|
|
13105
|
-
- type
|
|
13106
|
-
- contact
|
|
15192
|
+
$ref: '#/components/schemas/SpansAggregateSortType'
|
|
13107
15193
|
type: object
|
|
13108
|
-
|
|
13109
|
-
|
|
15194
|
+
SpansAggregateSortType:
|
|
15195
|
+
default: alphabetical
|
|
15196
|
+
description: The type of sorting algorithm.
|
|
13110
15197
|
enum:
|
|
13111
|
-
-
|
|
13112
|
-
|
|
15198
|
+
- alphabetical
|
|
15199
|
+
- measure
|
|
13113
15200
|
type: string
|
|
13114
15201
|
x-enum-varnames:
|
|
13115
|
-
-
|
|
13116
|
-
|
|
13117
|
-
|
|
13118
|
-
description:
|
|
15202
|
+
- ALPHABETICAL
|
|
15203
|
+
- MEASURE
|
|
15204
|
+
SpansAggregationFunction:
|
|
15205
|
+
description: An aggregation function.
|
|
13119
15206
|
enum:
|
|
13120
|
-
-
|
|
13121
|
-
|
|
15207
|
+
- count
|
|
15208
|
+
- cardinality
|
|
15209
|
+
- pc75
|
|
15210
|
+
- pc90
|
|
15211
|
+
- pc95
|
|
15212
|
+
- pc98
|
|
15213
|
+
- pc99
|
|
15214
|
+
- sum
|
|
15215
|
+
- min
|
|
15216
|
+
- max
|
|
15217
|
+
- avg
|
|
15218
|
+
- median
|
|
15219
|
+
example: pc90
|
|
13122
15220
|
type: string
|
|
13123
15221
|
x-enum-varnames:
|
|
13124
|
-
-
|
|
13125
|
-
|
|
13126
|
-
|
|
15222
|
+
- COUNT
|
|
15223
|
+
- CARDINALITY
|
|
15224
|
+
- PERCENTILE_75
|
|
15225
|
+
- PERCENTILE_90
|
|
15226
|
+
- PERCENTILE_95
|
|
15227
|
+
- PERCENTILE_98
|
|
15228
|
+
- PERCENTILE_99
|
|
15229
|
+
- SUM
|
|
15230
|
+
- MIN
|
|
15231
|
+
- MAX
|
|
15232
|
+
- AVG
|
|
15233
|
+
- MEDIAN
|
|
15234
|
+
SpansAttributes:
|
|
15235
|
+
description: JSON object containing all span attributes and their associated
|
|
15236
|
+
values.
|
|
13127
15237
|
properties:
|
|
13128
|
-
|
|
13129
|
-
|
|
13130
|
-
|
|
13131
|
-
|
|
15238
|
+
attributes:
|
|
15239
|
+
additionalProperties: {}
|
|
15240
|
+
description: JSON object of attributes from your span.
|
|
15241
|
+
example:
|
|
15242
|
+
customAttribute: 123
|
|
15243
|
+
duration: 2345
|
|
15244
|
+
type: object
|
|
15245
|
+
custom:
|
|
15246
|
+
additionalProperties: {}
|
|
15247
|
+
description: JSON object of custom spans data.
|
|
15248
|
+
type: object
|
|
15249
|
+
end_timestamp:
|
|
15250
|
+
description: End timestamp of your span.
|
|
15251
|
+
example: '2023-01-02T09:42:36.420Z'
|
|
15252
|
+
format: date-time
|
|
13132
15253
|
type: string
|
|
13133
|
-
|
|
13134
|
-
description:
|
|
13135
|
-
example:
|
|
15254
|
+
env:
|
|
15255
|
+
description: Name of the environment from where the spans are being sent.
|
|
15256
|
+
example: prod
|
|
13136
15257
|
type: string
|
|
13137
|
-
|
|
13138
|
-
|
|
13139
|
-
|
|
13140
|
-
|
|
13141
|
-
|
|
13142
|
-
|
|
13143
|
-
|
|
13144
|
-
|
|
13145
|
-
|
|
13146
|
-
|
|
13147
|
-
|
|
13148
|
-
|
|
13149
|
-
|
|
13150
|
-
|
|
13151
|
-
|
|
13152
|
-
|
|
13153
|
-
|
|
13154
|
-
|
|
13155
|
-
|
|
13156
|
-
|
|
13157
|
-
|
|
13158
|
-
|
|
13159
|
-
|
|
13160
|
-
|
|
13161
|
-
|
|
13162
|
-
|
|
13163
|
-
|
|
13164
|
-
|
|
15258
|
+
host:
|
|
15259
|
+
description: Name of the machine from where the spans are being sent.
|
|
15260
|
+
example: i-0123
|
|
15261
|
+
type: string
|
|
15262
|
+
ingestion_reason:
|
|
15263
|
+
description: The reason why the span was ingested.
|
|
15264
|
+
example: rule
|
|
15265
|
+
type: string
|
|
15266
|
+
parent_id:
|
|
15267
|
+
description: Id of the span that's parent of this span.
|
|
15268
|
+
example: '0'
|
|
15269
|
+
type: string
|
|
15270
|
+
resource_hash:
|
|
15271
|
+
description: Unique identifier of the resource.
|
|
15272
|
+
example: a12345678b91c23d
|
|
15273
|
+
type: string
|
|
15274
|
+
resource_name:
|
|
15275
|
+
description: The name of the resource.
|
|
15276
|
+
example: agent
|
|
15277
|
+
type: string
|
|
15278
|
+
retained_by:
|
|
15279
|
+
description: The reason why the span was indexed.
|
|
15280
|
+
example: retention_filter
|
|
15281
|
+
type: string
|
|
15282
|
+
service:
|
|
15283
|
+
description: 'The name of the application or service generating the span
|
|
15284
|
+
events.
|
|
15285
|
+
|
|
15286
|
+
It is used to switch from APM to Logs, so make sure you define the same
|
|
15287
|
+
|
|
15288
|
+
value when you use both products.'
|
|
15289
|
+
example: agent
|
|
15290
|
+
type: string
|
|
15291
|
+
single_span:
|
|
15292
|
+
description: Whether or not the span was collected as a stand-alone span.
|
|
15293
|
+
Always associated to "single_span" ingestion_reason if true.
|
|
15294
|
+
example: true
|
|
15295
|
+
type: boolean
|
|
15296
|
+
span_id:
|
|
15297
|
+
description: Id of the span.
|
|
15298
|
+
example: '1234567890987654321'
|
|
15299
|
+
type: string
|
|
15300
|
+
start_timestamp:
|
|
15301
|
+
description: Start timestamp of your span.
|
|
15302
|
+
example: '2023-01-02T09:42:36.320Z'
|
|
15303
|
+
format: date-time
|
|
15304
|
+
type: string
|
|
15305
|
+
tags:
|
|
15306
|
+
description: Array of tags associated with your span.
|
|
15307
|
+
example:
|
|
15308
|
+
- team:A
|
|
15309
|
+
items:
|
|
15310
|
+
description: Tag associated with your span.
|
|
15311
|
+
type: string
|
|
15312
|
+
type: array
|
|
15313
|
+
trace_id:
|
|
15314
|
+
description: Id of the trace to which the span belongs.
|
|
15315
|
+
example: '1234567890987654321'
|
|
13165
15316
|
type: string
|
|
13166
15317
|
type:
|
|
13167
|
-
|
|
13168
|
-
|
|
13169
|
-
description: Link URL.
|
|
13170
|
-
example: https://my-runbook
|
|
15318
|
+
description: The type of the span.
|
|
15319
|
+
example: web
|
|
13171
15320
|
type: string
|
|
13172
|
-
required:
|
|
13173
|
-
- name
|
|
13174
|
-
- type
|
|
13175
|
-
- url
|
|
13176
15321
|
type: object
|
|
13177
|
-
|
|
13178
|
-
description:
|
|
13179
|
-
enum:
|
|
13180
|
-
- doc
|
|
13181
|
-
- wiki
|
|
13182
|
-
- runbook
|
|
13183
|
-
- url
|
|
13184
|
-
- repo
|
|
13185
|
-
- dashboard
|
|
13186
|
-
- oncall
|
|
13187
|
-
- code
|
|
13188
|
-
- link
|
|
13189
|
-
example: runbook
|
|
13190
|
-
type: string
|
|
13191
|
-
x-enum-varnames:
|
|
13192
|
-
- DOC
|
|
13193
|
-
- WIKI
|
|
13194
|
-
- RUNBOOK
|
|
13195
|
-
- URL
|
|
13196
|
-
- REPO
|
|
13197
|
-
- DASHBOARD
|
|
13198
|
-
- ONCALL
|
|
13199
|
-
- CODE
|
|
13200
|
-
- LINK
|
|
13201
|
-
ServiceDefinitionV2MSTeams:
|
|
13202
|
-
description: Service owner's Microsoft Teams.
|
|
15322
|
+
SpansCompute:
|
|
15323
|
+
description: A compute rule to compute metrics or timeseries.
|
|
13203
15324
|
properties:
|
|
13204
|
-
|
|
13205
|
-
|
|
13206
|
-
|
|
15325
|
+
aggregation:
|
|
15326
|
+
$ref: '#/components/schemas/SpansAggregationFunction'
|
|
15327
|
+
interval:
|
|
15328
|
+
description: 'The time buckets'' size (only used for type=timeseries)
|
|
15329
|
+
|
|
15330
|
+
Defaults to a resolution of 150 points.'
|
|
15331
|
+
example: 5m
|
|
13207
15332
|
type: string
|
|
13208
|
-
|
|
13209
|
-
description:
|
|
13210
|
-
example:
|
|
15333
|
+
metric:
|
|
15334
|
+
description: The metric to use.
|
|
15335
|
+
example: '@duration'
|
|
13211
15336
|
type: string
|
|
13212
15337
|
type:
|
|
13213
|
-
$ref: '#/components/schemas/
|
|
15338
|
+
$ref: '#/components/schemas/SpansComputeType'
|
|
13214
15339
|
required:
|
|
13215
|
-
-
|
|
13216
|
-
- contact
|
|
15340
|
+
- aggregation
|
|
13217
15341
|
type: object
|
|
13218
|
-
|
|
13219
|
-
|
|
15342
|
+
SpansComputeType:
|
|
15343
|
+
default: total
|
|
15344
|
+
description: The type of compute.
|
|
13220
15345
|
enum:
|
|
13221
|
-
-
|
|
13222
|
-
|
|
15346
|
+
- timeseries
|
|
15347
|
+
- total
|
|
13223
15348
|
type: string
|
|
13224
15349
|
x-enum-varnames:
|
|
13225
|
-
-
|
|
13226
|
-
|
|
13227
|
-
|
|
15350
|
+
- TIMESERIES
|
|
15351
|
+
- TOTAL
|
|
15352
|
+
SpansGroupBy:
|
|
15353
|
+
description: A group by rule.
|
|
13228
15354
|
properties:
|
|
13229
|
-
|
|
13230
|
-
|
|
13231
|
-
|
|
13232
|
-
description: Opsgenie service url.
|
|
13233
|
-
example: https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000
|
|
15355
|
+
facet:
|
|
15356
|
+
description: The name of the facet to use (required).
|
|
15357
|
+
example: host
|
|
13234
15358
|
type: string
|
|
15359
|
+
histogram:
|
|
15360
|
+
$ref: '#/components/schemas/SpansGroupByHistogram'
|
|
15361
|
+
limit:
|
|
15362
|
+
default: 10
|
|
15363
|
+
description: The maximum buckets to return for this group by.
|
|
15364
|
+
format: int64
|
|
15365
|
+
type: integer
|
|
15366
|
+
missing:
|
|
15367
|
+
$ref: '#/components/schemas/SpansGroupByMissing'
|
|
15368
|
+
sort:
|
|
15369
|
+
$ref: '#/components/schemas/SpansAggregateSort'
|
|
15370
|
+
total:
|
|
15371
|
+
$ref: '#/components/schemas/SpansGroupByTotal'
|
|
15372
|
+
required:
|
|
15373
|
+
- facet
|
|
15374
|
+
type: object
|
|
15375
|
+
SpansGroupByHistogram:
|
|
15376
|
+
description: 'Used to perform a histogram computation (only for measure facets).
|
|
15377
|
+
|
|
15378
|
+
Note: At most 100 buckets are allowed, the number of buckets is (max - min)/interval.'
|
|
15379
|
+
properties:
|
|
15380
|
+
interval:
|
|
15381
|
+
description: The bin size of the histogram buckets.
|
|
15382
|
+
example: 10
|
|
15383
|
+
format: double
|
|
15384
|
+
type: number
|
|
15385
|
+
max:
|
|
15386
|
+
description: 'The maximum value for the measure used in the histogram
|
|
15387
|
+
|
|
15388
|
+
(values greater than this one are filtered out).'
|
|
15389
|
+
example: 100
|
|
15390
|
+
format: double
|
|
15391
|
+
type: number
|
|
15392
|
+
min:
|
|
15393
|
+
description: 'The minimum value for the measure used in the histogram
|
|
15394
|
+
|
|
15395
|
+
(values smaller than this one are filtered out).'
|
|
15396
|
+
example: 50
|
|
15397
|
+
format: double
|
|
15398
|
+
type: number
|
|
13235
15399
|
required:
|
|
13236
|
-
-
|
|
15400
|
+
- interval
|
|
15401
|
+
- min
|
|
15402
|
+
- max
|
|
13237
15403
|
type: object
|
|
13238
|
-
|
|
13239
|
-
description:
|
|
13240
|
-
|
|
13241
|
-
|
|
13242
|
-
-
|
|
13243
|
-
|
|
15404
|
+
SpansGroupByMissing:
|
|
15405
|
+
description: The value to use for spans that don't have the facet used to group
|
|
15406
|
+
by.
|
|
15407
|
+
oneOf:
|
|
15408
|
+
- $ref: '#/components/schemas/SpansGroupByMissingString'
|
|
15409
|
+
- $ref: '#/components/schemas/SpansGroupByMissingNumber'
|
|
15410
|
+
SpansGroupByMissingNumber:
|
|
15411
|
+
description: The missing value to use if there is a number valued facet.
|
|
15412
|
+
format: double
|
|
15413
|
+
type: number
|
|
15414
|
+
SpansGroupByMissingString:
|
|
15415
|
+
description: The missing value to use if there is string valued facet.
|
|
13244
15416
|
type: string
|
|
13245
|
-
|
|
13246
|
-
|
|
13247
|
-
|
|
13248
|
-
|
|
13249
|
-
|
|
13250
|
-
|
|
15417
|
+
SpansGroupByTotal:
|
|
15418
|
+
default: false
|
|
15419
|
+
description: A resulting object to put the given computes in over all the matching
|
|
15420
|
+
records.
|
|
15421
|
+
oneOf:
|
|
15422
|
+
- $ref: '#/components/schemas/SpansGroupByTotalBoolean'
|
|
15423
|
+
- $ref: '#/components/schemas/SpansGroupByTotalString'
|
|
15424
|
+
- $ref: '#/components/schemas/SpansGroupByTotalNumber'
|
|
15425
|
+
SpansGroupByTotalBoolean:
|
|
15426
|
+
description: If set to true, creates an additional bucket labeled "$facet_total".
|
|
15427
|
+
type: boolean
|
|
15428
|
+
SpansGroupByTotalNumber:
|
|
15429
|
+
description: A number to use as the key value for the total bucket.
|
|
15430
|
+
format: double
|
|
15431
|
+
type: number
|
|
15432
|
+
SpansGroupByTotalString:
|
|
15433
|
+
description: A string to use as the key value for the total bucket.
|
|
13251
15434
|
type: string
|
|
13252
|
-
|
|
13253
|
-
description:
|
|
15435
|
+
SpansListRequest:
|
|
15436
|
+
description: The request for a spans list.
|
|
13254
15437
|
properties:
|
|
13255
|
-
|
|
13256
|
-
|
|
13257
|
-
example: Source Code
|
|
13258
|
-
type: string
|
|
13259
|
-
provider:
|
|
13260
|
-
description: Repository provider.
|
|
13261
|
-
example: GitHub
|
|
13262
|
-
type: string
|
|
13263
|
-
url:
|
|
13264
|
-
description: Repository URL.
|
|
13265
|
-
example: https://github.com/DataDog/schema
|
|
13266
|
-
type: string
|
|
13267
|
-
required:
|
|
13268
|
-
- name
|
|
13269
|
-
- url
|
|
15438
|
+
data:
|
|
15439
|
+
$ref: '#/components/schemas/SpansListRequestData'
|
|
13270
15440
|
type: object
|
|
13271
|
-
|
|
13272
|
-
description:
|
|
15441
|
+
SpansListRequestAttributes:
|
|
15442
|
+
description: The object containing all the query parameters.
|
|
13273
15443
|
properties:
|
|
13274
|
-
|
|
13275
|
-
|
|
13276
|
-
|
|
13277
|
-
|
|
13278
|
-
|
|
13279
|
-
|
|
13280
|
-
|
|
13281
|
-
|
|
15444
|
+
filter:
|
|
15445
|
+
$ref: '#/components/schemas/SpansQueryFilter'
|
|
15446
|
+
options:
|
|
15447
|
+
$ref: '#/components/schemas/SpansQueryOptions'
|
|
15448
|
+
page:
|
|
15449
|
+
$ref: '#/components/schemas/SpansListRequestPage'
|
|
15450
|
+
sort:
|
|
15451
|
+
$ref: '#/components/schemas/SpansSort'
|
|
15452
|
+
type: object
|
|
15453
|
+
SpansListRequestData:
|
|
15454
|
+
description: The object containing the query content.
|
|
15455
|
+
properties:
|
|
15456
|
+
attributes:
|
|
15457
|
+
$ref: '#/components/schemas/SpansListRequestAttributes'
|
|
13282
15458
|
type:
|
|
13283
|
-
$ref: '#/components/schemas/
|
|
13284
|
-
required:
|
|
13285
|
-
- type
|
|
13286
|
-
- contact
|
|
15459
|
+
$ref: '#/components/schemas/SpansListRequestType'
|
|
13287
15460
|
type: object
|
|
13288
|
-
|
|
13289
|
-
description:
|
|
13290
|
-
|
|
13291
|
-
|
|
13292
|
-
|
|
13293
|
-
|
|
13294
|
-
|
|
13295
|
-
|
|
13296
|
-
|
|
13297
|
-
|
|
13298
|
-
|
|
15461
|
+
SpansListRequestPage:
|
|
15462
|
+
description: Paging attributes for listing spans.
|
|
15463
|
+
properties:
|
|
15464
|
+
cursor:
|
|
15465
|
+
description: List following results with a cursor provided in the previous
|
|
15466
|
+
query.
|
|
15467
|
+
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
|
15468
|
+
type: string
|
|
15469
|
+
limit:
|
|
15470
|
+
default: 10
|
|
15471
|
+
description: Maximum number of spans in the response.
|
|
15472
|
+
example: 25
|
|
15473
|
+
format: int32
|
|
15474
|
+
maximum: 1000
|
|
15475
|
+
type: integer
|
|
15476
|
+
type: object
|
|
15477
|
+
SpansListRequestType:
|
|
15478
|
+
default: search_request
|
|
15479
|
+
description: The type of resource. The value should always be search_request.
|
|
13299
15480
|
enum:
|
|
13300
|
-
-
|
|
13301
|
-
example:
|
|
15481
|
+
- search_request
|
|
15482
|
+
example: search_request
|
|
13302
15483
|
type: string
|
|
13303
15484
|
x-enum-varnames:
|
|
13304
|
-
-
|
|
13305
|
-
|
|
13306
|
-
description:
|
|
13307
|
-
|
|
13308
|
-
- $ref: '#/components/schemas/ServiceDefinitionV2Dot1'
|
|
13309
|
-
- $ref: '#/components/schemas/ServiceDefinitionV2'
|
|
13310
|
-
- $ref: '#/components/schemas/ServiceDefinitionRaw'
|
|
13311
|
-
ServiceDefinitionsListResponse:
|
|
13312
|
-
description: Create service definitions response.
|
|
15485
|
+
- SEARCH_REQUEST
|
|
15486
|
+
SpansListResponse:
|
|
15487
|
+
description: Response object with all spans matching the request and pagination
|
|
15488
|
+
information.
|
|
13313
15489
|
properties:
|
|
13314
15490
|
data:
|
|
13315
|
-
description:
|
|
15491
|
+
description: Array of spans matching the request.
|
|
13316
15492
|
items:
|
|
13317
|
-
$ref: '#/components/schemas/
|
|
15493
|
+
$ref: '#/components/schemas/Span'
|
|
13318
15494
|
type: array
|
|
15495
|
+
links:
|
|
15496
|
+
$ref: '#/components/schemas/SpansListResponseLinks'
|
|
15497
|
+
meta:
|
|
15498
|
+
$ref: '#/components/schemas/SpansListResponseMetadata'
|
|
13319
15499
|
type: object
|
|
13320
|
-
|
|
13321
|
-
description:
|
|
15500
|
+
SpansListResponseLinks:
|
|
15501
|
+
description: Links attributes.
|
|
13322
15502
|
properties:
|
|
13323
|
-
|
|
13324
|
-
description:
|
|
13325
|
-
|
|
13326
|
-
|
|
13327
|
-
|
|
13328
|
-
|
|
13329
|
-
|
|
13330
|
-
- channels
|
|
15503
|
+
next:
|
|
15504
|
+
description: 'Link for the next set of results. Note that the request can
|
|
15505
|
+
also be made using the
|
|
15506
|
+
|
|
15507
|
+
POST endpoint.'
|
|
15508
|
+
example: https://app.datadoghq.com/api/v2/spans/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
|
15509
|
+
type: string
|
|
13331
15510
|
type: object
|
|
13332
|
-
|
|
13333
|
-
description:
|
|
15511
|
+
SpansListResponseMetadata:
|
|
15512
|
+
description: The metadata associated with a request.
|
|
13334
15513
|
properties:
|
|
13335
|
-
|
|
13336
|
-
description:
|
|
13337
|
-
example:
|
|
13338
|
-
|
|
13339
|
-
|
|
13340
|
-
|
|
13341
|
-
|
|
13342
|
-
|
|
13343
|
-
|
|
13344
|
-
|
|
13345
|
-
example: https://slack.com/app_redirect?channel=C0123456789&team=T01234567
|
|
13346
|
-
type: string
|
|
13347
|
-
team_id:
|
|
13348
|
-
description: Slack team ID.
|
|
13349
|
-
example: T01234567
|
|
15514
|
+
elapsed:
|
|
15515
|
+
description: The time elapsed in milliseconds.
|
|
15516
|
+
example: 132
|
|
15517
|
+
format: int64
|
|
15518
|
+
type: integer
|
|
15519
|
+
page:
|
|
15520
|
+
$ref: '#/components/schemas/SpansResponseMetadataPage'
|
|
15521
|
+
request_id:
|
|
15522
|
+
description: The identifier of the request.
|
|
15523
|
+
example: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR
|
|
13350
15524
|
type: string
|
|
13351
|
-
|
|
13352
|
-
|
|
13353
|
-
|
|
13354
|
-
|
|
15525
|
+
status:
|
|
15526
|
+
$ref: '#/components/schemas/SpansAggregateResponseStatus'
|
|
15527
|
+
warnings:
|
|
15528
|
+
description: 'A list of warnings (non fatal errors) encountered, partial
|
|
15529
|
+
results might be returned if
|
|
15530
|
+
|
|
15531
|
+
warnings are present in the response.'
|
|
15532
|
+
items:
|
|
15533
|
+
$ref: '#/components/schemas/SpansWarning'
|
|
15534
|
+
type: array
|
|
13355
15535
|
type: object
|
|
13356
15536
|
SpansMetricCompute:
|
|
13357
15537
|
description: The compute rule to compute the span-based metric.
|
|
@@ -13573,6 +15753,101 @@ components:
|
|
|
13573
15753
|
$ref: '#/components/schemas/SpansMetricResponseData'
|
|
13574
15754
|
type: array
|
|
13575
15755
|
type: object
|
|
15756
|
+
SpansQueryFilter:
|
|
15757
|
+
description: The search and filter query settings.
|
|
15758
|
+
properties:
|
|
15759
|
+
from:
|
|
15760
|
+
default: now-15m
|
|
15761
|
+
description: The minimum time for the requested spans, supports date-time
|
|
15762
|
+
ISO8601, date math, and regular timestamps (milliseconds).
|
|
15763
|
+
example: now-15m
|
|
15764
|
+
type: string
|
|
15765
|
+
query:
|
|
15766
|
+
default: '*'
|
|
15767
|
+
description: The search query - following the span search syntax.
|
|
15768
|
+
example: service:web* AND @http.status_code:[200 TO 299]
|
|
15769
|
+
type: string
|
|
15770
|
+
to:
|
|
15771
|
+
default: now
|
|
15772
|
+
description: The maximum time for the requested spans, supports date-time
|
|
15773
|
+
ISO8601, date math, and regular timestamps (milliseconds).
|
|
15774
|
+
example: now
|
|
15775
|
+
type: string
|
|
15776
|
+
type: object
|
|
15777
|
+
SpansQueryOptions:
|
|
15778
|
+
description: 'Global query options that are used during the query.
|
|
15779
|
+
|
|
15780
|
+
Note: You should only supply timezone or time offset but not both otherwise
|
|
15781
|
+
the query will fail.'
|
|
15782
|
+
properties:
|
|
15783
|
+
timeOffset:
|
|
15784
|
+
description: The time offset (in seconds) to apply to the query.
|
|
15785
|
+
format: int64
|
|
15786
|
+
type: integer
|
|
15787
|
+
timezone:
|
|
15788
|
+
default: UTC
|
|
15789
|
+
description: The timezone can be specified as GMT, UTC, an offset from UTC
|
|
15790
|
+
(like UTC+1), or as a Timezone Database identifier (like America/New_York).
|
|
15791
|
+
example: GMT
|
|
15792
|
+
type: string
|
|
15793
|
+
type: object
|
|
15794
|
+
SpansResponseMetadataPage:
|
|
15795
|
+
description: Paging attributes.
|
|
15796
|
+
properties:
|
|
15797
|
+
after:
|
|
15798
|
+
description: 'The cursor to use to get the next results, if any. To make
|
|
15799
|
+
the next request, use the same
|
|
15800
|
+
|
|
15801
|
+
parameters with the addition of the `page[cursor]`.'
|
|
15802
|
+
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
|
15803
|
+
type: string
|
|
15804
|
+
type: object
|
|
15805
|
+
SpansSort:
|
|
15806
|
+
description: Sort parameters when querying spans.
|
|
15807
|
+
enum:
|
|
15808
|
+
- timestamp
|
|
15809
|
+
- -timestamp
|
|
15810
|
+
type: string
|
|
15811
|
+
x-enum-varnames:
|
|
15812
|
+
- TIMESTAMP_ASCENDING
|
|
15813
|
+
- TIMESTAMP_DESCENDING
|
|
15814
|
+
SpansSortOrder:
|
|
15815
|
+
description: The order to use, ascending or descending.
|
|
15816
|
+
enum:
|
|
15817
|
+
- asc
|
|
15818
|
+
- desc
|
|
15819
|
+
example: asc
|
|
15820
|
+
type: string
|
|
15821
|
+
x-enum-varnames:
|
|
15822
|
+
- ASCENDING
|
|
15823
|
+
- DESCENDING
|
|
15824
|
+
SpansType:
|
|
15825
|
+
default: spans
|
|
15826
|
+
description: Type of the span.
|
|
15827
|
+
enum:
|
|
15828
|
+
- spans
|
|
15829
|
+
example: spans
|
|
15830
|
+
type: string
|
|
15831
|
+
x-enum-varnames:
|
|
15832
|
+
- SPANS
|
|
15833
|
+
SpansWarning:
|
|
15834
|
+
description: A warning message indicating something that went wrong with the
|
|
15835
|
+
query.
|
|
15836
|
+
properties:
|
|
15837
|
+
code:
|
|
15838
|
+
description: A unique code for this type of warning.
|
|
15839
|
+
example: unknown_index
|
|
15840
|
+
type: string
|
|
15841
|
+
detail:
|
|
15842
|
+
description: A detailed explanation of this specific warning.
|
|
15843
|
+
example: 'indexes: foo, bar'
|
|
15844
|
+
type: string
|
|
15845
|
+
title:
|
|
15846
|
+
description: A short human-readable summary of the warning.
|
|
15847
|
+
example: One or several indexes are missing or invalid, results hold data
|
|
15848
|
+
from the other indexes
|
|
15849
|
+
type: string
|
|
15850
|
+
type: object
|
|
13576
15851
|
TagsEventAttribute:
|
|
13577
15852
|
description: Array of tags associated with your event.
|
|
13578
15853
|
example:
|
|
@@ -13613,7 +15888,7 @@ components:
|
|
|
13613
15888
|
handle:
|
|
13614
15889
|
description: The team's identifier
|
|
13615
15890
|
example: example-team
|
|
13616
|
-
maxLength:
|
|
15891
|
+
maxLength: 195
|
|
13617
15892
|
type: string
|
|
13618
15893
|
link_count:
|
|
13619
15894
|
description: The number of links belonging to the team
|
|
@@ -13628,7 +15903,7 @@ components:
|
|
|
13628
15903
|
name:
|
|
13629
15904
|
description: The name of the team
|
|
13630
15905
|
example: Example Team
|
|
13631
|
-
maxLength:
|
|
15906
|
+
maxLength: 200
|
|
13632
15907
|
type: string
|
|
13633
15908
|
summary:
|
|
13634
15909
|
description: A brief summary of the team, derived from the `description`
|
|
@@ -13964,12 +16239,12 @@ components:
|
|
|
13964
16239
|
handle:
|
|
13965
16240
|
description: The team's identifier
|
|
13966
16241
|
example: example-team
|
|
13967
|
-
maxLength:
|
|
16242
|
+
maxLength: 195
|
|
13968
16243
|
type: string
|
|
13969
16244
|
name:
|
|
13970
16245
|
description: The name of the team
|
|
13971
16246
|
example: Example Team
|
|
13972
|
-
maxLength:
|
|
16247
|
+
maxLength: 200
|
|
13973
16248
|
type: string
|
|
13974
16249
|
required:
|
|
13975
16250
|
- handle
|
|
@@ -14432,6 +16707,8 @@ components:
|
|
|
14432
16707
|
id:
|
|
14433
16708
|
description: ID of the user invitation.
|
|
14434
16709
|
type: string
|
|
16710
|
+
relationships:
|
|
16711
|
+
$ref: '#/components/schemas/UserInvitationRelationships'
|
|
14435
16712
|
type:
|
|
14436
16713
|
$ref: '#/components/schemas/UserInvitationsType'
|
|
14437
16714
|
type: object
|
|
@@ -14721,16 +16998,30 @@ components:
|
|
|
14721
16998
|
incident_read: View incidents in Datadog.
|
|
14722
16999
|
incident_settings_write: Configure Incidents settings.
|
|
14723
17000
|
incident_write: Create, view, and manage incidents in Datadog.
|
|
17001
|
+
metric_tags_write: Create and edit tag configurations for custom metrics.
|
|
14724
17002
|
metrics_read: View custom metrics.
|
|
14725
17003
|
monitors_downtime: Set downtimes to suppress alerts from any monitor in
|
|
14726
17004
|
an organization. The ability to write monitors is not required to set
|
|
14727
17005
|
downtimes.
|
|
14728
17006
|
monitors_read: View monitors.
|
|
17007
|
+
org_management: Edit organization configurations, including authentication
|
|
17008
|
+
and certain security preferences.
|
|
14729
17009
|
security_monitoring_filters_read: Read Security Filters.
|
|
14730
17010
|
security_monitoring_filters_write: Create, edit, and delete Security Filters.
|
|
17011
|
+
security_monitoring_findings_read: View CSPM Findings.
|
|
17012
|
+
security_monitoring_findings_write: Mute CSPM Findings.
|
|
14731
17013
|
security_monitoring_rules_read: Read Detection Rules.
|
|
14732
17014
|
security_monitoring_rules_write: Create and edit Detection Rules.
|
|
14733
17015
|
security_monitoring_signals_read: View Security Signals.
|
|
17016
|
+
synthetics_default_settings_read: View the default settings for Synthetic
|
|
17017
|
+
Monitoring.
|
|
17018
|
+
synthetics_default_settings_write: Create and edit default settings for
|
|
17019
|
+
Synthetic Monitoring.
|
|
17020
|
+
teams_manage: Manage Teams. Create, delete, rename, and edit the metadata
|
|
17021
|
+
of all Teams. To control Team membership across all Teams, use the User
|
|
17022
|
+
Access Manage permission.
|
|
17023
|
+
teams_read: Read Teams data. View Team names, metadata, and which users
|
|
17024
|
+
are on each Team.
|
|
14734
17025
|
timeseries_query: Query Timeseries data.
|
|
14735
17026
|
usage_read: View your organization's usage and usage attribution.
|
|
14736
17027
|
user_access_invite: Invite other users to your organization.
|
|
@@ -15544,6 +17835,84 @@ paths:
|
|
|
15544
17835
|
- AuthN Mappings
|
|
15545
17836
|
x-codegen-request-body-name: body
|
|
15546
17837
|
x-permission: OR(USER_ACCESS_MANAGE)
|
|
17838
|
+
/api/v2/ci/pipeline:
|
|
17839
|
+
post:
|
|
17840
|
+
description: 'Send your pipeline event to your Datadog platform over HTTP. For
|
|
17841
|
+
details about how pipeline executions are modeled and what execution types
|
|
17842
|
+
we support, see the [guide](https://docs.datadoghq.com/continuous_integration/guides/pipeline_data_model/).
|
|
17843
|
+
|
|
17844
|
+
|
|
17845
|
+
Pipeline events can be submitted with a timestamp that is up to 18 hours in
|
|
17846
|
+
the past.
|
|
17847
|
+
|
|
17848
|
+
|
|
17849
|
+
This API endpoint is in private beta.'
|
|
17850
|
+
operationId: CreateCIAppPipelineEvent
|
|
17851
|
+
requestBody:
|
|
17852
|
+
content:
|
|
17853
|
+
application/json:
|
|
17854
|
+
schema:
|
|
17855
|
+
$ref: '#/components/schemas/CIAppCreatePipelineEventRequest'
|
|
17856
|
+
required: true
|
|
17857
|
+
responses:
|
|
17858
|
+
'202':
|
|
17859
|
+
content:
|
|
17860
|
+
application/json:
|
|
17861
|
+
schema:
|
|
17862
|
+
type: object
|
|
17863
|
+
description: Request accepted for processing
|
|
17864
|
+
'400':
|
|
17865
|
+
content:
|
|
17866
|
+
application/json:
|
|
17867
|
+
schema:
|
|
17868
|
+
$ref: '#/components/schemas/HTTPCIAppErrors'
|
|
17869
|
+
description: Bad Request
|
|
17870
|
+
'401':
|
|
17871
|
+
content:
|
|
17872
|
+
application/json:
|
|
17873
|
+
schema:
|
|
17874
|
+
$ref: '#/components/schemas/HTTPCIAppErrors'
|
|
17875
|
+
description: Unauthorized
|
|
17876
|
+
'403':
|
|
17877
|
+
content:
|
|
17878
|
+
application/json:
|
|
17879
|
+
schema:
|
|
17880
|
+
$ref: '#/components/schemas/HTTPCIAppErrors'
|
|
17881
|
+
description: Forbidden
|
|
17882
|
+
'408':
|
|
17883
|
+
content:
|
|
17884
|
+
application/json:
|
|
17885
|
+
schema:
|
|
17886
|
+
$ref: '#/components/schemas/HTTPCIAppErrors'
|
|
17887
|
+
description: Request Timeout
|
|
17888
|
+
'413':
|
|
17889
|
+
content:
|
|
17890
|
+
application/json:
|
|
17891
|
+
schema:
|
|
17892
|
+
$ref: '#/components/schemas/HTTPCIAppErrors'
|
|
17893
|
+
description: Payload Too Large
|
|
17894
|
+
'429':
|
|
17895
|
+
content:
|
|
17896
|
+
application/json:
|
|
17897
|
+
schema:
|
|
17898
|
+
$ref: '#/components/schemas/HTTPCIAppErrors'
|
|
17899
|
+
description: Too Many Requests
|
|
17900
|
+
'500':
|
|
17901
|
+
content:
|
|
17902
|
+
application/json:
|
|
17903
|
+
schema:
|
|
17904
|
+
$ref: '#/components/schemas/HTTPCIAppErrors'
|
|
17905
|
+
description: Internal Server Error
|
|
17906
|
+
'503':
|
|
17907
|
+
content:
|
|
17908
|
+
application/json:
|
|
17909
|
+
schema:
|
|
17910
|
+
$ref: '#/components/schemas/HTTPCIAppErrors'
|
|
17911
|
+
description: Service Unavailable
|
|
17912
|
+
summary: Send pipeline event
|
|
17913
|
+
tags:
|
|
17914
|
+
- CI Visibility Pipelines
|
|
17915
|
+
x-codegen-request-body-name: body
|
|
15547
17916
|
/api/v2/ci/pipelines/analytics/aggregate:
|
|
15548
17917
|
post:
|
|
15549
17918
|
description: The API endpoint to aggregate CI Visibility pipeline events into
|
|
@@ -15575,7 +17944,7 @@ paths:
|
|
|
15575
17944
|
/api/v2/ci/pipelines/events:
|
|
15576
17945
|
get:
|
|
15577
17946
|
description: 'List endpoint returns CI Visibility pipeline events that match
|
|
15578
|
-
a log search query.
|
|
17947
|
+
a [log search query](https://docs.datadoghq.com/logs/explorer/search_syntax/).
|
|
15579
17948
|
|
|
15580
17949
|
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).
|
|
15581
17950
|
|
|
@@ -15654,7 +18023,7 @@ paths:
|
|
|
15654
18023
|
/api/v2/ci/pipelines/events/search:
|
|
15655
18024
|
post:
|
|
15656
18025
|
description: 'List endpoint returns CI Visibility pipeline events that match
|
|
15657
|
-
a log search query.
|
|
18026
|
+
a [log search query](https://docs.datadoghq.com/logs/explorer/search_syntax/).
|
|
15658
18027
|
|
|
15659
18028
|
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).
|
|
15660
18029
|
|
|
@@ -15719,8 +18088,8 @@ paths:
|
|
|
15719
18088
|
x-codegen-request-body-name: body
|
|
15720
18089
|
/api/v2/ci/tests/events:
|
|
15721
18090
|
get:
|
|
15722
|
-
description: 'List endpoint returns CI Visibility test events that match a log
|
|
15723
|
-
search query.
|
|
18091
|
+
description: 'List endpoint returns CI Visibility test events that match a [log
|
|
18092
|
+
search query](https://docs.datadoghq.com/logs/explorer/search_syntax/).
|
|
15724
18093
|
|
|
15725
18094
|
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).
|
|
15726
18095
|
|
|
@@ -15798,8 +18167,8 @@ paths:
|
|
|
15798
18167
|
resultsPath: data
|
|
15799
18168
|
/api/v2/ci/tests/events/search:
|
|
15800
18169
|
post:
|
|
15801
|
-
description: 'List endpoint returns CI Visibility test events that match a log
|
|
15802
|
-
search query.
|
|
18170
|
+
description: 'List endpoint returns CI Visibility test events that match a [log
|
|
18171
|
+
search query](https://docs.datadoghq.com/logs/explorer/search_syntax/).
|
|
15803
18172
|
|
|
15804
18173
|
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).
|
|
15805
18174
|
|
|
@@ -16119,7 +18488,238 @@ paths:
|
|
|
16119
18488
|
content:
|
|
16120
18489
|
application/json:
|
|
16121
18490
|
schema:
|
|
16122
|
-
$ref: '#/components/schemas/DashboardListAddItemsResponse'
|
|
18491
|
+
$ref: '#/components/schemas/DashboardListAddItemsResponse'
|
|
18492
|
+
description: OK
|
|
18493
|
+
'400':
|
|
18494
|
+
content:
|
|
18495
|
+
application/json:
|
|
18496
|
+
schema:
|
|
18497
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
18498
|
+
description: Bad Request
|
|
18499
|
+
'403':
|
|
18500
|
+
content:
|
|
18501
|
+
application/json:
|
|
18502
|
+
schema:
|
|
18503
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
18504
|
+
description: Forbidden
|
|
18505
|
+
'404':
|
|
18506
|
+
content:
|
|
18507
|
+
application/json:
|
|
18508
|
+
schema:
|
|
18509
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
18510
|
+
description: Not Found
|
|
18511
|
+
'429':
|
|
18512
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
18513
|
+
summary: Add Items to a Dashboard List
|
|
18514
|
+
tags:
|
|
18515
|
+
- Dashboard Lists
|
|
18516
|
+
x-codegen-request-body-name: body
|
|
18517
|
+
put:
|
|
18518
|
+
description: Update dashboards of an existing dashboard list.
|
|
18519
|
+
operationId: UpdateDashboardListItems
|
|
18520
|
+
parameters:
|
|
18521
|
+
- description: ID of the dashboard list to update items from.
|
|
18522
|
+
in: path
|
|
18523
|
+
name: dashboard_list_id
|
|
18524
|
+
required: true
|
|
18525
|
+
schema:
|
|
18526
|
+
format: int64
|
|
18527
|
+
type: integer
|
|
18528
|
+
requestBody:
|
|
18529
|
+
content:
|
|
18530
|
+
application/json:
|
|
18531
|
+
schema:
|
|
18532
|
+
$ref: '#/components/schemas/DashboardListUpdateItemsRequest'
|
|
18533
|
+
description: New dashboards of the dashboard list.
|
|
18534
|
+
required: true
|
|
18535
|
+
responses:
|
|
18536
|
+
'200':
|
|
18537
|
+
content:
|
|
18538
|
+
application/json:
|
|
18539
|
+
schema:
|
|
18540
|
+
$ref: '#/components/schemas/DashboardListUpdateItemsResponse'
|
|
18541
|
+
description: OK
|
|
18542
|
+
'400':
|
|
18543
|
+
content:
|
|
18544
|
+
application/json:
|
|
18545
|
+
schema:
|
|
18546
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
18547
|
+
description: Bad Request
|
|
18548
|
+
'403':
|
|
18549
|
+
content:
|
|
18550
|
+
application/json:
|
|
18551
|
+
schema:
|
|
18552
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
18553
|
+
description: Forbidden
|
|
18554
|
+
'404':
|
|
18555
|
+
content:
|
|
18556
|
+
application/json:
|
|
18557
|
+
schema:
|
|
18558
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
18559
|
+
description: Not Found
|
|
18560
|
+
'429':
|
|
18561
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
18562
|
+
summary: Update items of a dashboard list
|
|
18563
|
+
tags:
|
|
18564
|
+
- Dashboard Lists
|
|
18565
|
+
x-codegen-request-body-name: body
|
|
18566
|
+
/api/v2/downtime:
|
|
18567
|
+
get:
|
|
18568
|
+
description: Get all scheduled downtimes.
|
|
18569
|
+
operationId: ListDowntimes
|
|
18570
|
+
parameters:
|
|
18571
|
+
- description: Only return downtimes that are active when the request is made.
|
|
18572
|
+
in: query
|
|
18573
|
+
name: current_only
|
|
18574
|
+
required: false
|
|
18575
|
+
schema:
|
|
18576
|
+
type: boolean
|
|
18577
|
+
- description: 'Comma-separated list of resource paths for related resources
|
|
18578
|
+
to include in the response. Supported resource
|
|
18579
|
+
|
|
18580
|
+
paths are `created_by` and `monitor`.'
|
|
18581
|
+
in: query
|
|
18582
|
+
name: include
|
|
18583
|
+
required: false
|
|
18584
|
+
schema:
|
|
18585
|
+
example: created_by,monitor
|
|
18586
|
+
type: string
|
|
18587
|
+
responses:
|
|
18588
|
+
'200':
|
|
18589
|
+
content:
|
|
18590
|
+
application/json:
|
|
18591
|
+
schema:
|
|
18592
|
+
$ref: '#/components/schemas/ListDowntimesResponse'
|
|
18593
|
+
description: OK
|
|
18594
|
+
'403':
|
|
18595
|
+
content:
|
|
18596
|
+
application/json:
|
|
18597
|
+
schema:
|
|
18598
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
18599
|
+
description: Forbidden
|
|
18600
|
+
'429':
|
|
18601
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
18602
|
+
security:
|
|
18603
|
+
- apiKeyAuth: []
|
|
18604
|
+
appKeyAuth: []
|
|
18605
|
+
- AuthZ:
|
|
18606
|
+
- monitors_read
|
|
18607
|
+
summary: Get all downtimes
|
|
18608
|
+
tags:
|
|
18609
|
+
- Downtimes
|
|
18610
|
+
x-unstable: '**Note**: This endpoint is in private beta.
|
|
18611
|
+
|
|
18612
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
18613
|
+
post:
|
|
18614
|
+
description: Schedule a downtime.
|
|
18615
|
+
operationId: CreateDowntime
|
|
18616
|
+
requestBody:
|
|
18617
|
+
content:
|
|
18618
|
+
application/json:
|
|
18619
|
+
schema:
|
|
18620
|
+
$ref: '#/components/schemas/DowntimeCreateRequest'
|
|
18621
|
+
description: Schedule a downtime request body.
|
|
18622
|
+
required: true
|
|
18623
|
+
responses:
|
|
18624
|
+
'200':
|
|
18625
|
+
content:
|
|
18626
|
+
application/json:
|
|
18627
|
+
schema:
|
|
18628
|
+
$ref: '#/components/schemas/DowntimeResponse'
|
|
18629
|
+
description: OK
|
|
18630
|
+
'400':
|
|
18631
|
+
content:
|
|
18632
|
+
application/json:
|
|
18633
|
+
schema:
|
|
18634
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
18635
|
+
description: Bad Request
|
|
18636
|
+
'403':
|
|
18637
|
+
content:
|
|
18638
|
+
application/json:
|
|
18639
|
+
schema:
|
|
18640
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
18641
|
+
description: Forbidden
|
|
18642
|
+
'429':
|
|
18643
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
18644
|
+
security:
|
|
18645
|
+
- apiKeyAuth: []
|
|
18646
|
+
appKeyAuth: []
|
|
18647
|
+
- AuthZ:
|
|
18648
|
+
- monitors_downtime
|
|
18649
|
+
summary: Schedule a downtime
|
|
18650
|
+
tags:
|
|
18651
|
+
- Downtimes
|
|
18652
|
+
x-codegen-request-body-name: body
|
|
18653
|
+
x-unstable: '**Note**: This endpoint is in private beta.
|
|
18654
|
+
|
|
18655
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
18656
|
+
/api/v2/downtime/{downtime_id}:
|
|
18657
|
+
delete:
|
|
18658
|
+
description: Cancel a downtime.
|
|
18659
|
+
operationId: CancelDowntime
|
|
18660
|
+
parameters:
|
|
18661
|
+
- description: ID of the downtime to cancel.
|
|
18662
|
+
in: path
|
|
18663
|
+
name: downtime_id
|
|
18664
|
+
required: true
|
|
18665
|
+
schema:
|
|
18666
|
+
example: 00000000-0000-1234-0000-000000000000
|
|
18667
|
+
type: string
|
|
18668
|
+
responses:
|
|
18669
|
+
'204':
|
|
18670
|
+
description: OK
|
|
18671
|
+
'403':
|
|
18672
|
+
content:
|
|
18673
|
+
application/json:
|
|
18674
|
+
schema:
|
|
18675
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
18676
|
+
description: Forbidden
|
|
18677
|
+
'404':
|
|
18678
|
+
content:
|
|
18679
|
+
application/json:
|
|
18680
|
+
schema:
|
|
18681
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
18682
|
+
description: Downtime not found
|
|
18683
|
+
'429':
|
|
18684
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
18685
|
+
security:
|
|
18686
|
+
- apiKeyAuth: []
|
|
18687
|
+
appKeyAuth: []
|
|
18688
|
+
- AuthZ:
|
|
18689
|
+
- monitors_downtime
|
|
18690
|
+
summary: Cancel a downtime
|
|
18691
|
+
tags:
|
|
18692
|
+
- Downtimes
|
|
18693
|
+
x-unstable: '**Note**: This endpoint is in private beta.
|
|
18694
|
+
|
|
18695
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
18696
|
+
get:
|
|
18697
|
+
description: Get downtime detail by `downtime_id`.
|
|
18698
|
+
operationId: GetDowntime
|
|
18699
|
+
parameters:
|
|
18700
|
+
- description: ID of the downtime to fetch.
|
|
18701
|
+
in: path
|
|
18702
|
+
name: downtime_id
|
|
18703
|
+
required: true
|
|
18704
|
+
schema:
|
|
18705
|
+
example: 00000000-0000-1234-0000-000000000000
|
|
18706
|
+
type: string
|
|
18707
|
+
- description: 'Comma-separated list of resource paths for related resources
|
|
18708
|
+
to include in the response. Supported resource
|
|
18709
|
+
|
|
18710
|
+
paths are `created_by` and `monitor`.'
|
|
18711
|
+
in: query
|
|
18712
|
+
name: include
|
|
18713
|
+
required: false
|
|
18714
|
+
schema:
|
|
18715
|
+
example: created_by,monitor
|
|
18716
|
+
type: string
|
|
18717
|
+
responses:
|
|
18718
|
+
'200':
|
|
18719
|
+
content:
|
|
18720
|
+
application/json:
|
|
18721
|
+
schema:
|
|
18722
|
+
$ref: '#/components/schemas/DowntimeResponse'
|
|
16123
18723
|
description: OK
|
|
16124
18724
|
'400':
|
|
16125
18725
|
content:
|
|
@@ -16141,34 +18741,41 @@ paths:
|
|
|
16141
18741
|
description: Not Found
|
|
16142
18742
|
'429':
|
|
16143
18743
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
16144
|
-
|
|
18744
|
+
security:
|
|
18745
|
+
- apiKeyAuth: []
|
|
18746
|
+
appKeyAuth: []
|
|
18747
|
+
- AuthZ:
|
|
18748
|
+
- monitors_read
|
|
18749
|
+
summary: Get a downtime
|
|
16145
18750
|
tags:
|
|
16146
|
-
-
|
|
16147
|
-
x-
|
|
16148
|
-
|
|
16149
|
-
|
|
16150
|
-
|
|
18751
|
+
- Downtimes
|
|
18752
|
+
x-unstable: '**Note**: This endpoint is in private beta.
|
|
18753
|
+
|
|
18754
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
18755
|
+
patch:
|
|
18756
|
+
description: Update a downtime by `downtime_id`.
|
|
18757
|
+
operationId: UpdateDowntime
|
|
16151
18758
|
parameters:
|
|
16152
|
-
- description: ID of the
|
|
18759
|
+
- description: ID of the downtime to update.
|
|
16153
18760
|
in: path
|
|
16154
|
-
name:
|
|
18761
|
+
name: downtime_id
|
|
16155
18762
|
required: true
|
|
16156
18763
|
schema:
|
|
16157
|
-
|
|
16158
|
-
type:
|
|
18764
|
+
example: 00e000000-0000-1234-0000-000000000000
|
|
18765
|
+
type: string
|
|
16159
18766
|
requestBody:
|
|
16160
18767
|
content:
|
|
16161
18768
|
application/json:
|
|
16162
18769
|
schema:
|
|
16163
|
-
$ref: '#/components/schemas/
|
|
16164
|
-
description:
|
|
18770
|
+
$ref: '#/components/schemas/DowntimeUpdateRequest'
|
|
18771
|
+
description: Update a downtime request body.
|
|
16165
18772
|
required: true
|
|
16166
18773
|
responses:
|
|
16167
18774
|
'200':
|
|
16168
18775
|
content:
|
|
16169
18776
|
application/json:
|
|
16170
18777
|
schema:
|
|
16171
|
-
$ref: '#/components/schemas/
|
|
18778
|
+
$ref: '#/components/schemas/DowntimeResponse'
|
|
16172
18779
|
description: OK
|
|
16173
18780
|
'400':
|
|
16174
18781
|
content:
|
|
@@ -16187,13 +18794,21 @@ paths:
|
|
|
16187
18794
|
application/json:
|
|
16188
18795
|
schema:
|
|
16189
18796
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
16190
|
-
description:
|
|
18797
|
+
description: Downtime not found
|
|
16191
18798
|
'429':
|
|
16192
18799
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
16193
|
-
|
|
18800
|
+
security:
|
|
18801
|
+
- apiKeyAuth: []
|
|
18802
|
+
appKeyAuth: []
|
|
18803
|
+
- AuthZ:
|
|
18804
|
+
- monitors_downtime
|
|
18805
|
+
summary: Update a downtime
|
|
16194
18806
|
tags:
|
|
16195
|
-
-
|
|
18807
|
+
- Downtimes
|
|
16196
18808
|
x-codegen-request-body-name: body
|
|
18809
|
+
x-unstable: '**Note**: This endpoint is in private beta.
|
|
18810
|
+
|
|
18811
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
16197
18812
|
/api/v2/events:
|
|
16198
18813
|
get:
|
|
16199
18814
|
description: 'List endpoint returns events that match an events search query.
|
|
@@ -16272,7 +18887,7 @@ paths:
|
|
|
16272
18887
|
cursorPath: meta.page.after
|
|
16273
18888
|
limitParam: page[limit]
|
|
16274
18889
|
resultsPath: data
|
|
16275
|
-
x-unstable: '**Note**: This endpoint is in
|
|
18890
|
+
x-unstable: '**Note**: This endpoint is in beta.
|
|
16276
18891
|
|
|
16277
18892
|
For access, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
16278
18893
|
/api/v2/events/search:
|
|
@@ -16317,7 +18932,7 @@ paths:
|
|
|
16317
18932
|
cursorPath: meta.page.after
|
|
16318
18933
|
limitParam: body.page.limit
|
|
16319
18934
|
resultsPath: data
|
|
16320
|
-
x-unstable: '**Note**: This endpoint is in
|
|
18935
|
+
x-unstable: '**Note**: This endpoint is in beta.
|
|
16321
18936
|
|
|
16322
18937
|
For access, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
16323
18938
|
/api/v2/incidents:
|
|
@@ -18765,15 +21380,21 @@ paths:
|
|
|
18765
21380
|
required: false
|
|
18766
21381
|
schema:
|
|
18767
21382
|
type: string
|
|
18768
|
-
- description: 'For customers with multiple indexes, the indexes to search
|
|
21383
|
+
- description: 'For customers with multiple indexes, the indexes to search.
|
|
18769
21384
|
|
|
18770
21385
|
Defaults to ''*'' which means all indexes'
|
|
18771
|
-
example:
|
|
21386
|
+
example:
|
|
21387
|
+
- main
|
|
21388
|
+
- web
|
|
21389
|
+
explode: false
|
|
18772
21390
|
in: query
|
|
18773
|
-
name: filter[
|
|
21391
|
+
name: filter[indexes]
|
|
18774
21392
|
required: false
|
|
18775
21393
|
schema:
|
|
18776
|
-
|
|
21394
|
+
items:
|
|
21395
|
+
description: The name of a log index.
|
|
21396
|
+
type: string
|
|
21397
|
+
type: array
|
|
18777
21398
|
- description: Minimum timestamp for requested logs.
|
|
18778
21399
|
example: '2019-01-02T09:42:36.320Z'
|
|
18779
21400
|
in: query
|
|
@@ -19725,6 +22346,45 @@ paths:
|
|
|
19725
22346
|
tags:
|
|
19726
22347
|
- Monitors
|
|
19727
22348
|
x-codegen-request-body-name: body
|
|
22349
|
+
/api/v2/monitor/{monitor_id}/downtime_matches:
|
|
22350
|
+
get:
|
|
22351
|
+
description: Get all active downtimes for the specified monitor.
|
|
22352
|
+
operationId: ListMonitorDowntimes
|
|
22353
|
+
parameters:
|
|
22354
|
+
- description: The id of the monitor.
|
|
22355
|
+
in: path
|
|
22356
|
+
name: monitor_id
|
|
22357
|
+
required: true
|
|
22358
|
+
schema:
|
|
22359
|
+
format: int64
|
|
22360
|
+
type: integer
|
|
22361
|
+
responses:
|
|
22362
|
+
'200':
|
|
22363
|
+
content:
|
|
22364
|
+
application/json:
|
|
22365
|
+
schema:
|
|
22366
|
+
$ref: '#/components/schemas/MonitorDowntimeMatchResponse'
|
|
22367
|
+
description: OK
|
|
22368
|
+
'404':
|
|
22369
|
+
content:
|
|
22370
|
+
application/json:
|
|
22371
|
+
schema:
|
|
22372
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
22373
|
+
description: Monitor Not Found error
|
|
22374
|
+
'429':
|
|
22375
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
22376
|
+
security:
|
|
22377
|
+
- apiKeyAuth: []
|
|
22378
|
+
appKeyAuth: []
|
|
22379
|
+
- AuthZ:
|
|
22380
|
+
- monitors_read
|
|
22381
|
+
summary: Get active downtimes for a monitor
|
|
22382
|
+
tags:
|
|
22383
|
+
- Downtimes
|
|
22384
|
+
x-codegen-request-body-name: body
|
|
22385
|
+
x-unstable: '**Note**: This endpoint is in private beta.
|
|
22386
|
+
|
|
22387
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
19728
22388
|
/api/v2/permissions:
|
|
19729
22389
|
get:
|
|
19730
22390
|
description: Returns a list of all permissions, including name, description,
|
|
@@ -19771,13 +22431,16 @@ paths:
|
|
|
19771
22431
|
can also use the negation operator on strings. For example, use `filter[resource_type]=-aws*`
|
|
19772
22432
|
to filter for any non-AWS resources.\n\nThe operator must come after the equal
|
|
19773
22433
|
sign. For example, to filter with the `>=` operator, add the operator after
|
|
19774
|
-
the equal sign: `filter[evaluation_changed_at]=>=1678809373257`.\n\
|
|
19775
|
-
|
|
19776
|
-
|
|
19777
|
-
|
|
19778
|
-
|
|
19779
|
-
|
|
19780
|
-
|
|
22434
|
+
the equal sign: `filter[evaluation_changed_at]=>=1678809373257`.\n\nQuery
|
|
22435
|
+
parameters must be only among the documented ones and with values of correct
|
|
22436
|
+
types. Duplicated query parameters (e.g. `filter[status]=low&filter[status]=info`)
|
|
22437
|
+
are not allowed.\n\n### Response\n\nThe response includes an array of finding
|
|
22438
|
+
objects, pagination metadata, and a count of items that match the query.\n\nEach
|
|
22439
|
+
finding object contains the following:\n\n- The finding ID that can be used
|
|
22440
|
+
in a `GetFinding` request to retrieve the full finding details.\n- Core attributes,
|
|
22441
|
+
including status, evaluation, high-level resource details, muted state, and
|
|
22442
|
+
rule details.\n- `evaluation_changed_at` and `resource_discovery_date` time
|
|
22443
|
+
stamps.\n- An array of associated tags.\n"
|
|
19781
22444
|
operationId: ListFindings
|
|
19782
22445
|
parameters:
|
|
19783
22446
|
- description: Limit the number of findings returned. Must be <= 1000.
|
|
@@ -19877,17 +22540,13 @@ paths:
|
|
|
19877
22540
|
$ref: '#/components/schemas/ListFindingsResponse'
|
|
19878
22541
|
description: OK
|
|
19879
22542
|
'400':
|
|
19880
|
-
|
|
19881
|
-
application/json:
|
|
19882
|
-
schema:
|
|
19883
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
|
19884
|
-
description: Bad Request
|
|
22543
|
+
$ref: '#/components/responses/FindingsBadRequestResponse'
|
|
19885
22544
|
'403':
|
|
19886
|
-
$ref: '#/components/responses/
|
|
22545
|
+
$ref: '#/components/responses/FindingsForbiddenResponse'
|
|
19887
22546
|
'404':
|
|
19888
|
-
$ref: '#/components/responses/
|
|
22547
|
+
$ref: '#/components/responses/FindingsNotFoundResponse'
|
|
19889
22548
|
'429':
|
|
19890
|
-
$ref: '#/components/responses/
|
|
22549
|
+
$ref: '#/components/responses/FindingsTooManyRequestsResponse'
|
|
19891
22550
|
security:
|
|
19892
22551
|
- apiKeyAuth: []
|
|
19893
22552
|
appKeyAuth: []
|
|
@@ -19932,25 +22591,90 @@ paths:
|
|
|
19932
22591
|
$ref: '#/components/schemas/GetFindingResponse'
|
|
19933
22592
|
description: OK
|
|
19934
22593
|
'400':
|
|
22594
|
+
$ref: '#/components/responses/FindingsBadRequestResponse'
|
|
22595
|
+
'403':
|
|
22596
|
+
$ref: '#/components/responses/FindingsForbiddenResponse'
|
|
22597
|
+
'404':
|
|
22598
|
+
$ref: '#/components/responses/FindingsNotFoundResponse'
|
|
22599
|
+
'429':
|
|
22600
|
+
$ref: '#/components/responses/FindingsTooManyRequestsResponse'
|
|
22601
|
+
security:
|
|
22602
|
+
- apiKeyAuth: []
|
|
22603
|
+
appKeyAuth: []
|
|
22604
|
+
- AuthZ:
|
|
22605
|
+
- security_monitoring_findings_read
|
|
22606
|
+
summary: Get a finding
|
|
22607
|
+
tags:
|
|
22608
|
+
- Security Monitoring
|
|
22609
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
|
22610
|
+
|
|
22611
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
22612
|
+
patch:
|
|
22613
|
+
description: 'Mute or unmute a specific finding.
|
|
22614
|
+
|
|
22615
|
+
The API returns the updated finding object when the request is successful.'
|
|
22616
|
+
operationId: UpdateFinding
|
|
22617
|
+
parameters:
|
|
22618
|
+
- description: The ID of the finding.
|
|
22619
|
+
in: path
|
|
22620
|
+
name: finding_id
|
|
22621
|
+
required: true
|
|
22622
|
+
schema:
|
|
22623
|
+
type: string
|
|
22624
|
+
requestBody:
|
|
22625
|
+
content:
|
|
22626
|
+
application/json:
|
|
22627
|
+
schema:
|
|
22628
|
+
$ref: '#/components/schemas/MuteFindingRequest'
|
|
22629
|
+
description: 'To mute or unmute a finding, the request body should include
|
|
22630
|
+
at least two attributes: `muted` and `reason`. The allowed reasons depend
|
|
22631
|
+
on whether the finding is being muted or unmuted:
|
|
22632
|
+
|
|
22633
|
+
- To mute a finding: `PENDING_FIX`, `FALSE_POSITIVE`, `ACCEPTED_RISK`, `OTHER`.
|
|
22634
|
+
|
|
22635
|
+
- To unmute a finding : `NO_PENDING_FIX`, `HUMAN_ERROR`, `NO_LONGER_ACCEPTED_RISK`,
|
|
22636
|
+
`OTHER`.
|
|
22637
|
+
|
|
22638
|
+
'
|
|
22639
|
+
required: true
|
|
22640
|
+
responses:
|
|
22641
|
+
'200':
|
|
19935
22642
|
content:
|
|
19936
22643
|
application/json:
|
|
19937
22644
|
schema:
|
|
19938
|
-
$ref: '#/components/schemas/
|
|
19939
|
-
description:
|
|
22645
|
+
$ref: '#/components/schemas/MuteFindingResponse'
|
|
22646
|
+
description: OK
|
|
22647
|
+
'400':
|
|
22648
|
+
$ref: '#/components/responses/FindingsBadRequestResponse'
|
|
19940
22649
|
'403':
|
|
19941
|
-
$ref: '#/components/responses/
|
|
22650
|
+
$ref: '#/components/responses/FindingsForbiddenResponse'
|
|
19942
22651
|
'404':
|
|
19943
|
-
$ref: '#/components/responses/
|
|
22652
|
+
$ref: '#/components/responses/FindingsNotFoundResponse'
|
|
22653
|
+
'409':
|
|
22654
|
+
content:
|
|
22655
|
+
application/json:
|
|
22656
|
+
schema:
|
|
22657
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
|
22658
|
+
description: 'Resource Conflict: The finding has already been muted or unmuted
|
|
22659
|
+
within the last 60 seconds.'
|
|
22660
|
+
'422':
|
|
22661
|
+
content:
|
|
22662
|
+
application/json:
|
|
22663
|
+
schema:
|
|
22664
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
|
22665
|
+
description: 'Invalid Request: The server understands the request syntax
|
|
22666
|
+
but cannot process it due to invalid data.'
|
|
19944
22667
|
'429':
|
|
19945
|
-
$ref: '#/components/responses/
|
|
22668
|
+
$ref: '#/components/responses/FindingsTooManyRequestsResponse'
|
|
19946
22669
|
security:
|
|
19947
22670
|
- apiKeyAuth: []
|
|
19948
22671
|
appKeyAuth: []
|
|
19949
22672
|
- AuthZ:
|
|
19950
|
-
-
|
|
19951
|
-
summary:
|
|
22673
|
+
- security_monitoring_findings_write
|
|
22674
|
+
summary: Mute or unmute a finding
|
|
19952
22675
|
tags:
|
|
19953
22676
|
- Security Monitoring
|
|
22677
|
+
x-codegen-request-body-name: body
|
|
19954
22678
|
x-unstable: '**Note**: This endpoint is in public beta.
|
|
19955
22679
|
|
|
19956
22680
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
@@ -20051,7 +22775,7 @@ paths:
|
|
|
20051
22775
|
resultsPath: data
|
|
20052
22776
|
/api/v2/query/scalar:
|
|
20053
22777
|
post:
|
|
20054
|
-
description: 'Query scalar values (as seen on Query Value, Table and Toplist
|
|
22778
|
+
description: 'Query scalar values (as seen on Query Value, Table, and Toplist
|
|
20055
22779
|
widgets).
|
|
20056
22780
|
|
|
20057
22781
|
Multiple data sources are supported with the ability to
|
|
@@ -20088,13 +22812,13 @@ paths:
|
|
|
20088
22812
|
tags:
|
|
20089
22813
|
- Metrics
|
|
20090
22814
|
x-codegen-request-body-name: body
|
|
20091
|
-
x-unstable: '**Note**: This endpoint is GA for
|
|
20092
|
-
(RUM) and
|
|
22815
|
+
x-unstable: '**Note**: This endpoint is GA for Metrics, Real User Monitoring
|
|
22816
|
+
(RUM), and Cloud Cost Management data sources.
|
|
20093
22817
|
|
|
20094
22818
|
Support for logs is in beta. We are gradually onboarding support for more
|
|
20095
22819
|
sources. If you have any
|
|
20096
22820
|
|
|
20097
|
-
feedback, contact [Datadog
|
|
22821
|
+
feedback, contact [Datadog Support](https://docs.datadoghq.com/help/).'
|
|
20098
22822
|
/api/v2/query/timeseries:
|
|
20099
22823
|
post:
|
|
20100
22824
|
description: 'Query timeseries data across various data sources and
|
|
@@ -20127,17 +22851,19 @@ paths:
|
|
|
20127
22851
|
appKeyAuth: []
|
|
20128
22852
|
- AuthZ:
|
|
20129
22853
|
- timeseries_query
|
|
22854
|
+
- metrics_read
|
|
22855
|
+
- metric_tags_write
|
|
20130
22856
|
summary: Query timeseries data across multiple products
|
|
20131
22857
|
tags:
|
|
20132
22858
|
- Metrics
|
|
20133
22859
|
x-codegen-request-body-name: body
|
|
20134
|
-
x-unstable: '**Note**: This endpoint is GA for
|
|
20135
|
-
(RUM) and
|
|
22860
|
+
x-unstable: '**Note**: This endpoint is GA for Metrics, Real User Monitoring
|
|
22861
|
+
(RUM), and Cloud Cost Management data sources.
|
|
20136
22862
|
|
|
20137
22863
|
Support for logs is in beta. We are gradually onboarding support for more
|
|
20138
22864
|
sources. If you have any
|
|
20139
22865
|
|
|
20140
|
-
feedback, contact [Datadog
|
|
22866
|
+
feedback, contact [Datadog Support](https://docs.datadoghq.com/help/).'
|
|
20141
22867
|
/api/v2/restriction_policy/{resource_id}:
|
|
20142
22868
|
delete:
|
|
20143
22869
|
description: Deletes the restriction policy associated with a specified resource.
|
|
@@ -21973,6 +24699,8 @@ paths:
|
|
|
21973
24699
|
schema:
|
|
21974
24700
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
21975
24701
|
description: Authentication Error
|
|
24702
|
+
'404':
|
|
24703
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
21976
24704
|
'429':
|
|
21977
24705
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
21978
24706
|
summary: Delete Scanning Group
|
|
@@ -22017,6 +24745,8 @@ paths:
|
|
|
22017
24745
|
schema:
|
|
22018
24746
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
22019
24747
|
description: Authentication Error
|
|
24748
|
+
'404':
|
|
24749
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
22020
24750
|
'429':
|
|
22021
24751
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
22022
24752
|
summary: Update Scanning Group
|
|
@@ -22099,6 +24829,8 @@ paths:
|
|
|
22099
24829
|
schema:
|
|
22100
24830
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
22101
24831
|
description: Authentication Error
|
|
24832
|
+
'404':
|
|
24833
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
22102
24834
|
'429':
|
|
22103
24835
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
22104
24836
|
summary: Delete Scanning Rule
|
|
@@ -22142,6 +24874,8 @@ paths:
|
|
|
22142
24874
|
schema:
|
|
22143
24875
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
22144
24876
|
description: Authentication Error
|
|
24877
|
+
'404':
|
|
24878
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
22145
24879
|
'429':
|
|
22146
24880
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
22147
24881
|
summary: Update Scanning Rule
|
|
@@ -22769,6 +25503,165 @@ paths:
|
|
|
22769
25503
|
x-unstable: '**Note**: This endpoint is in public beta.
|
|
22770
25504
|
|
|
22771
25505
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
25506
|
+
/api/v2/spans/analytics/aggregate:
|
|
25507
|
+
post:
|
|
25508
|
+
description: 'The API endpoint to aggregate spans into buckets and compute metrics
|
|
25509
|
+
and timeseries.
|
|
25510
|
+
|
|
25511
|
+
This endpoint is rate limited to `300` requests per hour.'
|
|
25512
|
+
operationId: AggregateSpans
|
|
25513
|
+
requestBody:
|
|
25514
|
+
content:
|
|
25515
|
+
application/json:
|
|
25516
|
+
schema:
|
|
25517
|
+
$ref: '#/components/schemas/SpansAggregateRequest'
|
|
25518
|
+
required: true
|
|
25519
|
+
responses:
|
|
25520
|
+
'200':
|
|
25521
|
+
content:
|
|
25522
|
+
application/json:
|
|
25523
|
+
schema:
|
|
25524
|
+
$ref: '#/components/schemas/SpansAggregateResponse'
|
|
25525
|
+
description: OK
|
|
25526
|
+
'400':
|
|
25527
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
25528
|
+
'403':
|
|
25529
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
25530
|
+
'429':
|
|
25531
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
25532
|
+
summary: Aggregate spans
|
|
25533
|
+
tags:
|
|
25534
|
+
- Spans
|
|
25535
|
+
x-codegen-request-body-name: body
|
|
25536
|
+
/api/v2/spans/events:
|
|
25537
|
+
get:
|
|
25538
|
+
description: 'List endpoint returns spans that match a span search query.
|
|
25539
|
+
|
|
25540
|
+
[Results are paginated][1].
|
|
25541
|
+
|
|
25542
|
+
|
|
25543
|
+
Use this endpoint to see your latest spans.
|
|
25544
|
+
|
|
25545
|
+
This endpoint is rate limited to `300` requests per hour.
|
|
25546
|
+
|
|
25547
|
+
|
|
25548
|
+
[1]: /logs/guide/collect-multiple-logs-with-pagination?tab=v2api'
|
|
25549
|
+
operationId: ListSpansGet
|
|
25550
|
+
parameters:
|
|
25551
|
+
- description: Search query following spans syntax.
|
|
25552
|
+
example: '@datacenter:us @role:db'
|
|
25553
|
+
in: query
|
|
25554
|
+
name: filter[query]
|
|
25555
|
+
required: false
|
|
25556
|
+
schema:
|
|
25557
|
+
type: string
|
|
25558
|
+
- description: Minimum timestamp for requested spans. Supports date-time ISO8601,
|
|
25559
|
+
date math, and regular timestamps (milliseconds).
|
|
25560
|
+
example: '2023-01-02T09:42:36.320Z'
|
|
25561
|
+
in: query
|
|
25562
|
+
name: filter[from]
|
|
25563
|
+
required: false
|
|
25564
|
+
schema:
|
|
25565
|
+
type: string
|
|
25566
|
+
- description: Maximum timestamp for requested spans. Supports date-time ISO8601,
|
|
25567
|
+
date math, and regular timestamps (milliseconds).
|
|
25568
|
+
example: '2023-01-03T09:42:36.320Z'
|
|
25569
|
+
in: query
|
|
25570
|
+
name: filter[to]
|
|
25571
|
+
required: false
|
|
25572
|
+
schema:
|
|
25573
|
+
type: string
|
|
25574
|
+
- description: Order of spans in results.
|
|
25575
|
+
in: query
|
|
25576
|
+
name: sort
|
|
25577
|
+
required: false
|
|
25578
|
+
schema:
|
|
25579
|
+
$ref: '#/components/schemas/SpansSort'
|
|
25580
|
+
- description: List following results with a cursor provided in the previous
|
|
25581
|
+
query.
|
|
25582
|
+
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
|
25583
|
+
in: query
|
|
25584
|
+
name: page[cursor]
|
|
25585
|
+
required: false
|
|
25586
|
+
schema:
|
|
25587
|
+
type: string
|
|
25588
|
+
- description: Maximum number of spans in the response.
|
|
25589
|
+
example: 25
|
|
25590
|
+
in: query
|
|
25591
|
+
name: page[limit]
|
|
25592
|
+
required: false
|
|
25593
|
+
schema:
|
|
25594
|
+
default: 10
|
|
25595
|
+
format: int32
|
|
25596
|
+
maximum: 1000
|
|
25597
|
+
type: integer
|
|
25598
|
+
responses:
|
|
25599
|
+
'200':
|
|
25600
|
+
content:
|
|
25601
|
+
application/json:
|
|
25602
|
+
schema:
|
|
25603
|
+
$ref: '#/components/schemas/SpansListResponse'
|
|
25604
|
+
description: OK
|
|
25605
|
+
'400':
|
|
25606
|
+
$ref: '#/components/responses/SpansBadRequestResponse'
|
|
25607
|
+
'403':
|
|
25608
|
+
$ref: '#/components/responses/SpansForbiddenResponse'
|
|
25609
|
+
'422':
|
|
25610
|
+
$ref: '#/components/responses/SpansUnprocessableEntityResponse'
|
|
25611
|
+
'429':
|
|
25612
|
+
$ref: '#/components/responses/SpansTooManyRequestsResponse'
|
|
25613
|
+
summary: Get a list of spans
|
|
25614
|
+
tags:
|
|
25615
|
+
- Spans
|
|
25616
|
+
x-pagination:
|
|
25617
|
+
cursorParam: page[cursor]
|
|
25618
|
+
cursorPath: meta.page.after
|
|
25619
|
+
limitParam: page[limit]
|
|
25620
|
+
resultsPath: data
|
|
25621
|
+
/api/v2/spans/events/search:
|
|
25622
|
+
post:
|
|
25623
|
+
description: 'List endpoint returns spans that match a span search query.
|
|
25624
|
+
|
|
25625
|
+
[Results are paginated][1].
|
|
25626
|
+
|
|
25627
|
+
|
|
25628
|
+
Use this endpoint to build complex spans filtering and search.
|
|
25629
|
+
|
|
25630
|
+
This endpoint is rate limited to `300` requests per hour.
|
|
25631
|
+
|
|
25632
|
+
|
|
25633
|
+
[1]: /logs/guide/collect-multiple-logs-with-pagination?tab=v2api'
|
|
25634
|
+
operationId: ListSpans
|
|
25635
|
+
requestBody:
|
|
25636
|
+
content:
|
|
25637
|
+
application/json:
|
|
25638
|
+
schema:
|
|
25639
|
+
$ref: '#/components/schemas/SpansListRequest'
|
|
25640
|
+
required: true
|
|
25641
|
+
responses:
|
|
25642
|
+
'200':
|
|
25643
|
+
content:
|
|
25644
|
+
application/json:
|
|
25645
|
+
schema:
|
|
25646
|
+
$ref: '#/components/schemas/SpansListResponse'
|
|
25647
|
+
description: OK
|
|
25648
|
+
'400':
|
|
25649
|
+
$ref: '#/components/responses/SpansBadRequestResponse'
|
|
25650
|
+
'403':
|
|
25651
|
+
$ref: '#/components/responses/SpansForbiddenResponse'
|
|
25652
|
+
'422':
|
|
25653
|
+
$ref: '#/components/responses/SpansUnprocessableEntityResponse'
|
|
25654
|
+
'429':
|
|
25655
|
+
$ref: '#/components/responses/SpansTooManyRequestsResponse'
|
|
25656
|
+
summary: Search spans
|
|
25657
|
+
tags:
|
|
25658
|
+
- Spans
|
|
25659
|
+
x-codegen-request-body-name: body
|
|
25660
|
+
x-pagination:
|
|
25661
|
+
cursorParam: body.data.attributes.page.cursor
|
|
25662
|
+
cursorPath: meta.page.after
|
|
25663
|
+
limitParam: body.data.attributes.page.limit
|
|
25664
|
+
resultsPath: data
|
|
22772
25665
|
/api/v2/synthetics/settings/on_demand_concurrency_cap:
|
|
22773
25666
|
get:
|
|
22774
25667
|
description: Get the on-demand concurrency cap.
|
|
@@ -24611,7 +27504,8 @@ tags:
|
|
|
24611
27504
|
|
|
24612
27505
|
sent from Identity Providers.'
|
|
24613
27506
|
name: AuthN Mappings
|
|
24614
|
-
- description: Search or aggregate your CI Visibility pipeline events
|
|
27507
|
+
- description: Search or aggregate your CI Visibility pipeline events and send them
|
|
27508
|
+
to your Datadog site over HTTP.
|
|
24615
27509
|
name: CI Visibility Pipelines
|
|
24616
27510
|
- description: Search or aggregate your CI Visibility test events over HTTP.
|
|
24617
27511
|
name: CI Visibility Tests
|
|
@@ -24630,6 +27524,18 @@ tags:
|
|
|
24630
27524
|
|
|
24631
27525
|
organization.'
|
|
24632
27526
|
name: Dashboard Lists
|
|
27527
|
+
- description: '**Note**: Downtime V2 is currently in private beta. To request access,
|
|
27528
|
+
contact [Datadog support](https://docs.datadoghq.com/help/).
|
|
27529
|
+
|
|
27530
|
+
|
|
27531
|
+
[Downtiming](https://docs.datadoghq.com/monitors/notify/downtimes) gives
|
|
27532
|
+
|
|
27533
|
+
you greater control over monitor notifications by allowing you to globally exclude
|
|
27534
|
+
|
|
27535
|
+
scopes from alerting. Downtime settings, which can be scheduled with start and
|
|
27536
|
+
|
|
27537
|
+
end times, prevent all alerting related to specified Datadog tags.'
|
|
27538
|
+
name: Downtimes
|
|
24633
27539
|
- description: 'The events service allows you to programmatically post events to the
|
|
24634
27540
|
event stream
|
|
24635
27541
|
|
|
@@ -24740,10 +27646,11 @@ tags:
|
|
|
24740
27646
|
- description: 'A restriction policy defines the access control rules for a resource,
|
|
24741
27647
|
mapping a set of relations
|
|
24742
27648
|
|
|
24743
|
-
(such as editor and viewer) to a set of allowed principals (such as roles
|
|
24744
|
-
|
|
27649
|
+
(such as editor and viewer) to a set of allowed principals (such as roles, teams
|
|
27650
|
+
(beta), or users (beta)).
|
|
24745
27651
|
|
|
24746
|
-
determines who is authorized to perform what actions on
|
|
27652
|
+
The restriction policy determines who is authorized to perform what actions on
|
|
27653
|
+
the resource.'
|
|
24747
27654
|
name: Restriction Policies
|
|
24748
27655
|
- description: 'The Roles API is used to create and manage Datadog roles, what
|
|
24749
27656
|
|
|
@@ -24773,6 +27680,8 @@ tags:
|
|
|
24773
27680
|
externalDocs:
|
|
24774
27681
|
url: https://docs.datadoghq.com/tracing/service_catalog/
|
|
24775
27682
|
name: Service Definition
|
|
27683
|
+
- description: Search and aggregate your spans from your Datadog platform over HTTP.
|
|
27684
|
+
name: Spans
|
|
24776
27685
|
- description: Manage configuration of [span-based metrics](https://app.datadoghq.com/apm/traces/generate-metrics)
|
|
24777
27686
|
for your organization.
|
|
24778
27687
|
externalDocs:
|