datadog_api_client 2.40.0 → 2.41.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/.generated-info +2 -2
- data/.generator/schemas/v1/openapi.yaml +35 -0
- data/.generator/schemas/v2/openapi.yaml +3544 -93
- data/CHANGELOG.md +30 -0
- data/examples/v1/dashboards/CreateDashboard_3066042014.rb +1 -0
- data/examples/v1/dashboards/CreateDashboard_3451918078.rb +1 -0
- data/examples/v1/dashboards/CreateDashboard_4262729673.rb +1 -0
- data/examples/v2/agentless-scanning/CreateAwsOnDemandTask.rb +1 -1
- data/examples/v2/agentless-scanning/GetAwsScanOptions.rb +8 -0
- data/examples/v2/agentless-scanning/ListAwsScanOptions.rb +1 -1
- data/examples/v2/cloud-cost-management/DeleteCostAWSCURConfig.rb +1 -1
- data/examples/v2/cloud-cost-management/DeleteCostAzureUCConfig.rb +1 -1
- data/examples/v2/cloud-cost-management/DeleteCostGCPUsageCostConfig.rb +1 -1
- data/examples/v2/cloud-cost-management/UpdateCostAWSCURConfig.rb +1 -1
- data/examples/v2/cloud-cost-management/UpdateCostAzureUCConfigs.rb +1 -1
- data/examples/v2/cloud-cost-management/UpdateCostGCPUsageCostConfig.rb +1 -1
- data/examples/v2/datasets/CreateDataset.rb +1 -1
- data/examples/v2/datasets/UpdateDataset.rb +1 -1
- data/examples/v2/error-tracking/GetIssue.rb +8 -0
- data/examples/v2/error-tracking/SearchIssues.rb +17 -0
- data/examples/v2/error-tracking/UpdateIssueAssignee.rb +15 -0
- data/examples/v2/error-tracking/UpdateIssueState.rb +18 -0
- data/examples/v2/incidents/CreateIncidentNotificationTemplate.rb +31 -0
- data/examples/v2/incidents/DeleteIncidentNotificationTemplate.rb +8 -0
- data/examples/v2/incidents/DeleteIncidentNotificationTemplate_1602689347.rb +11 -0
- data/examples/v2/incidents/GetIncidentNotificationTemplate.rb +11 -0
- data/examples/v2/incidents/ListIncidentNotificationTemplates.rb +8 -0
- data/examples/v2/incidents/UpdateIncidentNotificationTemplate.rb +24 -0
- data/examples/v2/org-connections/CreateOrgConnections.rb +24 -0
- data/examples/v2/org-connections/DeleteOrgConnections.rb +8 -0
- data/examples/v2/org-connections/ListOrgConnections.rb +5 -0
- data/examples/v2/org-connections/UpdateOrgConnections.rb +21 -0
- data/examples/v2/rum/CreateRUMApplication_1946294560.rb +17 -0
- data/examples/v2/rum/UpdateRUMApplication_394074053.rb +20 -0
- data/examples/v2/security-monitoring/ConvertExistingSecurityMonitoringRule.rb +3 -3
- data/examples/v2/security-monitoring/ConvertSecurityMonitoringRuleFromJSONToTerraform.rb +1 -1
- data/examples/v2/security-monitoring/GetSecurityMonitoringHistsignal.rb +8 -0
- data/examples/v2/security-monitoring/GetSecurityMonitoringHistsignalsByJobId.rb +8 -0
- data/examples/v2/security-monitoring/GetSuppressionsAffectingFutureRule.rb +36 -0
- data/examples/v2/security-monitoring/GetSuppressionsAffectingRule.rb +8 -0
- data/examples/v2/security-monitoring/ListSecurityMonitoringHistsignals.rb +8 -0
- data/examples/v2/security-monitoring/SearchSecurityMonitoringHistsignals.rb +24 -0
- data/examples/v2/security-monitoring/ValidateSecurityMonitoringSuppression.rb +18 -0
- data/examples/v2/sensitive-data-scanner/CreateScanningRule_502667299.rb +37 -0
- data/examples/v2/service-scorecards/UpdateScorecardOutcomesAsync.rb +27 -0
- data/examples/v2/spa/GetSPARecommendations.rb +8 -0
- data/examples/v2/teams/SyncTeams.rb +18 -0
- data/examples/v2/teams/SyncTeams_3215592344.rb +18 -0
- data/lib/datadog_api_client/configuration.rb +12 -0
- data/lib/datadog_api_client/inflector.rb +166 -0
- data/lib/datadog_api_client/v1/models/logs_api_limit_reached_response.rb +105 -0
- data/lib/datadog_api_client/v1/models/synthetics_api_test_step.rb +11 -1
- data/lib/datadog_api_client/v1/models/synthetics_api_wait_step.rb +11 -1
- data/lib/datadog_api_client/v1/models/synthetics_ci_test.rb +13 -3
- data/lib/datadog_api_client/v1/models/widget_legacy_live_span.rb +11 -1
- data/lib/datadog_api_client/v1/models/widget_new_fixed_span.rb +11 -1
- data/lib/datadog_api_client/v1/models/widget_new_live_span.rb +11 -1
- data/lib/datadog_api_client/v2/api/action_connection_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/agentless_scanning_api.rb +67 -2
- data/lib/datadog_api_client/v2/api/app_builder_api.rb +8 -8
- data/lib/datadog_api_client/v2/api/cloud_cost_management_api.rb +14 -6
- data/lib/datadog_api_client/v2/api/error_tracking_api.rb +306 -0
- data/lib/datadog_api_client/v2/api/incidents_api.rb +369 -0
- data/lib/datadog_api_client/v2/api/monitors_api.rb +20 -0
- data/lib/datadog_api_client/v2/api/org_connections_api.rb +290 -0
- data/lib/datadog_api_client/v2/api/security_monitoring_api.rb +514 -0
- data/lib/datadog_api_client/v2/api/service_scorecards_api.rb +73 -0
- data/lib/datadog_api_client/v2/api/spa_api.rb +102 -0
- data/lib/datadog_api_client/v2/api/teams_api.rb +83 -0
- data/lib/datadog_api_client/v2/api/workflow_automation_api.rb +8 -8
- data/lib/datadog_api_client/v2/models/aws_cur_config.rb +1 -1
- data/lib/datadog_api_client/v2/models/aws_cur_config_post_request_attributes.rb +1 -11
- data/lib/datadog_api_client/v2/models/aws_namespace_filters_exclude_only.rb +4 -4
- data/lib/datadog_api_client/v2/models/azure_uc_config.rb +1 -1
- data/lib/datadog_api_client/v2/models/azure_uc_config_pair.rb +1 -1
- data/lib/datadog_api_client/v2/models/azure_uc_config_pair_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/component_recommendation.rb +123 -0
- data/lib/datadog_api_client/v2/models/cpu.rb +125 -0
- data/lib/datadog_api_client/v2/models/create_incident_notification_template_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/dataset_request.rb +2 -2
- data/lib/datadog_api_client/v2/models/dataset_response.rb +2 -2
- data/lib/datadog_api_client/v2/models/dataset_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/estimation.rb +145 -0
- data/lib/datadog_api_client/v2/models/get_issue_include_query_parameter_item.rb +28 -0
- data/lib/datadog_api_client/v2/models/google_meet_configuration_reference.rb +113 -0
- data/lib/datadog_api_client/v2/models/google_meet_configuration_reference_data.rb +144 -0
- data/lib/datadog_api_client/v2/models/incident_notification_template.rb +135 -0
- data/lib/datadog_api_client/v2/models/incident_notification_template_array.rb +147 -0
- data/lib/datadog_api_client/v2/models/incident_notification_template_array_meta.rb +105 -0
- data/lib/datadog_api_client/v2/models/incident_notification_template_array_meta_page.rb +115 -0
- data/lib/datadog_api_client/v2/models/incident_notification_template_attributes.rb +228 -0
- data/lib/datadog_api_client/v2/models/incident_notification_template_create_attributes.rb +186 -0
- data/lib/datadog_api_client/v2/models/incident_notification_template_create_data.rb +154 -0
- data/lib/datadog_api_client/v2/models/incident_notification_template_create_data_relationships.rb +105 -0
- data/lib/datadog_api_client/v2/models/incident_notification_template_included_items.rb +63 -0
- data/lib/datadog_api_client/v2/models/incident_notification_template_relationships.rb +125 -0
- data/lib/datadog_api_client/v2/models/incident_notification_template_response_data.rb +164 -0
- data/lib/datadog_api_client/v2/models/incident_notification_template_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/incident_notification_template_update_attributes.rb +135 -0
- data/lib/datadog_api_client/v2/models/incident_notification_template_update_data.rb +154 -0
- data/lib/datadog_api_client/v2/models/incident_type_object.rb +11 -1
- data/lib/datadog_api_client/v2/models/incident_type_relationships.rb +155 -0
- data/lib/datadog_api_client/v2/models/issue.rb +175 -0
- data/lib/datadog_api_client/v2/models/issue_assignee_relationship.rb +123 -0
- data/lib/datadog_api_client/v2/models/issue_attributes.rb +227 -0
- data/lib/datadog_api_client/v2/models/issue_case.rb +175 -0
- data/lib/datadog_api_client/v2/models/issue_case_attributes.rb +237 -0
- data/lib/datadog_api_client/v2/models/issue_case_insight.rb +125 -0
- data/lib/datadog_api_client/v2/models/issue_case_jira_issue.rb +115 -0
- data/lib/datadog_api_client/v2/models/issue_case_jira_issue_result.rb +135 -0
- data/lib/datadog_api_client/v2/models/issue_case_reference.rb +144 -0
- data/lib/datadog_api_client/v2/models/issue_case_relationship.rb +123 -0
- data/lib/datadog_api_client/v2/models/issue_case_relationships.rb +145 -0
- data/lib/datadog_api_client/v2/models/issue_case_resource_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/issue_included.rb +64 -0
- data/lib/datadog_api_client/v2/models/issue_language.rb +52 -0
- data/lib/datadog_api_client/v2/models/issue_platform.rb +33 -0
- data/lib/datadog_api_client/v2/models/issue_reference.rb +144 -0
- data/lib/datadog_api_client/v2/models/issue_relationships.rb +125 -0
- data/lib/datadog_api_client/v2/models/issue_response.rb +117 -0
- data/lib/datadog_api_client/v2/models/issue_state.rb +30 -0
- data/lib/datadog_api_client/v2/models/issue_team.rb +165 -0
- data/lib/datadog_api_client/v2/models/issue_team_attributes.rb +125 -0
- data/lib/datadog_api_client/v2/models/issue_team_owners_relationship.rb +125 -0
- data/lib/datadog_api_client/v2/models/issue_team_reference.rb +144 -0
- data/lib/datadog_api_client/v2/models/issue_team_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/issue_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/issue_update_assignee_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/issue_update_assignee_request_data.rb +144 -0
- data/lib/datadog_api_client/v2/models/issue_update_assignee_request_data_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/issue_update_state_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/issue_update_state_request_data.rb +165 -0
- data/lib/datadog_api_client/v2/models/issue_update_state_request_data_attributes.rb +123 -0
- data/lib/datadog_api_client/v2/models/issue_update_state_request_data_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/issue_user.rb +165 -0
- data/lib/datadog_api_client/v2/models/issue_user_attributes.rb +125 -0
- data/lib/datadog_api_client/v2/models/issue_user_reference.rb +144 -0
- data/lib/datadog_api_client/v2/models/issue_user_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/issues_search_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/issues_search_request_data.rb +144 -0
- data/lib/datadog_api_client/v2/models/issues_search_request_data_attributes.rb +195 -0
- data/lib/datadog_api_client/v2/models/issues_search_request_data_attributes_order_by.rb +29 -0
- data/lib/datadog_api_client/v2/models/issues_search_request_data_attributes_persona.rb +29 -0
- data/lib/datadog_api_client/v2/models/issues_search_request_data_attributes_track.rb +28 -0
- data/lib/datadog_api_client/v2/models/issues_search_request_data_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/issues_search_response.rb +119 -0
- data/lib/datadog_api_client/v2/models/issues_search_result.rb +175 -0
- data/lib/datadog_api_client/v2/models/issues_search_result_attributes.rb +125 -0
- data/lib/datadog_api_client/v2/models/issues_search_result_included.rb +65 -0
- data/lib/datadog_api_client/v2/models/issues_search_result_issue_relationship.rb +123 -0
- data/lib/datadog_api_client/v2/models/issues_search_result_relationships.rb +105 -0
- data/lib/datadog_api_client/v2/models/issues_search_result_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/microsoft_teams_configuration_reference.rb +113 -0
- data/lib/datadog_api_client/v2/models/microsoft_teams_configuration_reference_data.rb +144 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_amazon_security_lake_destination.rb +252 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_amazon_security_lake_destination_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_config_destination_item.rb +4 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_config_processor_item.rb +3 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_config_source_item.rb +2 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_crowd_strike_next_gen_siem_destination.rb +208 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_crowd_strike_next_gen_siem_destination_compression.rb +133 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_crowd_strike_next_gen_siem_destination_compression_algorithm.rb +27 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_crowd_strike_next_gen_siem_destination_encoding.rb +27 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_crowd_strike_next_gen_siem_destination_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_custom_processor.rb +215 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_custom_processor_remap.rb +207 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_custom_processor_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_datadog_tags_processor.rb +253 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_datadog_tags_processor_action.rb +27 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_datadog_tags_processor_mode.rb +26 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_datadog_tags_processor_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_socket_destination.rb +240 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_socket_destination_encoding.rb +27 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_socket_destination_framing.rb +64 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_socket_destination_framing_bytes.rb +123 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_socket_destination_framing_bytes_method.rb +26 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_socket_destination_framing_character_delimited.rb +152 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_socket_destination_framing_character_delimited_method.rb +26 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_socket_destination_framing_newline_delimited.rb +123 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_socket_destination_framing_newline_delimited_method.rb +26 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_socket_destination_mode.rb +27 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_socket_destination_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_socket_source.rb +196 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_socket_source_framing.rb +66 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_socket_source_framing_bytes.rb +123 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_socket_source_framing_bytes_method.rb +26 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_socket_source_framing_character_delimited.rb +152 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_socket_source_framing_character_delimited_method.rb +26 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_socket_source_framing_chunked_gelf.rb +123 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_socket_source_framing_chunked_gelf_method.rb +26 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_socket_source_framing_newline_delimited.rb +123 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_socket_source_framing_newline_delimited_method.rb +26 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_socket_source_framing_octet_counting.rb +123 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_socket_source_framing_octet_counting_method.rb +26 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_socket_source_mode.rb +27 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_socket_source_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/org_connection.rb +186 -0
- data/lib/datadog_api_client/v2/models/org_connection_attributes.rb +146 -0
- data/lib/datadog_api_client/v2/models/org_connection_create.rb +165 -0
- data/lib/datadog_api_client/v2/models/org_connection_create_attributes.rb +129 -0
- data/lib/datadog_api_client/v2/models/org_connection_create_relationships.rb +123 -0
- data/lib/datadog_api_client/v2/models/org_connection_create_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/org_connection_list_response.rb +135 -0
- data/lib/datadog_api_client/v2/models/org_connection_list_response_meta.rb +105 -0
- data/lib/datadog_api_client/v2/models/org_connection_list_response_meta_page.rb +115 -0
- data/lib/datadog_api_client/v2/models/org_connection_org_relationship.rb +105 -0
- data/lib/datadog_api_client/v2/models/org_connection_org_relationship_data.rb +125 -0
- data/lib/datadog_api_client/v2/models/org_connection_org_relationship_data_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/org_connection_relationships.rb +125 -0
- data/lib/datadog_api_client/v2/models/org_connection_response.rb +123 -0
- data/lib/datadog_api_client/v2/models/org_connection_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/org_connection_type_enum.rb +27 -0
- data/lib/datadog_api_client/v2/models/org_connection_update.rb +165 -0
- data/lib/datadog_api_client/v2/models/org_connection_update_attributes.rb +129 -0
- data/lib/datadog_api_client/v2/models/org_connection_update_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/org_connection_user_relationship.rb +105 -0
- data/lib/datadog_api_client/v2/models/org_connection_user_relationship_data.rb +125 -0
- data/lib/datadog_api_client/v2/models/org_connection_user_relationship_data_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/patch_incident_notification_template_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/recommendation_attributes.rb +144 -0
- data/lib/datadog_api_client/v2/models/recommendation_data.rb +154 -0
- data/lib/datadog_api_client/v2/models/recommendation_document.rb +123 -0
- data/lib/datadog_api_client/v2/models/recommendation_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/relationship_to_incident_type.rb +123 -0
- data/lib/datadog_api_client/v2/models/relationship_to_incident_type_data.rb +144 -0
- data/lib/datadog_api_client/v2/models/rule_attributes.rb +33 -1
- data/lib/datadog_api_client/v2/models/rum_application_attributes.rb +11 -1
- data/lib/datadog_api_client/v2/models/rum_application_create_attributes.rb +21 -1
- data/lib/datadog_api_client/v2/models/rum_application_list_attributes.rb +11 -1
- data/lib/datadog_api_client/v2/models/rum_application_update_attributes.rb +21 -1
- data/lib/datadog_api_client/v2/models/rum_event_processing_scale.rb +115 -0
- data/lib/datadog_api_client/v2/models/rum_event_processing_state.rb +28 -0
- data/lib/datadog_api_client/v2/models/rum_product_analytics_retention_scale.rb +115 -0
- data/lib/datadog_api_client/v2/models/rum_product_analytics_retention_state.rb +27 -0
- data/lib/datadog_api_client/v2/models/rum_product_scales.rb +115 -0
- data/lib/datadog_api_client/v2/models/search_issues_include_query_parameter_item.rb +29 -0
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_text_replacement.rb +11 -1
- data/lib/datadog_api_client/v2/models/shift.rb +2 -2
- data/lib/datadog_api_client/v2/models/shift_data.rb +3 -3
- data/lib/datadog_api_client/v2/models/shift_data_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/shift_data_relationships.rb +1 -1
- data/lib/datadog_api_client/v2/models/shift_included.rb +1 -1
- data/lib/datadog_api_client/v2/models/team_sync_attributes.rb +144 -0
- data/lib/datadog_api_client/v2/models/team_sync_attributes_source.rb +26 -0
- data/lib/datadog_api_client/v2/models/team_sync_attributes_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/team_sync_bulk_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/team_sync_data.rb +144 -0
- data/lib/datadog_api_client/v2/models/team_sync_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/update_outcomes_async_attributes.rb +107 -0
- data/lib/datadog_api_client/v2/models/update_outcomes_async_request.rb +105 -0
- data/lib/datadog_api_client/v2/models/update_outcomes_async_request_data.rb +115 -0
- data/lib/datadog_api_client/v2/models/update_outcomes_async_request_item.rb +175 -0
- data/lib/datadog_api_client/v2/models/update_outcomes_async_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/zoom_configuration_reference.rb +113 -0
- data/lib/datadog_api_client/v2/models/zoom_configuration_reference_data.rb +144 -0
- data/lib/datadog_api_client/version.rb +1 -1
- metadata +196 -1
@@ -221,7 +221,8 @@ components:
|
|
221
221
|
name: cloud_account_id
|
222
222
|
required: true
|
223
223
|
schema:
|
224
|
-
|
224
|
+
format: int64
|
225
|
+
type: integer
|
225
226
|
CloudWorkloadSecurityAgentRuleID:
|
226
227
|
description: The ID of the Agent rule
|
227
228
|
example: 3b5-v82-ns6
|
@@ -414,6 +415,17 @@ components:
|
|
414
415
|
required: true
|
415
416
|
schema:
|
416
417
|
type: string
|
418
|
+
GetIssueIncludeQueryParameter:
|
419
|
+
description: Comma-separated list of relationship objects that should be included
|
420
|
+
in the response.
|
421
|
+
explode: false
|
422
|
+
in: query
|
423
|
+
name: include
|
424
|
+
required: false
|
425
|
+
schema:
|
426
|
+
items:
|
427
|
+
$ref: '#/components/schemas/GetIssueIncludeQueryParameterItem'
|
428
|
+
type: array
|
417
429
|
HistoricalJobID:
|
418
430
|
description: The ID of the job.
|
419
431
|
in: path
|
@@ -421,6 +433,13 @@ components:
|
|
421
433
|
required: true
|
422
434
|
schema:
|
423
435
|
type: string
|
436
|
+
HistoricalSignalID:
|
437
|
+
description: The ID of the historical signal.
|
438
|
+
in: path
|
439
|
+
name: histsignal_id
|
440
|
+
required: true
|
441
|
+
schema:
|
442
|
+
type: string
|
424
443
|
IncidentAttachmentFilterQueryParameter:
|
425
444
|
description: Specifies which types of attachments are included in the response.
|
426
445
|
explode: false
|
@@ -466,6 +485,37 @@ components:
|
|
466
485
|
required: true
|
467
486
|
schema:
|
468
487
|
type: string
|
488
|
+
IncidentNotificationTemplateIDPathParameter:
|
489
|
+
description: The ID of the notification template.
|
490
|
+
in: path
|
491
|
+
name: id
|
492
|
+
required: true
|
493
|
+
schema:
|
494
|
+
example: 00000000-0000-0000-0000-000000000001
|
495
|
+
format: uuid
|
496
|
+
type: string
|
497
|
+
IncidentNotificationTemplateIncidentTypeFilterQueryParameter:
|
498
|
+
description: Optional incident type ID filter.
|
499
|
+
explode: false
|
500
|
+
in: query
|
501
|
+
name: filter[incident-type]
|
502
|
+
required: false
|
503
|
+
schema:
|
504
|
+
example: 00000000-0000-0000-0000-000000000001
|
505
|
+
format: uuid
|
506
|
+
type: string
|
507
|
+
IncidentNotificationTemplateIncludeQueryParameter:
|
508
|
+
description: 'Comma-separated list of relationships to include. Supported values:
|
509
|
+
`created_by_user`, `last_modified_by_user`, `incident_type`
|
510
|
+
|
511
|
+
'
|
512
|
+
explode: false
|
513
|
+
in: query
|
514
|
+
name: include
|
515
|
+
required: false
|
516
|
+
schema:
|
517
|
+
example: created_by_user,incident_type
|
518
|
+
type: string
|
469
519
|
IncidentSearchIncludeQueryParameter:
|
470
520
|
description: Specifies which types of related objects should be included in
|
471
521
|
the response.
|
@@ -578,6 +628,14 @@ components:
|
|
578
628
|
required: true
|
579
629
|
schema:
|
580
630
|
type: string
|
631
|
+
IssueIDPathParameter:
|
632
|
+
description: The identifier of the issue.
|
633
|
+
example: c1726a66-1f64-11ee-b338-da7ad0900002
|
634
|
+
in: path
|
635
|
+
name: issue_id
|
636
|
+
required: true
|
637
|
+
schema:
|
638
|
+
type: string
|
581
639
|
KindID:
|
582
640
|
description: Entity kind.
|
583
641
|
in: path
|
@@ -680,6 +738,15 @@ components:
|
|
680
738
|
schema:
|
681
739
|
example: monitor_timezone
|
682
740
|
type: string
|
741
|
+
OrgConnectionId:
|
742
|
+
description: The unique identifier of the org connection.
|
743
|
+
in: path
|
744
|
+
name: connection_id
|
745
|
+
required: true
|
746
|
+
schema:
|
747
|
+
example: f9ec96b0-8c8a-4b0a-9b0a-1b2c3d4e5f6a
|
748
|
+
format: uuid
|
749
|
+
type: string
|
683
750
|
PageNumber:
|
684
751
|
description: Specific page number to return.
|
685
752
|
in: query
|
@@ -725,6 +792,58 @@ components:
|
|
725
792
|
required: true
|
726
793
|
schema:
|
727
794
|
type: string
|
795
|
+
QueryFilterFrom:
|
796
|
+
description: The minimum timestamp for requested security signals.
|
797
|
+
example: '2019-01-02T09:42:36.320Z'
|
798
|
+
in: query
|
799
|
+
name: filter[from]
|
800
|
+
required: false
|
801
|
+
schema:
|
802
|
+
format: date-time
|
803
|
+
type: string
|
804
|
+
QueryFilterSearch:
|
805
|
+
description: The search query for security signals.
|
806
|
+
example: security:attack status:high
|
807
|
+
in: query
|
808
|
+
name: filter[query]
|
809
|
+
required: false
|
810
|
+
schema:
|
811
|
+
type: string
|
812
|
+
QueryFilterTo:
|
813
|
+
description: The maximum timestamp for requested security signals.
|
814
|
+
example: '2019-01-03T09:42:36.320Z'
|
815
|
+
in: query
|
816
|
+
name: filter[to]
|
817
|
+
required: false
|
818
|
+
schema:
|
819
|
+
format: date-time
|
820
|
+
type: string
|
821
|
+
QueryPageCursor:
|
822
|
+
description: A list of results using the cursor provided in the previous query.
|
823
|
+
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
824
|
+
in: query
|
825
|
+
name: page[cursor]
|
826
|
+
required: false
|
827
|
+
schema:
|
828
|
+
type: string
|
829
|
+
QueryPageLimit:
|
830
|
+
description: The maximum number of security signals in the response.
|
831
|
+
example: 25
|
832
|
+
in: query
|
833
|
+
name: page[limit]
|
834
|
+
required: false
|
835
|
+
schema:
|
836
|
+
default: 10
|
837
|
+
format: int32
|
838
|
+
maximum: 1000
|
839
|
+
type: integer
|
840
|
+
QuerySort:
|
841
|
+
description: The order of the security signals in results.
|
842
|
+
in: query
|
843
|
+
name: sort
|
844
|
+
required: false
|
845
|
+
schema:
|
846
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalsSort'
|
728
847
|
RelationInclude:
|
729
848
|
description: Include relationship data.
|
730
849
|
explode: true
|
@@ -823,6 +942,17 @@ components:
|
|
823
942
|
required: false
|
824
943
|
schema:
|
825
944
|
$ref: '#/components/schemas/ServiceDefinitionSchemaVersions'
|
945
|
+
SearchIssuesIncludeQueryParameter:
|
946
|
+
description: Comma-separated list of relationship objects that should be included
|
947
|
+
in the response.
|
948
|
+
explode: false
|
949
|
+
in: query
|
950
|
+
name: include
|
951
|
+
required: false
|
952
|
+
schema:
|
953
|
+
items:
|
954
|
+
$ref: '#/components/schemas/SearchIssuesIncludeQueryParameterItem'
|
955
|
+
type: array
|
826
956
|
SecurityFilterID:
|
827
957
|
description: The ID of the security filter.
|
828
958
|
in: path
|
@@ -1763,20 +1893,21 @@ components:
|
|
1763
1893
|
- $ref: '#/components/schemas/AWSNamespaceFiltersIncludeOnly'
|
1764
1894
|
AWSNamespaceFiltersExcludeOnly:
|
1765
1895
|
description: 'Exclude only these namespaces from metrics collection. Defaults
|
1766
|
-
to `["AWS/SQS", "AWS/ElasticMapReduce"]`.
|
1896
|
+
to `["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"]`.
|
1767
1897
|
|
1768
|
-
`AWS/SQS` and `AWS/
|
1769
|
-
AWS CloudWatch costs from `GetMetricData` API calls.'
|
1898
|
+
`AWS/SQS`, `AWS/ElasticMapReduce`, and `AWS/Usage` are excluded by default
|
1899
|
+
to reduce your AWS CloudWatch costs from `GetMetricData` API calls.'
|
1770
1900
|
properties:
|
1771
1901
|
exclude_only:
|
1772
1902
|
description: 'Exclude only these namespaces from metrics collection. Defaults
|
1773
|
-
to `["AWS/SQS", "AWS/ElasticMapReduce"]`.
|
1903
|
+
to `["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"]`.
|
1774
1904
|
|
1775
|
-
`AWS/SQS` and `AWS/
|
1776
|
-
your AWS CloudWatch costs from `GetMetricData` API calls.'
|
1905
|
+
`AWS/SQS`, `AWS/ElasticMapReduce`, and `AWS/Usage` are excluded by default
|
1906
|
+
to reduce your AWS CloudWatch costs from `GetMetricData` API calls.'
|
1777
1907
|
example:
|
1778
1908
|
- AWS/SQS
|
1779
1909
|
- AWS/ElasticMapReduce
|
1910
|
+
- AWS/Usage
|
1780
1911
|
items:
|
1781
1912
|
example: AWS/SQS
|
1782
1913
|
type: string
|
@@ -4500,8 +4631,7 @@ components:
|
|
4500
4631
|
$ref: '#/components/schemas/AwsCURConfigAttributes'
|
4501
4632
|
id:
|
4502
4633
|
description: The ID of the AWS CUR config.
|
4503
|
-
|
4504
|
-
type: integer
|
4634
|
+
type: string
|
4505
4635
|
type:
|
4506
4636
|
$ref: '#/components/schemas/AwsCURConfigType'
|
4507
4637
|
required:
|
@@ -4642,9 +4772,6 @@ components:
|
|
4642
4772
|
description: The region the bucket is located in.
|
4643
4773
|
example: us-east-1
|
4644
4774
|
type: string
|
4645
|
-
is_enabled:
|
4646
|
-
description: Whether or not the Cloud Cost Management account is enabled.
|
4647
|
-
type: boolean
|
4648
4775
|
months:
|
4649
4776
|
description: The month of the report.
|
4650
4777
|
format: int32
|
@@ -5136,8 +5263,7 @@ components:
|
|
5136
5263
|
type: string
|
5137
5264
|
id:
|
5138
5265
|
description: The ID of the Azure config.
|
5139
|
-
|
5140
|
-
type: integer
|
5266
|
+
type: string
|
5141
5267
|
months:
|
5142
5268
|
deprecated: true
|
5143
5269
|
description: The number of months the report has been backfilled.
|
@@ -5187,8 +5313,7 @@ components:
|
|
5187
5313
|
$ref: '#/components/schemas/AzureUCConfigPairAttributes'
|
5188
5314
|
id:
|
5189
5315
|
description: The ID of Cloud Cost Management account.
|
5190
|
-
|
5191
|
-
type: integer
|
5316
|
+
type: string
|
5192
5317
|
type:
|
5193
5318
|
$ref: '#/components/schemas/AzureUCConfigPairType'
|
5194
5319
|
required:
|
@@ -5205,8 +5330,7 @@ components:
|
|
5205
5330
|
type: array
|
5206
5331
|
id:
|
5207
5332
|
description: The ID of the Azure config pair.
|
5208
|
-
|
5209
|
-
type: integer
|
5333
|
+
type: string
|
5210
5334
|
required:
|
5211
5335
|
- configs
|
5212
5336
|
type: object
|
@@ -9290,6 +9414,15 @@ components:
|
|
9290
9414
|
that evaluates to a boolean.
|
9291
9415
|
example: ${true}
|
9292
9416
|
type: string
|
9417
|
+
ComponentRecommendation:
|
9418
|
+
description: Resource recommendation for a single Spark component (driver or
|
9419
|
+
executor). Contains estimation data used to patch Spark job specs.
|
9420
|
+
properties:
|
9421
|
+
estimation:
|
9422
|
+
$ref: '#/components/schemas/Estimation'
|
9423
|
+
required:
|
9424
|
+
- estimation
|
9425
|
+
type: object
|
9293
9426
|
ComponentType:
|
9294
9427
|
description: The UI component type.
|
9295
9428
|
enum:
|
@@ -10486,6 +10619,28 @@ components:
|
|
10486
10619
|
type: string
|
10487
10620
|
x-enum-varnames:
|
10488
10621
|
- COST_BY_ORG
|
10622
|
+
Cpu:
|
10623
|
+
description: CPU usage statistics derived from historical Spark job metrics.
|
10624
|
+
Provides multiple estimates so users can choose between conservative and cost-saving
|
10625
|
+
risk profiles.
|
10626
|
+
properties:
|
10627
|
+
max:
|
10628
|
+
description: Maximum CPU usage observed for the job, expressed in millicores.
|
10629
|
+
This represents the upper bound of usage.
|
10630
|
+
format: int64
|
10631
|
+
type: integer
|
10632
|
+
p75:
|
10633
|
+
description: 75th percentile of CPU usage (millicores). Represents a cost-saving
|
10634
|
+
configuration while covering most workloads.
|
10635
|
+
format: int64
|
10636
|
+
type: integer
|
10637
|
+
p95:
|
10638
|
+
description: 95th percentile of CPU usage (millicores). Balances performance
|
10639
|
+
and cost, providing a safer margin than p75.
|
10640
|
+
format: int64
|
10641
|
+
type: integer
|
10642
|
+
type: object
|
10643
|
+
x-model-simple-name: SpaCpu
|
10489
10644
|
CreateActionConnectionRequest:
|
10490
10645
|
description: Request used to create an action connection.
|
10491
10646
|
properties:
|
@@ -10696,6 +10851,14 @@ components:
|
|
10696
10851
|
meta:
|
10697
10852
|
$ref: '#/components/schemas/DataDeletionResponseMeta'
|
10698
10853
|
type: object
|
10854
|
+
CreateIncidentNotificationTemplateRequest:
|
10855
|
+
description: Create request for a notification template.
|
10856
|
+
properties:
|
10857
|
+
data:
|
10858
|
+
$ref: '#/components/schemas/IncidentNotificationTemplateCreateData'
|
10859
|
+
required:
|
10860
|
+
- data
|
10861
|
+
type: object
|
10699
10862
|
CreateNotificationRuleParameters:
|
10700
10863
|
description: Body of the notification rule create request.
|
10701
10864
|
properties:
|
@@ -13264,9 +13427,7 @@ components:
|
|
13264
13427
|
attributes:
|
13265
13428
|
$ref: '#/components/schemas/DatasetAttributesRequest'
|
13266
13429
|
type:
|
13267
|
-
|
13268
|
-
example: dataset
|
13269
|
-
type: string
|
13430
|
+
$ref: '#/components/schemas/DatasetType'
|
13270
13431
|
required:
|
13271
13432
|
- type
|
13272
13433
|
- attributes
|
@@ -13288,9 +13449,7 @@ components:
|
|
13288
13449
|
example: 123e4567-e89b-12d3-a456-426614174000
|
13289
13450
|
type: string
|
13290
13451
|
type:
|
13291
|
-
|
13292
|
-
example: dataset
|
13293
|
-
type: string
|
13452
|
+
$ref: '#/components/schemas/DatasetType'
|
13294
13453
|
type: object
|
13295
13454
|
DatasetResponseMulti:
|
13296
13455
|
description: Response containing a list of datasets.
|
@@ -13307,6 +13466,15 @@ components:
|
|
13307
13466
|
data:
|
13308
13467
|
$ref: '#/components/schemas/DatasetResponse'
|
13309
13468
|
type: object
|
13469
|
+
DatasetType:
|
13470
|
+
default: dataset
|
13471
|
+
description: Resource type, always set to `dataset`.
|
13472
|
+
enum:
|
13473
|
+
- dataset
|
13474
|
+
example: dataset
|
13475
|
+
type: string
|
13476
|
+
x-enum-varnames:
|
13477
|
+
- DATASET
|
13310
13478
|
DatasetUpdateRequest:
|
13311
13479
|
description: Edit request for a dataset.
|
13312
13480
|
properties:
|
@@ -14454,6 +14622,10 @@ components:
|
|
14454
14622
|
description: Entity definition in raw JSON or YAML representation.
|
14455
14623
|
example: "apiVersion: v3\nkind: service\nmetadata:\n name: myservice\n"
|
14456
14624
|
type: string
|
14625
|
+
EntityReference:
|
14626
|
+
description: The unique reference for an IDP entity.
|
14627
|
+
example: service:my-service
|
14628
|
+
type: string
|
14457
14629
|
EntityRelationships:
|
14458
14630
|
description: Entity relationships.
|
14459
14631
|
properties:
|
@@ -15938,6 +16110,33 @@ components:
|
|
15938
16110
|
type: string
|
15939
16111
|
x-enum-varnames:
|
15940
16112
|
- ESCALATION_POLICY_STEPS
|
16113
|
+
Estimation:
|
16114
|
+
description: Recommended resource values for a Spark driver or executor, derived
|
16115
|
+
from recent real usage metrics. Used by SPA to propose more efficient pod
|
16116
|
+
sizing.
|
16117
|
+
properties:
|
16118
|
+
cpu:
|
16119
|
+
$ref: '#/components/schemas/Cpu'
|
16120
|
+
ephemeral_storage:
|
16121
|
+
description: Recommended ephemeral storage allocation (in MiB). Derived
|
16122
|
+
from job temporary storage patterns.
|
16123
|
+
format: int64
|
16124
|
+
type: integer
|
16125
|
+
heap:
|
16126
|
+
description: Recommended JVM heap size (in MiB).
|
16127
|
+
format: int64
|
16128
|
+
type: integer
|
16129
|
+
memory:
|
16130
|
+
description: Recommended total memory allocation (in MiB). Includes both
|
16131
|
+
heap and overhead.
|
16132
|
+
format: int64
|
16133
|
+
type: integer
|
16134
|
+
overhead:
|
16135
|
+
description: Recommended JVM overhead (in MiB). Computed as total memory
|
16136
|
+
- heap.
|
16137
|
+
format: int64
|
16138
|
+
type: integer
|
16139
|
+
type: object
|
15941
16140
|
Event:
|
15942
16141
|
description: The metadata associated with a request.
|
15943
16142
|
properties:
|
@@ -18201,6 +18400,18 @@ components:
|
|
18201
18400
|
$ref: '#/components/schemas/GetInterfacesData'
|
18202
18401
|
type: array
|
18203
18402
|
type: object
|
18403
|
+
GetIssueIncludeQueryParameterItem:
|
18404
|
+
description: Relationship object that should be included in the response.
|
18405
|
+
enum:
|
18406
|
+
- assignee
|
18407
|
+
- case
|
18408
|
+
- team_owners
|
18409
|
+
example: case
|
18410
|
+
type: string
|
18411
|
+
x-enum-varnames:
|
18412
|
+
- ASSIGNEE
|
18413
|
+
- CASE
|
18414
|
+
- TEAM_OWNERS
|
18204
18415
|
GetResourceEvaluationFiltersResponse:
|
18205
18416
|
description: The definition of `GetResourceEvaluationFiltersResponse` object.
|
18206
18417
|
properties:
|
@@ -18378,6 +18589,31 @@ components:
|
|
18378
18589
|
required:
|
18379
18590
|
- type
|
18380
18591
|
type: object
|
18592
|
+
GoogleMeetConfigurationReference:
|
18593
|
+
description: A reference to a Google Meet Configuration resource.
|
18594
|
+
nullable: true
|
18595
|
+
properties:
|
18596
|
+
data:
|
18597
|
+
$ref: '#/components/schemas/GoogleMeetConfigurationReferenceData'
|
18598
|
+
required:
|
18599
|
+
- data
|
18600
|
+
type: object
|
18601
|
+
GoogleMeetConfigurationReferenceData:
|
18602
|
+
description: The Google Meet configuration relationship data object.
|
18603
|
+
nullable: true
|
18604
|
+
properties:
|
18605
|
+
id:
|
18606
|
+
description: The unique identifier of the Google Meet configuration.
|
18607
|
+
example: 00000000-0000-0000-0000-000000000000
|
18608
|
+
type: string
|
18609
|
+
type:
|
18610
|
+
description: The type of the Google Meet configuration.
|
18611
|
+
example: google_meet_configurations
|
18612
|
+
type: string
|
18613
|
+
required:
|
18614
|
+
- id
|
18615
|
+
- type
|
18616
|
+
type: object
|
18381
18617
|
GreyNoiseAPIKey:
|
18382
18618
|
description: The definition of the `GreyNoiseAPIKey` object.
|
18383
18619
|
properties:
|
@@ -19703,6 +19939,256 @@ components:
|
|
19703
19939
|
example: '@test.user@test.com'
|
19704
19940
|
type: string
|
19705
19941
|
type: object
|
19942
|
+
IncidentNotificationTemplate:
|
19943
|
+
description: Response with a notification template.
|
19944
|
+
properties:
|
19945
|
+
data:
|
19946
|
+
$ref: '#/components/schemas/IncidentNotificationTemplateResponseData'
|
19947
|
+
included:
|
19948
|
+
description: Related objects that are included in the response.
|
19949
|
+
items:
|
19950
|
+
$ref: '#/components/schemas/IncidentNotificationTemplateIncludedItems'
|
19951
|
+
type: array
|
19952
|
+
required:
|
19953
|
+
- data
|
19954
|
+
type: object
|
19955
|
+
IncidentNotificationTemplateArray:
|
19956
|
+
description: Response with notification templates.
|
19957
|
+
properties:
|
19958
|
+
data:
|
19959
|
+
description: The `NotificationTemplateArray` `data`.
|
19960
|
+
items:
|
19961
|
+
$ref: '#/components/schemas/IncidentNotificationTemplateResponseData'
|
19962
|
+
type: array
|
19963
|
+
included:
|
19964
|
+
description: Related objects that are included in the response.
|
19965
|
+
items:
|
19966
|
+
$ref: '#/components/schemas/IncidentNotificationTemplateIncludedItems'
|
19967
|
+
type: array
|
19968
|
+
meta:
|
19969
|
+
$ref: '#/components/schemas/IncidentNotificationTemplateArrayMeta'
|
19970
|
+
required:
|
19971
|
+
- data
|
19972
|
+
type: object
|
19973
|
+
IncidentNotificationTemplateArrayMeta:
|
19974
|
+
description: Response metadata.
|
19975
|
+
properties:
|
19976
|
+
page:
|
19977
|
+
$ref: '#/components/schemas/IncidentNotificationTemplateArrayMetaPage'
|
19978
|
+
type: object
|
19979
|
+
IncidentNotificationTemplateArrayMetaPage:
|
19980
|
+
description: Pagination metadata.
|
19981
|
+
properties:
|
19982
|
+
total_count:
|
19983
|
+
description: Total number of notification templates.
|
19984
|
+
example: 42
|
19985
|
+
format: int64
|
19986
|
+
type: integer
|
19987
|
+
total_filtered_count:
|
19988
|
+
description: Total number of notification templates matching the filter.
|
19989
|
+
example: 15
|
19990
|
+
format: int64
|
19991
|
+
type: integer
|
19992
|
+
type: object
|
19993
|
+
IncidentNotificationTemplateAttributes:
|
19994
|
+
description: The notification template's attributes.
|
19995
|
+
properties:
|
19996
|
+
category:
|
19997
|
+
description: The category of the notification template.
|
19998
|
+
example: alert
|
19999
|
+
type: string
|
20000
|
+
content:
|
20001
|
+
description: The content body of the notification template.
|
20002
|
+
example: 'An incident has been declared.
|
20003
|
+
|
20004
|
+
|
20005
|
+
Title: {{incident.title}}
|
20006
|
+
|
20007
|
+
Severity: {{incident.severity}}
|
20008
|
+
|
20009
|
+
Affected Services: {{incident.services}}
|
20010
|
+
|
20011
|
+
Status: {{incident.state}}
|
20012
|
+
|
20013
|
+
|
20014
|
+
Please join the incident channel for updates.'
|
20015
|
+
type: string
|
20016
|
+
created:
|
20017
|
+
description: Timestamp when the notification template was created.
|
20018
|
+
example: '2025-01-15T10:30:00Z'
|
20019
|
+
format: date-time
|
20020
|
+
readOnly: true
|
20021
|
+
type: string
|
20022
|
+
modified:
|
20023
|
+
description: Timestamp when the notification template was last modified.
|
20024
|
+
example: '2025-01-15T14:45:00Z'
|
20025
|
+
format: date-time
|
20026
|
+
readOnly: true
|
20027
|
+
type: string
|
20028
|
+
name:
|
20029
|
+
description: The name of the notification template.
|
20030
|
+
example: Incident Alert Template
|
20031
|
+
type: string
|
20032
|
+
subject:
|
20033
|
+
description: The subject line of the notification template.
|
20034
|
+
example: '{{incident.severity}} Incident: {{incident.title}}'
|
20035
|
+
type: string
|
20036
|
+
required:
|
20037
|
+
- name
|
20038
|
+
- subject
|
20039
|
+
- content
|
20040
|
+
- category
|
20041
|
+
- created
|
20042
|
+
- modified
|
20043
|
+
type: object
|
20044
|
+
IncidentNotificationTemplateCreateAttributes:
|
20045
|
+
description: The attributes for creating a notification template.
|
20046
|
+
properties:
|
20047
|
+
category:
|
20048
|
+
description: The category of the notification template.
|
20049
|
+
example: alert
|
20050
|
+
type: string
|
20051
|
+
content:
|
20052
|
+
description: The content body of the notification template.
|
20053
|
+
example: 'An incident has been declared.
|
20054
|
+
|
20055
|
+
|
20056
|
+
Title: {{incident.title}}
|
20057
|
+
|
20058
|
+
Severity: {{incident.severity}}
|
20059
|
+
|
20060
|
+
Affected Services: {{incident.services}}
|
20061
|
+
|
20062
|
+
Status: {{incident.state}}
|
20063
|
+
|
20064
|
+
|
20065
|
+
Please join the incident channel for updates.'
|
20066
|
+
type: string
|
20067
|
+
name:
|
20068
|
+
description: The name of the notification template.
|
20069
|
+
example: Incident Alert Template
|
20070
|
+
type: string
|
20071
|
+
subject:
|
20072
|
+
description: The subject line of the notification template.
|
20073
|
+
example: '{{incident.severity}} Incident: {{incident.title}}'
|
20074
|
+
type: string
|
20075
|
+
required:
|
20076
|
+
- name
|
20077
|
+
- subject
|
20078
|
+
- content
|
20079
|
+
- category
|
20080
|
+
type: object
|
20081
|
+
IncidentNotificationTemplateCreateData:
|
20082
|
+
description: Notification template data for a create request.
|
20083
|
+
properties:
|
20084
|
+
attributes:
|
20085
|
+
$ref: '#/components/schemas/IncidentNotificationTemplateCreateAttributes'
|
20086
|
+
relationships:
|
20087
|
+
$ref: '#/components/schemas/IncidentNotificationTemplateCreateDataRelationships'
|
20088
|
+
type:
|
20089
|
+
$ref: '#/components/schemas/IncidentNotificationTemplateType'
|
20090
|
+
required:
|
20091
|
+
- type
|
20092
|
+
- attributes
|
20093
|
+
type: object
|
20094
|
+
IncidentNotificationTemplateCreateDataRelationships:
|
20095
|
+
description: The definition of `NotificationTemplateCreateDataRelationships`
|
20096
|
+
object.
|
20097
|
+
properties:
|
20098
|
+
incident_type:
|
20099
|
+
$ref: '#/components/schemas/RelationshipToIncidentType'
|
20100
|
+
type: object
|
20101
|
+
IncidentNotificationTemplateIncludedItems:
|
20102
|
+
description: Objects related to a notification template.
|
20103
|
+
oneOf:
|
20104
|
+
- $ref: '#/components/schemas/User'
|
20105
|
+
- $ref: '#/components/schemas/IncidentTypeObject'
|
20106
|
+
IncidentNotificationTemplateRelationships:
|
20107
|
+
description: The notification template's resource relationships.
|
20108
|
+
properties:
|
20109
|
+
created_by_user:
|
20110
|
+
$ref: '#/components/schemas/RelationshipToUser'
|
20111
|
+
incident_type:
|
20112
|
+
$ref: '#/components/schemas/RelationshipToIncidentType'
|
20113
|
+
last_modified_by_user:
|
20114
|
+
$ref: '#/components/schemas/RelationshipToUser'
|
20115
|
+
type: object
|
20116
|
+
IncidentNotificationTemplateResponseData:
|
20117
|
+
description: Notification template data from a response.
|
20118
|
+
properties:
|
20119
|
+
attributes:
|
20120
|
+
$ref: '#/components/schemas/IncidentNotificationTemplateAttributes'
|
20121
|
+
id:
|
20122
|
+
description: The unique identifier of the notification template.
|
20123
|
+
example: 00000000-0000-0000-0000-000000000001
|
20124
|
+
format: uuid
|
20125
|
+
type: string
|
20126
|
+
relationships:
|
20127
|
+
$ref: '#/components/schemas/IncidentNotificationTemplateRelationships'
|
20128
|
+
type:
|
20129
|
+
$ref: '#/components/schemas/IncidentNotificationTemplateType'
|
20130
|
+
required:
|
20131
|
+
- id
|
20132
|
+
- type
|
20133
|
+
type: object
|
20134
|
+
IncidentNotificationTemplateType:
|
20135
|
+
description: Notification templates resource type.
|
20136
|
+
enum:
|
20137
|
+
- notification_templates
|
20138
|
+
example: notification_templates
|
20139
|
+
type: string
|
20140
|
+
x-enum-varnames:
|
20141
|
+
- NOTIFICATION_TEMPLATES
|
20142
|
+
IncidentNotificationTemplateUpdateAttributes:
|
20143
|
+
description: The attributes to update on a notification template.
|
20144
|
+
properties:
|
20145
|
+
category:
|
20146
|
+
description: The category of the notification template.
|
20147
|
+
example: update
|
20148
|
+
type: string
|
20149
|
+
content:
|
20150
|
+
description: The content body of the notification template.
|
20151
|
+
example: 'Incident Status Update:
|
20152
|
+
|
20153
|
+
|
20154
|
+
Title: {{incident.title}}
|
20155
|
+
|
20156
|
+
New Status: {{incident.state}}
|
20157
|
+
|
20158
|
+
Severity: {{incident.severity}}
|
20159
|
+
|
20160
|
+
Services: {{incident.services}}
|
20161
|
+
|
20162
|
+
Commander: {{incident.commander}}
|
20163
|
+
|
20164
|
+
|
20165
|
+
For more details, visit the incident page.'
|
20166
|
+
type: string
|
20167
|
+
name:
|
20168
|
+
description: The name of the notification template.
|
20169
|
+
example: Incident Status Update Template
|
20170
|
+
type: string
|
20171
|
+
subject:
|
20172
|
+
description: The subject line of the notification template.
|
20173
|
+
example: 'Incident Update: {{incident.title}} - {{incident.state}}'
|
20174
|
+
type: string
|
20175
|
+
type: object
|
20176
|
+
IncidentNotificationTemplateUpdateData:
|
20177
|
+
description: Notification template data for an update request.
|
20178
|
+
properties:
|
20179
|
+
attributes:
|
20180
|
+
$ref: '#/components/schemas/IncidentNotificationTemplateUpdateAttributes'
|
20181
|
+
id:
|
20182
|
+
description: The unique identifier of the notification template.
|
20183
|
+
example: 00000000-0000-0000-0000-000000000001
|
20184
|
+
format: uuid
|
20185
|
+
type: string
|
20186
|
+
type:
|
20187
|
+
$ref: '#/components/schemas/IncidentNotificationTemplateType'
|
20188
|
+
required:
|
20189
|
+
- id
|
20190
|
+
- type
|
20191
|
+
type: object
|
19706
20192
|
IncidentPostmortemType:
|
19707
20193
|
default: incident_postmortems
|
19708
20194
|
description: Incident postmortem resource type.
|
@@ -20862,6 +21348,8 @@ components:
|
|
20862
21348
|
description: The incident type's ID.
|
20863
21349
|
example: 00000000-0000-0000-0000-000000000000
|
20864
21350
|
type: string
|
21351
|
+
relationships:
|
21352
|
+
$ref: '#/components/schemas/IncidentTypeRelationships'
|
20865
21353
|
type:
|
20866
21354
|
$ref: '#/components/schemas/IncidentTypeType'
|
20867
21355
|
required:
|
@@ -20892,6 +21380,21 @@ components:
|
|
20892
21380
|
required:
|
20893
21381
|
- data
|
20894
21382
|
type: object
|
21383
|
+
IncidentTypeRelationships:
|
21384
|
+
additionalProperties: {}
|
21385
|
+
description: The incident type's resource relationships.
|
21386
|
+
properties:
|
21387
|
+
created_by_user:
|
21388
|
+
$ref: '#/components/schemas/RelationshipToUser'
|
21389
|
+
google_meet_configuration:
|
21390
|
+
$ref: '#/components/schemas/GoogleMeetConfigurationReference'
|
21391
|
+
last_modified_by_user:
|
21392
|
+
$ref: '#/components/schemas/RelationshipToUser'
|
21393
|
+
microsoft_teams_configuration:
|
21394
|
+
$ref: '#/components/schemas/MicrosoftTeamsConfigurationReference'
|
21395
|
+
zoom_configuration:
|
21396
|
+
$ref: '#/components/schemas/ZoomConfigurationReference'
|
21397
|
+
type: object
|
20895
21398
|
IncidentTypeResponse:
|
20896
21399
|
description: Incident type response data.
|
20897
21400
|
properties:
|
@@ -21321,6 +21824,773 @@ components:
|
|
21321
21824
|
- DOWN
|
21322
21825
|
- WARNING
|
21323
21826
|
- 'OFF'
|
21827
|
+
Issue:
|
21828
|
+
description: The issue matching the request.
|
21829
|
+
properties:
|
21830
|
+
attributes:
|
21831
|
+
$ref: '#/components/schemas/IssueAttributes'
|
21832
|
+
id:
|
21833
|
+
description: Issue identifier.
|
21834
|
+
example: c1726a66-1f64-11ee-b338-da7ad0900002
|
21835
|
+
type: string
|
21836
|
+
relationships:
|
21837
|
+
$ref: '#/components/schemas/IssueRelationships'
|
21838
|
+
type:
|
21839
|
+
$ref: '#/components/schemas/IssueType'
|
21840
|
+
required:
|
21841
|
+
- id
|
21842
|
+
- type
|
21843
|
+
- attributes
|
21844
|
+
type: object
|
21845
|
+
IssueAssigneeRelationship:
|
21846
|
+
description: Relationship between the issue and assignee.
|
21847
|
+
properties:
|
21848
|
+
data:
|
21849
|
+
$ref: '#/components/schemas/IssueUserReference'
|
21850
|
+
required:
|
21851
|
+
- data
|
21852
|
+
type: object
|
21853
|
+
IssueAttributes:
|
21854
|
+
description: Object containing the information of an issue.
|
21855
|
+
properties:
|
21856
|
+
error_message:
|
21857
|
+
description: Error message associated with the issue.
|
21858
|
+
example: object of type 'NoneType' has no len()
|
21859
|
+
type: string
|
21860
|
+
error_type:
|
21861
|
+
description: Type of the error that matches the issue.
|
21862
|
+
example: builtins.TypeError
|
21863
|
+
type: string
|
21864
|
+
file_path:
|
21865
|
+
description: Path of the file where the issue occurred.
|
21866
|
+
example: /django-email/conduit/apps/core/utils.py
|
21867
|
+
type: string
|
21868
|
+
first_seen:
|
21869
|
+
description: Timestamp of the first seen error in milliseconds since the
|
21870
|
+
Unix epoch.
|
21871
|
+
example: 1671612804001
|
21872
|
+
format: int64
|
21873
|
+
type: integer
|
21874
|
+
first_seen_version:
|
21875
|
+
description: The application version (for example, git commit hash) where
|
21876
|
+
the issue was first observed.
|
21877
|
+
example: aaf65cd0
|
21878
|
+
type: string
|
21879
|
+
function_name:
|
21880
|
+
description: Name of the function where the issue occurred.
|
21881
|
+
example: filter_forbidden_tags
|
21882
|
+
type: string
|
21883
|
+
is_crash:
|
21884
|
+
description: Error is a crash.
|
21885
|
+
example: false
|
21886
|
+
type: boolean
|
21887
|
+
languages:
|
21888
|
+
description: Array of programming languages associated with the issue.
|
21889
|
+
example:
|
21890
|
+
- PYTHON
|
21891
|
+
- GO
|
21892
|
+
items:
|
21893
|
+
$ref: '#/components/schemas/IssueLanguage'
|
21894
|
+
type: array
|
21895
|
+
last_seen:
|
21896
|
+
description: Timestamp of the last seen error in milliseconds since the
|
21897
|
+
Unix epoch.
|
21898
|
+
example: 1671620003100
|
21899
|
+
format: int64
|
21900
|
+
type: integer
|
21901
|
+
last_seen_version:
|
21902
|
+
description: The application version (for example, git commit hash) where
|
21903
|
+
the issue was last observed.
|
21904
|
+
example: b6199f80
|
21905
|
+
type: string
|
21906
|
+
platform:
|
21907
|
+
$ref: '#/components/schemas/IssuePlatform'
|
21908
|
+
service:
|
21909
|
+
description: Service name.
|
21910
|
+
example: email-api-py
|
21911
|
+
type: string
|
21912
|
+
state:
|
21913
|
+
$ref: '#/components/schemas/IssueState'
|
21914
|
+
type: object
|
21915
|
+
IssueCase:
|
21916
|
+
description: The case attached to the issue.
|
21917
|
+
properties:
|
21918
|
+
attributes:
|
21919
|
+
$ref: '#/components/schemas/IssueCaseAttributes'
|
21920
|
+
id:
|
21921
|
+
description: Case identifier.
|
21922
|
+
example: 2841440d-e780-4fe2-96cd-6a8c1d194da5
|
21923
|
+
type: string
|
21924
|
+
relationships:
|
21925
|
+
$ref: '#/components/schemas/IssueCaseRelationships'
|
21926
|
+
type:
|
21927
|
+
$ref: '#/components/schemas/IssueCaseResourceType'
|
21928
|
+
required:
|
21929
|
+
- id
|
21930
|
+
- type
|
21931
|
+
- attributes
|
21932
|
+
type: object
|
21933
|
+
IssueCaseAttributes:
|
21934
|
+
description: Object containing the information of a case.
|
21935
|
+
properties:
|
21936
|
+
archived_at:
|
21937
|
+
description: Timestamp of when the case was archived.
|
21938
|
+
example: '2025-01-01T00:00:00Z'
|
21939
|
+
format: date-time
|
21940
|
+
type: string
|
21941
|
+
closed_at:
|
21942
|
+
description: Timestamp of when the case was closed.
|
21943
|
+
example: '2025-01-01T00:00:00Z'
|
21944
|
+
format: date-time
|
21945
|
+
type: string
|
21946
|
+
created_at:
|
21947
|
+
description: Timestamp of when the case was created.
|
21948
|
+
example: '2025-01-01T00:00:00Z'
|
21949
|
+
format: date-time
|
21950
|
+
type: string
|
21951
|
+
creation_source:
|
21952
|
+
description: Source of the case creation.
|
21953
|
+
example: ERROR_TRACKING
|
21954
|
+
type: string
|
21955
|
+
description:
|
21956
|
+
description: Description of the case.
|
21957
|
+
type: string
|
21958
|
+
due_date:
|
21959
|
+
description: Due date of the case.
|
21960
|
+
example: '2025-01-01'
|
21961
|
+
type: string
|
21962
|
+
insights:
|
21963
|
+
description: Insights of the case.
|
21964
|
+
items:
|
21965
|
+
$ref: '#/components/schemas/IssueCaseInsight'
|
21966
|
+
type: array
|
21967
|
+
jira_issue:
|
21968
|
+
$ref: '#/components/schemas/IssueCaseJiraIssue'
|
21969
|
+
key:
|
21970
|
+
description: Key of the case.
|
21971
|
+
example: ET-123
|
21972
|
+
type: string
|
21973
|
+
modified_at:
|
21974
|
+
description: Timestamp of when the case was last modified.
|
21975
|
+
example: '2025-01-01T00:00:00Z'
|
21976
|
+
format: date-time
|
21977
|
+
type: string
|
21978
|
+
priority:
|
21979
|
+
$ref: '#/components/schemas/CasePriority'
|
21980
|
+
status:
|
21981
|
+
$ref: '#/components/schemas/CaseStatus'
|
21982
|
+
title:
|
21983
|
+
description: Title of the case.
|
21984
|
+
example: 'Error: HTTP error'
|
21985
|
+
type: string
|
21986
|
+
type:
|
21987
|
+
description: Type of the case.
|
21988
|
+
example: ERROR_TRACKING_ISSUE
|
21989
|
+
type: string
|
21990
|
+
type: object
|
21991
|
+
IssueCaseInsight:
|
21992
|
+
description: Insight of the case.
|
21993
|
+
properties:
|
21994
|
+
ref:
|
21995
|
+
description: Reference of the insight.
|
21996
|
+
example: /error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5
|
21997
|
+
type: string
|
21998
|
+
resource_id:
|
21999
|
+
description: Insight identifier.
|
22000
|
+
example: 2841440d-e780-4fe2-96cd-6a8c1d194da5
|
22001
|
+
type: string
|
22002
|
+
type:
|
22003
|
+
description: Type of the insight.
|
22004
|
+
example: ERROR_TRACKING
|
22005
|
+
type: string
|
22006
|
+
type: object
|
22007
|
+
IssueCaseJiraIssue:
|
22008
|
+
description: Jira issue of the case.
|
22009
|
+
properties:
|
22010
|
+
result:
|
22011
|
+
$ref: '#/components/schemas/IssueCaseJiraIssueResult'
|
22012
|
+
status:
|
22013
|
+
description: Creation status of the Jira issue.
|
22014
|
+
example: COMPLETED
|
22015
|
+
type: string
|
22016
|
+
type: object
|
22017
|
+
IssueCaseJiraIssueResult:
|
22018
|
+
description: Contains the identifiers and URL for a successfully created Jira
|
22019
|
+
issue.
|
22020
|
+
properties:
|
22021
|
+
issue_id:
|
22022
|
+
description: Jira issue identifier.
|
22023
|
+
example: '1904866'
|
22024
|
+
type: string
|
22025
|
+
issue_key:
|
22026
|
+
description: Jira issue key.
|
22027
|
+
example: ET-123
|
22028
|
+
type: string
|
22029
|
+
issue_url:
|
22030
|
+
description: Jira issue URL.
|
22031
|
+
example: https://your-jira-instance.atlassian.net/browse/ET-123
|
22032
|
+
type: string
|
22033
|
+
project_key:
|
22034
|
+
description: Jira project key.
|
22035
|
+
example: ET
|
22036
|
+
type: string
|
22037
|
+
type: object
|
22038
|
+
IssueCaseReference:
|
22039
|
+
description: The case the issue is attached to.
|
22040
|
+
properties:
|
22041
|
+
id:
|
22042
|
+
description: Case identifier.
|
22043
|
+
example: 2841440d-e780-4fe2-96cd-6a8c1d194da5
|
22044
|
+
type: string
|
22045
|
+
type:
|
22046
|
+
$ref: '#/components/schemas/IssueCaseResourceType'
|
22047
|
+
required:
|
22048
|
+
- id
|
22049
|
+
- type
|
22050
|
+
type: object
|
22051
|
+
IssueCaseRelationship:
|
22052
|
+
description: Relationship between the issue and case.
|
22053
|
+
properties:
|
22054
|
+
data:
|
22055
|
+
$ref: '#/components/schemas/IssueCaseReference'
|
22056
|
+
required:
|
22057
|
+
- data
|
22058
|
+
type: object
|
22059
|
+
IssueCaseRelationships:
|
22060
|
+
description: Resources related to a case.
|
22061
|
+
properties:
|
22062
|
+
assignee:
|
22063
|
+
$ref: '#/components/schemas/NullableUserRelationship'
|
22064
|
+
created_by:
|
22065
|
+
$ref: '#/components/schemas/NullableUserRelationship'
|
22066
|
+
modified_by:
|
22067
|
+
$ref: '#/components/schemas/NullableUserRelationship'
|
22068
|
+
project:
|
22069
|
+
$ref: '#/components/schemas/ProjectRelationship'
|
22070
|
+
type: object
|
22071
|
+
IssueCaseResourceType:
|
22072
|
+
description: Type of the object.
|
22073
|
+
enum:
|
22074
|
+
- case
|
22075
|
+
example: case
|
22076
|
+
type: string
|
22077
|
+
x-enum-varnames:
|
22078
|
+
- CASE
|
22079
|
+
IssueIncluded:
|
22080
|
+
description: An array of related resources, returned when the `include` query
|
22081
|
+
parameter is used.
|
22082
|
+
oneOf:
|
22083
|
+
- $ref: '#/components/schemas/IssueCase'
|
22084
|
+
- $ref: '#/components/schemas/IssueUser'
|
22085
|
+
- $ref: '#/components/schemas/IssueTeam'
|
22086
|
+
IssueLanguage:
|
22087
|
+
description: Programming language associated with the issue.
|
22088
|
+
enum:
|
22089
|
+
- BRIGHTSCRIPT
|
22090
|
+
- C
|
22091
|
+
- C_PLUS_PLUS
|
22092
|
+
- C_SHARP
|
22093
|
+
- CLOJURE
|
22094
|
+
- DOT_NET
|
22095
|
+
- ELIXIR
|
22096
|
+
- ERLANG
|
22097
|
+
- GO
|
22098
|
+
- GROOVY
|
22099
|
+
- HASKELL
|
22100
|
+
- HCL
|
22101
|
+
- JAVA
|
22102
|
+
- JAVASCRIPT
|
22103
|
+
- JVM
|
22104
|
+
- KOTLIN
|
22105
|
+
- OBJECTIVE_C
|
22106
|
+
- PERL
|
22107
|
+
- PHP
|
22108
|
+
- PYTHON
|
22109
|
+
- RUBY
|
22110
|
+
- RUST
|
22111
|
+
- SCALA
|
22112
|
+
- SWIFT
|
22113
|
+
- TERRAFORM
|
22114
|
+
- TYPESCRIPT
|
22115
|
+
- UNKNOWN
|
22116
|
+
example: PYTHON
|
22117
|
+
type: string
|
22118
|
+
x-enum-varnames:
|
22119
|
+
- BRIGHTSCRIPT
|
22120
|
+
- C
|
22121
|
+
- C_PLUS_PLUS
|
22122
|
+
- C_SHARP
|
22123
|
+
- CLOJURE
|
22124
|
+
- DOT_NET
|
22125
|
+
- ELIXIR
|
22126
|
+
- ERLANG
|
22127
|
+
- GO
|
22128
|
+
- GROOVY
|
22129
|
+
- HASKELL
|
22130
|
+
- HCL
|
22131
|
+
- JAVA
|
22132
|
+
- JAVASCRIPT
|
22133
|
+
- JVM
|
22134
|
+
- KOTLIN
|
22135
|
+
- OBJECTIVE_C
|
22136
|
+
- PERL
|
22137
|
+
- PHP
|
22138
|
+
- PYTHON
|
22139
|
+
- RUBY
|
22140
|
+
- RUST
|
22141
|
+
- SCALA
|
22142
|
+
- SWIFT
|
22143
|
+
- TERRAFORM
|
22144
|
+
- TYPESCRIPT
|
22145
|
+
- UNKNOWN
|
22146
|
+
IssuePlatform:
|
22147
|
+
description: Platform associated with the issue.
|
22148
|
+
enum:
|
22149
|
+
- ANDROID
|
22150
|
+
- BACKEND
|
22151
|
+
- BROWSER
|
22152
|
+
- FLUTTER
|
22153
|
+
- IOS
|
22154
|
+
- REACT_NATIVE
|
22155
|
+
- ROKU
|
22156
|
+
- UNKNOWN
|
22157
|
+
example: BACKEND
|
22158
|
+
type: string
|
22159
|
+
x-enum-varnames:
|
22160
|
+
- ANDROID
|
22161
|
+
- BACKEND
|
22162
|
+
- BROWSER
|
22163
|
+
- FLUTTER
|
22164
|
+
- IOS
|
22165
|
+
- REACT_NATIVE
|
22166
|
+
- ROKU
|
22167
|
+
- UNKNOWN
|
22168
|
+
IssueReference:
|
22169
|
+
description: The issue the search result corresponds to.
|
22170
|
+
properties:
|
22171
|
+
id:
|
22172
|
+
description: Issue identifier.
|
22173
|
+
example: c1726a66-1f64-11ee-b338-da7ad0900002
|
22174
|
+
type: string
|
22175
|
+
type:
|
22176
|
+
$ref: '#/components/schemas/IssueType'
|
22177
|
+
required:
|
22178
|
+
- id
|
22179
|
+
- type
|
22180
|
+
type: object
|
22181
|
+
IssueRelationships:
|
22182
|
+
description: Relationship between the issue and an assignee, case and/or teams.
|
22183
|
+
properties:
|
22184
|
+
assignee:
|
22185
|
+
$ref: '#/components/schemas/IssueAssigneeRelationship'
|
22186
|
+
case:
|
22187
|
+
$ref: '#/components/schemas/IssueCaseRelationship'
|
22188
|
+
team_owners:
|
22189
|
+
$ref: '#/components/schemas/IssueTeamOwnersRelationship'
|
22190
|
+
type: object
|
22191
|
+
IssueResponse:
|
22192
|
+
description: Response containing error tracking issue data.
|
22193
|
+
properties:
|
22194
|
+
data:
|
22195
|
+
$ref: '#/components/schemas/Issue'
|
22196
|
+
included:
|
22197
|
+
description: Array of resources related to the issue.
|
22198
|
+
items:
|
22199
|
+
$ref: '#/components/schemas/IssueIncluded'
|
22200
|
+
type: array
|
22201
|
+
type: object
|
22202
|
+
IssueState:
|
22203
|
+
description: State of the issue
|
22204
|
+
enum:
|
22205
|
+
- OPEN
|
22206
|
+
- ACKNOWLEDGED
|
22207
|
+
- RESOLVED
|
22208
|
+
- IGNORED
|
22209
|
+
- EXCLUDED
|
22210
|
+
example: RESOLVED
|
22211
|
+
type: string
|
22212
|
+
x-enum-varnames:
|
22213
|
+
- OPEN
|
22214
|
+
- ACKNOWLEDGED
|
22215
|
+
- RESOLVED
|
22216
|
+
- IGNORED
|
22217
|
+
- EXCLUDED
|
22218
|
+
IssueTeam:
|
22219
|
+
description: A team that owns an issue.
|
22220
|
+
properties:
|
22221
|
+
attributes:
|
22222
|
+
$ref: '#/components/schemas/IssueTeamAttributes'
|
22223
|
+
id:
|
22224
|
+
description: Team identifier.
|
22225
|
+
example: 221b0179-6447-4d03-91c3-3ca98bf60e8a
|
22226
|
+
type: string
|
22227
|
+
type:
|
22228
|
+
$ref: '#/components/schemas/IssueTeamType'
|
22229
|
+
required:
|
22230
|
+
- id
|
22231
|
+
- type
|
22232
|
+
- attributes
|
22233
|
+
type: object
|
22234
|
+
IssueTeamAttributes:
|
22235
|
+
description: Object containing the information of a team.
|
22236
|
+
properties:
|
22237
|
+
handle:
|
22238
|
+
description: The team's identifier.
|
22239
|
+
example: team-handle
|
22240
|
+
type: string
|
22241
|
+
name:
|
22242
|
+
description: The name of the team.
|
22243
|
+
example: Team Name
|
22244
|
+
type: string
|
22245
|
+
summary:
|
22246
|
+
description: A brief summary of the team, derived from its description.
|
22247
|
+
example: This is a team.
|
22248
|
+
type: string
|
22249
|
+
type: object
|
22250
|
+
IssueTeamOwnersRelationship:
|
22251
|
+
description: Relationship between the issue and teams.
|
22252
|
+
properties:
|
22253
|
+
data:
|
22254
|
+
description: Array of teams that are owners of the issue.
|
22255
|
+
items:
|
22256
|
+
$ref: '#/components/schemas/IssueTeamReference'
|
22257
|
+
type: array
|
22258
|
+
required:
|
22259
|
+
- data
|
22260
|
+
type: object
|
22261
|
+
IssueTeamReference:
|
22262
|
+
description: A team that owns the issue.
|
22263
|
+
properties:
|
22264
|
+
id:
|
22265
|
+
description: Team identifier.
|
22266
|
+
example: 221b0179-6447-4d03-91c3-3ca98bf60e8a
|
22267
|
+
type: string
|
22268
|
+
type:
|
22269
|
+
$ref: '#/components/schemas/IssueTeamType'
|
22270
|
+
required:
|
22271
|
+
- id
|
22272
|
+
- type
|
22273
|
+
type: object
|
22274
|
+
IssueTeamType:
|
22275
|
+
description: Type of the object.
|
22276
|
+
enum:
|
22277
|
+
- team
|
22278
|
+
example: team
|
22279
|
+
type: string
|
22280
|
+
x-enum-varnames:
|
22281
|
+
- TEAM
|
22282
|
+
IssueType:
|
22283
|
+
description: Type of the object.
|
22284
|
+
enum:
|
22285
|
+
- issue
|
22286
|
+
example: issue
|
22287
|
+
type: string
|
22288
|
+
x-enum-varnames:
|
22289
|
+
- ISSUE
|
22290
|
+
IssueUpdateAssigneeRequest:
|
22291
|
+
description: Update issue assignee request payload.
|
22292
|
+
properties:
|
22293
|
+
data:
|
22294
|
+
$ref: '#/components/schemas/IssueUpdateAssigneeRequestData'
|
22295
|
+
required:
|
22296
|
+
- data
|
22297
|
+
type: object
|
22298
|
+
IssueUpdateAssigneeRequestData:
|
22299
|
+
description: Update issue assignee request.
|
22300
|
+
properties:
|
22301
|
+
id:
|
22302
|
+
description: User identifier.
|
22303
|
+
example: 87cb11a0-278c-440a-99fe-701223c80296
|
22304
|
+
type: string
|
22305
|
+
type:
|
22306
|
+
$ref: '#/components/schemas/IssueUpdateAssigneeRequestDataType'
|
22307
|
+
required:
|
22308
|
+
- id
|
22309
|
+
- type
|
22310
|
+
type: object
|
22311
|
+
IssueUpdateAssigneeRequestDataType:
|
22312
|
+
description: Type of the object.
|
22313
|
+
enum:
|
22314
|
+
- assignee
|
22315
|
+
example: assignee
|
22316
|
+
type: string
|
22317
|
+
x-enum-varnames:
|
22318
|
+
- ASSIGNEE
|
22319
|
+
IssueUpdateStateRequest:
|
22320
|
+
description: Update issue state request payload.
|
22321
|
+
properties:
|
22322
|
+
data:
|
22323
|
+
$ref: '#/components/schemas/IssueUpdateStateRequestData'
|
22324
|
+
required:
|
22325
|
+
- data
|
22326
|
+
type: object
|
22327
|
+
IssueUpdateStateRequestData:
|
22328
|
+
description: Update issue state request.
|
22329
|
+
properties:
|
22330
|
+
attributes:
|
22331
|
+
$ref: '#/components/schemas/IssueUpdateStateRequestDataAttributes'
|
22332
|
+
id:
|
22333
|
+
description: Issue identifier.
|
22334
|
+
example: c1726a66-1f64-11ee-b338-da7ad0900002
|
22335
|
+
type: string
|
22336
|
+
type:
|
22337
|
+
$ref: '#/components/schemas/IssueUpdateStateRequestDataType'
|
22338
|
+
required:
|
22339
|
+
- id
|
22340
|
+
- type
|
22341
|
+
- attributes
|
22342
|
+
type: object
|
22343
|
+
IssueUpdateStateRequestDataAttributes:
|
22344
|
+
description: Object describing an issue state update request.
|
22345
|
+
properties:
|
22346
|
+
state:
|
22347
|
+
$ref: '#/components/schemas/IssueState'
|
22348
|
+
required:
|
22349
|
+
- state
|
22350
|
+
type: object
|
22351
|
+
IssueUpdateStateRequestDataType:
|
22352
|
+
description: Type of the object.
|
22353
|
+
enum:
|
22354
|
+
- error_tracking_issue
|
22355
|
+
example: error_tracking_issue
|
22356
|
+
type: string
|
22357
|
+
x-enum-varnames:
|
22358
|
+
- ERROR_TRACKING_ISSUE
|
22359
|
+
IssueUser:
|
22360
|
+
description: The user to whom the issue is assigned.
|
22361
|
+
properties:
|
22362
|
+
attributes:
|
22363
|
+
$ref: '#/components/schemas/IssueUserAttributes'
|
22364
|
+
id:
|
22365
|
+
description: User identifier.
|
22366
|
+
example: 87cb11a0-278c-440a-99fe-701223c80296
|
22367
|
+
type: string
|
22368
|
+
type:
|
22369
|
+
$ref: '#/components/schemas/IssueUserType'
|
22370
|
+
required:
|
22371
|
+
- id
|
22372
|
+
- type
|
22373
|
+
- attributes
|
22374
|
+
type: object
|
22375
|
+
IssueUserAttributes:
|
22376
|
+
description: Object containing the information of a user.
|
22377
|
+
properties:
|
22378
|
+
email:
|
22379
|
+
description: Email of the user.
|
22380
|
+
example: user@company.com
|
22381
|
+
type: string
|
22382
|
+
handle:
|
22383
|
+
description: Handle of the user.
|
22384
|
+
example: User Handle
|
22385
|
+
type: string
|
22386
|
+
name:
|
22387
|
+
description: Name of the user.
|
22388
|
+
example: User Name
|
22389
|
+
type: string
|
22390
|
+
type: object
|
22391
|
+
IssueUserReference:
|
22392
|
+
description: The user the issue is assigned to.
|
22393
|
+
properties:
|
22394
|
+
id:
|
22395
|
+
description: User identifier.
|
22396
|
+
example: 87cb11a0-278c-440a-99fe-701223c80296
|
22397
|
+
type: string
|
22398
|
+
type:
|
22399
|
+
$ref: '#/components/schemas/IssueUserType'
|
22400
|
+
required:
|
22401
|
+
- id
|
22402
|
+
- type
|
22403
|
+
type: object
|
22404
|
+
IssueUserType:
|
22405
|
+
description: Type of the object
|
22406
|
+
enum:
|
22407
|
+
- user
|
22408
|
+
example: user
|
22409
|
+
type: string
|
22410
|
+
x-enum-varnames:
|
22411
|
+
- USER
|
22412
|
+
IssuesSearchRequest:
|
22413
|
+
description: Search issues request payload.
|
22414
|
+
properties:
|
22415
|
+
data:
|
22416
|
+
$ref: '#/components/schemas/IssuesSearchRequestData'
|
22417
|
+
required:
|
22418
|
+
- data
|
22419
|
+
type: object
|
22420
|
+
IssuesSearchRequestData:
|
22421
|
+
description: Search issues request.
|
22422
|
+
properties:
|
22423
|
+
attributes:
|
22424
|
+
$ref: '#/components/schemas/IssuesSearchRequestDataAttributes'
|
22425
|
+
type:
|
22426
|
+
$ref: '#/components/schemas/IssuesSearchRequestDataType'
|
22427
|
+
required:
|
22428
|
+
- type
|
22429
|
+
- attributes
|
22430
|
+
type: object
|
22431
|
+
IssuesSearchRequestDataAttributes:
|
22432
|
+
description: Object describing a search issue request.
|
22433
|
+
properties:
|
22434
|
+
from:
|
22435
|
+
description: Start date (inclusive) of the query in milliseconds since the
|
22436
|
+
Unix epoch.
|
22437
|
+
example: 1671612804000
|
22438
|
+
format: int64
|
22439
|
+
type: integer
|
22440
|
+
order_by:
|
22441
|
+
$ref: '#/components/schemas/IssuesSearchRequestDataAttributesOrderBy'
|
22442
|
+
persona:
|
22443
|
+
$ref: '#/components/schemas/IssuesSearchRequestDataAttributesPersona'
|
22444
|
+
query:
|
22445
|
+
description: Search query following the event search syntax.
|
22446
|
+
example: service:orders-* AND @language:go
|
22447
|
+
type: string
|
22448
|
+
to:
|
22449
|
+
description: End date (exclusive) of the query in milliseconds since the
|
22450
|
+
Unix epoch.
|
22451
|
+
example: 1671620004000
|
22452
|
+
format: int64
|
22453
|
+
type: integer
|
22454
|
+
track:
|
22455
|
+
$ref: '#/components/schemas/IssuesSearchRequestDataAttributesTrack'
|
22456
|
+
required:
|
22457
|
+
- query
|
22458
|
+
- from
|
22459
|
+
- to
|
22460
|
+
type: object
|
22461
|
+
IssuesSearchRequestDataAttributesOrderBy:
|
22462
|
+
description: The attribute to sort the search results by.
|
22463
|
+
enum:
|
22464
|
+
- TOTAL_COUNT
|
22465
|
+
- FIRST_SEEN
|
22466
|
+
- IMPACTED_SESSIONS
|
22467
|
+
- PRIORITY
|
22468
|
+
example: IMPACTED_SESSIONS
|
22469
|
+
type: string
|
22470
|
+
x-enum-varnames:
|
22471
|
+
- TOTAL_COUNT
|
22472
|
+
- FIRST_SEEN
|
22473
|
+
- IMPACTED_SESSIONS
|
22474
|
+
- PRIORITY
|
22475
|
+
IssuesSearchRequestDataAttributesPersona:
|
22476
|
+
description: Persona for the search. Either track(s) or persona(s) must be specified.
|
22477
|
+
enum:
|
22478
|
+
- ALL
|
22479
|
+
- BROWSER
|
22480
|
+
- MOBILE
|
22481
|
+
- BACKEND
|
22482
|
+
example: BACKEND
|
22483
|
+
type: string
|
22484
|
+
x-enum-varnames:
|
22485
|
+
- ALL
|
22486
|
+
- BROWSER
|
22487
|
+
- MOBILE
|
22488
|
+
- BACKEND
|
22489
|
+
IssuesSearchRequestDataAttributesTrack:
|
22490
|
+
description: Track of the events to query. Either track(s) or persona(s) must
|
22491
|
+
be specified.
|
22492
|
+
enum:
|
22493
|
+
- trace
|
22494
|
+
- logs
|
22495
|
+
- rum
|
22496
|
+
example: trace
|
22497
|
+
type: string
|
22498
|
+
x-enum-varnames:
|
22499
|
+
- TRACE
|
22500
|
+
- LOGS
|
22501
|
+
- RUM
|
22502
|
+
IssuesSearchRequestDataType:
|
22503
|
+
description: Type of the object.
|
22504
|
+
enum:
|
22505
|
+
- search_request
|
22506
|
+
example: search_request
|
22507
|
+
type: string
|
22508
|
+
x-enum-varnames:
|
22509
|
+
- SEARCH_REQUEST
|
22510
|
+
IssuesSearchResponse:
|
22511
|
+
description: Search issues response payload.
|
22512
|
+
properties:
|
22513
|
+
data:
|
22514
|
+
description: Array of results matching the search query.
|
22515
|
+
items:
|
22516
|
+
$ref: '#/components/schemas/IssuesSearchResult'
|
22517
|
+
type: array
|
22518
|
+
included:
|
22519
|
+
description: Array of resources related to the search results.
|
22520
|
+
items:
|
22521
|
+
$ref: '#/components/schemas/IssuesSearchResultIncluded'
|
22522
|
+
type: array
|
22523
|
+
type: object
|
22524
|
+
IssuesSearchResult:
|
22525
|
+
description: Result matching the search query.
|
22526
|
+
properties:
|
22527
|
+
attributes:
|
22528
|
+
$ref: '#/components/schemas/IssuesSearchResultAttributes'
|
22529
|
+
id:
|
22530
|
+
description: Search result identifier (matches the nested issue's identifier).
|
22531
|
+
example: c1726a66-1f64-11ee-b338-da7ad0900002
|
22532
|
+
type: string
|
22533
|
+
relationships:
|
22534
|
+
$ref: '#/components/schemas/IssuesSearchResultRelationships'
|
22535
|
+
type:
|
22536
|
+
$ref: '#/components/schemas/IssuesSearchResultType'
|
22537
|
+
required:
|
22538
|
+
- id
|
22539
|
+
- type
|
22540
|
+
- attributes
|
22541
|
+
type: object
|
22542
|
+
IssuesSearchResultAttributes:
|
22543
|
+
description: Object containing the information of a search result.
|
22544
|
+
properties:
|
22545
|
+
impacted_sessions:
|
22546
|
+
description: Count of sessions impacted by the issue over the queried time
|
22547
|
+
window.
|
22548
|
+
example: 12
|
22549
|
+
format: int64
|
22550
|
+
type: integer
|
22551
|
+
impacted_users:
|
22552
|
+
description: Count of users impacted by the issue over the queried time
|
22553
|
+
window.
|
22554
|
+
example: 4
|
22555
|
+
format: int64
|
22556
|
+
type: integer
|
22557
|
+
total_count:
|
22558
|
+
description: Total count of errors that match the issue over the queried
|
22559
|
+
time window.
|
22560
|
+
example: 82
|
22561
|
+
format: int64
|
22562
|
+
type: integer
|
22563
|
+
type: object
|
22564
|
+
IssuesSearchResultIncluded:
|
22565
|
+
description: An array of related resources, returned when the `include` query
|
22566
|
+
parameter is used.
|
22567
|
+
oneOf:
|
22568
|
+
- $ref: '#/components/schemas/Issue'
|
22569
|
+
- $ref: '#/components/schemas/Case'
|
22570
|
+
- $ref: '#/components/schemas/IssueUser'
|
22571
|
+
- $ref: '#/components/schemas/IssueTeam'
|
22572
|
+
IssuesSearchResultIssueRelationship:
|
22573
|
+
description: Relationship between the search result and the corresponding issue.
|
22574
|
+
properties:
|
22575
|
+
data:
|
22576
|
+
$ref: '#/components/schemas/IssueReference'
|
22577
|
+
required:
|
22578
|
+
- data
|
22579
|
+
type: object
|
22580
|
+
IssuesSearchResultRelationships:
|
22581
|
+
description: Relationships between the search result and other resources.
|
22582
|
+
properties:
|
22583
|
+
issue:
|
22584
|
+
$ref: '#/components/schemas/IssuesSearchResultIssueRelationship'
|
22585
|
+
type: object
|
22586
|
+
IssuesSearchResultType:
|
22587
|
+
description: Type of the object.
|
22588
|
+
enum:
|
22589
|
+
- error_tracking_search_result
|
22590
|
+
example: error_tracking_search_result
|
22591
|
+
type: string
|
22592
|
+
x-enum-varnames:
|
22593
|
+
- ERROR_TRACKING_SEARCH_RESULT
|
21324
22594
|
JSONAPIErrorItem:
|
21325
22595
|
description: API error response body
|
21326
22596
|
properties:
|
@@ -25128,6 +26398,31 @@ components:
|
|
25128
26398
|
type: string
|
25129
26399
|
x-enum-varnames:
|
25130
26400
|
- MS_TEAMS_CHANNEL_INFO
|
26401
|
+
MicrosoftTeamsConfigurationReference:
|
26402
|
+
description: A reference to a Microsoft Teams Configuration resource.
|
26403
|
+
nullable: true
|
26404
|
+
properties:
|
26405
|
+
data:
|
26406
|
+
$ref: '#/components/schemas/MicrosoftTeamsConfigurationReferenceData'
|
26407
|
+
required:
|
26408
|
+
- data
|
26409
|
+
type: object
|
26410
|
+
MicrosoftTeamsConfigurationReferenceData:
|
26411
|
+
description: The Microsoft Teams configuration relationship data object.
|
26412
|
+
nullable: true
|
26413
|
+
properties:
|
26414
|
+
id:
|
26415
|
+
description: The unique identifier of the Microsoft Teams configuration.
|
26416
|
+
example: 00000000-0000-0000-0000-000000000000
|
26417
|
+
type: string
|
26418
|
+
type:
|
26419
|
+
description: The type of the Microsoft Teams configuration.
|
26420
|
+
example: microsoft_teams_configurations
|
26421
|
+
type: string
|
26422
|
+
required:
|
26423
|
+
- id
|
26424
|
+
- type
|
26425
|
+
type: object
|
25131
26426
|
MicrosoftTeamsCreateTenantBasedHandleRequest:
|
25132
26427
|
description: Create tenant-based handle request.
|
25133
26428
|
properties:
|
@@ -26851,6 +28146,59 @@ components:
|
|
26851
28146
|
type: string
|
26852
28147
|
x-enum-varnames:
|
26853
28148
|
- AMAZON_S3
|
28149
|
+
ObservabilityPipelineAmazonSecurityLakeDestination:
|
28150
|
+
description: 'The `amazon_security_lake` destination sends your logs to Amazon
|
28151
|
+
Security Lake.
|
28152
|
+
|
28153
|
+
'
|
28154
|
+
properties:
|
28155
|
+
auth:
|
28156
|
+
$ref: '#/components/schemas/ObservabilityPipelineAwsAuth'
|
28157
|
+
bucket:
|
28158
|
+
description: Name of the Amazon S3 bucket in Security Lake (3-63 characters).
|
28159
|
+
example: security-lake-bucket
|
28160
|
+
type: string
|
28161
|
+
custom_source_name:
|
28162
|
+
description: Custom source name for the logs in Security Lake.
|
28163
|
+
example: my-custom-source
|
28164
|
+
type: string
|
28165
|
+
id:
|
28166
|
+
description: Unique identifier for the destination component.
|
28167
|
+
example: amazon-security-lake-destination
|
28168
|
+
type: string
|
28169
|
+
inputs:
|
28170
|
+
description: A list of component IDs whose output is used as the `input`
|
28171
|
+
for this component.
|
28172
|
+
example:
|
28173
|
+
- filter-processor
|
28174
|
+
items:
|
28175
|
+
type: string
|
28176
|
+
type: array
|
28177
|
+
region:
|
28178
|
+
description: AWS region of the S3 bucket.
|
28179
|
+
example: us-east-1
|
28180
|
+
type: string
|
28181
|
+
tls:
|
28182
|
+
$ref: '#/components/schemas/ObservabilityPipelineTls'
|
28183
|
+
type:
|
28184
|
+
$ref: '#/components/schemas/ObservabilityPipelineAmazonSecurityLakeDestinationType'
|
28185
|
+
required:
|
28186
|
+
- id
|
28187
|
+
- type
|
28188
|
+
- inputs
|
28189
|
+
- bucket
|
28190
|
+
- region
|
28191
|
+
- custom_source_name
|
28192
|
+
type: object
|
28193
|
+
ObservabilityPipelineAmazonSecurityLakeDestinationType:
|
28194
|
+
default: amazon_security_lake
|
28195
|
+
description: The destination type. Always `amazon_security_lake`.
|
28196
|
+
enum:
|
28197
|
+
- amazon_security_lake
|
28198
|
+
example: amazon_security_lake
|
28199
|
+
type: string
|
28200
|
+
x-enum-varnames:
|
28201
|
+
- AMAZON_SECURITY_LAKE
|
26854
28202
|
ObservabilityPipelineAwsAuth:
|
26855
28203
|
description: "AWS authentication credentials used for accessing AWS services
|
26856
28204
|
such as S3.\nIf omitted, the system\u2019s default credentials are used (for
|
@@ -26922,6 +28270,9 @@ components:
|
|
26922
28270
|
- $ref: '#/components/schemas/ObservabilityPipelineSentinelOneDestination'
|
26923
28271
|
- $ref: '#/components/schemas/ObservabilityPipelineOpenSearchDestination'
|
26924
28272
|
- $ref: '#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestination'
|
28273
|
+
- $ref: '#/components/schemas/ObservabilityPipelineSocketDestination'
|
28274
|
+
- $ref: '#/components/schemas/ObservabilityPipelineAmazonSecurityLakeDestination'
|
28275
|
+
- $ref: '#/components/schemas/ObservabilityPipelineCrowdStrikeNextGenSiemDestination'
|
26925
28276
|
ObservabilityPipelineConfigProcessorItem:
|
26926
28277
|
description: A processor for the pipeline.
|
26927
28278
|
oneOf:
|
@@ -26941,6 +28292,8 @@ components:
|
|
26941
28292
|
- $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableProcessor'
|
26942
28293
|
- $ref: '#/components/schemas/ObservabilityPipelineReduceProcessor'
|
26943
28294
|
- $ref: '#/components/schemas/ObservabilityPipelineThrottleProcessor'
|
28295
|
+
- $ref: '#/components/schemas/ObservabilityPipelineCustomProcessor'
|
28296
|
+
- $ref: '#/components/schemas/ObservabilityPipelineDatadogTagsProcessor'
|
26944
28297
|
ObservabilityPipelineConfigSourceItem:
|
26945
28298
|
description: A data source for the pipeline.
|
26946
28299
|
oneOf:
|
@@ -26959,6 +28312,159 @@ components:
|
|
26959
28312
|
- $ref: '#/components/schemas/ObservabilityPipelineGooglePubSubSource'
|
26960
28313
|
- $ref: '#/components/schemas/ObservabilityPipelineHttpClientSource'
|
26961
28314
|
- $ref: '#/components/schemas/ObservabilityPipelineLogstashSource'
|
28315
|
+
- $ref: '#/components/schemas/ObservabilityPipelineSocketSource'
|
28316
|
+
ObservabilityPipelineCrowdStrikeNextGenSiemDestination:
|
28317
|
+
description: The `crowdstrike_next_gen_siem` destination forwards logs to CrowdStrike
|
28318
|
+
Next Gen SIEM.
|
28319
|
+
properties:
|
28320
|
+
compression:
|
28321
|
+
$ref: '#/components/schemas/ObservabilityPipelineCrowdStrikeNextGenSiemDestinationCompression'
|
28322
|
+
encoding:
|
28323
|
+
$ref: '#/components/schemas/ObservabilityPipelineCrowdStrikeNextGenSiemDestinationEncoding'
|
28324
|
+
id:
|
28325
|
+
description: The unique identifier for this component.
|
28326
|
+
example: crowdstrike-ngsiem-destination
|
28327
|
+
type: string
|
28328
|
+
inputs:
|
28329
|
+
description: A list of component IDs whose output is used as the `input`
|
28330
|
+
for this component.
|
28331
|
+
example:
|
28332
|
+
- filter-processor
|
28333
|
+
items:
|
28334
|
+
type: string
|
28335
|
+
type: array
|
28336
|
+
tls:
|
28337
|
+
$ref: '#/components/schemas/ObservabilityPipelineTls'
|
28338
|
+
type:
|
28339
|
+
$ref: '#/components/schemas/ObservabilityPipelineCrowdStrikeNextGenSiemDestinationType'
|
28340
|
+
required:
|
28341
|
+
- id
|
28342
|
+
- type
|
28343
|
+
- inputs
|
28344
|
+
- encoding
|
28345
|
+
type: object
|
28346
|
+
ObservabilityPipelineCrowdStrikeNextGenSiemDestinationCompression:
|
28347
|
+
description: Compression configuration for log events.
|
28348
|
+
properties:
|
28349
|
+
algorithm:
|
28350
|
+
$ref: '#/components/schemas/ObservabilityPipelineCrowdStrikeNextGenSiemDestinationCompressionAlgorithm'
|
28351
|
+
level:
|
28352
|
+
description: Compression level.
|
28353
|
+
example: 6
|
28354
|
+
format: int64
|
28355
|
+
type: integer
|
28356
|
+
required:
|
28357
|
+
- algorithm
|
28358
|
+
type: object
|
28359
|
+
ObservabilityPipelineCrowdStrikeNextGenSiemDestinationCompressionAlgorithm:
|
28360
|
+
description: Compression algorithm for log events.
|
28361
|
+
enum:
|
28362
|
+
- gzip
|
28363
|
+
- zlib
|
28364
|
+
example: gzip
|
28365
|
+
type: string
|
28366
|
+
x-enum-varnames:
|
28367
|
+
- GZIP
|
28368
|
+
- ZLIB
|
28369
|
+
ObservabilityPipelineCrowdStrikeNextGenSiemDestinationEncoding:
|
28370
|
+
description: Encoding format for log events.
|
28371
|
+
enum:
|
28372
|
+
- json
|
28373
|
+
- raw_message
|
28374
|
+
example: json
|
28375
|
+
type: string
|
28376
|
+
x-enum-varnames:
|
28377
|
+
- JSON
|
28378
|
+
- RAW_MESSAGE
|
28379
|
+
ObservabilityPipelineCrowdStrikeNextGenSiemDestinationType:
|
28380
|
+
default: crowdstrike_next_gen_siem
|
28381
|
+
description: The destination type. The value should always be `crowdstrike_next_gen_siem`.
|
28382
|
+
enum:
|
28383
|
+
- crowdstrike_next_gen_siem
|
28384
|
+
example: crowdstrike_next_gen_siem
|
28385
|
+
type: string
|
28386
|
+
x-enum-varnames:
|
28387
|
+
- CROWDSTRIKE_NEXT_GEN_SIEM
|
28388
|
+
ObservabilityPipelineCustomProcessor:
|
28389
|
+
description: The `custom_processor` processor transforms events using [Vector
|
28390
|
+
Remap Language (VRL)](https://vector.dev/docs/reference/vrl/) scripts with
|
28391
|
+
advanced filtering capabilities.
|
28392
|
+
properties:
|
28393
|
+
id:
|
28394
|
+
description: The unique identifier for this processor.
|
28395
|
+
example: remap-vrl-processor
|
28396
|
+
type: string
|
28397
|
+
include:
|
28398
|
+
default: '*'
|
28399
|
+
description: A Datadog search query used to determine which logs this processor
|
28400
|
+
targets. This field should always be set to `*` for the custom_processor
|
28401
|
+
processor.
|
28402
|
+
example: '*'
|
28403
|
+
type: string
|
28404
|
+
inputs:
|
28405
|
+
description: A list of component IDs whose output is used as the input for
|
28406
|
+
this processor.
|
28407
|
+
example:
|
28408
|
+
- datadog-agent-source
|
28409
|
+
items:
|
28410
|
+
type: string
|
28411
|
+
type: array
|
28412
|
+
remaps:
|
28413
|
+
description: Array of VRL remap rules.
|
28414
|
+
items:
|
28415
|
+
$ref: '#/components/schemas/ObservabilityPipelineCustomProcessorRemap'
|
28416
|
+
minItems: 1
|
28417
|
+
type: array
|
28418
|
+
type:
|
28419
|
+
$ref: '#/components/schemas/ObservabilityPipelineCustomProcessorType'
|
28420
|
+
required:
|
28421
|
+
- id
|
28422
|
+
- type
|
28423
|
+
- include
|
28424
|
+
- remaps
|
28425
|
+
- inputs
|
28426
|
+
type: object
|
28427
|
+
ObservabilityPipelineCustomProcessorRemap:
|
28428
|
+
description: Defines a single VRL remap rule with its own filtering and transformation
|
28429
|
+
logic.
|
28430
|
+
properties:
|
28431
|
+
drop_on_error:
|
28432
|
+
description: Whether to drop events that caused errors during processing.
|
28433
|
+
example: false
|
28434
|
+
type: boolean
|
28435
|
+
enabled:
|
28436
|
+
description: Whether this remap rule is enabled.
|
28437
|
+
example: true
|
28438
|
+
type: boolean
|
28439
|
+
include:
|
28440
|
+
description: A Datadog search query used to filter events for this specific
|
28441
|
+
remap rule.
|
28442
|
+
example: service:web
|
28443
|
+
type: string
|
28444
|
+
name:
|
28445
|
+
description: A descriptive name for this remap rule.
|
28446
|
+
example: Parse JSON from message field
|
28447
|
+
type: string
|
28448
|
+
source:
|
28449
|
+
description: The VRL script source code that defines the processing logic.
|
28450
|
+
example: . = parse_json!(.message)
|
28451
|
+
type: string
|
28452
|
+
required:
|
28453
|
+
- include
|
28454
|
+
- name
|
28455
|
+
- source
|
28456
|
+
- enabled
|
28457
|
+
- drop_on_error
|
28458
|
+
type: object
|
28459
|
+
ObservabilityPipelineCustomProcessorType:
|
28460
|
+
default: custom_processor
|
28461
|
+
description: The processor type. The value should always be `custom_processor`.
|
28462
|
+
enum:
|
28463
|
+
- custom_processor
|
28464
|
+
example: custom_processor
|
28465
|
+
type: string
|
28466
|
+
x-enum-varnames:
|
28467
|
+
- CUSTOM_PROCESSOR
|
26962
28468
|
ObservabilityPipelineData:
|
26963
28469
|
description: "Contains the pipeline\u2019s ID, type, and configuration attributes."
|
26964
28470
|
properties:
|
@@ -27050,6 +28556,80 @@ components:
|
|
27050
28556
|
type: string
|
27051
28557
|
x-enum-varnames:
|
27052
28558
|
- DATADOG_LOGS
|
28559
|
+
ObservabilityPipelineDatadogTagsProcessor:
|
28560
|
+
description: The `datadog_tags` processor includes or excludes specific Datadog
|
28561
|
+
tags in your logs.
|
28562
|
+
properties:
|
28563
|
+
action:
|
28564
|
+
$ref: '#/components/schemas/ObservabilityPipelineDatadogTagsProcessorAction'
|
28565
|
+
id:
|
28566
|
+
description: The unique identifier for this component. Used to reference
|
28567
|
+
this component in other parts of the pipeline (for example, as the `input`
|
28568
|
+
to downstream components).
|
28569
|
+
example: datadog-tags-processor
|
28570
|
+
type: string
|
28571
|
+
include:
|
28572
|
+
description: A Datadog search query used to determine which logs this processor
|
28573
|
+
targets.
|
28574
|
+
example: service:my-service
|
28575
|
+
type: string
|
28576
|
+
inputs:
|
28577
|
+
description: A list of component IDs whose output is used as the `input`
|
28578
|
+
for this component.
|
28579
|
+
example:
|
28580
|
+
- datadog-agent-source
|
28581
|
+
items:
|
28582
|
+
type: string
|
28583
|
+
type: array
|
28584
|
+
keys:
|
28585
|
+
description: A list of tag keys.
|
28586
|
+
example:
|
28587
|
+
- env
|
28588
|
+
- service
|
28589
|
+
- version
|
28590
|
+
items:
|
28591
|
+
type: string
|
28592
|
+
type: array
|
28593
|
+
mode:
|
28594
|
+
$ref: '#/components/schemas/ObservabilityPipelineDatadogTagsProcessorMode'
|
28595
|
+
type:
|
28596
|
+
$ref: '#/components/schemas/ObservabilityPipelineDatadogTagsProcessorType'
|
28597
|
+
required:
|
28598
|
+
- id
|
28599
|
+
- type
|
28600
|
+
- include
|
28601
|
+
- mode
|
28602
|
+
- action
|
28603
|
+
- keys
|
28604
|
+
- inputs
|
28605
|
+
type: object
|
28606
|
+
ObservabilityPipelineDatadogTagsProcessorAction:
|
28607
|
+
description: The action to take on tags with matching keys.
|
28608
|
+
enum:
|
28609
|
+
- include
|
28610
|
+
- exclude
|
28611
|
+
example: include
|
28612
|
+
type: string
|
28613
|
+
x-enum-varnames:
|
28614
|
+
- INCLUDE
|
28615
|
+
- EXCLUDE
|
28616
|
+
ObservabilityPipelineDatadogTagsProcessorMode:
|
28617
|
+
description: The processing mode.
|
28618
|
+
enum:
|
28619
|
+
- filter
|
28620
|
+
example: filter
|
28621
|
+
type: string
|
28622
|
+
x-enum-varnames:
|
28623
|
+
- FILTER
|
28624
|
+
ObservabilityPipelineDatadogTagsProcessorType:
|
28625
|
+
default: datadog_tags
|
28626
|
+
description: The processor type. The value should always be `datadog_tags`.
|
28627
|
+
enum:
|
28628
|
+
- datadog_tags
|
28629
|
+
example: datadog_tags
|
28630
|
+
type: string
|
28631
|
+
x-enum-varnames:
|
28632
|
+
- DATADOG_TAGS
|
27053
28633
|
ObservabilityPipelineDecoding:
|
27054
28634
|
description: The decoding format used to interpret incoming logs.
|
27055
28635
|
enum:
|
@@ -29241,6 +30821,278 @@ components:
|
|
29241
30821
|
type: string
|
29242
30822
|
x-enum-varnames:
|
29243
30823
|
- SENTINEL_ONE
|
30824
|
+
ObservabilityPipelineSocketDestination:
|
30825
|
+
description: 'The `socket` destination sends logs over TCP or UDP to a remote
|
30826
|
+
server.
|
30827
|
+
|
30828
|
+
'
|
30829
|
+
properties:
|
30830
|
+
encoding:
|
30831
|
+
$ref: '#/components/schemas/ObservabilityPipelineSocketDestinationEncoding'
|
30832
|
+
framing:
|
30833
|
+
$ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFraming'
|
30834
|
+
id:
|
30835
|
+
description: The unique identifier for this component.
|
30836
|
+
example: socket-destination
|
30837
|
+
type: string
|
30838
|
+
inputs:
|
30839
|
+
description: A list of component IDs whose output is used as the `input`
|
30840
|
+
for this component.
|
30841
|
+
example:
|
30842
|
+
- filter-processor
|
30843
|
+
items:
|
30844
|
+
type: string
|
30845
|
+
type: array
|
30846
|
+
mode:
|
30847
|
+
$ref: '#/components/schemas/ObservabilityPipelineSocketDestinationMode'
|
30848
|
+
tls:
|
30849
|
+
$ref: '#/components/schemas/ObservabilityPipelineTls'
|
30850
|
+
description: TLS configuration. Relevant only when `mode` is `tcp`.
|
30851
|
+
type:
|
30852
|
+
$ref: '#/components/schemas/ObservabilityPipelineSocketDestinationType'
|
30853
|
+
required:
|
30854
|
+
- id
|
30855
|
+
- type
|
30856
|
+
- inputs
|
30857
|
+
- encoding
|
30858
|
+
- framing
|
30859
|
+
- mode
|
30860
|
+
type: object
|
30861
|
+
ObservabilityPipelineSocketDestinationEncoding:
|
30862
|
+
description: Encoding format for log events.
|
30863
|
+
enum:
|
30864
|
+
- json
|
30865
|
+
- raw_message
|
30866
|
+
example: json
|
30867
|
+
type: string
|
30868
|
+
x-enum-varnames:
|
30869
|
+
- JSON
|
30870
|
+
- RAW_MESSAGE
|
30871
|
+
ObservabilityPipelineSocketDestinationFraming:
|
30872
|
+
description: Framing method configuration.
|
30873
|
+
oneOf:
|
30874
|
+
- $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingNewlineDelimited'
|
30875
|
+
- $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingBytes'
|
30876
|
+
- $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingCharacterDelimited'
|
30877
|
+
ObservabilityPipelineSocketDestinationFramingBytes:
|
30878
|
+
description: Event data is not delimited at all.
|
30879
|
+
properties:
|
30880
|
+
method:
|
30881
|
+
$ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingBytesMethod'
|
30882
|
+
required:
|
30883
|
+
- method
|
30884
|
+
type: object
|
30885
|
+
ObservabilityPipelineSocketDestinationFramingBytesMethod:
|
30886
|
+
description: The definition of `ObservabilityPipelineSocketDestinationFramingBytesMethod`
|
30887
|
+
object.
|
30888
|
+
enum:
|
30889
|
+
- bytes
|
30890
|
+
example: bytes
|
30891
|
+
type: string
|
30892
|
+
x-enum-varnames:
|
30893
|
+
- BYTES
|
30894
|
+
ObservabilityPipelineSocketDestinationFramingCharacterDelimited:
|
30895
|
+
description: Each log event is separated using the specified delimiter character.
|
30896
|
+
properties:
|
30897
|
+
delimiter:
|
30898
|
+
description: A single ASCII character used as a delimiter.
|
30899
|
+
example: '|'
|
30900
|
+
maxLength: 1
|
30901
|
+
minLength: 1
|
30902
|
+
type: string
|
30903
|
+
method:
|
30904
|
+
$ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod'
|
30905
|
+
required:
|
30906
|
+
- method
|
30907
|
+
- delimiter
|
30908
|
+
type: object
|
30909
|
+
ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod:
|
30910
|
+
description: The definition of `ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod`
|
30911
|
+
object.
|
30912
|
+
enum:
|
30913
|
+
- character_delimited
|
30914
|
+
example: character_delimited
|
30915
|
+
type: string
|
30916
|
+
x-enum-varnames:
|
30917
|
+
- CHARACTER_DELIMITED
|
30918
|
+
ObservabilityPipelineSocketDestinationFramingNewlineDelimited:
|
30919
|
+
description: Each log event is delimited by a newline character.
|
30920
|
+
properties:
|
30921
|
+
method:
|
30922
|
+
$ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod'
|
30923
|
+
required:
|
30924
|
+
- method
|
30925
|
+
type: object
|
30926
|
+
ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod:
|
30927
|
+
description: The definition of `ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod`
|
30928
|
+
object.
|
30929
|
+
enum:
|
30930
|
+
- newline_delimited
|
30931
|
+
example: newline_delimited
|
30932
|
+
type: string
|
30933
|
+
x-enum-varnames:
|
30934
|
+
- NEWLINE_DELIMITED
|
30935
|
+
ObservabilityPipelineSocketDestinationMode:
|
30936
|
+
description: Protocol used to send logs.
|
30937
|
+
enum:
|
30938
|
+
- tcp
|
30939
|
+
- udp
|
30940
|
+
example: tcp
|
30941
|
+
type: string
|
30942
|
+
x-enum-varnames:
|
30943
|
+
- TCP
|
30944
|
+
- UDP
|
30945
|
+
ObservabilityPipelineSocketDestinationType:
|
30946
|
+
default: socket
|
30947
|
+
description: The destination type. The value should always be `socket`.
|
30948
|
+
enum:
|
30949
|
+
- socket
|
30950
|
+
example: socket
|
30951
|
+
type: string
|
30952
|
+
x-enum-varnames:
|
30953
|
+
- SOCKET
|
30954
|
+
ObservabilityPipelineSocketSource:
|
30955
|
+
description: 'The `socket` source ingests logs over TCP or UDP.
|
30956
|
+
|
30957
|
+
'
|
30958
|
+
properties:
|
30959
|
+
framing:
|
30960
|
+
$ref: '#/components/schemas/ObservabilityPipelineSocketSourceFraming'
|
30961
|
+
id:
|
30962
|
+
description: The unique identifier for this component. Used to reference
|
30963
|
+
this component in other parts of the pipeline (e.g., as input to downstream
|
30964
|
+
components).
|
30965
|
+
example: socket-source
|
30966
|
+
type: string
|
30967
|
+
mode:
|
30968
|
+
$ref: '#/components/schemas/ObservabilityPipelineSocketSourceMode'
|
30969
|
+
tls:
|
30970
|
+
$ref: '#/components/schemas/ObservabilityPipelineTls'
|
30971
|
+
description: TLS configuration. Relevant only when `mode` is `tcp`.
|
30972
|
+
type:
|
30973
|
+
$ref: '#/components/schemas/ObservabilityPipelineSocketSourceType'
|
30974
|
+
required:
|
30975
|
+
- id
|
30976
|
+
- type
|
30977
|
+
- mode
|
30978
|
+
- framing
|
30979
|
+
type: object
|
30980
|
+
ObservabilityPipelineSocketSourceFraming:
|
30981
|
+
description: Framing method configuration for the socket source.
|
30982
|
+
oneOf:
|
30983
|
+
- $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingNewlineDelimited'
|
30984
|
+
- $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingBytes'
|
30985
|
+
- $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingCharacterDelimited'
|
30986
|
+
- $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingOctetCounting'
|
30987
|
+
- $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingChunkedGelf'
|
30988
|
+
ObservabilityPipelineSocketSourceFramingBytes:
|
30989
|
+
description: Byte frames are passed through as-is according to the underlying
|
30990
|
+
I/O boundaries (for example, split between messages or stream segments).
|
30991
|
+
properties:
|
30992
|
+
method:
|
30993
|
+
$ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingBytesMethod'
|
30994
|
+
required:
|
30995
|
+
- method
|
30996
|
+
type: object
|
30997
|
+
ObservabilityPipelineSocketSourceFramingBytesMethod:
|
30998
|
+
description: Byte frames are passed through as-is according to the underlying
|
30999
|
+
I/O boundaries (for example, split between messages or stream segments).
|
31000
|
+
enum:
|
31001
|
+
- bytes
|
31002
|
+
example: bytes
|
31003
|
+
type: string
|
31004
|
+
x-enum-varnames:
|
31005
|
+
- BYTES
|
31006
|
+
ObservabilityPipelineSocketSourceFramingCharacterDelimited:
|
31007
|
+
description: Byte frames which are delimited by a chosen character.
|
31008
|
+
properties:
|
31009
|
+
delimiter:
|
31010
|
+
description: A single ASCII character used to delimit events.
|
31011
|
+
example: '|'
|
31012
|
+
maxLength: 1
|
31013
|
+
minLength: 1
|
31014
|
+
type: string
|
31015
|
+
method:
|
31016
|
+
$ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingCharacterDelimitedMethod'
|
31017
|
+
required:
|
31018
|
+
- method
|
31019
|
+
- delimiter
|
31020
|
+
type: object
|
31021
|
+
ObservabilityPipelineSocketSourceFramingCharacterDelimitedMethod:
|
31022
|
+
description: Byte frames which are delimited by a chosen character.
|
31023
|
+
enum:
|
31024
|
+
- character_delimited
|
31025
|
+
example: character_delimited
|
31026
|
+
type: string
|
31027
|
+
x-enum-varnames:
|
31028
|
+
- CHARACTER_DELIMITED
|
31029
|
+
ObservabilityPipelineSocketSourceFramingChunkedGelf:
|
31030
|
+
description: Byte frames which are chunked GELF messages.
|
31031
|
+
properties:
|
31032
|
+
method:
|
31033
|
+
$ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingChunkedGelfMethod'
|
31034
|
+
required:
|
31035
|
+
- method
|
31036
|
+
type: object
|
31037
|
+
ObservabilityPipelineSocketSourceFramingChunkedGelfMethod:
|
31038
|
+
description: Byte frames which are chunked GELF messages.
|
31039
|
+
enum:
|
31040
|
+
- chunked_gelf
|
31041
|
+
example: chunked_gelf
|
31042
|
+
type: string
|
31043
|
+
x-enum-varnames:
|
31044
|
+
- CHUNKED_GELF
|
31045
|
+
ObservabilityPipelineSocketSourceFramingNewlineDelimited:
|
31046
|
+
description: Byte frames which are delimited by a newline character.
|
31047
|
+
properties:
|
31048
|
+
method:
|
31049
|
+
$ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingNewlineDelimitedMethod'
|
31050
|
+
required:
|
31051
|
+
- method
|
31052
|
+
type: object
|
31053
|
+
ObservabilityPipelineSocketSourceFramingNewlineDelimitedMethod:
|
31054
|
+
description: Byte frames which are delimited by a newline character.
|
31055
|
+
enum:
|
31056
|
+
- newline_delimited
|
31057
|
+
example: newline_delimited
|
31058
|
+
type: string
|
31059
|
+
x-enum-varnames:
|
31060
|
+
- NEWLINE_DELIMITED
|
31061
|
+
ObservabilityPipelineSocketSourceFramingOctetCounting:
|
31062
|
+
description: Byte frames according to the octet counting format as per RFC6587.
|
31063
|
+
properties:
|
31064
|
+
method:
|
31065
|
+
$ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingOctetCountingMethod'
|
31066
|
+
required:
|
31067
|
+
- method
|
31068
|
+
type: object
|
31069
|
+
ObservabilityPipelineSocketSourceFramingOctetCountingMethod:
|
31070
|
+
description: Byte frames according to the octet counting format as per RFC6587.
|
31071
|
+
enum:
|
31072
|
+
- octet_counting
|
31073
|
+
example: octet_counting
|
31074
|
+
type: string
|
31075
|
+
x-enum-varnames:
|
31076
|
+
- OCTET_COUNTING
|
31077
|
+
ObservabilityPipelineSocketSourceMode:
|
31078
|
+
description: Protocol used to receive logs.
|
31079
|
+
enum:
|
31080
|
+
- tcp
|
31081
|
+
- udp
|
31082
|
+
example: tcp
|
31083
|
+
type: string
|
31084
|
+
x-enum-varnames:
|
31085
|
+
- TCP
|
31086
|
+
- UDP
|
31087
|
+
ObservabilityPipelineSocketSourceType:
|
31088
|
+
default: socket
|
31089
|
+
description: The source type. The value should always be `socket`.
|
31090
|
+
enum:
|
31091
|
+
- socket
|
31092
|
+
example: socket
|
31093
|
+
type: string
|
31094
|
+
x-enum-varnames:
|
31095
|
+
- SOCKET
|
29244
31096
|
ObservabilityPipelineSpec:
|
29245
31097
|
description: Input schema representing an observability pipeline configuration.
|
29246
31098
|
Used in create and validate requests.
|
@@ -30275,6 +32127,255 @@ components:
|
|
30275
32127
|
required:
|
30276
32128
|
- data
|
30277
32129
|
type: object
|
32130
|
+
OrgConnection:
|
32131
|
+
description: An org connection.
|
32132
|
+
properties:
|
32133
|
+
attributes:
|
32134
|
+
$ref: '#/components/schemas/OrgConnectionAttributes'
|
32135
|
+
id:
|
32136
|
+
description: The unique identifier of the org connection.
|
32137
|
+
example: f9ec96b0-8c8a-4b0a-9b0a-1b2c3d4e5f6a
|
32138
|
+
format: uuid
|
32139
|
+
type: string
|
32140
|
+
relationships:
|
32141
|
+
$ref: '#/components/schemas/OrgConnectionRelationships'
|
32142
|
+
type:
|
32143
|
+
$ref: '#/components/schemas/OrgConnectionType'
|
32144
|
+
required:
|
32145
|
+
- id
|
32146
|
+
- type
|
32147
|
+
- attributes
|
32148
|
+
- relationships
|
32149
|
+
type: object
|
32150
|
+
OrgConnectionAttributes:
|
32151
|
+
description: Org connection attributes.
|
32152
|
+
properties:
|
32153
|
+
connection_types:
|
32154
|
+
description: List of connection types.
|
32155
|
+
example:
|
32156
|
+
- logs
|
32157
|
+
- metrics
|
32158
|
+
items:
|
32159
|
+
$ref: '#/components/schemas/OrgConnectionTypeEnum'
|
32160
|
+
type: array
|
32161
|
+
created_at:
|
32162
|
+
description: Timestamp when the connection was created.
|
32163
|
+
example: '2023-01-01T12:00:00Z'
|
32164
|
+
format: date-time
|
32165
|
+
type: string
|
32166
|
+
required:
|
32167
|
+
- connection_types
|
32168
|
+
- created_at
|
32169
|
+
type: object
|
32170
|
+
OrgConnectionCreate:
|
32171
|
+
description: Org connection creation data.
|
32172
|
+
properties:
|
32173
|
+
attributes:
|
32174
|
+
$ref: '#/components/schemas/OrgConnectionCreateAttributes'
|
32175
|
+
relationships:
|
32176
|
+
$ref: '#/components/schemas/OrgConnectionCreateRelationships'
|
32177
|
+
type:
|
32178
|
+
$ref: '#/components/schemas/OrgConnectionType'
|
32179
|
+
required:
|
32180
|
+
- type
|
32181
|
+
- attributes
|
32182
|
+
- relationships
|
32183
|
+
type: object
|
32184
|
+
OrgConnectionCreateAttributes:
|
32185
|
+
description: Attributes for creating an org connection.
|
32186
|
+
properties:
|
32187
|
+
connection_types:
|
32188
|
+
description: List of connection types to establish.
|
32189
|
+
example:
|
32190
|
+
- logs
|
32191
|
+
items:
|
32192
|
+
$ref: '#/components/schemas/OrgConnectionTypeEnum'
|
32193
|
+
minItems: 1
|
32194
|
+
type: array
|
32195
|
+
required:
|
32196
|
+
- connection_types
|
32197
|
+
type: object
|
32198
|
+
OrgConnectionCreateRelationships:
|
32199
|
+
description: Relationships for org connection creation.
|
32200
|
+
properties:
|
32201
|
+
sink_org:
|
32202
|
+
$ref: '#/components/schemas/OrgConnectionOrgRelationship'
|
32203
|
+
required:
|
32204
|
+
- sink_org
|
32205
|
+
type: object
|
32206
|
+
OrgConnectionCreateRequest:
|
32207
|
+
description: Request to create an org connection.
|
32208
|
+
properties:
|
32209
|
+
data:
|
32210
|
+
$ref: '#/components/schemas/OrgConnectionCreate'
|
32211
|
+
required:
|
32212
|
+
- data
|
32213
|
+
type: object
|
32214
|
+
OrgConnectionListResponse:
|
32215
|
+
description: Response containing a list of org connections.
|
32216
|
+
properties:
|
32217
|
+
data:
|
32218
|
+
description: List of org connections.
|
32219
|
+
items:
|
32220
|
+
$ref: '#/components/schemas/OrgConnection'
|
32221
|
+
type: array
|
32222
|
+
meta:
|
32223
|
+
$ref: '#/components/schemas/OrgConnectionListResponseMeta'
|
32224
|
+
required:
|
32225
|
+
- data
|
32226
|
+
type: object
|
32227
|
+
OrgConnectionListResponseMeta:
|
32228
|
+
description: Pagination metadata.
|
32229
|
+
properties:
|
32230
|
+
page:
|
32231
|
+
$ref: '#/components/schemas/OrgConnectionListResponseMetaPage'
|
32232
|
+
type: object
|
32233
|
+
OrgConnectionListResponseMetaPage:
|
32234
|
+
description: Page information.
|
32235
|
+
properties:
|
32236
|
+
total_count:
|
32237
|
+
description: Total number of org connections.
|
32238
|
+
example: 0
|
32239
|
+
format: int64
|
32240
|
+
type: integer
|
32241
|
+
total_filtered_count:
|
32242
|
+
description: Total number of org connections matching the filter.
|
32243
|
+
example: 0
|
32244
|
+
format: int64
|
32245
|
+
type: integer
|
32246
|
+
type: object
|
32247
|
+
OrgConnectionOrgRelationship:
|
32248
|
+
description: Org relationship.
|
32249
|
+
properties:
|
32250
|
+
data:
|
32251
|
+
$ref: '#/components/schemas/OrgConnectionOrgRelationshipData'
|
32252
|
+
type: object
|
32253
|
+
OrgConnectionOrgRelationshipData:
|
32254
|
+
description: The definition of `OrgConnectionOrgRelationshipData` object.
|
32255
|
+
properties:
|
32256
|
+
id:
|
32257
|
+
description: Org UUID.
|
32258
|
+
example: f9ec96b0-8c8a-4b0a-9b0a-1b2c3d4e5f6a
|
32259
|
+
type: string
|
32260
|
+
name:
|
32261
|
+
description: Org name.
|
32262
|
+
example: Example Org
|
32263
|
+
type: string
|
32264
|
+
type:
|
32265
|
+
$ref: '#/components/schemas/OrgConnectionOrgRelationshipDataType'
|
32266
|
+
type: object
|
32267
|
+
OrgConnectionOrgRelationshipDataType:
|
32268
|
+
description: The type of the organization relationship.
|
32269
|
+
enum:
|
32270
|
+
- orgs
|
32271
|
+
example: orgs
|
32272
|
+
type: string
|
32273
|
+
x-enum-varnames:
|
32274
|
+
- ORGS
|
32275
|
+
OrgConnectionRelationships:
|
32276
|
+
description: Related organizations and user.
|
32277
|
+
properties:
|
32278
|
+
created_by:
|
32279
|
+
$ref: '#/components/schemas/OrgConnectionUserRelationship'
|
32280
|
+
sink_org:
|
32281
|
+
$ref: '#/components/schemas/OrgConnectionOrgRelationship'
|
32282
|
+
source_org:
|
32283
|
+
$ref: '#/components/schemas/OrgConnectionOrgRelationship'
|
32284
|
+
type: object
|
32285
|
+
OrgConnectionResponse:
|
32286
|
+
description: Response containing a single org connection.
|
32287
|
+
properties:
|
32288
|
+
data:
|
32289
|
+
$ref: '#/components/schemas/OrgConnection'
|
32290
|
+
required:
|
32291
|
+
- data
|
32292
|
+
type: object
|
32293
|
+
OrgConnectionType:
|
32294
|
+
description: Org connection type.
|
32295
|
+
enum:
|
32296
|
+
- org_connection
|
32297
|
+
example: org_connection
|
32298
|
+
type: string
|
32299
|
+
x-enum-varnames:
|
32300
|
+
- ORG_CONNECTION
|
32301
|
+
OrgConnectionTypeEnum:
|
32302
|
+
description: Available connection types between organizations.
|
32303
|
+
enum:
|
32304
|
+
- logs
|
32305
|
+
- metrics
|
32306
|
+
example: logs
|
32307
|
+
type: string
|
32308
|
+
x-enum-varnames:
|
32309
|
+
- LOGS
|
32310
|
+
- METRICS
|
32311
|
+
OrgConnectionUpdate:
|
32312
|
+
description: Org connection update data.
|
32313
|
+
properties:
|
32314
|
+
attributes:
|
32315
|
+
$ref: '#/components/schemas/OrgConnectionUpdateAttributes'
|
32316
|
+
id:
|
32317
|
+
description: The unique identifier of the org connection.
|
32318
|
+
example: f9ec96b0-8c8a-4b0a-9b0a-1b2c3d4e5f6a
|
32319
|
+
format: uuid
|
32320
|
+
type: string
|
32321
|
+
type:
|
32322
|
+
$ref: '#/components/schemas/OrgConnectionType'
|
32323
|
+
required:
|
32324
|
+
- type
|
32325
|
+
- id
|
32326
|
+
- attributes
|
32327
|
+
type: object
|
32328
|
+
OrgConnectionUpdateAttributes:
|
32329
|
+
description: Attributes for updating an org connection.
|
32330
|
+
properties:
|
32331
|
+
connection_types:
|
32332
|
+
description: Updated list of connection types.
|
32333
|
+
example:
|
32334
|
+
- logs
|
32335
|
+
- metrics
|
32336
|
+
items:
|
32337
|
+
$ref: '#/components/schemas/OrgConnectionTypeEnum'
|
32338
|
+
minItems: 1
|
32339
|
+
type: array
|
32340
|
+
required:
|
32341
|
+
- connection_types
|
32342
|
+
type: object
|
32343
|
+
OrgConnectionUpdateRequest:
|
32344
|
+
description: Request to update an org connection.
|
32345
|
+
properties:
|
32346
|
+
data:
|
32347
|
+
$ref: '#/components/schemas/OrgConnectionUpdate'
|
32348
|
+
required:
|
32349
|
+
- data
|
32350
|
+
type: object
|
32351
|
+
OrgConnectionUserRelationship:
|
32352
|
+
description: User relationship.
|
32353
|
+
properties:
|
32354
|
+
data:
|
32355
|
+
$ref: '#/components/schemas/OrgConnectionUserRelationshipData'
|
32356
|
+
type: object
|
32357
|
+
OrgConnectionUserRelationshipData:
|
32358
|
+
description: The data for a user relationship.
|
32359
|
+
properties:
|
32360
|
+
id:
|
32361
|
+
description: User UUID.
|
32362
|
+
example: usr123abc456
|
32363
|
+
type: string
|
32364
|
+
name:
|
32365
|
+
description: User name.
|
32366
|
+
example: John Doe
|
32367
|
+
type: string
|
32368
|
+
type:
|
32369
|
+
$ref: '#/components/schemas/OrgConnectionUserRelationshipDataType'
|
32370
|
+
type: object
|
32371
|
+
OrgConnectionUserRelationshipDataType:
|
32372
|
+
description: The type of the user relationship.
|
32373
|
+
enum:
|
32374
|
+
- users
|
32375
|
+
example: users
|
32376
|
+
type: string
|
32377
|
+
x-enum-varnames:
|
32378
|
+
- USERS
|
30278
32379
|
Organization:
|
30279
32380
|
description: Organization object.
|
30280
32381
|
properties:
|
@@ -30710,6 +32811,14 @@ components:
|
|
30710
32811
|
$ref: '#/components/schemas/ApplicationKeyResponseIncludedItem'
|
30711
32812
|
type: array
|
30712
32813
|
type: object
|
32814
|
+
PatchIncidentNotificationTemplateRequest:
|
32815
|
+
description: Update request for a notification template.
|
32816
|
+
properties:
|
32817
|
+
data:
|
32818
|
+
$ref: '#/components/schemas/IncidentNotificationTemplateUpdateData'
|
32819
|
+
required:
|
32820
|
+
- data
|
32821
|
+
type: object
|
30713
32822
|
PatchNotificationRuleParameters:
|
30714
32823
|
description: Body of the notification rule patch request.
|
30715
32824
|
properties:
|
@@ -31604,6 +33713,8 @@ components:
|
|
31604
33713
|
format: int32
|
31605
33714
|
maximum: 2147483647
|
31606
33715
|
type: integer
|
33716
|
+
product_scales:
|
33717
|
+
$ref: '#/components/schemas/RUMProductScales'
|
31607
33718
|
type:
|
31608
33719
|
description: Type of the RUM application. Supported values are `browser`,
|
31609
33720
|
`ios`, `android`, `react-native`, `flutter`, `roku`, `electron`, `unity`,
|
@@ -31648,6 +33759,10 @@ components:
|
|
31648
33759
|
description: Name of the RUM application.
|
31649
33760
|
example: my_new_rum_application
|
31650
33761
|
type: string
|
33762
|
+
product_analytics_retention_state:
|
33763
|
+
$ref: '#/components/schemas/RUMProductAnalyticsRetentionState'
|
33764
|
+
rum_event_processing_state:
|
33765
|
+
$ref: '#/components/schemas/RUMEventProcessingState'
|
31651
33766
|
type:
|
31652
33767
|
description: Type of the RUM application. Supported values are `browser`,
|
31653
33768
|
`ios`, `android`, `react-native`, `flutter`, `roku`, `electron`, `unity`,
|
@@ -31722,6 +33837,8 @@ components:
|
|
31722
33837
|
format: int32
|
31723
33838
|
maximum: 2147483647
|
31724
33839
|
type: integer
|
33840
|
+
product_scales:
|
33841
|
+
$ref: '#/components/schemas/RUMProductScales'
|
31725
33842
|
type:
|
31726
33843
|
description: Type of the RUM application. Supported values are `browser`,
|
31727
33844
|
`ios`, `android`, `react-native`, `flutter`, `roku`, `electron`, `unity`,
|
@@ -31793,6 +33910,10 @@ components:
|
|
31793
33910
|
description: Name of the RUM application.
|
31794
33911
|
example: updated_name_for_my_existing_rum_application
|
31795
33912
|
type: string
|
33913
|
+
product_analytics_retention_state:
|
33914
|
+
$ref: '#/components/schemas/RUMProductAnalyticsRetentionState'
|
33915
|
+
rum_event_processing_state:
|
33916
|
+
$ref: '#/components/schemas/RUMEventProcessingState'
|
31796
33917
|
type:
|
31797
33918
|
description: Type of the RUM application. Supported values are `browser`,
|
31798
33919
|
`ios`, `android`, `react-native`, `flutter`, `roku`, `electron`, `unity`,
|
@@ -31921,6 +34042,33 @@ components:
|
|
31921
34042
|
format: date-time
|
31922
34043
|
type: string
|
31923
34044
|
type: object
|
34045
|
+
RUMEventProcessingScale:
|
34046
|
+
description: RUM event processing scale configuration.
|
34047
|
+
properties:
|
34048
|
+
last_modified_at:
|
34049
|
+
description: Timestamp in milliseconds when this scale was last modified.
|
34050
|
+
example: 1721897494108
|
34051
|
+
format: int64
|
34052
|
+
type: integer
|
34053
|
+
state:
|
34054
|
+
$ref: '#/components/schemas/RUMEventProcessingState'
|
34055
|
+
type: object
|
34056
|
+
RUMEventProcessingState:
|
34057
|
+
description: Configures which RUM events are processed and stored for the application.
|
34058
|
+
enum:
|
34059
|
+
- ALL
|
34060
|
+
- ERROR_FOCUSED_MODE
|
34061
|
+
- NONE
|
34062
|
+
example: ALL
|
34063
|
+
type: string
|
34064
|
+
x-enum-descriptions:
|
34065
|
+
- Process and store all RUM events (sessions, views, actions, resources, errors)
|
34066
|
+
- Process and store only error events and related critical events
|
34067
|
+
- "Disable RUM event processing\u2014no events are stored"
|
34068
|
+
x-enum-varnames:
|
34069
|
+
- ALL
|
34070
|
+
- ERROR_FOCUSED_MODE
|
34071
|
+
- NONE
|
31924
34072
|
RUMEventType:
|
31925
34073
|
default: rum
|
31926
34074
|
description: Type of the event.
|
@@ -32027,6 +34175,39 @@ components:
|
|
32027
34175
|
RUMGroupByTotalString:
|
32028
34176
|
description: A string to use as the key value for the total bucket.
|
32029
34177
|
type: string
|
34178
|
+
RUMProductAnalyticsRetentionScale:
|
34179
|
+
description: Product Analytics retention scale configuration.
|
34180
|
+
properties:
|
34181
|
+
last_modified_at:
|
34182
|
+
description: Timestamp in milliseconds when this scale was last modified.
|
34183
|
+
example: 1747922145974
|
34184
|
+
format: int64
|
34185
|
+
type: integer
|
34186
|
+
state:
|
34187
|
+
$ref: '#/components/schemas/RUMProductAnalyticsRetentionState'
|
34188
|
+
type: object
|
34189
|
+
RUMProductAnalyticsRetentionState:
|
34190
|
+
description: Controls the retention policy for Product Analytics data derived
|
34191
|
+
from RUM events.
|
34192
|
+
enum:
|
34193
|
+
- MAX
|
34194
|
+
- NONE
|
34195
|
+
example: MAX
|
34196
|
+
type: string
|
34197
|
+
x-enum-descriptions:
|
34198
|
+
- Store Product Analytics data for the maximum available retention period
|
34199
|
+
- Do not store Product Analytics data
|
34200
|
+
x-enum-varnames:
|
34201
|
+
- MAX
|
34202
|
+
- NONE
|
34203
|
+
RUMProductScales:
|
34204
|
+
description: Product Scales configuration for the RUM application.
|
34205
|
+
properties:
|
34206
|
+
product_analytics_retention_scale:
|
34207
|
+
$ref: '#/components/schemas/RUMProductAnalyticsRetentionScale'
|
34208
|
+
rum_event_processing_scale:
|
34209
|
+
$ref: '#/components/schemas/RUMEventProcessingScale'
|
34210
|
+
type: object
|
32030
34211
|
RUMQueryFilter:
|
32031
34212
|
description: The search and filter query settings.
|
32032
34213
|
properties:
|
@@ -32207,6 +34388,52 @@ components:
|
|
32207
34388
|
x-enum-varnames:
|
32208
34389
|
- ANY
|
32209
34390
|
- ALL
|
34391
|
+
RecommendationAttributes:
|
34392
|
+
description: Attributes of the SPA Recommendation resource. Contains recommendations
|
34393
|
+
for both driver and executor components.
|
34394
|
+
properties:
|
34395
|
+
driver:
|
34396
|
+
$ref: '#/components/schemas/ComponentRecommendation'
|
34397
|
+
executor:
|
34398
|
+
$ref: '#/components/schemas/ComponentRecommendation'
|
34399
|
+
required:
|
34400
|
+
- driver
|
34401
|
+
- executor
|
34402
|
+
type: object
|
34403
|
+
RecommendationData:
|
34404
|
+
description: JSON:API resource object for SPA Recommendation. Includes type,
|
34405
|
+
optional ID, and resource attributes with structured recommendations.
|
34406
|
+
properties:
|
34407
|
+
attributes:
|
34408
|
+
$ref: '#/components/schemas/RecommendationAttributes'
|
34409
|
+
id:
|
34410
|
+
description: Resource identifier for the recommendation. Optional in responses.
|
34411
|
+
type: string
|
34412
|
+
type:
|
34413
|
+
$ref: '#/components/schemas/RecommendationType'
|
34414
|
+
required:
|
34415
|
+
- type
|
34416
|
+
- attributes
|
34417
|
+
type: object
|
34418
|
+
RecommendationDocument:
|
34419
|
+
description: JSON:API document containing a single Recommendation resource.
|
34420
|
+
Returned by SPA when the Spark Gateway requests recommendations.
|
34421
|
+
properties:
|
34422
|
+
data:
|
34423
|
+
$ref: '#/components/schemas/RecommendationData'
|
34424
|
+
required:
|
34425
|
+
- data
|
34426
|
+
type: object
|
34427
|
+
RecommendationType:
|
34428
|
+
default: recommendation
|
34429
|
+
description: JSON:API resource type for Spark Pod Autosizing recommendations.
|
34430
|
+
Identifies the Recommendation resource returned by SPA.
|
34431
|
+
enum:
|
34432
|
+
- recommendation
|
34433
|
+
example: recommendation
|
34434
|
+
type: string
|
34435
|
+
x-enum-varnames:
|
34436
|
+
- RECOMMENDATION
|
32210
34437
|
RegisterAppKeyResponse:
|
32211
34438
|
description: The response object after creating an app key registration.
|
32212
34439
|
properties:
|
@@ -32499,6 +34726,27 @@ components:
|
|
32499
34726
|
required:
|
32500
34727
|
- data
|
32501
34728
|
type: object
|
34729
|
+
RelationshipToIncidentType:
|
34730
|
+
description: Relationship to an incident type.
|
34731
|
+
properties:
|
34732
|
+
data:
|
34733
|
+
$ref: '#/components/schemas/RelationshipToIncidentTypeData'
|
34734
|
+
required:
|
34735
|
+
- data
|
34736
|
+
type: object
|
34737
|
+
RelationshipToIncidentTypeData:
|
34738
|
+
description: Relationship to incident type object.
|
34739
|
+
properties:
|
34740
|
+
id:
|
34741
|
+
description: The incident type's ID.
|
34742
|
+
example: 00000000-0000-0000-0000-000000000000
|
34743
|
+
type: string
|
34744
|
+
type:
|
34745
|
+
$ref: '#/components/schemas/IncidentTypeType'
|
34746
|
+
required:
|
34747
|
+
- id
|
34748
|
+
- type
|
34749
|
+
type: object
|
32502
34750
|
RelationshipToIncidentUserDefinedFieldData:
|
32503
34751
|
description: Relationship to impact object.
|
32504
34752
|
properties:
|
@@ -33711,6 +35959,8 @@ components:
|
|
33711
35959
|
description: If enabled, the rule is calculated as part of the score.
|
33712
35960
|
example: true
|
33713
35961
|
type: boolean
|
35962
|
+
level:
|
35963
|
+
$ref: '#/components/schemas/RuleLevel'
|
33714
35964
|
modified_at:
|
33715
35965
|
description: Time of the last rule outcome modification.
|
33716
35966
|
format: date-time
|
@@ -33731,6 +35981,13 @@ components:
|
|
33731
35981
|
description: The unique ID for a scorecard rule.
|
33732
35982
|
example: q8MQxk8TCqrHnWkx
|
33733
35983
|
type: string
|
35984
|
+
RuleLevel:
|
35985
|
+
description: The maturity level of the rule (1, 2, or 3).
|
35986
|
+
example: 2
|
35987
|
+
format: int32
|
35988
|
+
maximum: 3
|
35989
|
+
minimum: 1
|
35990
|
+
type: integer
|
33734
35991
|
RuleName:
|
33735
35992
|
description: Name of the notification rule.
|
33736
35993
|
example: Rule 1
|
@@ -35509,6 +37766,20 @@ components:
|
|
35509
37766
|
type: string
|
35510
37767
|
x-enum-varnames:
|
35511
37768
|
- SCORECARD
|
37769
|
+
SearchIssuesIncludeQueryParameterItem:
|
37770
|
+
description: Relationship object that should be included in the search response.
|
37771
|
+
enum:
|
37772
|
+
- issue
|
37773
|
+
- issue.assignee
|
37774
|
+
- issue.case
|
37775
|
+
- issue.team_owners
|
37776
|
+
example: issue.case
|
37777
|
+
type: string
|
37778
|
+
x-enum-varnames:
|
37779
|
+
- ISSUE
|
37780
|
+
- ISSUE_ASSIGNEE
|
37781
|
+
- ISSUE_CASE
|
37782
|
+
- ISSUE_TEAM_OWNERS
|
35512
37783
|
SecurityFilter:
|
35513
37784
|
description: The security filter's properties.
|
35514
37785
|
properties:
|
@@ -38712,6 +40983,12 @@ components:
|
|
38712
40983
|
replacement_string:
|
38713
40984
|
description: Required if type == 'replacement_string'.
|
38714
40985
|
type: string
|
40986
|
+
should_save_match:
|
40987
|
+
description: "Only valid when type == `replacement_string`. When enabled,
|
40988
|
+
matches can be unmasked in logs by users with \u2018Data Scanner Unmask\u2019
|
40989
|
+
permission. As a security best practice, avoid masking for highly-sensitive,
|
40990
|
+
long-lived data."
|
40991
|
+
type: boolean
|
38715
40992
|
type:
|
38716
40993
|
$ref: '#/components/schemas/SensitiveDataScannerTextReplacementType'
|
38717
40994
|
type: object
|
@@ -39828,7 +42105,7 @@ components:
|
|
39828
42105
|
type: string
|
39829
42106
|
type: object
|
39830
42107
|
Shift:
|
39831
|
-
description:
|
42108
|
+
description: An on-call shift with its associated data and relationships.
|
39832
42109
|
example:
|
39833
42110
|
data:
|
39834
42111
|
attributes:
|
@@ -39859,7 +42136,7 @@ components:
|
|
39859
42136
|
type: array
|
39860
42137
|
type: object
|
39861
42138
|
ShiftData:
|
39862
|
-
description:
|
42139
|
+
description: Data for an on-call shift.
|
39863
42140
|
properties:
|
39864
42141
|
attributes:
|
39865
42142
|
$ref: '#/components/schemas/ShiftDataAttributes'
|
@@ -39874,7 +42151,7 @@ components:
|
|
39874
42151
|
- type
|
39875
42152
|
type: object
|
39876
42153
|
ShiftDataAttributes:
|
39877
|
-
description:
|
42154
|
+
description: Attributes for an on-call shift.
|
39878
42155
|
properties:
|
39879
42156
|
end:
|
39880
42157
|
description: The end time of the shift.
|
@@ -39886,7 +42163,7 @@ components:
|
|
39886
42163
|
type: string
|
39887
42164
|
type: object
|
39888
42165
|
ShiftDataRelationships:
|
39889
|
-
description:
|
42166
|
+
description: Relationships for an on-call shift.
|
39890
42167
|
properties:
|
39891
42168
|
user:
|
39892
42169
|
$ref: '#/components/schemas/ShiftDataRelationshipsUser'
|
@@ -39933,7 +42210,7 @@ components:
|
|
39933
42210
|
x-enum-varnames:
|
39934
42211
|
- SHIFTS
|
39935
42212
|
ShiftIncluded:
|
39936
|
-
description:
|
42213
|
+
description: Included data for shift operations.
|
39937
42214
|
oneOf:
|
39938
42215
|
- $ref: '#/components/schemas/ScheduleUser'
|
39939
42216
|
SimpleMonitorUserTemplate:
|
@@ -42273,6 +44550,68 @@ components:
|
|
42273
44550
|
urgency:
|
42274
44551
|
$ref: '#/components/schemas/Urgency'
|
42275
44552
|
type: object
|
44553
|
+
TeamSyncAttributes:
|
44554
|
+
description: Team sync attributes.
|
44555
|
+
properties:
|
44556
|
+
source:
|
44557
|
+
$ref: '#/components/schemas/TeamSyncAttributesSource'
|
44558
|
+
type:
|
44559
|
+
$ref: '#/components/schemas/TeamSyncAttributesType'
|
44560
|
+
required:
|
44561
|
+
- source
|
44562
|
+
- type
|
44563
|
+
type: object
|
44564
|
+
TeamSyncAttributesSource:
|
44565
|
+
description: The external source platform for team synchronization. Only "github"
|
44566
|
+
is supported.
|
44567
|
+
enum:
|
44568
|
+
- github
|
44569
|
+
example: github
|
44570
|
+
type: string
|
44571
|
+
x-enum-varnames:
|
44572
|
+
- GITHUB
|
44573
|
+
TeamSyncAttributesType:
|
44574
|
+
description: The type of synchronization operation. Only "link" is supported,
|
44575
|
+
which links existing teams by matching names.
|
44576
|
+
enum:
|
44577
|
+
- link
|
44578
|
+
example: link
|
44579
|
+
type: string
|
44580
|
+
x-enum-varnames:
|
44581
|
+
- LINK
|
44582
|
+
TeamSyncBulkType:
|
44583
|
+
description: Team sync bulk type.
|
44584
|
+
enum:
|
44585
|
+
- team_sync_bulk
|
44586
|
+
example: team_sync_bulk
|
44587
|
+
type: string
|
44588
|
+
x-enum-varnames:
|
44589
|
+
- TEAM_SYNC_BULK
|
44590
|
+
TeamSyncData:
|
44591
|
+
description: Team sync data.
|
44592
|
+
properties:
|
44593
|
+
attributes:
|
44594
|
+
$ref: '#/components/schemas/TeamSyncAttributes'
|
44595
|
+
type:
|
44596
|
+
$ref: '#/components/schemas/TeamSyncBulkType'
|
44597
|
+
required:
|
44598
|
+
- attributes
|
44599
|
+
- type
|
44600
|
+
type: object
|
44601
|
+
TeamSyncRequest:
|
44602
|
+
description: Team sync request.
|
44603
|
+
example:
|
44604
|
+
data:
|
44605
|
+
attributes:
|
44606
|
+
source: github
|
44607
|
+
type: link
|
44608
|
+
type: team_sync_bulk
|
44609
|
+
properties:
|
44610
|
+
data:
|
44611
|
+
$ref: '#/components/schemas/TeamSyncData'
|
44612
|
+
required:
|
44613
|
+
- data
|
44614
|
+
type: object
|
42276
44615
|
TeamTarget:
|
42277
44616
|
description: Represents a team target for an escalation policy step, including
|
42278
44617
|
the team's ID and resource type.
|
@@ -43034,6 +45373,57 @@ components:
|
|
43034
45373
|
id:
|
43035
45374
|
$ref: '#/components/schemas/ApiID'
|
43036
45375
|
type: object
|
45376
|
+
UpdateOutcomesAsyncAttributes:
|
45377
|
+
description: The JSON:API attributes for a batched set of scorecard outcomes.
|
45378
|
+
properties:
|
45379
|
+
results:
|
45380
|
+
description: Set of scorecard outcomes to update asynchronously.
|
45381
|
+
items:
|
45382
|
+
$ref: '#/components/schemas/UpdateOutcomesAsyncRequestItem'
|
45383
|
+
type: array
|
45384
|
+
type: object
|
45385
|
+
UpdateOutcomesAsyncRequest:
|
45386
|
+
description: Scorecard outcomes batch request.
|
45387
|
+
properties:
|
45388
|
+
data:
|
45389
|
+
$ref: '#/components/schemas/UpdateOutcomesAsyncRequestData'
|
45390
|
+
type: object
|
45391
|
+
UpdateOutcomesAsyncRequestData:
|
45392
|
+
description: Scorecard outcomes batch request data.
|
45393
|
+
properties:
|
45394
|
+
attributes:
|
45395
|
+
$ref: '#/components/schemas/UpdateOutcomesAsyncAttributes'
|
45396
|
+
type:
|
45397
|
+
$ref: '#/components/schemas/UpdateOutcomesAsyncType'
|
45398
|
+
type: object
|
45399
|
+
UpdateOutcomesAsyncRequestItem:
|
45400
|
+
description: Scorecard outcome for a single entity and rule.
|
45401
|
+
properties:
|
45402
|
+
entity_reference:
|
45403
|
+
$ref: '#/components/schemas/EntityReference'
|
45404
|
+
remarks:
|
45405
|
+
description: Any remarks regarding the scorecard rule's evaluation. Supports
|
45406
|
+
HTML hyperlinks.
|
45407
|
+
example: 'See: <a href="https://app.datadoghq.com/services">Services</a>'
|
45408
|
+
type: string
|
45409
|
+
rule_id:
|
45410
|
+
$ref: '#/components/schemas/RuleId'
|
45411
|
+
state:
|
45412
|
+
$ref: '#/components/schemas/State'
|
45413
|
+
required:
|
45414
|
+
- rule_id
|
45415
|
+
- entity_reference
|
45416
|
+
- state
|
45417
|
+
type: object
|
45418
|
+
UpdateOutcomesAsyncType:
|
45419
|
+
default: batched-outcome
|
45420
|
+
description: The JSON:API type for scorecard outcomes.
|
45421
|
+
enum:
|
45422
|
+
- batched-outcome
|
45423
|
+
example: batched-outcome
|
45424
|
+
type: string
|
45425
|
+
x-enum-varnames:
|
45426
|
+
- BATCHED_OUTCOME
|
43037
45427
|
UpdateResourceEvaluationFiltersRequest:
|
43038
45428
|
description: Request object to update a resource filter.
|
43039
45429
|
properties:
|
@@ -44806,6 +47196,31 @@ components:
|
|
44806
47196
|
oneOf:
|
44807
47197
|
- $ref: '#/components/schemas/XRayServicesIncludeAll'
|
44808
47198
|
- $ref: '#/components/schemas/XRayServicesIncludeOnly'
|
47199
|
+
ZoomConfigurationReference:
|
47200
|
+
description: A reference to a Zoom configuration resource.
|
47201
|
+
nullable: true
|
47202
|
+
properties:
|
47203
|
+
data:
|
47204
|
+
$ref: '#/components/schemas/ZoomConfigurationReferenceData'
|
47205
|
+
required:
|
47206
|
+
- data
|
47207
|
+
type: object
|
47208
|
+
ZoomConfigurationReferenceData:
|
47209
|
+
description: The Zoom configuration relationship data object.
|
47210
|
+
nullable: true
|
47211
|
+
properties:
|
47212
|
+
id:
|
47213
|
+
description: The unique identifier of the Zoom configuration.
|
47214
|
+
example: 00000000-0000-0000-0000-000000000000
|
47215
|
+
type: string
|
47216
|
+
type:
|
47217
|
+
description: The type of the Zoom configuration.
|
47218
|
+
example: zoom_configurations
|
47219
|
+
type: string
|
47220
|
+
required:
|
47221
|
+
- id
|
47222
|
+
- type
|
47223
|
+
type: object
|
44809
47224
|
securitySchemes:
|
44810
47225
|
AuthZ:
|
44811
47226
|
description: This API uses OAuth 2 with the implicit grant flow.
|
@@ -44848,11 +47263,14 @@ components:
|
|
44848
47263
|
data_scanner_write: Edit Data Scanner configurations.
|
44849
47264
|
embeddable_graphs_share: Generate public links to share embeddable graphs
|
44850
47265
|
externally.
|
47266
|
+
error_tracking_read: Read Error Tracking data.
|
47267
|
+
error_tracking_write: Edit Error Tracking issues.
|
44851
47268
|
events_read: Read Events data.
|
44852
47269
|
hosts_read: List hosts and their attributes.
|
44853
47270
|
incident_notification_settings_write: Configure Incidents Notification
|
44854
47271
|
settings.
|
44855
47272
|
incident_read: View incidents in Datadog.
|
47273
|
+
incident_settings_read: View Incident Settings.
|
44856
47274
|
incident_settings_write: Configure Incident Settings.
|
44857
47275
|
incident_write: Create, view, and manage incidents in Datadog.
|
44858
47276
|
metrics_read: View custom metrics.
|
@@ -44861,6 +47279,8 @@ components:
|
|
44861
47279
|
is not required to set downtimes.
|
44862
47280
|
monitors_read: View monitors.
|
44863
47281
|
monitors_write: Edit, delete, and resolve individual monitors.
|
47282
|
+
org_connections_read: Read cross organization connections.
|
47283
|
+
org_connections_write: Create, edit, and delete cross organization connections.
|
44864
47284
|
org_management: Edit org configurations, including authentication and
|
44865
47285
|
certain security preferences such as configuring SAML, renaming an org,
|
44866
47286
|
configuring allowed login methods, creating child orgs, subscribing
|
@@ -45154,6 +47574,7 @@ paths:
|
|
45154
47574
|
delete:
|
45155
47575
|
description: Delete an existing Action Connection. This API requires a [registered
|
45156
47576
|
application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
47577
|
+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
|
45157
47578
|
operationId: DeleteActionConnection
|
45158
47579
|
parameters:
|
45159
47580
|
- $ref: '#/components/parameters/ConnectionId'
|
@@ -45287,7 +47708,7 @@ paths:
|
|
45287
47708
|
$ref: '#/components/responses/NotAuthorizedResponse'
|
45288
47709
|
'429':
|
45289
47710
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
45290
|
-
summary:
|
47711
|
+
summary: List AWS Scan Options
|
45291
47712
|
tags:
|
45292
47713
|
- Agentless Scanning
|
45293
47714
|
post:
|
@@ -45339,6 +47760,29 @@ paths:
|
|
45339
47760
|
summary: Delete AWS Scan Options
|
45340
47761
|
tags:
|
45341
47762
|
- Agentless Scanning
|
47763
|
+
get:
|
47764
|
+
description: Fetches the Agentless scan options for an activated account.
|
47765
|
+
operationId: GetAwsScanOptions
|
47766
|
+
parameters:
|
47767
|
+
- $ref: '#/components/parameters/AwsAccountId'
|
47768
|
+
responses:
|
47769
|
+
'200':
|
47770
|
+
content:
|
47771
|
+
application/json:
|
47772
|
+
schema:
|
47773
|
+
$ref: '#/components/schemas/AwsScanOptionsResponse'
|
47774
|
+
description: OK
|
47775
|
+
'400':
|
47776
|
+
$ref: '#/components/responses/BadRequestResponse'
|
47777
|
+
'403':
|
47778
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
47779
|
+
'404':
|
47780
|
+
$ref: '#/components/responses/NotFoundResponse'
|
47781
|
+
'429':
|
47782
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
47783
|
+
summary: Get AWS scan options
|
47784
|
+
tags:
|
47785
|
+
- Agentless Scanning
|
45342
47786
|
patch:
|
45343
47787
|
description: Update the Agentless scan options for an activated account.
|
45344
47788
|
operationId: UpdateAwsScanOptions
|
@@ -46258,6 +48702,7 @@ paths:
|
|
46258
48702
|
delete:
|
46259
48703
|
description: Delete multiple apps in a single request from a list of app IDs.
|
46260
48704
|
This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
48705
|
+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
|
46261
48706
|
operationId: DeleteApps
|
46262
48707
|
requestBody:
|
46263
48708
|
content:
|
@@ -46304,6 +48749,7 @@ paths:
|
|
46304
48749
|
is paginated. Only basic app information such as the app ID, name, and description
|
46305
48750
|
is returned by this endpoint. This API requires a [registered application
|
46306
48751
|
key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
48752
|
+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
|
46307
48753
|
operationId: ListApps
|
46308
48754
|
parameters:
|
46309
48755
|
- description: The number of apps to return per page.
|
@@ -46411,6 +48857,7 @@ paths:
|
|
46411
48857
|
post:
|
46412
48858
|
description: Create a new app, returning the app ID. This API requires a [registered
|
46413
48859
|
application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
48860
|
+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
|
46414
48861
|
operationId: CreateApp
|
46415
48862
|
requestBody:
|
46416
48863
|
content:
|
@@ -46452,6 +48899,7 @@ paths:
|
|
46452
48899
|
delete:
|
46453
48900
|
description: Delete a single app. This API requires a [registered application
|
46454
48901
|
key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
48902
|
+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
|
46455
48903
|
operationId: DeleteApp
|
46456
48904
|
parameters:
|
46457
48905
|
- description: The ID of the app to delete.
|
@@ -46505,6 +48953,7 @@ paths:
|
|
46505
48953
|
get:
|
46506
48954
|
description: Get the full definition of an app. This API requires a [registered
|
46507
48955
|
application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
48956
|
+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
|
46508
48957
|
operationId: GetApp
|
46509
48958
|
parameters:
|
46510
48959
|
- description: The ID of the app to retrieve.
|
@@ -46568,6 +49017,7 @@ paths:
|
|
46568
49017
|
patch:
|
46569
49018
|
description: Update an existing app. This creates a new version of the app.
|
46570
49019
|
This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
49020
|
+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
|
46571
49021
|
operationId: UpdateApp
|
46572
49022
|
parameters:
|
46573
49023
|
- description: The ID of the app to update.
|
@@ -46621,6 +49071,7 @@ paths:
|
|
46621
49071
|
(`00000000-0000-0000-0000-000000000000`). The app can still be updated and
|
46622
49072
|
published again in the future. This API requires a [registered application
|
46623
49073
|
key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
49074
|
+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
|
46624
49075
|
operationId: UnpublishApp
|
46625
49076
|
parameters:
|
46626
49077
|
- description: The ID of the app to unpublish.
|
@@ -46670,6 +49121,7 @@ paths:
|
|
46670
49121
|
to the correct users, you also need to set a [Restriction Policy](https://docs.datadoghq.com/api/latest/restriction-policies/)
|
46671
49122
|
on the app if a policy does not yet exist. This API requires a [registered
|
46672
49123
|
application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
49124
|
+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
|
46673
49125
|
operationId: PublishApp
|
46674
49126
|
parameters:
|
46675
49127
|
- description: The ID of the app to publish.
|
@@ -48904,6 +51356,12 @@ paths:
|
|
48904
51356
|
schema:
|
48905
51357
|
$ref: '#/components/schemas/APIErrorResponse'
|
48906
51358
|
description: Forbidden
|
51359
|
+
'404':
|
51360
|
+
content:
|
51361
|
+
application/json:
|
51362
|
+
schema:
|
51363
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
51364
|
+
description: Not Found
|
48907
51365
|
'429':
|
48908
51366
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
48909
51367
|
security:
|
@@ -49056,6 +51514,12 @@ paths:
|
|
49056
51514
|
schema:
|
49057
51515
|
$ref: '#/components/schemas/APIErrorResponse'
|
49058
51516
|
description: Forbidden
|
51517
|
+
'404':
|
51518
|
+
content:
|
51519
|
+
application/json:
|
51520
|
+
schema:
|
51521
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
51522
|
+
description: Not Found
|
49059
51523
|
'429':
|
49060
51524
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
49061
51525
|
security:
|
@@ -49173,6 +51637,31 @@ paths:
|
|
49173
51637
|
get:
|
49174
51638
|
description: List the Custom Costs files.
|
49175
51639
|
operationId: ListCustomCostsFiles
|
51640
|
+
parameters:
|
51641
|
+
- description: Page number for pagination
|
51642
|
+
in: query
|
51643
|
+
name: page[number]
|
51644
|
+
schema:
|
51645
|
+
format: int64
|
51646
|
+
type: integer
|
51647
|
+
- description: Page size for pagination
|
51648
|
+
in: query
|
51649
|
+
name: page[size]
|
51650
|
+
schema:
|
51651
|
+
default: 100
|
51652
|
+
format: int64
|
51653
|
+
type: integer
|
51654
|
+
- description: Filter by file status
|
51655
|
+
in: query
|
51656
|
+
name: filter[status]
|
51657
|
+
schema:
|
51658
|
+
type: string
|
51659
|
+
- description: Sort key with optional descending prefix
|
51660
|
+
in: query
|
51661
|
+
name: sort
|
51662
|
+
schema:
|
51663
|
+
default: created_at
|
51664
|
+
type: string
|
49176
51665
|
responses:
|
49177
51666
|
'200':
|
49178
51667
|
content:
|
@@ -49180,6 +51669,12 @@ paths:
|
|
49180
51669
|
schema:
|
49181
51670
|
$ref: '#/components/schemas/CustomCostsFileListResponse'
|
49182
51671
|
description: OK
|
51672
|
+
'400':
|
51673
|
+
content:
|
51674
|
+
application/json:
|
51675
|
+
schema:
|
51676
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
51677
|
+
description: Bad Request
|
49183
51678
|
'403':
|
49184
51679
|
content:
|
49185
51680
|
application/json:
|
@@ -49212,6 +51707,12 @@ paths:
|
|
49212
51707
|
schema:
|
49213
51708
|
$ref: '#/components/schemas/CustomCostsFileUploadResponse'
|
49214
51709
|
description: Accepted
|
51710
|
+
'400':
|
51711
|
+
content:
|
51712
|
+
application/json:
|
51713
|
+
schema:
|
51714
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
51715
|
+
description: Bad Request
|
49215
51716
|
'403':
|
49216
51717
|
content:
|
49217
51718
|
application/json:
|
@@ -49243,6 +51744,12 @@ paths:
|
|
49243
51744
|
schema:
|
49244
51745
|
$ref: '#/components/schemas/APIErrorResponse'
|
49245
51746
|
description: Forbidden
|
51747
|
+
'404':
|
51748
|
+
content:
|
51749
|
+
application/json:
|
51750
|
+
schema:
|
51751
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
51752
|
+
description: Not Found
|
49246
51753
|
'429':
|
49247
51754
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
49248
51755
|
security:
|
@@ -49271,6 +51778,12 @@ paths:
|
|
49271
51778
|
schema:
|
49272
51779
|
$ref: '#/components/schemas/APIErrorResponse'
|
49273
51780
|
description: Forbidden
|
51781
|
+
'404':
|
51782
|
+
content:
|
51783
|
+
application/json:
|
51784
|
+
schema:
|
51785
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
51786
|
+
description: Not Found
|
49274
51787
|
'429':
|
49275
51788
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
49276
51789
|
security:
|
@@ -49599,13 +52112,15 @@ paths:
|
|
49599
52112
|
appKeyAuth: []
|
49600
52113
|
- AuthZ:
|
49601
52114
|
- usage_read
|
52115
|
+
- billing_read
|
49602
52116
|
summary: Get Monthly Cost Attribution
|
49603
52117
|
tags:
|
49604
52118
|
- Usage Metering
|
49605
52119
|
x-permission:
|
49606
|
-
operator:
|
52120
|
+
operator: AND
|
49607
52121
|
permissions:
|
49608
52122
|
- usage_read
|
52123
|
+
- billing_read
|
49609
52124
|
/api/v2/csm/onboarding/agents:
|
49610
52125
|
get:
|
49611
52126
|
description: Get the list of all CSM Agents running on your hosts and containers.
|
@@ -51162,6 +53677,159 @@ paths:
|
|
51162
53677
|
operator: OR
|
51163
53678
|
permissions:
|
51164
53679
|
- monitors_downtime
|
53680
|
+
/api/v2/error-tracking/issues/search:
|
53681
|
+
post:
|
53682
|
+
description: Search issues endpoint allows you to programmatically search for
|
53683
|
+
issues within your organization. This endpoint returns a list of issues that
|
53684
|
+
match a given search query, following the event search syntax. The search
|
53685
|
+
results are limited to a maximum of 100 issues per request.
|
53686
|
+
operationId: SearchIssues
|
53687
|
+
parameters:
|
53688
|
+
- $ref: '#/components/parameters/SearchIssuesIncludeQueryParameter'
|
53689
|
+
requestBody:
|
53690
|
+
content:
|
53691
|
+
application/json:
|
53692
|
+
schema:
|
53693
|
+
$ref: '#/components/schemas/IssuesSearchRequest'
|
53694
|
+
description: Search issues request payload.
|
53695
|
+
required: true
|
53696
|
+
responses:
|
53697
|
+
'200':
|
53698
|
+
content:
|
53699
|
+
application/json:
|
53700
|
+
schema:
|
53701
|
+
$ref: '#/components/schemas/IssuesSearchResponse'
|
53702
|
+
description: OK
|
53703
|
+
'400':
|
53704
|
+
$ref: '#/components/responses/BadRequestResponse'
|
53705
|
+
'401':
|
53706
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
53707
|
+
'403':
|
53708
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
53709
|
+
'429':
|
53710
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
53711
|
+
security:
|
53712
|
+
- apiKeyAuth: []
|
53713
|
+
appKeyAuth: []
|
53714
|
+
- AuthZ:
|
53715
|
+
- error_tracking_read
|
53716
|
+
summary: Search error tracking issues
|
53717
|
+
tags:
|
53718
|
+
- Error Tracking
|
53719
|
+
/api/v2/error-tracking/issues/{issue_id}:
|
53720
|
+
get:
|
53721
|
+
description: Retrieve the full details for a specific error tracking issue,
|
53722
|
+
including attributes and relationships.
|
53723
|
+
operationId: GetIssue
|
53724
|
+
parameters:
|
53725
|
+
- $ref: '#/components/parameters/IssueIDPathParameter'
|
53726
|
+
- $ref: '#/components/parameters/GetIssueIncludeQueryParameter'
|
53727
|
+
responses:
|
53728
|
+
'200':
|
53729
|
+
content:
|
53730
|
+
application/json:
|
53731
|
+
schema:
|
53732
|
+
$ref: '#/components/schemas/IssueResponse'
|
53733
|
+
description: OK
|
53734
|
+
'400':
|
53735
|
+
$ref: '#/components/responses/BadRequestResponse'
|
53736
|
+
'401':
|
53737
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
53738
|
+
'403':
|
53739
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
53740
|
+
'404':
|
53741
|
+
$ref: '#/components/responses/NotFoundResponse'
|
53742
|
+
'429':
|
53743
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
53744
|
+
security:
|
53745
|
+
- apiKeyAuth: []
|
53746
|
+
appKeyAuth: []
|
53747
|
+
- AuthZ:
|
53748
|
+
- error_tracking_read
|
53749
|
+
summary: Get the details of an error tracking issue
|
53750
|
+
tags:
|
53751
|
+
- Error Tracking
|
53752
|
+
/api/v2/error-tracking/issues/{issue_id}/assignee:
|
53753
|
+
put:
|
53754
|
+
description: Update the assignee of an issue by `issue_id`.
|
53755
|
+
operationId: UpdateIssueAssignee
|
53756
|
+
parameters:
|
53757
|
+
- $ref: '#/components/parameters/IssueIDPathParameter'
|
53758
|
+
requestBody:
|
53759
|
+
content:
|
53760
|
+
application/json:
|
53761
|
+
schema:
|
53762
|
+
$ref: '#/components/schemas/IssueUpdateAssigneeRequest'
|
53763
|
+
description: Update issue assignee request payload.
|
53764
|
+
required: true
|
53765
|
+
responses:
|
53766
|
+
'200':
|
53767
|
+
content:
|
53768
|
+
application/json:
|
53769
|
+
schema:
|
53770
|
+
$ref: '#/components/schemas/IssueResponse'
|
53771
|
+
description: OK
|
53772
|
+
'400':
|
53773
|
+
$ref: '#/components/responses/BadRequestResponse'
|
53774
|
+
'401':
|
53775
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
53776
|
+
'403':
|
53777
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
53778
|
+
'404':
|
53779
|
+
$ref: '#/components/responses/NotFoundResponse'
|
53780
|
+
'429':
|
53781
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
53782
|
+
security:
|
53783
|
+
- apiKeyAuth: []
|
53784
|
+
appKeyAuth: []
|
53785
|
+
- AuthZ:
|
53786
|
+
- error_tracking_read
|
53787
|
+
- error_tracking_write
|
53788
|
+
- cases_read
|
53789
|
+
- cases_write
|
53790
|
+
summary: Update the assignee of an issue
|
53791
|
+
tags:
|
53792
|
+
- Error Tracking
|
53793
|
+
/api/v2/error-tracking/issues/{issue_id}/state:
|
53794
|
+
put:
|
53795
|
+
description: Update the state of an issue by `issue_id`. Use this endpoint to
|
53796
|
+
move an issue between states such as `OPEN`, `RESOLVED`, or `IGNORED`.
|
53797
|
+
operationId: UpdateIssueState
|
53798
|
+
parameters:
|
53799
|
+
- $ref: '#/components/parameters/IssueIDPathParameter'
|
53800
|
+
requestBody:
|
53801
|
+
content:
|
53802
|
+
application/json:
|
53803
|
+
schema:
|
53804
|
+
$ref: '#/components/schemas/IssueUpdateStateRequest'
|
53805
|
+
description: Update issue state request payload.
|
53806
|
+
required: true
|
53807
|
+
responses:
|
53808
|
+
'200':
|
53809
|
+
content:
|
53810
|
+
application/json:
|
53811
|
+
schema:
|
53812
|
+
$ref: '#/components/schemas/IssueResponse'
|
53813
|
+
description: OK
|
53814
|
+
'400':
|
53815
|
+
$ref: '#/components/responses/BadRequestResponse'
|
53816
|
+
'401':
|
53817
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
53818
|
+
'403':
|
53819
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
53820
|
+
'404':
|
53821
|
+
$ref: '#/components/responses/NotFoundResponse'
|
53822
|
+
'429':
|
53823
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
53824
|
+
security:
|
53825
|
+
- apiKeyAuth: []
|
53826
|
+
appKeyAuth: []
|
53827
|
+
- AuthZ:
|
53828
|
+
- error_tracking_read
|
53829
|
+
- error_tracking_write
|
53830
|
+
summary: Update the state of an issue
|
53831
|
+
tags:
|
53832
|
+
- Error Tracking
|
51165
53833
|
/api/v2/events:
|
51166
53834
|
get:
|
51167
53835
|
description: 'List endpoint returns events that match an events search query.
|
@@ -51530,6 +54198,208 @@ paths:
|
|
51530
54198
|
- incident_write
|
51531
54199
|
x-unstable: '**Note**: This endpoint is in public beta.
|
51532
54200
|
|
54201
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
54202
|
+
/api/v2/incidents/config/notification-templates:
|
54203
|
+
get:
|
54204
|
+
description: Lists all notification templates. Optionally filter by incident
|
54205
|
+
type.
|
54206
|
+
operationId: ListIncidentNotificationTemplates
|
54207
|
+
parameters:
|
54208
|
+
- $ref: '#/components/parameters/IncidentNotificationTemplateIncidentTypeFilterQueryParameter'
|
54209
|
+
- $ref: '#/components/parameters/IncidentNotificationTemplateIncludeQueryParameter'
|
54210
|
+
responses:
|
54211
|
+
'200':
|
54212
|
+
content:
|
54213
|
+
application/json:
|
54214
|
+
schema:
|
54215
|
+
$ref: '#/components/schemas/IncidentNotificationTemplateArray'
|
54216
|
+
description: OK
|
54217
|
+
'400':
|
54218
|
+
$ref: '#/components/responses/BadRequestResponse'
|
54219
|
+
'401':
|
54220
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
54221
|
+
'403':
|
54222
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
54223
|
+
'404':
|
54224
|
+
$ref: '#/components/responses/NotFoundResponse'
|
54225
|
+
'429':
|
54226
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
54227
|
+
security:
|
54228
|
+
- apiKeyAuth: []
|
54229
|
+
appKeyAuth: []
|
54230
|
+
- AuthZ:
|
54231
|
+
- incident_settings_read
|
54232
|
+
summary: List incident notification templates
|
54233
|
+
tags:
|
54234
|
+
- Incidents
|
54235
|
+
x-permission:
|
54236
|
+
operator: AND
|
54237
|
+
permissions:
|
54238
|
+
- incident_notification_settings_read
|
54239
|
+
x-unstable: '**Note**: This endpoint is in Preview.
|
54240
|
+
|
54241
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
54242
|
+
post:
|
54243
|
+
description: Creates a new notification template.
|
54244
|
+
operationId: CreateIncidentNotificationTemplate
|
54245
|
+
requestBody:
|
54246
|
+
content:
|
54247
|
+
application/json:
|
54248
|
+
schema:
|
54249
|
+
$ref: '#/components/schemas/CreateIncidentNotificationTemplateRequest'
|
54250
|
+
required: true
|
54251
|
+
responses:
|
54252
|
+
'201':
|
54253
|
+
content:
|
54254
|
+
application/json:
|
54255
|
+
schema:
|
54256
|
+
$ref: '#/components/schemas/IncidentNotificationTemplate'
|
54257
|
+
description: Created
|
54258
|
+
'400':
|
54259
|
+
$ref: '#/components/responses/BadRequestResponse'
|
54260
|
+
'401':
|
54261
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
54262
|
+
'403':
|
54263
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
54264
|
+
'404':
|
54265
|
+
$ref: '#/components/responses/NotFoundResponse'
|
54266
|
+
'429':
|
54267
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
54268
|
+
security:
|
54269
|
+
- apiKeyAuth: []
|
54270
|
+
appKeyAuth: []
|
54271
|
+
- AuthZ:
|
54272
|
+
- incident_notification_settings_write
|
54273
|
+
summary: Create incident notification template
|
54274
|
+
tags:
|
54275
|
+
- Incidents
|
54276
|
+
x-codegen-request-body-name: body
|
54277
|
+
x-permission:
|
54278
|
+
operator: AND
|
54279
|
+
permissions:
|
54280
|
+
- incident_notification_settings_write
|
54281
|
+
x-unstable: '**Note**: This endpoint is in Preview.
|
54282
|
+
|
54283
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
54284
|
+
/api/v2/incidents/config/notification-templates/{id}:
|
54285
|
+
delete:
|
54286
|
+
description: Deletes a notification template by its ID.
|
54287
|
+
operationId: DeleteIncidentNotificationTemplate
|
54288
|
+
parameters:
|
54289
|
+
- $ref: '#/components/parameters/IncidentNotificationTemplateIDPathParameter'
|
54290
|
+
- $ref: '#/components/parameters/IncidentNotificationTemplateIncludeQueryParameter'
|
54291
|
+
responses:
|
54292
|
+
'204':
|
54293
|
+
description: No Content
|
54294
|
+
'400':
|
54295
|
+
$ref: '#/components/responses/BadRequestResponse'
|
54296
|
+
'401':
|
54297
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
54298
|
+
'403':
|
54299
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
54300
|
+
'404':
|
54301
|
+
$ref: '#/components/responses/NotFoundResponse'
|
54302
|
+
'429':
|
54303
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
54304
|
+
security:
|
54305
|
+
- apiKeyAuth: []
|
54306
|
+
appKeyAuth: []
|
54307
|
+
- AuthZ:
|
54308
|
+
- incident_notification_settings_write
|
54309
|
+
summary: Delete a notification template
|
54310
|
+
tags:
|
54311
|
+
- Incidents
|
54312
|
+
x-permission:
|
54313
|
+
operator: AND
|
54314
|
+
permissions:
|
54315
|
+
- incident_notification_settings_write
|
54316
|
+
x-unstable: '**Note**: This endpoint is in Preview.
|
54317
|
+
|
54318
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
54319
|
+
get:
|
54320
|
+
description: Retrieves a specific notification template by its ID.
|
54321
|
+
operationId: GetIncidentNotificationTemplate
|
54322
|
+
parameters:
|
54323
|
+
- $ref: '#/components/parameters/IncidentNotificationTemplateIDPathParameter'
|
54324
|
+
- $ref: '#/components/parameters/IncidentNotificationTemplateIncludeQueryParameter'
|
54325
|
+
responses:
|
54326
|
+
'200':
|
54327
|
+
content:
|
54328
|
+
application/json:
|
54329
|
+
schema:
|
54330
|
+
$ref: '#/components/schemas/IncidentNotificationTemplate'
|
54331
|
+
description: OK
|
54332
|
+
'400':
|
54333
|
+
$ref: '#/components/responses/BadRequestResponse'
|
54334
|
+
'401':
|
54335
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
54336
|
+
'403':
|
54337
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
54338
|
+
'404':
|
54339
|
+
$ref: '#/components/responses/NotFoundResponse'
|
54340
|
+
'429':
|
54341
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
54342
|
+
security:
|
54343
|
+
- apiKeyAuth: []
|
54344
|
+
appKeyAuth: []
|
54345
|
+
- AuthZ:
|
54346
|
+
- incident_settings_read
|
54347
|
+
summary: Get incident notification template
|
54348
|
+
tags:
|
54349
|
+
- Incidents
|
54350
|
+
x-permission:
|
54351
|
+
operator: OR
|
54352
|
+
permissions:
|
54353
|
+
- incident_settings_read
|
54354
|
+
- incident_write
|
54355
|
+
- incident_read
|
54356
|
+
x-unstable: '**Note**: This endpoint is in Preview.
|
54357
|
+
|
54358
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
54359
|
+
patch:
|
54360
|
+
description: Updates an existing notification template's attributes.
|
54361
|
+
operationId: UpdateIncidentNotificationTemplate
|
54362
|
+
parameters:
|
54363
|
+
- $ref: '#/components/parameters/IncidentNotificationTemplateIDPathParameter'
|
54364
|
+
- $ref: '#/components/parameters/IncidentNotificationTemplateIncludeQueryParameter'
|
54365
|
+
requestBody:
|
54366
|
+
content:
|
54367
|
+
application/json:
|
54368
|
+
schema:
|
54369
|
+
$ref: '#/components/schemas/PatchIncidentNotificationTemplateRequest'
|
54370
|
+
required: true
|
54371
|
+
responses:
|
54372
|
+
'200':
|
54373
|
+
content:
|
54374
|
+
application/json:
|
54375
|
+
schema:
|
54376
|
+
$ref: '#/components/schemas/IncidentNotificationTemplate'
|
54377
|
+
description: OK
|
54378
|
+
'400':
|
54379
|
+
$ref: '#/components/responses/BadRequestResponse'
|
54380
|
+
'401':
|
54381
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
54382
|
+
'403':
|
54383
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
54384
|
+
'404':
|
54385
|
+
$ref: '#/components/responses/NotFoundResponse'
|
54386
|
+
'429':
|
54387
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
54388
|
+
security:
|
54389
|
+
- apiKeyAuth: []
|
54390
|
+
appKeyAuth: []
|
54391
|
+
- AuthZ:
|
54392
|
+
- incident_notification_settings_write
|
54393
|
+
summary: Update incident notification template
|
54394
|
+
tags:
|
54395
|
+
- Incidents
|
54396
|
+
x-codegen-request-body-name: body
|
54397
|
+
x-permission:
|
54398
|
+
operator: AND
|
54399
|
+
permissions:
|
54400
|
+
- incident_notification_settings_write
|
54401
|
+
x-unstable: '**Note**: This endpoint is in Preview.
|
54402
|
+
|
51533
54403
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
51534
54404
|
/api/v2/incidents/config/types:
|
51535
54405
|
get:
|
@@ -55875,25 +58745,25 @@ paths:
|
|
55875
58745
|
content:
|
55876
58746
|
application/json:
|
55877
58747
|
schema:
|
55878
|
-
$ref: '#/components/schemas/
|
58748
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
55879
58749
|
description: Bad Request
|
55880
58750
|
'403':
|
55881
58751
|
content:
|
55882
58752
|
application/json:
|
55883
58753
|
schema:
|
55884
|
-
$ref: '#/components/schemas/
|
58754
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
55885
58755
|
description: Forbidden
|
55886
58756
|
'404':
|
55887
58757
|
content:
|
55888
58758
|
application/json:
|
55889
58759
|
schema:
|
55890
|
-
$ref: '#/components/schemas/
|
58760
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
55891
58761
|
description: Not Found
|
55892
58762
|
'429':
|
55893
58763
|
content:
|
55894
58764
|
application/json:
|
55895
58765
|
schema:
|
55896
|
-
$ref: '#/components/schemas/
|
58766
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
55897
58767
|
description: Too Many Requests
|
55898
58768
|
summary: Get tag key cardinality details
|
55899
58769
|
tags:
|
@@ -56156,6 +59026,47 @@ paths:
|
|
56156
59026
|
description: Returns a list of all monitor notification rules.
|
56157
59027
|
operationId: GetMonitorNotificationRules
|
56158
59028
|
parameters:
|
59029
|
+
- description: The page to start paginating from. If `page` is not specified,
|
59030
|
+
the argument defaults to the first page.
|
59031
|
+
in: query
|
59032
|
+
name: page
|
59033
|
+
required: false
|
59034
|
+
schema:
|
59035
|
+
format: int32
|
59036
|
+
maximum: 1000000
|
59037
|
+
minimum: 0
|
59038
|
+
type: integer
|
59039
|
+
- description: The number of rules to return per page. If `per_page` is not
|
59040
|
+
specified, the argument defaults to 100.
|
59041
|
+
in: query
|
59042
|
+
name: per_page
|
59043
|
+
required: false
|
59044
|
+
schema:
|
59045
|
+
format: int32
|
59046
|
+
maximum: 1000
|
59047
|
+
minimum: 1
|
59048
|
+
type: integer
|
59049
|
+
- description: 'String for sort order, composed of field and sort order separated
|
59050
|
+
by a colon, for example `name:asc`. Supported sort directions: `asc`, `desc`.
|
59051
|
+
Supported fields: `name`, `created_at`.'
|
59052
|
+
in: query
|
59053
|
+
name: sort
|
59054
|
+
required: false
|
59055
|
+
schema:
|
59056
|
+
type: string
|
59057
|
+
- description: 'JSON-encoded filter object. Supported keys:
|
59058
|
+
|
59059
|
+
* `text`: Free-text query matched against rule name, tags, and recipients.
|
59060
|
+
|
59061
|
+
* `tags`: Array of strings. Return rules that have any of these tags.
|
59062
|
+
|
59063
|
+
* `recipients`: Array of strings. Return rules that have any of these recipients.'
|
59064
|
+
example: '{"text":"error","tags":["env:prod","team:my-team"],"recipients":["slack-monitor-app","email@example.com"]}'
|
59065
|
+
in: query
|
59066
|
+
name: filters
|
59067
|
+
required: false
|
59068
|
+
schema:
|
59069
|
+
type: string
|
56159
59070
|
- description: 'Comma-separated list of resource paths for related resources
|
56160
59071
|
to include in the response. Supported resource
|
56161
59072
|
|
@@ -58013,6 +60924,148 @@ paths:
|
|
58013
60924
|
operator: OR
|
58014
60925
|
permissions:
|
58015
60926
|
- org_management
|
60927
|
+
/api/v2/org_connections:
|
60928
|
+
get:
|
60929
|
+
description: Returns a list of org connections.
|
60930
|
+
operationId: ListOrgConnections
|
60931
|
+
responses:
|
60932
|
+
'200':
|
60933
|
+
content:
|
60934
|
+
application/json:
|
60935
|
+
schema:
|
60936
|
+
$ref: '#/components/schemas/OrgConnectionListResponse'
|
60937
|
+
description: OK
|
60938
|
+
'401':
|
60939
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
60940
|
+
'403':
|
60941
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
60942
|
+
'429':
|
60943
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
60944
|
+
security:
|
60945
|
+
- apiKeyAuth: []
|
60946
|
+
appKeyAuth: []
|
60947
|
+
- AuthZ:
|
60948
|
+
- org_connections_read
|
60949
|
+
summary: List Org Connections
|
60950
|
+
tags:
|
60951
|
+
- Org Connections
|
60952
|
+
x-permission:
|
60953
|
+
operator: OR
|
60954
|
+
permissions:
|
60955
|
+
- org_connections_read
|
60956
|
+
post:
|
60957
|
+
description: Create a new org connection between the current org and a target
|
60958
|
+
org.
|
60959
|
+
operationId: CreateOrgConnections
|
60960
|
+
requestBody:
|
60961
|
+
content:
|
60962
|
+
application/json:
|
60963
|
+
schema:
|
60964
|
+
$ref: '#/components/schemas/OrgConnectionCreateRequest'
|
60965
|
+
required: true
|
60966
|
+
responses:
|
60967
|
+
'200':
|
60968
|
+
content:
|
60969
|
+
application/json:
|
60970
|
+
schema:
|
60971
|
+
$ref: '#/components/schemas/OrgConnectionResponse'
|
60972
|
+
description: OK
|
60973
|
+
'400':
|
60974
|
+
$ref: '#/components/responses/BadRequestResponse'
|
60975
|
+
'401':
|
60976
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
60977
|
+
'403':
|
60978
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
60979
|
+
'404':
|
60980
|
+
$ref: '#/components/responses/NotFoundResponse'
|
60981
|
+
'409':
|
60982
|
+
$ref: '#/components/responses/ConflictResponse'
|
60983
|
+
'429':
|
60984
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
60985
|
+
security:
|
60986
|
+
- apiKeyAuth: []
|
60987
|
+
appKeyAuth: []
|
60988
|
+
- AuthZ:
|
60989
|
+
- org_connections_write
|
60990
|
+
summary: Create Org Connection
|
60991
|
+
tags:
|
60992
|
+
- Org Connections
|
60993
|
+
x-codegen-request-body-name: body
|
60994
|
+
x-permission:
|
60995
|
+
operator: OR
|
60996
|
+
permissions:
|
60997
|
+
- org_connections_write
|
60998
|
+
/api/v2/org_connections/{connection_id}:
|
60999
|
+
delete:
|
61000
|
+
description: Delete an existing org connection.
|
61001
|
+
operationId: DeleteOrgConnections
|
61002
|
+
parameters:
|
61003
|
+
- $ref: '#/components/parameters/OrgConnectionId'
|
61004
|
+
responses:
|
61005
|
+
'200':
|
61006
|
+
description: OK
|
61007
|
+
'400':
|
61008
|
+
$ref: '#/components/responses/BadRequestResponse'
|
61009
|
+
'401':
|
61010
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
61011
|
+
'403':
|
61012
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
61013
|
+
'404':
|
61014
|
+
$ref: '#/components/responses/NotFoundResponse'
|
61015
|
+
'429':
|
61016
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
61017
|
+
security:
|
61018
|
+
- apiKeyAuth: []
|
61019
|
+
appKeyAuth: []
|
61020
|
+
- AuthZ:
|
61021
|
+
- org_connections_write
|
61022
|
+
summary: Delete Org Connection
|
61023
|
+
tags:
|
61024
|
+
- Org Connections
|
61025
|
+
x-permission:
|
61026
|
+
operator: OR
|
61027
|
+
permissions:
|
61028
|
+
- org_connections_write
|
61029
|
+
patch:
|
61030
|
+
description: Update an existing org connection.
|
61031
|
+
operationId: UpdateOrgConnections
|
61032
|
+
parameters:
|
61033
|
+
- $ref: '#/components/parameters/OrgConnectionId'
|
61034
|
+
requestBody:
|
61035
|
+
content:
|
61036
|
+
application/json:
|
61037
|
+
schema:
|
61038
|
+
$ref: '#/components/schemas/OrgConnectionUpdateRequest'
|
61039
|
+
required: true
|
61040
|
+
responses:
|
61041
|
+
'200':
|
61042
|
+
content:
|
61043
|
+
application/json:
|
61044
|
+
schema:
|
61045
|
+
$ref: '#/components/schemas/OrgConnectionResponse'
|
61046
|
+
description: OK
|
61047
|
+
'400':
|
61048
|
+
$ref: '#/components/responses/BadRequestResponse'
|
61049
|
+
'401':
|
61050
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
61051
|
+
'403':
|
61052
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
61053
|
+
'404':
|
61054
|
+
$ref: '#/components/responses/NotFoundResponse'
|
61055
|
+
'429':
|
61056
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
61057
|
+
security:
|
61058
|
+
- apiKeyAuth: []
|
61059
|
+
appKeyAuth: []
|
61060
|
+
- AuthZ:
|
61061
|
+
- org_connections_write
|
61062
|
+
summary: Update Org Connection
|
61063
|
+
tags:
|
61064
|
+
- Org Connections
|
61065
|
+
x-permission:
|
61066
|
+
operator: OR
|
61067
|
+
permissions:
|
61068
|
+
- org_connections_write
|
58016
61069
|
/api/v2/permissions:
|
58017
61070
|
get:
|
58018
61071
|
description: Returns a list of all permissions, including name, description,
|
@@ -61018,6 +64071,39 @@ paths:
|
|
61018
64071
|
resultsPath: data
|
61019
64072
|
x-unstable: '**Note**: This endpoint is in public beta.
|
61020
64073
|
|
64074
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
64075
|
+
post:
|
64076
|
+
description: Updates multiple scorecard rule outcomes in a single batched request.
|
64077
|
+
operationId: UpdateScorecardOutcomesAsync
|
64078
|
+
requestBody:
|
64079
|
+
content:
|
64080
|
+
application/json:
|
64081
|
+
schema:
|
64082
|
+
$ref: '#/components/schemas/UpdateOutcomesAsyncRequest'
|
64083
|
+
description: Set of scorecard outcomes.
|
64084
|
+
required: true
|
64085
|
+
responses:
|
64086
|
+
'202':
|
64087
|
+
description: Accepted
|
64088
|
+
'400':
|
64089
|
+
$ref: '#/components/responses/BadRequestResponse'
|
64090
|
+
'403':
|
64091
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
64092
|
+
'409':
|
64093
|
+
$ref: '#/components/responses/ConflictResponse'
|
64094
|
+
'429':
|
64095
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
64096
|
+
security:
|
64097
|
+
- apiKeyAuth: []
|
64098
|
+
appKeyAuth: []
|
64099
|
+
- AuthZ:
|
64100
|
+
- apm_service_catalog_write
|
64101
|
+
summary: Update Scorecard outcomes asynchronously
|
64102
|
+
tags:
|
64103
|
+
- Service Scorecards
|
64104
|
+
x-codegen-request-body-name: body
|
64105
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
64106
|
+
|
61021
64107
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
61022
64108
|
/api/v2/scorecard/outcomes/batch:
|
61023
64109
|
post:
|
@@ -62786,6 +65872,97 @@ paths:
|
|
62786
65872
|
tags:
|
62787
65873
|
- Security Monitoring
|
62788
65874
|
x-codegen-request-body-name: body
|
65875
|
+
/api/v2/security_monitoring/configuration/suppressions/rules:
|
65876
|
+
post:
|
65877
|
+
description: Get the list of suppressions that would affect a rule.
|
65878
|
+
operationId: GetSuppressionsAffectingFutureRule
|
65879
|
+
requestBody:
|
65880
|
+
content:
|
65881
|
+
application/json:
|
65882
|
+
schema:
|
65883
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleCreatePayload'
|
65884
|
+
required: true
|
65885
|
+
responses:
|
65886
|
+
'200':
|
65887
|
+
content:
|
65888
|
+
application/json:
|
65889
|
+
schema:
|
65890
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionsResponse'
|
65891
|
+
description: OK
|
65892
|
+
'400':
|
65893
|
+
$ref: '#/components/responses/BadRequestResponse'
|
65894
|
+
'403':
|
65895
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
65896
|
+
'429':
|
65897
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
65898
|
+
security:
|
65899
|
+
- apiKeyAuth: []
|
65900
|
+
appKeyAuth: []
|
65901
|
+
- AuthZ:
|
65902
|
+
- security_monitoring_suppressions_read
|
65903
|
+
summary: Get suppressions affecting future rule
|
65904
|
+
tags:
|
65905
|
+
- Security Monitoring
|
65906
|
+
/api/v2/security_monitoring/configuration/suppressions/rules/{rule_id}:
|
65907
|
+
get:
|
65908
|
+
description: Get the list of suppressions that affect a specific existing rule
|
65909
|
+
by its ID.
|
65910
|
+
operationId: GetSuppressionsAffectingRule
|
65911
|
+
parameters:
|
65912
|
+
- $ref: '#/components/parameters/SecurityMonitoringRuleID'
|
65913
|
+
responses:
|
65914
|
+
'200':
|
65915
|
+
content:
|
65916
|
+
application/json:
|
65917
|
+
schema:
|
65918
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionsResponse'
|
65919
|
+
description: OK
|
65920
|
+
'403':
|
65921
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
65922
|
+
'404':
|
65923
|
+
$ref: '#/components/responses/NotFoundResponse'
|
65924
|
+
'429':
|
65925
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
65926
|
+
security:
|
65927
|
+
- apiKeyAuth: []
|
65928
|
+
appKeyAuth: []
|
65929
|
+
- AuthZ:
|
65930
|
+
- security_monitoring_suppressions_read
|
65931
|
+
summary: Get suppressions affecting a specific rule
|
65932
|
+
tags:
|
65933
|
+
- Security Monitoring
|
65934
|
+
/api/v2/security_monitoring/configuration/suppressions/validation:
|
65935
|
+
post:
|
65936
|
+
description: Validate a suppression rule.
|
65937
|
+
operationId: ValidateSecurityMonitoringSuppression
|
65938
|
+
requestBody:
|
65939
|
+
content:
|
65940
|
+
application/json:
|
65941
|
+
schema:
|
65942
|
+
$ref: '#/components/schemas/SecurityMonitoringSuppressionCreateRequest'
|
65943
|
+
required: true
|
65944
|
+
responses:
|
65945
|
+
'204':
|
65946
|
+
description: OK
|
65947
|
+
'400':
|
65948
|
+
$ref: '#/components/responses/BadRequestResponse'
|
65949
|
+
'403':
|
65950
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
65951
|
+
'429':
|
65952
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
65953
|
+
security:
|
65954
|
+
- apiKeyAuth: []
|
65955
|
+
appKeyAuth: []
|
65956
|
+
- AuthZ:
|
65957
|
+
- security_monitoring_suppressions_write
|
65958
|
+
summary: Validate a suppression rule
|
65959
|
+
tags:
|
65960
|
+
- Security Monitoring
|
65961
|
+
x-codegen-request-body-name: body
|
65962
|
+
x-permission:
|
65963
|
+
operator: OR
|
65964
|
+
permissions:
|
65965
|
+
- security_monitoring_suppressions_write
|
62789
65966
|
/api/v2/security_monitoring/configuration/suppressions/{suppression_id}:
|
62790
65967
|
delete:
|
62791
65968
|
description: Delete a specific suppression rule.
|
@@ -63276,52 +66453,12 @@ paths:
|
|
63276
66453
|
security signals.'
|
63277
66454
|
operationId: ListSecurityMonitoringSignals
|
63278
66455
|
parameters:
|
63279
|
-
-
|
63280
|
-
|
63281
|
-
|
63282
|
-
|
63283
|
-
|
63284
|
-
|
63285
|
-
type: string
|
63286
|
-
- description: The minimum timestamp for requested security signals.
|
63287
|
-
example: '2019-01-02T09:42:36.320Z'
|
63288
|
-
in: query
|
63289
|
-
name: filter[from]
|
63290
|
-
required: false
|
63291
|
-
schema:
|
63292
|
-
format: date-time
|
63293
|
-
type: string
|
63294
|
-
- description: The maximum timestamp for requested security signals.
|
63295
|
-
example: '2019-01-03T09:42:36.320Z'
|
63296
|
-
in: query
|
63297
|
-
name: filter[to]
|
63298
|
-
required: false
|
63299
|
-
schema:
|
63300
|
-
format: date-time
|
63301
|
-
type: string
|
63302
|
-
- description: The order of the security signals in results.
|
63303
|
-
in: query
|
63304
|
-
name: sort
|
63305
|
-
required: false
|
63306
|
-
schema:
|
63307
|
-
$ref: '#/components/schemas/SecurityMonitoringSignalsSort'
|
63308
|
-
- description: A list of results using the cursor provided in the previous query.
|
63309
|
-
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
63310
|
-
in: query
|
63311
|
-
name: page[cursor]
|
63312
|
-
required: false
|
63313
|
-
schema:
|
63314
|
-
type: string
|
63315
|
-
- description: The maximum number of security signals in the response.
|
63316
|
-
example: 25
|
63317
|
-
in: query
|
63318
|
-
name: page[limit]
|
63319
|
-
required: false
|
63320
|
-
schema:
|
63321
|
-
default: 10
|
63322
|
-
format: int32
|
63323
|
-
maximum: 1000
|
63324
|
-
type: integer
|
66456
|
+
- $ref: '#/components/parameters/QueryFilterSearch'
|
66457
|
+
- $ref: '#/components/parameters/QueryFilterFrom'
|
66458
|
+
- $ref: '#/components/parameters/QueryFilterTo'
|
66459
|
+
- $ref: '#/components/parameters/QuerySort'
|
66460
|
+
- $ref: '#/components/parameters/QueryPageCursor'
|
66461
|
+
- $ref: '#/components/parameters/QueryPageLimit'
|
63325
66462
|
responses:
|
63326
66463
|
'200':
|
63327
66464
|
content:
|
@@ -64602,6 +67739,123 @@ paths:
|
|
64602
67739
|
permissions:
|
64603
67740
|
- incident_settings_write
|
64604
67741
|
x-unstable: '**Note**: This endpoint is deprecated.'
|
67742
|
+
/api/v2/siem-historical-detections/histsignals:
|
67743
|
+
get:
|
67744
|
+
description: List hist signals.
|
67745
|
+
operationId: ListSecurityMonitoringHistsignals
|
67746
|
+
parameters:
|
67747
|
+
- $ref: '#/components/parameters/QueryFilterSearch'
|
67748
|
+
- $ref: '#/components/parameters/QueryFilterFrom'
|
67749
|
+
- $ref: '#/components/parameters/QueryFilterTo'
|
67750
|
+
- $ref: '#/components/parameters/QuerySort'
|
67751
|
+
- $ref: '#/components/parameters/QueryPageCursor'
|
67752
|
+
- $ref: '#/components/parameters/QueryPageLimit'
|
67753
|
+
responses:
|
67754
|
+
'200':
|
67755
|
+
content:
|
67756
|
+
application/json:
|
67757
|
+
schema:
|
67758
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalsListResponse'
|
67759
|
+
description: OK
|
67760
|
+
'400':
|
67761
|
+
$ref: '#/components/responses/BadRequestResponse'
|
67762
|
+
'403':
|
67763
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
67764
|
+
'404':
|
67765
|
+
$ref: '#/components/responses/NotFoundResponse'
|
67766
|
+
'429':
|
67767
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
67768
|
+
security:
|
67769
|
+
- apiKeyAuth: []
|
67770
|
+
appKeyAuth: []
|
67771
|
+
- AuthZ:
|
67772
|
+
- security_monitoring_signals_read
|
67773
|
+
summary: List hist signals
|
67774
|
+
tags:
|
67775
|
+
- Security Monitoring
|
67776
|
+
x-permission:
|
67777
|
+
operator: OR
|
67778
|
+
permissions:
|
67779
|
+
- security_monitoring_signals_read
|
67780
|
+
x-unstable: '**Note**: This endpoint is in beta and may be subject to changes.
|
67781
|
+
|
67782
|
+
Please check the documentation regularly for updates.'
|
67783
|
+
/api/v2/siem-historical-detections/histsignals/search:
|
67784
|
+
get:
|
67785
|
+
description: Search hist signals.
|
67786
|
+
operationId: SearchSecurityMonitoringHistsignals
|
67787
|
+
requestBody:
|
67788
|
+
content:
|
67789
|
+
application/json:
|
67790
|
+
schema:
|
67791
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalListRequest'
|
67792
|
+
required: false
|
67793
|
+
responses:
|
67794
|
+
'200':
|
67795
|
+
content:
|
67796
|
+
application/json:
|
67797
|
+
schema:
|
67798
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalsListResponse'
|
67799
|
+
description: OK
|
67800
|
+
'400':
|
67801
|
+
$ref: '#/components/responses/BadRequestResponse'
|
67802
|
+
'403':
|
67803
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
67804
|
+
'404':
|
67805
|
+
$ref: '#/components/responses/NotFoundResponse'
|
67806
|
+
'429':
|
67807
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
67808
|
+
security:
|
67809
|
+
- apiKeyAuth: []
|
67810
|
+
appKeyAuth: []
|
67811
|
+
- AuthZ:
|
67812
|
+
- security_monitoring_signals_read
|
67813
|
+
summary: Search hist signals
|
67814
|
+
tags:
|
67815
|
+
- Security Monitoring
|
67816
|
+
x-permission:
|
67817
|
+
operator: OR
|
67818
|
+
permissions:
|
67819
|
+
- security_monitoring_signals_read
|
67820
|
+
x-unstable: '**Note**: This endpoint is in beta and may be subject to changes.
|
67821
|
+
|
67822
|
+
Please check the documentation regularly for updates.'
|
67823
|
+
/api/v2/siem-historical-detections/histsignals/{histsignal_id}:
|
67824
|
+
get:
|
67825
|
+
description: Get a hist signal's details.
|
67826
|
+
operationId: GetSecurityMonitoringHistsignal
|
67827
|
+
parameters:
|
67828
|
+
- $ref: '#/components/parameters/HistoricalSignalID'
|
67829
|
+
responses:
|
67830
|
+
'200':
|
67831
|
+
content:
|
67832
|
+
application/json:
|
67833
|
+
schema:
|
67834
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalResponse'
|
67835
|
+
description: OK
|
67836
|
+
'400':
|
67837
|
+
$ref: '#/components/responses/BadRequestResponse'
|
67838
|
+
'403':
|
67839
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
67840
|
+
'404':
|
67841
|
+
$ref: '#/components/responses/NotFoundResponse'
|
67842
|
+
'429':
|
67843
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
67844
|
+
security:
|
67845
|
+
- apiKeyAuth: []
|
67846
|
+
appKeyAuth: []
|
67847
|
+
- AuthZ:
|
67848
|
+
- security_monitoring_signals_read
|
67849
|
+
summary: Get a hist signal's details
|
67850
|
+
tags:
|
67851
|
+
- Security Monitoring
|
67852
|
+
x-permission:
|
67853
|
+
operator: OR
|
67854
|
+
permissions:
|
67855
|
+
- security_monitoring_signals_read
|
67856
|
+
x-unstable: '**Note**: This endpoint is in beta and may be subject to changes.
|
67857
|
+
|
67858
|
+
Please check the documentation regularly for updates.'
|
64605
67859
|
/api/v2/siem-historical-detections/jobs:
|
64606
67860
|
get:
|
64607
67861
|
description: List historical jobs.
|
@@ -64823,6 +68077,48 @@ paths:
|
|
64823
68077
|
- security_monitoring_rules_write
|
64824
68078
|
x-unstable: '**Note**: This endpoint is in beta and may be subject to changes.
|
64825
68079
|
|
68080
|
+
Please check the documentation regularly for updates.'
|
68081
|
+
/api/v2/siem-historical-detections/jobs/{job_id}/histsignals:
|
68082
|
+
get:
|
68083
|
+
description: Get a job's hist signals.
|
68084
|
+
operationId: GetSecurityMonitoringHistsignalsByJobId
|
68085
|
+
parameters:
|
68086
|
+
- $ref: '#/components/parameters/HistoricalJobID'
|
68087
|
+
- $ref: '#/components/parameters/QueryFilterSearch'
|
68088
|
+
- $ref: '#/components/parameters/QueryFilterFrom'
|
68089
|
+
- $ref: '#/components/parameters/QueryFilterTo'
|
68090
|
+
- $ref: '#/components/parameters/QuerySort'
|
68091
|
+
- $ref: '#/components/parameters/QueryPageCursor'
|
68092
|
+
- $ref: '#/components/parameters/QueryPageLimit'
|
68093
|
+
responses:
|
68094
|
+
'200':
|
68095
|
+
content:
|
68096
|
+
application/json:
|
68097
|
+
schema:
|
68098
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalsListResponse'
|
68099
|
+
description: OK
|
68100
|
+
'400':
|
68101
|
+
$ref: '#/components/responses/BadRequestResponse'
|
68102
|
+
'403':
|
68103
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
68104
|
+
'404':
|
68105
|
+
$ref: '#/components/responses/NotFoundResponse'
|
68106
|
+
'429':
|
68107
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
68108
|
+
security:
|
68109
|
+
- apiKeyAuth: []
|
68110
|
+
appKeyAuth: []
|
68111
|
+
- AuthZ:
|
68112
|
+
- security_monitoring_signals_read
|
68113
|
+
summary: Get a job's hist signals
|
68114
|
+
tags:
|
68115
|
+
- Security Monitoring
|
68116
|
+
x-permission:
|
68117
|
+
operator: OR
|
68118
|
+
permissions:
|
68119
|
+
- security_monitoring_signals_read
|
68120
|
+
x-unstable: '**Note**: This endpoint is in beta and may be subject to changes.
|
68121
|
+
|
64826
68122
|
Please check the documentation regularly for updates.'
|
64827
68123
|
/api/v2/slo/report:
|
64828
68124
|
post:
|
@@ -64971,6 +68267,69 @@ paths:
|
|
64971
68267
|
x-unstable: '**Note**: This feature is in private beta. To request access, use
|
64972
68268
|
the request access form in the [Service Level Objectives](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-csv-export)
|
64973
68269
|
docs.'
|
68270
|
+
/api/v2/spa/recommendations/{service}/{shard}:
|
68271
|
+
get:
|
68272
|
+
description: Retrieve resource recommendations for a Spark job. The caller (Spark
|
68273
|
+
Gateway or DJM UI) provides a service name and shard identifier, and SPA returns
|
68274
|
+
structured recommendations for driver and executor resources.
|
68275
|
+
operationId: GetSPARecommendations
|
68276
|
+
parameters:
|
68277
|
+
- description: The shard tag for a spark job, which differentiates jobs within
|
68278
|
+
the same service that have different resource needs
|
68279
|
+
in: path
|
68280
|
+
name: shard
|
68281
|
+
required: true
|
68282
|
+
schema:
|
68283
|
+
type: string
|
68284
|
+
- description: The service name for a spark job
|
68285
|
+
in: path
|
68286
|
+
name: service
|
68287
|
+
required: true
|
68288
|
+
schema:
|
68289
|
+
type: string
|
68290
|
+
responses:
|
68291
|
+
'200':
|
68292
|
+
content:
|
68293
|
+
application/json:
|
68294
|
+
example:
|
68295
|
+
data:
|
68296
|
+
attributes:
|
68297
|
+
driver:
|
68298
|
+
estimation:
|
68299
|
+
cpu:
|
68300
|
+
max: 1500
|
68301
|
+
p75: 1000
|
68302
|
+
p95: 1200
|
68303
|
+
ephemeral_storage: 896
|
68304
|
+
heap: 6144
|
68305
|
+
memory: 7168
|
68306
|
+
overhead: 1024
|
68307
|
+
executor:
|
68308
|
+
estimation:
|
68309
|
+
cpu:
|
68310
|
+
max: 2000
|
68311
|
+
p75: 1200
|
68312
|
+
p95: 1500
|
68313
|
+
ephemeral_storage: 512
|
68314
|
+
heap: 3072
|
68315
|
+
memory: 4096
|
68316
|
+
overhead: 1024
|
68317
|
+
id: dedupeactivecontexts:adp_dedupeactivecontexts_org2
|
68318
|
+
type: recommendation
|
68319
|
+
schema:
|
68320
|
+
$ref: '#/components/schemas/RecommendationDocument'
|
68321
|
+
description: OK
|
68322
|
+
'400':
|
68323
|
+
$ref: '#/components/responses/BadRequestResponse'
|
68324
|
+
'403':
|
68325
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
68326
|
+
'429':
|
68327
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
68328
|
+
summary: Get SPA Recommendations
|
68329
|
+
tags:
|
68330
|
+
- Spa
|
68331
|
+
x-unstable: '**Note**: This endpoint is in public beta and may change in the
|
68332
|
+
future. It is not yet recommended for production use.'
|
64974
68333
|
/api/v2/spans/analytics/aggregate:
|
64975
68334
|
post:
|
64976
68335
|
description: 'The API endpoint to aggregate spans into buckets and compute metrics
|
@@ -65313,6 +68672,71 @@ paths:
|
|
65313
68672
|
permissions:
|
65314
68673
|
- teams_read
|
65315
68674
|
- teams_manage
|
68675
|
+
/api/v2/team/sync:
|
68676
|
+
post:
|
68677
|
+
description: 'This endpoint attempts to link your existing Datadog teams with
|
68678
|
+
GitHub teams by matching their names.
|
68679
|
+
|
68680
|
+
It evaluates all current Datadog teams and compares them against teams in
|
68681
|
+
the GitHub organization
|
68682
|
+
|
68683
|
+
connected to your Datadog account, based on Datadog Team handle and GitHub
|
68684
|
+
Team slug
|
68685
|
+
|
68686
|
+
(lowercased and kebab-cased).
|
68687
|
+
|
68688
|
+
|
68689
|
+
This operation is read-only on the GitHub side, no teams will be modified
|
68690
|
+
or created.
|
68691
|
+
|
68692
|
+
|
68693
|
+
[A GitHub organization must be connected to your Datadog account](https://docs.datadoghq.com/integrations/github/),
|
68694
|
+
|
68695
|
+
and the GitHub App integrated with Datadog must have the `Members Read` permission.
|
68696
|
+
Matching is performed by comparing the Datadog team handle to the GitHub team
|
68697
|
+
slug
|
68698
|
+
|
68699
|
+
using a normalized exact match; case is ignored and spaces are removed. No
|
68700
|
+
modifications are made
|
68701
|
+
|
68702
|
+
to teams in GitHub. This will not create new Teams in Datadog.'
|
68703
|
+
operationId: SyncTeams
|
68704
|
+
requestBody:
|
68705
|
+
content:
|
68706
|
+
application/json:
|
68707
|
+
schema:
|
68708
|
+
$ref: '#/components/schemas/TeamSyncRequest'
|
68709
|
+
required: true
|
68710
|
+
responses:
|
68711
|
+
'200':
|
68712
|
+
description: OK
|
68713
|
+
'403':
|
68714
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
68715
|
+
'429':
|
68716
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
68717
|
+
'500':
|
68718
|
+
content:
|
68719
|
+
application/json:
|
68720
|
+
schema:
|
68721
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
68722
|
+
description: Internal Server Error - Unexpected error during linking.
|
68723
|
+
security:
|
68724
|
+
- apiKeyAuth: []
|
68725
|
+
appKeyAuth: []
|
68726
|
+
- AuthZ:
|
68727
|
+
- teams_manage
|
68728
|
+
summary: Link Teams with GitHub Teams
|
68729
|
+
tags:
|
68730
|
+
- Teams
|
68731
|
+
x-codegen-request-body-name: body
|
68732
|
+
x-permission:
|
68733
|
+
operator: AND
|
68734
|
+
permissions:
|
68735
|
+
- teams_manage
|
68736
|
+
x-unstable: '**Note**: This endpoint is in Preview. To request access, fill
|
68737
|
+
out this [form](https://www.datadoghq.com/product-preview/github-integration-for-teams/).
|
68738
|
+
|
68739
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
65316
68740
|
/api/v2/team/{super_team_id}/member_teams:
|
65317
68741
|
get:
|
65318
68742
|
description: Get all member teams.
|
@@ -66525,13 +69949,15 @@ paths:
|
|
66525
69949
|
appKeyAuth: []
|
66526
69950
|
- AuthZ:
|
66527
69951
|
- usage_read
|
69952
|
+
- billing_read
|
66528
69953
|
summary: Get cost across multi-org account
|
66529
69954
|
tags:
|
66530
69955
|
- Usage Metering
|
66531
69956
|
x-permission:
|
66532
|
-
operator:
|
69957
|
+
operator: AND
|
66533
69958
|
permissions:
|
66534
69959
|
- usage_read
|
69960
|
+
- billing_read
|
66535
69961
|
/api/v2/usage/estimated_cost:
|
66536
69962
|
get:
|
66537
69963
|
description: 'Get estimated cost across multi-org and single root-org accounts.
|
@@ -66629,13 +70055,15 @@ paths:
|
|
66629
70055
|
appKeyAuth: []
|
66630
70056
|
- AuthZ:
|
66631
70057
|
- usage_read
|
70058
|
+
- billing_read
|
66632
70059
|
summary: Get estimated cost across your account
|
66633
70060
|
tags:
|
66634
70061
|
- Usage Metering
|
66635
70062
|
x-permission:
|
66636
|
-
operator:
|
70063
|
+
operator: AND
|
66637
70064
|
permissions:
|
66638
70065
|
- usage_read
|
70066
|
+
- billing_read
|
66639
70067
|
/api/v2/usage/historical_cost:
|
66640
70068
|
get:
|
66641
70069
|
description: 'Get historical cost across multi-org and single root-org accounts.
|
@@ -66647,14 +70075,6 @@ paths:
|
|
66647
70075
|
This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/).'
|
66648
70076
|
operationId: GetHistoricalCostByOrg
|
66649
70077
|
parameters:
|
66650
|
-
- description: String to specify whether cost is broken down at a parent-org
|
66651
|
-
level or at the sub-org level. Available views are `summary` and `sub-org`. Defaults
|
66652
|
-
to `summary`.
|
66653
|
-
in: query
|
66654
|
-
name: view
|
66655
|
-
required: false
|
66656
|
-
schema:
|
66657
|
-
type: string
|
66658
70078
|
- description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
|
66659
70079
|
for cost beginning this month.'
|
66660
70080
|
in: query
|
@@ -66663,6 +70083,14 @@ paths:
|
|
66663
70083
|
schema:
|
66664
70084
|
format: date-time
|
66665
70085
|
type: string
|
70086
|
+
- description: String to specify whether cost is broken down at a parent-org
|
70087
|
+
level or at the sub-org level. Available views are `summary` and `sub-org`. Defaults
|
70088
|
+
to `summary`.
|
70089
|
+
in: query
|
70090
|
+
name: view
|
70091
|
+
required: false
|
70092
|
+
schema:
|
70093
|
+
type: string
|
66666
70094
|
- description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
|
66667
70095
|
for cost ending this month.'
|
66668
70096
|
in: query
|
@@ -66710,13 +70138,15 @@ paths:
|
|
66710
70138
|
appKeyAuth: []
|
66711
70139
|
- AuthZ:
|
66712
70140
|
- usage_read
|
70141
|
+
- billing_read
|
66713
70142
|
summary: Get historical cost across your account
|
66714
70143
|
tags:
|
66715
70144
|
- Usage Metering
|
66716
70145
|
x-permission:
|
66717
|
-
operator:
|
70146
|
+
operator: AND
|
66718
70147
|
permissions:
|
66719
70148
|
- usage_read
|
70149
|
+
- billing_read
|
66720
70150
|
/api/v2/usage/hourly_usage:
|
66721
70151
|
get:
|
66722
70152
|
description: Get hourly usage by product family.
|
@@ -67045,13 +70475,15 @@ paths:
|
|
67045
70475
|
appKeyAuth: []
|
67046
70476
|
- AuthZ:
|
67047
70477
|
- usage_read
|
70478
|
+
- billing_read
|
67048
70479
|
summary: Get projected cost across your account
|
67049
70480
|
tags:
|
67050
70481
|
- Usage Metering
|
67051
70482
|
x-permission:
|
67052
|
-
operator:
|
70483
|
+
operator: AND
|
67053
70484
|
permissions:
|
67054
70485
|
- usage_read
|
70486
|
+
- billing_read
|
67055
70487
|
/api/v2/user_invitations:
|
67056
70488
|
post:
|
67057
70489
|
description: Sends emails to one or more users inviting them to join the organization.
|
@@ -67532,6 +70964,7 @@ paths:
|
|
67532
70964
|
post:
|
67533
70965
|
description: Create a new workflow, returning the workflow ID. This API requires
|
67534
70966
|
a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
70967
|
+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
|
67535
70968
|
operationId: CreateWorkflow
|
67536
70969
|
requestBody:
|
67537
70970
|
content:
|
@@ -67575,6 +71008,7 @@ paths:
|
|
67575
71008
|
delete:
|
67576
71009
|
description: Delete a workflow by ID. This API requires a [registered application
|
67577
71010
|
key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
71011
|
+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
|
67578
71012
|
operationId: DeleteWorkflow
|
67579
71013
|
parameters:
|
67580
71014
|
- $ref: '#/components/parameters/WorkflowId'
|
@@ -67609,6 +71043,7 @@ paths:
|
|
67609
71043
|
get:
|
67610
71044
|
description: Get a workflow by ID. This API requires a [registered application
|
67611
71045
|
key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
71046
|
+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
|
67612
71047
|
operationId: GetWorkflow
|
67613
71048
|
parameters:
|
67614
71049
|
- $ref: '#/components/parameters/WorkflowId'
|
@@ -67653,6 +71088,7 @@ paths:
|
|
67653
71088
|
patch:
|
67654
71089
|
description: Update a workflow by ID. This API requires a [registered application
|
67655
71090
|
key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
71091
|
+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
|
67656
71092
|
operationId: UpdateWorkflow
|
67657
71093
|
parameters:
|
67658
71094
|
- $ref: '#/components/parameters/WorkflowId'
|
@@ -67704,6 +71140,7 @@ paths:
|
|
67704
71140
|
get:
|
67705
71141
|
description: List all instances of a given workflow. This API requires a [registered
|
67706
71142
|
application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
71143
|
+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
|
67707
71144
|
operationId: ListWorkflowInstances
|
67708
71145
|
parameters:
|
67709
71146
|
- $ref: '#/components/parameters/WorkflowId'
|
@@ -67737,6 +71174,7 @@ paths:
|
|
67737
71174
|
post:
|
67738
71175
|
description: Execute the given workflow. This API requires a [registered application
|
67739
71176
|
key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
71177
|
+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
|
67740
71178
|
operationId: CreateWorkflowInstance
|
67741
71179
|
parameters:
|
67742
71180
|
- $ref: '#/components/parameters/WorkflowId'
|
@@ -67776,6 +71214,7 @@ paths:
|
|
67776
71214
|
get:
|
67777
71215
|
description: Get a specific execution of a given workflow. This API requires
|
67778
71216
|
a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
71217
|
+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
|
67779
71218
|
operationId: GetWorkflowInstance
|
67780
71219
|
parameters:
|
67781
71220
|
- $ref: '#/components/parameters/WorkflowId'
|
@@ -67811,6 +71250,7 @@ paths:
|
|
67811
71250
|
put:
|
67812
71251
|
description: Cancels a specific execution of a given workflow. This API requires
|
67813
71252
|
a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
|
71253
|
+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
|
67814
71254
|
operationId: CancelWorkflowInstance
|
67815
71255
|
parameters:
|
67816
71256
|
- $ref: '#/components/parameters/WorkflowId'
|
@@ -68053,6 +71493,9 @@ tags:
|
|
68053
71493
|
|
68054
71494
|
end times, prevent all alerting related to specified Datadog tags.'
|
68055
71495
|
name: Downtimes
|
71496
|
+
- description: View and manage issues within Error Tracking. See the [Error Tracking
|
71497
|
+
page](https://docs.datadoghq.com/error_tracking/) for more information.
|
71498
|
+
name: Error Tracking
|
68056
71499
|
- description: 'The Event Management API allows you to programmatically post events
|
68057
71500
|
to the Events Explorer and fetch events from the Events Explorer. See the [Event
|
68058
71501
|
Management page](https://docs.datadoghq.com/service_management/events/) for more
|
@@ -68213,6 +71656,11 @@ tags:
|
|
68213
71656
|
externalDocs:
|
68214
71657
|
url: https://docs.datadoghq.com/api/latest/opsgenie-integration
|
68215
71658
|
name: Opsgenie Integration
|
71659
|
+
- description: Manage connections between organizations. Org connections allow for
|
71660
|
+
controlled sharing of data between different Datadog organizations. See the [Cross-Organization
|
71661
|
+
Visibiltiy](https://docs.datadoghq.com/account_management/org_settings/cross_org_visibility/)
|
71662
|
+
page for more information.
|
71663
|
+
name: Org Connections
|
68216
71664
|
- description: Create, edit, and manage your organizations. Read more about [multi-org
|
68217
71665
|
accounts](https://docs.datadoghq.com/account_management/multi_organization).
|
68218
71666
|
externalDocs:
|
@@ -68323,6 +71771,9 @@ tags:
|
|
68323
71771
|
externalDocs:
|
68324
71772
|
url: https://docs.datadoghq.com/service_catalog/service_definitions#metadata-schema-v30-beta
|
68325
71773
|
name: Software Catalog
|
71774
|
+
- description: SPA (Spark Pod Autosizing) API. Provides resource recommendations and
|
71775
|
+
cost insights to help optimize Spark job configurations.
|
71776
|
+
name: Spa
|
68326
71777
|
- description: Search and aggregate your spans from your Datadog platform over HTTP.
|
68327
71778
|
name: Spans
|
68328
71779
|
- description: Manage configuration of [span-based metrics](https://app.datadoghq.com/apm/traces/generate-metrics)
|