datadog_api_client 2.26.1 → 2.28.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.apigentools-info +4 -4
- data/.generator/conftest.py +0 -3
- data/.generator/schemas/v1/openapi.yaml +2123 -212
- data/.generator/schemas/v2/openapi.yaml +3082 -240
- data/.generator/src/generator/formatter.py +3 -44
- data/.generator/src/generator/keywords.json +43 -0
- data/.generator/src/generator/templates/api.j2 +4 -0
- data/.generator/src/generator/templates/api_client.j2 +1 -0
- data/.github/workflows/approved_status.yml +4 -0
- data/.github/workflows/changelog.yml +5 -0
- data/.github/workflows/codeql-analysis.yml +4 -0
- data/.github/workflows/docs.yml +3 -0
- data/.github/workflows/labeler.yml +5 -0
- data/.github/workflows/prepare_release.yml +4 -0
- data/.github/workflows/publish.yml +5 -0
- data/.github/workflows/release.yml +4 -0
- data/.github/workflows/stale.yml +6 -0
- data/.github/workflows/test.yml +3 -0
- data/.github/workflows/test_integration.yml +3 -0
- data/CHANGELOG.md +66 -0
- data/examples/v1/dashboards/CreateDashboard_1413226400.rb +66 -0
- data/examples/v1/dashboards/CreateDashboard_1433408735.rb +44 -0
- data/examples/v1/dashboards/CreateDashboard_3298564989.rb +65 -0
- data/examples/v1/dashboards/CreateDashboard_794302680.rb +152 -0
- data/examples/v1/gcp-integration/CreateGCPIntegration.rb +1 -0
- data/examples/v1/gcp-integration/UpdateGCPIntegration.rb +1 -0
- data/examples/v1/gcp-integration/UpdateGCPIntegration_3544259255.rb +1 -0
- data/examples/v1/monitors/ValidateExistingMonitor.rb +0 -1
- data/examples/v1/monitors/ValidateMonitor.rb +0 -1
- data/examples/v1/monitors/ValidateMonitor_4247196452.rb +0 -1
- data/examples/v1/synthetics/CreateSyntheticsAPITest.rb +3 -1
- data/examples/v1/synthetics/CreateSyntheticsAPITest_1072503741.rb +1 -1
- data/examples/v1/synthetics/CreateSyntheticsAPITest_1279271422.rb +1 -1
- data/examples/v1/synthetics/CreateSyntheticsAPITest_1402674167.rb +1 -1
- data/examples/v1/synthetics/CreateSyntheticsAPITest_3829801148.rb +1 -1
- data/examples/v1/synthetics/CreateSyntheticsMobileTest.rb +27 -0
- data/examples/v1/synthetics/FetchUptimes.rb +13 -0
- data/examples/v1/synthetics/GetMobileTest.rb +8 -0
- data/examples/v1/synthetics/UpdateBrowserTest.rb +3 -1
- data/examples/v1/synthetics/UpdateMobileTest.rb +30 -0
- data/examples/v2/domain-allowlist/GetDomainAllowlist.rb +5 -0
- data/examples/v2/domain-allowlist/PatchDomainAllowlist.rb +17 -0
- data/examples/v2/gcp-integration/CreateGCPSTSAccount_2597004741.rb +1 -0
- data/examples/v2/incidents/CreateIncidentType.rb +19 -0
- data/examples/v2/incidents/DeleteIncidentType.rb +11 -0
- data/examples/v2/incidents/GetIncidentType.rb +8 -0
- data/examples/v2/incidents/ListIncidentTypes.rb +8 -0
- data/examples/v2/incidents/UpdateIncidentType.rb +22 -0
- data/examples/v2/logs/AggregateLogs_2955613758.rb +0 -1
- data/examples/v2/metrics/QueryScalarData.rb +0 -3
- data/examples/v2/metrics/QueryScalarData_3112571352.rb +0 -3
- data/examples/v2/metrics/QueryTimeseriesData.rb +0 -3
- data/examples/v2/metrics/QueryTimeseriesData_301142940.rb +0 -3
- data/examples/v2/microsoft-teams-integration/CreateTenantBasedHandle.rb +17 -0
- data/examples/v2/microsoft-teams-integration/CreateTenantBasedHandle_1540689753.rb +17 -0
- data/examples/v2/microsoft-teams-integration/DeleteTenantBasedHandle.rb +5 -0
- data/examples/v2/microsoft-teams-integration/DeleteTenantBasedHandle_377884154.rb +8 -0
- data/examples/v2/microsoft-teams-integration/GetChannelByName.rb +5 -0
- data/examples/v2/microsoft-teams-integration/GetTenantBasedHandle.rb +5 -0
- data/examples/v2/microsoft-teams-integration/GetTenantBasedHandle_2883785101.rb +8 -0
- data/examples/v2/microsoft-teams-integration/ListTenantBasedHandles.rb +5 -0
- data/examples/v2/microsoft-teams-integration/ListTenantBasedHandles_769592979.rb +5 -0
- data/examples/v2/microsoft-teams-integration/UpdateTenantBasedHandle.rb +17 -0
- data/examples/v2/microsoft-teams-integration/UpdateTenantBasedHandle_419892746.rb +18 -0
- data/examples/v2/rum-metrics/CreateRumMetric.rb +32 -0
- data/examples/v2/rum-metrics/DeleteRumMetric.rb +8 -0
- data/examples/v2/rum-metrics/GetRumMetric.rb +8 -0
- data/examples/v2/rum-metrics/ListRumMetrics.rb +5 -0
- data/examples/v2/rum-metrics/UpdateRumMetric.rb +29 -0
- data/examples/v2/security-monitoring/CreateSecurityMonitoringRule.rb +9 -0
- data/examples/v2/security-monitoring/ListFindings_1668290866.rb +14 -0
- data/examples/v2/usage-metering/GetBillingDimensionMapping.rb +8 -0
- data/examples/v2/usage-metering/GetMonthlyCostAttribution.rb +4 -1
- data/lib/datadog_api_client/api_client.rb +1 -0
- data/lib/datadog_api_client/configuration.rb +6 -2
- data/lib/datadog_api_client/inflector.rb +109 -5
- data/lib/datadog_api_client/v1/api/monitors_api.rb +6 -3
- data/lib/datadog_api_client/v1/api/synthetics_api.rb +274 -0
- data/lib/datadog_api_client/v1/api/usage_metering_api.rb +5 -3
- data/lib/datadog_api_client/v1/models/gcp_account.rb +11 -1
- data/lib/datadog_api_client/v1/models/hourly_usage_attribution_usage_type.rb +2 -3
- data/lib/datadog_api_client/v1/models/list_stream_source.rb +1 -0
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_supported_metrics.rb +4 -6
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_values.rb +21 -61
- data/lib/datadog_api_client/v1/models/slo_history_monitor.rb +1 -1
- data/lib/datadog_api_client/v1/models/synthetics_batch_details_data.rb +2 -2
- data/lib/datadog_api_client/v1/models/synthetics_batch_result.rb +2 -2
- data/lib/datadog_api_client/v1/models/{synthetics_status.rb → synthetics_batch_status.rb} +4 -4
- data/lib/datadog_api_client/v1/models/synthetics_config_variable_type.rb +1 -0
- data/lib/datadog_api_client/v1/models/synthetics_fetch_uptimes_payload.rb +167 -0
- data/lib/datadog_api_client/v1/models/synthetics_mobile_step.rb +229 -0
- data/lib/datadog_api_client/v1/models/synthetics_mobile_step_params.rb +249 -0
- data/lib/datadog_api_client/v1/models/synthetics_mobile_step_params_direction.rb +29 -0
- data/lib/datadog_api_client/v1/models/synthetics_mobile_step_params_element.rb +175 -0
- data/lib/datadog_api_client/v1/models/synthetics_mobile_step_params_element_context_type.rb +27 -0
- data/lib/datadog_api_client/v1/models/synthetics_mobile_step_params_element_relative_position.rb +115 -0
- data/lib/datadog_api_client/v1/models/synthetics_mobile_step_params_element_user_locator.rb +117 -0
- data/lib/datadog_api_client/v1/models/synthetics_mobile_step_params_element_user_locator_values_items.rb +115 -0
- data/lib/datadog_api_client/v1/models/synthetics_mobile_step_params_element_user_locator_values_items_type.rb +30 -0
- data/lib/datadog_api_client/v1/models/synthetics_mobile_step_params_positions_items.rb +115 -0
- data/lib/datadog_api_client/v1/models/synthetics_mobile_step_params_value.rb +63 -0
- data/lib/datadog_api_client/v1/models/synthetics_mobile_step_params_variable.rb +144 -0
- data/lib/datadog_api_client/v1/models/synthetics_mobile_step_type.rb +42 -0
- data/lib/datadog_api_client/v1/models/synthetics_mobile_test.rb +263 -0
- data/lib/datadog_api_client/v1/models/synthetics_mobile_test_config.rb +117 -0
- data/lib/datadog_api_client/v1/models/synthetics_mobile_test_options.rb +380 -0
- data/lib/datadog_api_client/v1/models/synthetics_mobile_test_type.rb +26 -0
- data/lib/datadog_api_client/v1/models/synthetics_mobile_tests_mobile_application.rb +173 -0
- data/lib/datadog_api_client/v1/models/synthetics_mobile_tests_mobile_application_reference_type.rb +27 -0
- data/lib/datadog_api_client/v1/models/synthetics_step.rb +22 -2
- data/lib/datadog_api_client/v1/models/synthetics_step_detail.rb +21 -1
- data/lib/datadog_api_client/v1/models/synthetics_test_ci_options.rb +19 -1
- data/lib/datadog_api_client/v1/models/synthetics_test_details_type.rb +1 -0
- data/lib/datadog_api_client/v1/models/synthetics_test_options_monitor_options.rb +34 -4
- data/lib/datadog_api_client/v1/models/synthetics_test_options_monitor_options_notification_preset_name.rb +29 -0
- data/lib/datadog_api_client/v1/models/synthetics_test_options_scheduling.rb +31 -2
- data/lib/datadog_api_client/v1/models/synthetics_test_options_scheduling_timeframe.rb +32 -6
- data/lib/datadog_api_client/v1/models/synthetics_test_request.rb +1 -1
- data/lib/datadog_api_client/v1/models/synthetics_test_request_port.rb +63 -0
- data/lib/datadog_api_client/v1/models/synthetics_test_restriction_policy_binding.rb +117 -0
- data/lib/datadog_api_client/v1/models/synthetics_test_restriction_policy_binding_relation.rb +27 -0
- data/lib/datadog_api_client/v1/models/synthetics_test_uptime.rb +135 -0
- data/lib/datadog_api_client/v1/models/synthetics_uptime.rb +161 -0
- data/lib/datadog_api_client/v1/models/table_widget_request.rb +16 -4
- data/lib/datadog_api_client/v1/models/table_widget_text_format_match.rb +144 -0
- data/lib/datadog_api_client/v1/models/table_widget_text_format_match_type.rb +31 -0
- data/lib/datadog_api_client/v1/models/table_widget_text_format_palette.rb +36 -0
- data/lib/datadog_api_client/v1/models/table_widget_text_format_replace.rb +63 -0
- data/lib/datadog_api_client/v1/models/table_widget_text_format_replace_all.rb +144 -0
- data/lib/datadog_api_client/v1/models/table_widget_text_format_replace_all_type.rb +26 -0
- data/lib/datadog_api_client/v1/models/table_widget_text_format_replace_substring.rb +165 -0
- data/lib/datadog_api_client/v1/models/table_widget_text_format_replace_substring_type.rb +26 -0
- data/lib/datadog_api_client/v1/models/table_widget_text_format_rule.rb +163 -0
- data/lib/datadog_api_client/v1/models/toplist_widget_stacked.rb +1 -12
- data/lib/datadog_api_client/v1/models/usage_summary_date.rb +51 -1
- data/lib/datadog_api_client/v1/models/usage_summary_date_org.rb +51 -1
- data/lib/datadog_api_client/v1/models/usage_summary_response.rb +51 -1
- data/lib/datadog_api_client/v2/api/authn_mappings_api.rb +3 -3
- data/lib/datadog_api_client/v2/api/cloud_cost_management_api.rb +3 -69
- data/lib/datadog_api_client/v2/api/domain_allowlist_api.rb +153 -0
- data/lib/datadog_api_client/v2/api/incidents_api.rb +362 -1
- data/lib/datadog_api_client/v2/api/metrics_api.rb +5 -17
- data/lib/datadog_api_client/v2/api/microsoft_teams_integration_api.rb +434 -0
- data/lib/datadog_api_client/v2/api/restriction_policies_api.rb +3 -3
- data/lib/datadog_api_client/v2/api/rum_metrics_api.rb +357 -0
- data/lib/datadog_api_client/v2/api/security_monitoring_api.rb +3 -0
- data/lib/datadog_api_client/v2/api/software_catalog_api.rb +19 -19
- data/lib/datadog_api_client/v2/api/teams_api.rb +1 -0
- data/lib/datadog_api_client/v2/api/usage_metering_api.rb +79 -10
- data/lib/datadog_api_client/v2/models/billing_dimensions_mapping_body_item.rb +125 -0
- data/lib/datadog_api_client/v2/models/billing_dimensions_mapping_body_item_attributes.rb +127 -0
- data/lib/datadog_api_client/v2/models/billing_dimensions_mapping_body_item_attributes_endpoints_items.rb +127 -0
- data/lib/datadog_api_client/v2/models/billing_dimensions_mapping_body_item_attributes_endpoints_items_status.rb +27 -0
- data/lib/datadog_api_client/v2/models/billing_dimensions_mapping_response.rb +107 -0
- data/lib/datadog_api_client/v2/models/cloudflare_account_create_request_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/cloudflare_account_response_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/cloudflare_account_update_request_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/domain_allowlist.rb +151 -0
- data/lib/datadog_api_client/v2/models/domain_allowlist_attributes.rb +117 -0
- data/lib/datadog_api_client/v2/models/domain_allowlist_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/domain_allowlist_response.rb +105 -0
- data/lib/datadog_api_client/v2/models/domain_allowlist_response_data.rb +151 -0
- data/lib/datadog_api_client/v2/models/domain_allowlist_response_data_attributes.rb +117 -0
- data/lib/datadog_api_client/v2/models/domain_allowlist_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/dora_deployment_request_attributes.rb +11 -1
- data/lib/datadog_api_client/v2/models/entity_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/entity_data.rb +1 -1
- data/lib/datadog_api_client/v2/models/entity_response_included_incident.rb +1 -1
- data/lib/datadog_api_client/v2/models/entity_response_included_raw_schema.rb +1 -1
- data/lib/datadog_api_client/v2/models/entity_response_included_related_oncall_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/entity_response_included_related_oncall_escalation_item.rb +1 -1
- data/lib/datadog_api_client/v2/models/entity_response_included_schema.rb +1 -1
- data/lib/datadog_api_client/v2/models/entity_v3_api_version.rb +1 -1
- data/lib/datadog_api_client/v2/models/entity_v3_datadog_code_location_item.rb +3 -3
- data/lib/datadog_api_client/v2/models/entity_v3_datadog_event_item.rb +2 -2
- data/lib/datadog_api_client/v2/models/entity_v3_datadog_integration_opsgenie.rb +2 -2
- data/lib/datadog_api_client/v2/models/entity_v3_datadog_integration_pagerduty.rb +2 -2
- data/lib/datadog_api_client/v2/models/entity_v3_datadog_log_item.rb +3 -3
- data/lib/datadog_api_client/v2/models/entity_v3_datadog_performance.rb +2 -2
- data/lib/datadog_api_client/v2/models/entity_v3_datadog_pipelines.rb +2 -2
- data/lib/datadog_api_client/v2/models/entity_v3_datastore.rb +4 -4
- data/lib/datadog_api_client/v2/models/entity_v3_datastore_datadog.rb +4 -4
- data/lib/datadog_api_client/v2/models/entity_v3_datastore_spec.rb +2 -2
- data/lib/datadog_api_client/v2/models/entity_v3_integrations.rb +3 -3
- data/lib/datadog_api_client/v2/models/entity_v3_metadata.rb +9 -9
- data/lib/datadog_api_client/v2/models/entity_v3_metadata_additional_owners_items.rb +2 -2
- data/lib/datadog_api_client/v2/models/entity_v3_metadata_contacts_items.rb +2 -2
- data/lib/datadog_api_client/v2/models/entity_v3_metadata_links_items.rb +2 -2
- data/lib/datadog_api_client/v2/models/entity_v3_metadata_owner.rb +2 -2
- data/lib/datadog_api_client/v2/models/entity_v3_queue.rb +5 -5
- data/lib/datadog_api_client/v2/models/entity_v3_queue_datadog.rb +4 -4
- data/lib/datadog_api_client/v2/models/entity_v3_queue_spec.rb +2 -2
- data/lib/datadog_api_client/v2/models/entity_v3_service.rb +5 -5
- data/lib/datadog_api_client/v2/models/entity_v3_service_datadog.rb +6 -6
- data/lib/datadog_api_client/v2/models/entity_v3_service_spec.rb +3 -3
- data/lib/datadog_api_client/v2/models/entity_v3_system.rb +5 -5
- data/lib/datadog_api_client/v2/models/entity_v3_system_datadog.rb +5 -5
- data/lib/datadog_api_client/v2/models/fastly_services_response.rb +1 -1
- data/lib/datadog_api_client/v2/models/finding_attributes.rb +14 -4
- data/lib/datadog_api_client/v2/models/finding_vulnerability_type.rb +29 -0
- data/lib/datadog_api_client/v2/models/gcp_metric_namespace_config.rb +115 -0
- data/lib/datadog_api_client/v2/models/gcpsts_service_account_attributes.rb +23 -1
- data/lib/datadog_api_client/v2/models/incident_create_attributes.rb +11 -1
- data/lib/datadog_api_client/v2/models/incident_integration_metadata_metadata.rb +2 -1
- data/lib/datadog_api_client/v2/models/incident_notification_handle.rb +1 -1
- data/lib/datadog_api_client/v2/models/incident_response_attributes.rb +11 -1
- data/lib/datadog_api_client/v2/models/incident_response_included_item.rb +1 -1
- data/lib/datadog_api_client/v2/models/incident_type_attributes.rb +193 -0
- data/lib/datadog_api_client/v2/models/incident_type_create_data.rb +144 -0
- data/lib/datadog_api_client/v2/models/incident_type_create_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/incident_type_list_response.rb +125 -0
- data/lib/datadog_api_client/v2/models/{aws_related_account.rb → incident_type_object.rb} +8 -8
- data/lib/datadog_api_client/v2/models/incident_type_patch_data.rb +165 -0
- data/lib/datadog_api_client/v2/models/incident_type_patch_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/incident_type_response.rb +123 -0
- data/lib/datadog_api_client/v2/models/{aws_related_account_type.rb → incident_type_type.rb} +3 -3
- data/lib/datadog_api_client/v2/models/incident_type_update_attributes.rb +175 -0
- data/lib/datadog_api_client/v2/models/incident_user_attributes.rb +153 -0
- data/lib/datadog_api_client/v2/models/incident_user_data.rb +125 -0
- data/lib/datadog_api_client/v2/models/include_type.rb +1 -1
- data/lib/datadog_api_client/v2/models/list_entity_catalog_response_links.rb +3 -3
- data/lib/datadog_api_client/v2/models/metric_tag_configuration_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/metric_tag_configuration_create_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/metric_tag_configuration_metric_type_category.rb +27 -0
- data/lib/datadog_api_client/v2/models/metric_tag_configuration_update_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/microsoft_teams_channel_info_response_attributes.rb +165 -0
- data/lib/datadog_api_client/v2/models/microsoft_teams_channel_info_response_data.rb +147 -0
- data/lib/datadog_api_client/v2/models/microsoft_teams_channel_info_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/microsoft_teams_create_tenant_based_handle_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/microsoft_teams_get_channel_by_name_response.rb +105 -0
- data/lib/datadog_api_client/v2/models/microsoft_teams_tenant_based_handle_attributes.rb +186 -0
- data/lib/datadog_api_client/v2/models/microsoft_teams_tenant_based_handle_info_response_attributes.rb +249 -0
- data/lib/datadog_api_client/v2/models/microsoft_teams_tenant_based_handle_info_response_data.rb +147 -0
- data/lib/datadog_api_client/v2/models/microsoft_teams_tenant_based_handle_info_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/microsoft_teams_tenant_based_handle_request_attributes.rb +202 -0
- data/lib/datadog_api_client/v2/models/microsoft_teams_tenant_based_handle_request_data.rb +144 -0
- data/lib/datadog_api_client/v2/models/microsoft_teams_tenant_based_handle_response.rb +123 -0
- data/lib/datadog_api_client/v2/models/microsoft_teams_tenant_based_handle_response_data.rb +147 -0
- data/lib/datadog_api_client/v2/models/microsoft_teams_tenant_based_handle_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/microsoft_teams_tenant_based_handles_response.rb +125 -0
- data/lib/datadog_api_client/v2/models/microsoft_teams_update_tenant_based_handle_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/microsoft_teams_update_tenant_based_handle_request_data.rb +144 -0
- data/lib/datadog_api_client/v2/models/ms_teams_integration_metadata.rb +125 -0
- data/lib/datadog_api_client/v2/models/ms_teams_integration_metadata_teams_item.rb +186 -0
- data/lib/datadog_api_client/v2/models/powerpack_template_variable.rb +35 -4
- data/lib/datadog_api_client/v2/models/relation_type.rb +1 -1
- data/lib/datadog_api_client/v2/models/relationship_item.rb +1 -1
- data/lib/datadog_api_client/v2/models/rum_metric_compute.rb +145 -0
- data/lib/datadog_api_client/v2/models/rum_metric_compute_aggregation_type.rb +27 -0
- data/lib/datadog_api_client/v2/models/rum_metric_create_attributes.rb +176 -0
- data/lib/datadog_api_client/v2/models/rum_metric_create_data.rb +165 -0
- data/lib/datadog_api_client/v2/models/rum_metric_create_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/rum_metric_event_type.rb +32 -0
- data/lib/datadog_api_client/v2/models/rum_metric_filter.rb +123 -0
- data/lib/datadog_api_client/v2/models/rum_metric_group_by.rb +133 -0
- data/lib/datadog_api_client/v2/models/rum_metric_response.rb +105 -0
- data/lib/datadog_api_client/v2/models/rum_metric_response_attributes.rb +147 -0
- data/lib/datadog_api_client/v2/models/rum_metric_response_compute.rb +127 -0
- data/lib/datadog_api_client/v2/models/rum_metric_response_data.rb +125 -0
- data/lib/datadog_api_client/v2/models/rum_metric_response_filter.rb +105 -0
- data/lib/datadog_api_client/v2/models/rum_metric_response_group_by.rb +115 -0
- data/lib/datadog_api_client/v2/models/{aws_related_account_attributes.rb → rum_metric_response_uniqueness.rb} +11 -21
- data/lib/datadog_api_client/v2/models/rum_metric_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/rum_metric_uniqueness.rb +123 -0
- data/lib/datadog_api_client/v2/models/rum_metric_uniqueness_when.rb +27 -0
- data/lib/datadog_api_client/v2/models/rum_metric_update_attributes.rb +127 -0
- data/lib/datadog_api_client/v2/models/rum_metric_update_compute.rb +106 -0
- data/lib/datadog_api_client/v2/models/rum_metric_update_data.rb +154 -0
- data/lib/datadog_api_client/v2/models/rum_metric_update_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/{aws_related_accounts_response.rb → rum_metrics_response.rb} +5 -5
- data/lib/datadog_api_client/v2/models/security_monitoring_reference_table.rb +145 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb +13 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_create_payload.rb +13 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_payload.rb +13 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_response.rb +13 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_test_payload.rb +13 -1
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_included_keyword_configuration.rb +15 -4
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_meta.rb +2 -2
- data/lib/datadog_api_client/v2/models/team_update_attributes.rb +1 -26
- data/lib/datadog_api_client/v2/models/upsert_catalog_entity_request.rb +1 -1
- data/lib/datadog_api_client/version.rb +1 -1
- metadata +145 -8
- data/examples/v2/cloud-cost-management/ListAWSRelatedAccounts.rb +0 -5
|
@@ -3314,6 +3314,12 @@ components:
|
|
|
3314
3314
|
to be set to true.'
|
|
3315
3315
|
example: true
|
|
3316
3316
|
type: boolean
|
|
3317
|
+
is_resource_change_collection_enabled:
|
|
3318
|
+
default: false
|
|
3319
|
+
description: When enabled, Datadog scans for all resource change data in
|
|
3320
|
+
your Google Cloud environment.
|
|
3321
|
+
example: true
|
|
3322
|
+
type: boolean
|
|
3317
3323
|
is_security_command_center_enabled:
|
|
3318
3324
|
default: false
|
|
3319
3325
|
description: 'When enabled, Datadog will attempt to collect Security Command
|
|
@@ -4182,15 +4188,14 @@ components:
|
|
|
4182
4188
|
- custom_timeseries_usage
|
|
4183
4189
|
- cws_containers_usage
|
|
4184
4190
|
- cws_hosts_usage
|
|
4191
|
+
- data_jobs_monitoring_usage
|
|
4192
|
+
- data_stream_monitoring_usage
|
|
4185
4193
|
- dbm_hosts_usage
|
|
4186
4194
|
- dbm_queries_usage
|
|
4187
4195
|
- error_tracking_usage
|
|
4188
4196
|
- error_tracking_percentage
|
|
4189
|
-
- estimated_indexed_logs_usage
|
|
4190
4197
|
- estimated_indexed_spans_usage
|
|
4191
|
-
- estimated_ingested_logs_usage
|
|
4192
4198
|
- estimated_ingested_spans_usage
|
|
4193
|
-
- estimated_rum_sessions_usage
|
|
4194
4199
|
- fargate_usage
|
|
4195
4200
|
- functions_usage
|
|
4196
4201
|
- incident_management_monthly_active_users_usage
|
|
@@ -4255,15 +4260,14 @@ components:
|
|
|
4255
4260
|
- CUSTOM_TIMESERIES_USAGE
|
|
4256
4261
|
- CWS_CONTAINERS_USAGE
|
|
4257
4262
|
- CWS_HOSTS_USAGE
|
|
4263
|
+
- DATA_JOBS_MONITORING_USAGE
|
|
4264
|
+
- DATA_STREAM_MONITORING_USAGE
|
|
4258
4265
|
- DBM_HOSTS_USAGE
|
|
4259
4266
|
- DBM_QUERIES_USAGE
|
|
4260
4267
|
- ERROR_TRACKING_USAGE
|
|
4261
4268
|
- ERROR_TRACKING_PERCENTAGE
|
|
4262
|
-
- ESTIMATED_INDEXED_LOGS_USAGE
|
|
4263
4269
|
- ESTIMATED_INDEXED_SPANS_USAGE
|
|
4264
|
-
- ESTIMATED_INGESTED_LOGS_USAGE
|
|
4265
4270
|
- ESTIMATED_INGESTED_SPANS_USAGE
|
|
4266
|
-
- ESTIMATED_RUM_SESSIONS_USAGE
|
|
4267
4271
|
- FARGATE_USAGE
|
|
4268
4272
|
- FUNCTIONS_USAGE
|
|
4269
4273
|
- INCIDENT_MANAGEMENT_MONTHLY_ACTIVE_USERS_USAGE
|
|
@@ -4786,6 +4790,7 @@ components:
|
|
|
4786
4790
|
- logs_transaction_stream
|
|
4787
4791
|
- event_stream
|
|
4788
4792
|
- rum_stream
|
|
4793
|
+
- llm_observability_stream
|
|
4789
4794
|
example: apm_issue_stream
|
|
4790
4795
|
type: string
|
|
4791
4796
|
x-enum-varnames:
|
|
@@ -4801,6 +4806,7 @@ components:
|
|
|
4801
4806
|
- LOGS_TRANSACTION_STREAM
|
|
4802
4807
|
- EVENT_STREAM
|
|
4803
4808
|
- RUM_STREAM
|
|
4809
|
+
- LLM_OBSERVABILITY_STREAM
|
|
4804
4810
|
ListStreamWidgetDefinition:
|
|
4805
4811
|
description: 'The list stream visualization displays a table of recent events
|
|
4806
4812
|
in your application that
|
|
@@ -7935,16 +7941,16 @@ components:
|
|
|
7935
7941
|
- cws_containers_usage
|
|
7936
7942
|
- cws_hosts_percentage
|
|
7937
7943
|
- cws_hosts_usage
|
|
7944
|
+
- data_jobs_monitoring_usage
|
|
7945
|
+
- data_jobs_monitoring_percentage
|
|
7946
|
+
- data_stream_monitoring_usage
|
|
7947
|
+
- data_stream_monitoring_percentage
|
|
7938
7948
|
- dbm_hosts_percentage
|
|
7939
7949
|
- dbm_hosts_usage
|
|
7940
7950
|
- dbm_queries_percentage
|
|
7941
7951
|
- dbm_queries_usage
|
|
7942
7952
|
- error_tracking_usage
|
|
7943
7953
|
- error_tracking_percentage
|
|
7944
|
-
- estimated_indexed_logs_usage
|
|
7945
|
-
- estimated_indexed_logs_percentage
|
|
7946
|
-
- estimated_ingested_logs_usage
|
|
7947
|
-
- estimated_ingested_logs_percentage
|
|
7948
7954
|
- estimated_indexed_spans_usage
|
|
7949
7955
|
- estimated_indexed_spans_percentage
|
|
7950
7956
|
- estimated_ingested_spans_usage
|
|
@@ -7983,8 +7989,6 @@ components:
|
|
|
7983
7989
|
- serverless_apps_percentage
|
|
7984
7990
|
- snmp_usage
|
|
7985
7991
|
- snmp_percentage
|
|
7986
|
-
- estimated_rum_sessions_usage
|
|
7987
|
-
- estimated_rum_sessions_percentage
|
|
7988
7992
|
- universal_service_monitoring_usage
|
|
7989
7993
|
- universal_service_monitoring_percentage
|
|
7990
7994
|
- vuln_management_hosts_usage
|
|
@@ -8076,16 +8080,16 @@ components:
|
|
|
8076
8080
|
- CWS_CONTAINERS_USAGE
|
|
8077
8081
|
- CWS_HOSTS_PERCENTAGE
|
|
8078
8082
|
- CWS_HOSTS_USAGE
|
|
8083
|
+
- DATA_JOBS_MONITORING_USAGE
|
|
8084
|
+
- DATA_JOBS_MONITORING_PERCENTAGE
|
|
8085
|
+
- DATA_STREAM_MONITORING_USAGE
|
|
8086
|
+
- DATA_STREAM_MONITORING_PERCENTAGE
|
|
8079
8087
|
- DBM_HOSTS_PERCENTAGE
|
|
8080
8088
|
- DBM_HOSTS_USAGE
|
|
8081
8089
|
- DBM_QUERIES_PERCENTAGE
|
|
8082
8090
|
- DBM_QUERIES_USAGE
|
|
8083
8091
|
- ERROR_TRACKING_USAGE
|
|
8084
8092
|
- ERROR_TRACKING_PERCENTAGE
|
|
8085
|
-
- ESTIMATED_INDEXED_LOGS_USAGE
|
|
8086
|
-
- ESTIMATED_INDEXED_LOGS_PERCENTAGE
|
|
8087
|
-
- ESTIMATED_INGESTED_LOGS_USAGE
|
|
8088
|
-
- ESTIMATED_INGESTED_LOGS_PERCENTAGE
|
|
8089
8093
|
- ESTIMATED_INDEXED_SPANS_USAGE
|
|
8090
8094
|
- ESTIMATED_INDEXED_SPANS_PERCENTAGE
|
|
8091
8095
|
- ESTIMATED_INGESTED_SPANS_USAGE
|
|
@@ -8124,8 +8128,6 @@ components:
|
|
|
8124
8128
|
- SERVERLESS_APPS_PERCENTAGE
|
|
8125
8129
|
- SNMP_USAGE
|
|
8126
8130
|
- SNMP_PERCENTAGE
|
|
8127
|
-
- ESTIMATED_RUM_SESSIONS_USAGE
|
|
8128
|
-
- ESTIMATED_RUM_SESSIONS_PERCENTAGE
|
|
8129
8131
|
- UNIVERSAL_SERVICE_MONITORING_USAGE
|
|
8130
8132
|
- UNIVERSAL_SERVICE_MONITORING_PERCENTAGE
|
|
8131
8133
|
- VULN_MANAGEMENT_HOSTS_USAGE
|
|
@@ -8363,6 +8365,14 @@ components:
|
|
|
8363
8365
|
description: The Cloud Workload Security host usage by tag(s).
|
|
8364
8366
|
format: double
|
|
8365
8367
|
type: number
|
|
8368
|
+
data_jobs_monitoring_usage:
|
|
8369
|
+
description: The Data Jobs Monitoring usage by tag(s).
|
|
8370
|
+
format: double
|
|
8371
|
+
type: number
|
|
8372
|
+
data_stream_monitoring_usage:
|
|
8373
|
+
description: The Data Stream Monitoring usage by tag(s).
|
|
8374
|
+
format: double
|
|
8375
|
+
type: number
|
|
8366
8376
|
dbm_hosts_percentage:
|
|
8367
8377
|
description: The percentage of Database Monitoring host usage by tag(s).
|
|
8368
8378
|
format: double
|
|
@@ -8387,14 +8397,6 @@ components:
|
|
|
8387
8397
|
description: The error tracking events usage by tag(s).
|
|
8388
8398
|
format: double
|
|
8389
8399
|
type: number
|
|
8390
|
-
estimated_indexed_logs_percentage:
|
|
8391
|
-
description: The percentage of estimated live indexed logs usage by tag(s).
|
|
8392
|
-
format: double
|
|
8393
|
-
type: number
|
|
8394
|
-
estimated_indexed_logs_usage:
|
|
8395
|
-
description: The estimated live indexed logs usage by tag(s).
|
|
8396
|
-
format: double
|
|
8397
|
-
type: number
|
|
8398
8400
|
estimated_indexed_spans_percentage:
|
|
8399
8401
|
description: The percentage of estimated indexed spans usage by tag(s).
|
|
8400
8402
|
format: double
|
|
@@ -8403,14 +8405,6 @@ components:
|
|
|
8403
8405
|
description: The estimated indexed spans usage by tag(s).
|
|
8404
8406
|
format: double
|
|
8405
8407
|
type: number
|
|
8406
|
-
estimated_ingested_logs_percentage:
|
|
8407
|
-
description: The percentage of estimated live ingested logs usage by tag(s).
|
|
8408
|
-
format: double
|
|
8409
|
-
type: number
|
|
8410
|
-
estimated_ingested_logs_usage:
|
|
8411
|
-
description: The estimated live ingested logs usage by tag(s).
|
|
8412
|
-
format: double
|
|
8413
|
-
type: number
|
|
8414
8408
|
estimated_ingested_spans_percentage:
|
|
8415
8409
|
description: The percentage of estimated ingested spans usage by tag(s).
|
|
8416
8410
|
format: double
|
|
@@ -8419,14 +8413,6 @@ components:
|
|
|
8419
8413
|
description: The estimated ingested spans usage by tag(s).
|
|
8420
8414
|
format: double
|
|
8421
8415
|
type: number
|
|
8422
|
-
estimated_rum_sessions_percentage:
|
|
8423
|
-
description: The percentage of estimated rum sessions usage by tag(s).
|
|
8424
|
-
format: double
|
|
8425
|
-
type: number
|
|
8426
|
-
estimated_rum_sessions_usage:
|
|
8427
|
-
description: The estimated rum sessions usage by tag(s).
|
|
8428
|
-
format: double
|
|
8429
|
-
type: number
|
|
8430
8416
|
fargate_percentage:
|
|
8431
8417
|
description: The percentage of Fargate usage by tags.
|
|
8432
8418
|
format: double
|
|
@@ -10827,7 +10813,7 @@ components:
|
|
|
10827
10813
|
Periods of no data are counted either as uptime or downtime depending
|
|
10828
10814
|
on monitor settings.
|
|
10829
10815
|
|
|
10830
|
-
See [SLO
|
|
10816
|
+
See [SLO documentation](https://docs.datadoghq.com/service_management/service_level_objectives/monitor/#missing-data)
|
|
10831
10817
|
|
|
10832
10818
|
for detailed information.'
|
|
10833
10819
|
example:
|
|
@@ -14432,7 +14418,7 @@ components:
|
|
|
14432
14418
|
$ref: '#/components/schemas/SyntheticsBatchResult'
|
|
14433
14419
|
type: array
|
|
14434
14420
|
status:
|
|
14435
|
-
$ref: '#/components/schemas/
|
|
14421
|
+
$ref: '#/components/schemas/SyntheticsBatchStatus'
|
|
14436
14422
|
type: object
|
|
14437
14423
|
SyntheticsBatchResult:
|
|
14438
14424
|
description: Object with the results of a Synthetic batch.
|
|
@@ -14456,7 +14442,7 @@ components:
|
|
|
14456
14442
|
format: double
|
|
14457
14443
|
type: number
|
|
14458
14444
|
status:
|
|
14459
|
-
$ref: '#/components/schemas/
|
|
14445
|
+
$ref: '#/components/schemas/SyntheticsBatchStatus'
|
|
14460
14446
|
test_name:
|
|
14461
14447
|
description: Name of the test.
|
|
14462
14448
|
type: string
|
|
@@ -14466,6 +14452,17 @@ components:
|
|
|
14466
14452
|
test_type:
|
|
14467
14453
|
$ref: '#/components/schemas/SyntheticsTestDetailsType'
|
|
14468
14454
|
type: object
|
|
14455
|
+
SyntheticsBatchStatus:
|
|
14456
|
+
description: Determines whether the batch has passed, failed, or is in progress.
|
|
14457
|
+
enum:
|
|
14458
|
+
- passed
|
|
14459
|
+
- skipped
|
|
14460
|
+
- failed
|
|
14461
|
+
type: string
|
|
14462
|
+
x-enum-varnames:
|
|
14463
|
+
- PASSED
|
|
14464
|
+
- SKIPPED
|
|
14465
|
+
- FAILED
|
|
14469
14466
|
SyntheticsBrowserError:
|
|
14470
14467
|
description: Error response object for a browser test.
|
|
14471
14468
|
properties:
|
|
@@ -15051,11 +15048,13 @@ components:
|
|
|
15051
15048
|
enum:
|
|
15052
15049
|
- global
|
|
15053
15050
|
- text
|
|
15051
|
+
- email
|
|
15054
15052
|
example: text
|
|
15055
15053
|
type: string
|
|
15056
15054
|
x-enum-varnames:
|
|
15057
15055
|
- GLOBAL
|
|
15058
15056
|
- TEXT
|
|
15057
|
+
- EMAIL
|
|
15059
15058
|
SyntheticsCoreWebVitals:
|
|
15060
15059
|
description: Core Web Vitals attached to a browser test step.
|
|
15061
15060
|
properties:
|
|
@@ -15182,6 +15181,32 @@ components:
|
|
|
15182
15181
|
- EDGE_LAPTOP_LARGE
|
|
15183
15182
|
- EDGE_TABLET
|
|
15184
15183
|
- EDGE_MOBILE_SMALL
|
|
15184
|
+
SyntheticsFetchUptimesPayload:
|
|
15185
|
+
description: Object containing IDs of Synthetic tests and a timeframe.
|
|
15186
|
+
properties:
|
|
15187
|
+
from_ts:
|
|
15188
|
+
description: Timestamp in seconds (Unix epoch) for the start of uptime.
|
|
15189
|
+
example: 0
|
|
15190
|
+
format: int64
|
|
15191
|
+
type: integer
|
|
15192
|
+
public_ids:
|
|
15193
|
+
description: An array of Synthetic test IDs you want to delete.
|
|
15194
|
+
example: []
|
|
15195
|
+
items:
|
|
15196
|
+
description: A Synthetic test ID.
|
|
15197
|
+
example: abc-def-123
|
|
15198
|
+
type: string
|
|
15199
|
+
type: array
|
|
15200
|
+
to_ts:
|
|
15201
|
+
description: Timestamp in seconds (Unix epoch) for the end of uptime.
|
|
15202
|
+
example: 0
|
|
15203
|
+
format: int64
|
|
15204
|
+
type: integer
|
|
15205
|
+
required:
|
|
15206
|
+
- from_ts
|
|
15207
|
+
- to_ts
|
|
15208
|
+
- public_ids
|
|
15209
|
+
type: object
|
|
15185
15210
|
SyntheticsGetAPITestLatestResultsResponse:
|
|
15186
15211
|
description: Object with the latest Synthetic API test run.
|
|
15187
15212
|
properties:
|
|
@@ -15458,179 +15483,639 @@ components:
|
|
|
15458
15483
|
$ref: '#/components/schemas/SyntheticsLocation'
|
|
15459
15484
|
type: array
|
|
15460
15485
|
type: object
|
|
15461
|
-
|
|
15462
|
-
description:
|
|
15463
|
-
example:
|
|
15486
|
+
SyntheticsMobileDeviceID:
|
|
15487
|
+
description: The device ID.
|
|
15488
|
+
example: synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16
|
|
15489
|
+
type: string
|
|
15490
|
+
SyntheticsMobileStep:
|
|
15491
|
+
description: The steps used in a Synthetic mobile test.
|
|
15464
15492
|
properties:
|
|
15465
|
-
|
|
15466
|
-
description:
|
|
15467
|
-
|
|
15468
|
-
|
|
15469
|
-
|
|
15493
|
+
allowFailure:
|
|
15494
|
+
description: A boolean set to allow this step to fail.
|
|
15495
|
+
type: boolean
|
|
15496
|
+
hasNewStepElement:
|
|
15497
|
+
description: A boolean set to determine if the step has a new step element.
|
|
15498
|
+
type: boolean
|
|
15499
|
+
isCritical:
|
|
15500
|
+
description: A boolean to use in addition to `allowFailure` to determine
|
|
15501
|
+
if the test should be marked as failed when the step fails.
|
|
15502
|
+
type: boolean
|
|
15470
15503
|
name:
|
|
15471
|
-
description:
|
|
15504
|
+
description: The name of the step.
|
|
15505
|
+
example: ''
|
|
15506
|
+
maxLength: 1500
|
|
15472
15507
|
type: string
|
|
15473
|
-
|
|
15474
|
-
|
|
15475
|
-
secure:
|
|
15476
|
-
description: Determines whether or not the extracted value will be obfuscated.
|
|
15508
|
+
noScreenshot:
|
|
15509
|
+
description: A boolean set to not take a screenshot for the step.
|
|
15477
15510
|
type: boolean
|
|
15511
|
+
params:
|
|
15512
|
+
$ref: '#/components/schemas/SyntheticsMobileStepParams'
|
|
15513
|
+
publicId:
|
|
15514
|
+
description: The public ID of the step.
|
|
15515
|
+
example: pub-lic-id0
|
|
15516
|
+
type: string
|
|
15517
|
+
timeout:
|
|
15518
|
+
description: The time before declaring a step failed.
|
|
15519
|
+
format: int64
|
|
15520
|
+
type: integer
|
|
15478
15521
|
type:
|
|
15479
|
-
$ref: '#/components/schemas/
|
|
15480
|
-
|
|
15481
|
-
|
|
15482
|
-
|
|
15483
|
-
|
|
15484
|
-
properties:
|
|
15485
|
-
data:
|
|
15486
|
-
description: Array of [JSON Patch](https://jsonpatch.com) operations to
|
|
15487
|
-
perform on the test
|
|
15488
|
-
example:
|
|
15489
|
-
- op: replace
|
|
15490
|
-
path: /name
|
|
15491
|
-
value: New test name
|
|
15492
|
-
- op: remove
|
|
15493
|
-
path: /config/assertions/0
|
|
15494
|
-
items:
|
|
15495
|
-
$ref: '#/components/schemas/SyntheticsPatchTestOperation'
|
|
15496
|
-
type: array
|
|
15522
|
+
$ref: '#/components/schemas/SyntheticsMobileStepType'
|
|
15523
|
+
required:
|
|
15524
|
+
- name
|
|
15525
|
+
- params
|
|
15526
|
+
- type
|
|
15497
15527
|
type: object
|
|
15498
|
-
|
|
15499
|
-
description:
|
|
15500
|
-
on the test
|
|
15528
|
+
SyntheticsMobileStepParams:
|
|
15529
|
+
description: The parameters of a mobile step.
|
|
15501
15530
|
properties:
|
|
15502
|
-
|
|
15503
|
-
$ref: '#/components/schemas/
|
|
15504
|
-
|
|
15505
|
-
description:
|
|
15506
|
-
|
|
15531
|
+
check:
|
|
15532
|
+
$ref: '#/components/schemas/SyntheticsCheckType'
|
|
15533
|
+
delay:
|
|
15534
|
+
description: Number of milliseconds to wait between inputs in a `typeText`
|
|
15535
|
+
step type.
|
|
15536
|
+
format: int64
|
|
15537
|
+
maximum: 5000
|
|
15538
|
+
minimum: 0
|
|
15539
|
+
type: integer
|
|
15540
|
+
direction:
|
|
15541
|
+
$ref: '#/components/schemas/SyntheticsMobileStepParamsDirection'
|
|
15542
|
+
element:
|
|
15543
|
+
$ref: '#/components/schemas/SyntheticsMobileStepParamsElement'
|
|
15544
|
+
enabled:
|
|
15545
|
+
description: Boolean to change the state of the wifi for a `toggleWiFi`
|
|
15546
|
+
step type.
|
|
15547
|
+
type: boolean
|
|
15548
|
+
maxScrolls:
|
|
15549
|
+
description: Maximum number of scrolls to do for a `scrollToElement` step
|
|
15550
|
+
type.
|
|
15551
|
+
format: int64
|
|
15552
|
+
type: integer
|
|
15553
|
+
positions:
|
|
15554
|
+
$ref: '#/components/schemas/SyntheticsMobileStepParamsPositions'
|
|
15555
|
+
subtestPublicId:
|
|
15556
|
+
description: Public ID of the test to be played as part of a `playSubTest`
|
|
15557
|
+
step type.
|
|
15507
15558
|
type: string
|
|
15508
15559
|
value:
|
|
15509
|
-
|
|
15510
|
-
|
|
15560
|
+
$ref: '#/components/schemas/SyntheticsMobileStepParamsValue'
|
|
15561
|
+
variable:
|
|
15562
|
+
$ref: '#/components/schemas/SyntheticsMobileStepParamsVariable'
|
|
15563
|
+
withEnter:
|
|
15564
|
+
description: Boolean to indicate if `Enter` should be pressed at the end
|
|
15565
|
+
of the `typeText` step type.
|
|
15566
|
+
type: boolean
|
|
15567
|
+
x:
|
|
15568
|
+
description: Amount to scroll by on the `x` axis for a `scroll` step type.
|
|
15569
|
+
format: double
|
|
15570
|
+
type: number
|
|
15571
|
+
y:
|
|
15572
|
+
description: Amount to scroll by on the `y` axis for a `scroll` step type.
|
|
15573
|
+
format: double
|
|
15574
|
+
type: number
|
|
15511
15575
|
type: object
|
|
15512
|
-
|
|
15513
|
-
description: The
|
|
15576
|
+
SyntheticsMobileStepParamsDirection:
|
|
15577
|
+
description: The direction of the scroll for a `scrollToElement` step type.
|
|
15514
15578
|
enum:
|
|
15515
|
-
-
|
|
15516
|
-
-
|
|
15517
|
-
-
|
|
15518
|
-
-
|
|
15519
|
-
- copy
|
|
15520
|
-
- test
|
|
15521
|
-
example: replace
|
|
15579
|
+
- up
|
|
15580
|
+
- down
|
|
15581
|
+
- left
|
|
15582
|
+
- right
|
|
15522
15583
|
type: string
|
|
15523
15584
|
x-enum-varnames:
|
|
15524
|
-
-
|
|
15525
|
-
-
|
|
15526
|
-
-
|
|
15527
|
-
-
|
|
15528
|
-
|
|
15529
|
-
|
|
15530
|
-
SyntheticsPlayingTab:
|
|
15531
|
-
description: Navigate between different tabs for your browser test.
|
|
15532
|
-
enum:
|
|
15533
|
-
- -1
|
|
15534
|
-
- 0
|
|
15535
|
-
- 1
|
|
15536
|
-
- 2
|
|
15537
|
-
- 3
|
|
15538
|
-
format: int64
|
|
15539
|
-
type: integer
|
|
15540
|
-
x-enum-varnames:
|
|
15541
|
-
- MAIN_TAB
|
|
15542
|
-
- NEW_TAB
|
|
15543
|
-
- TAB_1
|
|
15544
|
-
- TAB_2
|
|
15545
|
-
- TAB_3
|
|
15546
|
-
SyntheticsPrivateLocation:
|
|
15547
|
-
description: Object containing information about the private location to create.
|
|
15585
|
+
- UP
|
|
15586
|
+
- DOWN
|
|
15587
|
+
- LEFT
|
|
15588
|
+
- RIGHT
|
|
15589
|
+
SyntheticsMobileStepParamsElement:
|
|
15590
|
+
description: Information about the element used for a step.
|
|
15548
15591
|
properties:
|
|
15549
|
-
|
|
15550
|
-
description:
|
|
15551
|
-
example: Description of private location
|
|
15552
|
-
type: string
|
|
15553
|
-
id:
|
|
15554
|
-
description: Unique identifier of the private location.
|
|
15555
|
-
readOnly: true
|
|
15592
|
+
context:
|
|
15593
|
+
description: Context of the element.
|
|
15556
15594
|
type: string
|
|
15557
|
-
|
|
15558
|
-
$ref: '#/components/schemas/
|
|
15559
|
-
|
|
15560
|
-
description:
|
|
15561
|
-
example: New private location
|
|
15595
|
+
contextType:
|
|
15596
|
+
$ref: '#/components/schemas/SyntheticsMobileStepParamsElementContextType'
|
|
15597
|
+
elementDescription:
|
|
15598
|
+
description: Description of the element.
|
|
15562
15599
|
type: string
|
|
15563
|
-
|
|
15564
|
-
|
|
15565
|
-
tags:
|
|
15566
|
-
description: Array of tags attached to the private location.
|
|
15567
|
-
example:
|
|
15568
|
-
- team:front
|
|
15569
|
-
items:
|
|
15570
|
-
description: A tag attached to the private location.
|
|
15571
|
-
example: team:front
|
|
15572
|
-
type: string
|
|
15573
|
-
type: array
|
|
15574
|
-
required:
|
|
15575
|
-
- name
|
|
15576
|
-
- description
|
|
15577
|
-
- tags
|
|
15578
|
-
type: object
|
|
15579
|
-
SyntheticsPrivateLocationCreationResponse:
|
|
15580
|
-
description: Object that contains the new private location, the public key for
|
|
15581
|
-
result encryption, and the configuration skeleton.
|
|
15582
|
-
properties:
|
|
15583
|
-
config:
|
|
15584
|
-
description: Configuration skeleton for the private location. See installation
|
|
15585
|
-
instructions of the private location on how to use this configuration.
|
|
15600
|
+
multiLocator:
|
|
15601
|
+
description: Multi-locator to find the element.
|
|
15586
15602
|
type: object
|
|
15587
|
-
|
|
15588
|
-
$ref: '#/components/schemas/
|
|
15589
|
-
|
|
15590
|
-
|
|
15591
|
-
type: object
|
|
15592
|
-
SyntheticsPrivateLocationCreationResponseResultEncryption:
|
|
15593
|
-
description: Public key for the result encryption.
|
|
15594
|
-
properties:
|
|
15595
|
-
id:
|
|
15596
|
-
description: Fingerprint for the encryption key.
|
|
15603
|
+
relativePosition:
|
|
15604
|
+
$ref: '#/components/schemas/SyntheticsMobileStepParamsElementRelativePosition'
|
|
15605
|
+
textContent:
|
|
15606
|
+
description: Text content of the element.
|
|
15597
15607
|
type: string
|
|
15598
|
-
|
|
15599
|
-
|
|
15608
|
+
userLocator:
|
|
15609
|
+
$ref: '#/components/schemas/SyntheticsMobileStepParamsElementUserLocator'
|
|
15610
|
+
viewName:
|
|
15611
|
+
description: Name of the view of the element.
|
|
15600
15612
|
type: string
|
|
15601
15613
|
type: object
|
|
15602
|
-
|
|
15603
|
-
description:
|
|
15614
|
+
SyntheticsMobileStepParamsElementContextType:
|
|
15615
|
+
description: Type of the context that the element is in.
|
|
15616
|
+
enum:
|
|
15617
|
+
- native
|
|
15618
|
+
- web
|
|
15619
|
+
type: string
|
|
15620
|
+
x-enum-varnames:
|
|
15621
|
+
- NATIVE
|
|
15622
|
+
- WEB
|
|
15623
|
+
SyntheticsMobileStepParamsElementRelativePosition:
|
|
15624
|
+
description: Position of the action relative to the element.
|
|
15604
15625
|
properties:
|
|
15605
|
-
|
|
15606
|
-
|
|
15626
|
+
x:
|
|
15627
|
+
description: The `relativePosition` on the `x` axis for the element.
|
|
15628
|
+
format: double
|
|
15629
|
+
type: number
|
|
15630
|
+
y:
|
|
15631
|
+
description: The `relativePosition` on the `y` axis for the element.
|
|
15632
|
+
format: double
|
|
15633
|
+
type: number
|
|
15607
15634
|
type: object
|
|
15608
|
-
|
|
15609
|
-
description:
|
|
15610
|
-
when creating the private location.
|
|
15635
|
+
SyntheticsMobileStepParamsElementUserLocator:
|
|
15636
|
+
description: User locator to find the element.
|
|
15611
15637
|
properties:
|
|
15612
|
-
|
|
15613
|
-
|
|
15614
|
-
|
|
15615
|
-
|
|
15616
|
-
|
|
15638
|
+
failTestOnCannotLocate:
|
|
15639
|
+
description: Whether if the the test should fail if the element cannot be
|
|
15640
|
+
found.
|
|
15641
|
+
type: boolean
|
|
15642
|
+
values:
|
|
15643
|
+
description: Values of the user locator.
|
|
15644
|
+
items:
|
|
15645
|
+
$ref: '#/components/schemas/SyntheticsMobileStepParamsElementUserLocatorValuesItems'
|
|
15646
|
+
type: array
|
|
15617
15647
|
type: object
|
|
15618
|
-
|
|
15619
|
-
description:
|
|
15648
|
+
SyntheticsMobileStepParamsElementUserLocatorValuesItems:
|
|
15649
|
+
description: A single user locator object.
|
|
15620
15650
|
properties:
|
|
15621
|
-
|
|
15622
|
-
|
|
15623
|
-
|
|
15624
|
-
|
|
15625
|
-
key:
|
|
15626
|
-
description: Secret access key for the private location.
|
|
15627
|
-
readOnly: true
|
|
15651
|
+
type:
|
|
15652
|
+
$ref: '#/components/schemas/SyntheticsMobileStepParamsElementUserLocatorValuesItemsType'
|
|
15653
|
+
value:
|
|
15654
|
+
description: Value of a user locator.
|
|
15628
15655
|
type: string
|
|
15629
15656
|
type: object
|
|
15630
|
-
|
|
15631
|
-
description:
|
|
15632
|
-
|
|
15633
|
-
|
|
15657
|
+
SyntheticsMobileStepParamsElementUserLocatorValuesItemsType:
|
|
15658
|
+
description: Type of a user locator.
|
|
15659
|
+
enum:
|
|
15660
|
+
- accessibility-id
|
|
15661
|
+
- id
|
|
15662
|
+
- ios-predicate-string
|
|
15663
|
+
- ios-class-chain
|
|
15664
|
+
- xpath
|
|
15665
|
+
type: string
|
|
15666
|
+
x-enum-varnames:
|
|
15667
|
+
- ACCESSIBILITY_ID
|
|
15668
|
+
- ID
|
|
15669
|
+
- IOS_PREDICATE_STRING
|
|
15670
|
+
- IOS_CLASS_CHAIN
|
|
15671
|
+
- XPATH
|
|
15672
|
+
SyntheticsMobileStepParamsPositions:
|
|
15673
|
+
description: List of positions for the `flick` step type. The maximum is 10
|
|
15674
|
+
flicks per step
|
|
15675
|
+
items:
|
|
15676
|
+
$ref: '#/components/schemas/SyntheticsMobileStepParamsPositionsItems'
|
|
15677
|
+
type: array
|
|
15678
|
+
SyntheticsMobileStepParamsPositionsItems:
|
|
15679
|
+
description: A description of a single position for a `flick` step type.
|
|
15680
|
+
properties:
|
|
15681
|
+
x:
|
|
15682
|
+
description: The `x` position for the flick.
|
|
15683
|
+
format: double
|
|
15684
|
+
type: number
|
|
15685
|
+
y:
|
|
15686
|
+
description: The `y` position for the flick.
|
|
15687
|
+
format: double
|
|
15688
|
+
type: number
|
|
15689
|
+
type: object
|
|
15690
|
+
SyntheticsMobileStepParamsValue:
|
|
15691
|
+
description: Values used in the step for in multiple step types.
|
|
15692
|
+
oneOf:
|
|
15693
|
+
- $ref: '#/components/schemas/SyntheticsMobileStepParamsValueString'
|
|
15694
|
+
- $ref: '#/components/schemas/SyntheticsMobileStepParamsValueNumber'
|
|
15695
|
+
SyntheticsMobileStepParamsValueNumber:
|
|
15696
|
+
description: Value used in the step for in multiple step types.
|
|
15697
|
+
format: int64
|
|
15698
|
+
type: integer
|
|
15699
|
+
SyntheticsMobileStepParamsValueString:
|
|
15700
|
+
description: Value used in the step for in multiple step types.
|
|
15701
|
+
type: string
|
|
15702
|
+
SyntheticsMobileStepParamsVariable:
|
|
15703
|
+
description: Variable object for `extractVariable` step type.
|
|
15704
|
+
properties:
|
|
15705
|
+
example:
|
|
15706
|
+
description: An example for the variable.
|
|
15707
|
+
example: ''
|
|
15708
|
+
type: string
|
|
15709
|
+
name:
|
|
15710
|
+
description: The variable name.
|
|
15711
|
+
example: VAR_NAME
|
|
15712
|
+
type: string
|
|
15713
|
+
required:
|
|
15714
|
+
- name
|
|
15715
|
+
- example
|
|
15716
|
+
type: object
|
|
15717
|
+
SyntheticsMobileStepType:
|
|
15718
|
+
description: Step type used in your mobile Synthetic test.
|
|
15719
|
+
enum:
|
|
15720
|
+
- assertElementContent
|
|
15721
|
+
- assertScreenContains
|
|
15722
|
+
- assertScreenLacks
|
|
15723
|
+
- doubleTap
|
|
15724
|
+
- extractVariable
|
|
15725
|
+
- flick
|
|
15726
|
+
- openDeeplink
|
|
15727
|
+
- playSubTest
|
|
15728
|
+
- pressBack
|
|
15729
|
+
- restartApplication
|
|
15730
|
+
- rotate
|
|
15731
|
+
- scroll
|
|
15732
|
+
- scrollToElement
|
|
15733
|
+
- tap
|
|
15734
|
+
- toggleWiFi
|
|
15735
|
+
- typeText
|
|
15736
|
+
- wait
|
|
15737
|
+
example: assertElementContent
|
|
15738
|
+
type: string
|
|
15739
|
+
x-enum-varnames:
|
|
15740
|
+
- ASSERTELEMENTCONTENT
|
|
15741
|
+
- ASSERTSCREENCONTAINS
|
|
15742
|
+
- ASSERTSCREENLACKS
|
|
15743
|
+
- DOUBLETAP
|
|
15744
|
+
- EXTRACTVARIABLE
|
|
15745
|
+
- FLICK
|
|
15746
|
+
- OPENDEEPLINK
|
|
15747
|
+
- PLAYSUBTEST
|
|
15748
|
+
- PRESSBACK
|
|
15749
|
+
- RESTARTAPPLICATION
|
|
15750
|
+
- ROTATE
|
|
15751
|
+
- SCROLL
|
|
15752
|
+
- SCROLLTOELEMENT
|
|
15753
|
+
- TAP
|
|
15754
|
+
- TOGGLEWIFI
|
|
15755
|
+
- TYPETEXT
|
|
15756
|
+
- WAIT
|
|
15757
|
+
SyntheticsMobileTest:
|
|
15758
|
+
description: Object containing details about a Synthetic mobile test.
|
|
15759
|
+
properties:
|
|
15760
|
+
config:
|
|
15761
|
+
$ref: '#/components/schemas/SyntheticsMobileTestConfig'
|
|
15762
|
+
device_ids:
|
|
15763
|
+
description: Array with the different device IDs used to run the test.
|
|
15764
|
+
items:
|
|
15765
|
+
$ref: '#/components/schemas/SyntheticsMobileDeviceID'
|
|
15766
|
+
type: array
|
|
15767
|
+
message:
|
|
15768
|
+
description: Notification message associated with the test.
|
|
15769
|
+
example: Notification message
|
|
15770
|
+
type: string
|
|
15771
|
+
monitor_id:
|
|
15772
|
+
description: The associated monitor ID.
|
|
15773
|
+
example: 12345678
|
|
15774
|
+
format: int64
|
|
15775
|
+
readOnly: true
|
|
15776
|
+
type: integer
|
|
15777
|
+
name:
|
|
15778
|
+
description: Name of the test.
|
|
15779
|
+
example: Example test name
|
|
15780
|
+
type: string
|
|
15781
|
+
options:
|
|
15782
|
+
$ref: '#/components/schemas/SyntheticsMobileTestOptions'
|
|
15783
|
+
public_id:
|
|
15784
|
+
description: The public ID of the test.
|
|
15785
|
+
example: 123-abc-456
|
|
15786
|
+
readOnly: true
|
|
15787
|
+
type: string
|
|
15788
|
+
status:
|
|
15789
|
+
$ref: '#/components/schemas/SyntheticsTestPauseStatus'
|
|
15790
|
+
steps:
|
|
15791
|
+
description: Array of steps for the test.
|
|
15792
|
+
items:
|
|
15793
|
+
$ref: '#/components/schemas/SyntheticsMobileStep'
|
|
15794
|
+
type: array
|
|
15795
|
+
tags:
|
|
15796
|
+
description: Array of tags attached to the test.
|
|
15797
|
+
example:
|
|
15798
|
+
- env:production
|
|
15799
|
+
items:
|
|
15800
|
+
description: A tag attached to the test.
|
|
15801
|
+
type: string
|
|
15802
|
+
type: array
|
|
15803
|
+
type:
|
|
15804
|
+
$ref: '#/components/schemas/SyntheticsMobileTestType'
|
|
15805
|
+
required:
|
|
15806
|
+
- config
|
|
15807
|
+
- name
|
|
15808
|
+
- options
|
|
15809
|
+
- type
|
|
15810
|
+
type: object
|
|
15811
|
+
SyntheticsMobileTestConfig:
|
|
15812
|
+
description: Configuration object for a Synthetic mobile test.
|
|
15813
|
+
properties:
|
|
15814
|
+
initialApplicationArguments:
|
|
15815
|
+
$ref: '#/components/schemas/SyntheticsMobileTestInitialApplicationArguments'
|
|
15816
|
+
variables:
|
|
15817
|
+
description: Array of variables used for the test steps.
|
|
15818
|
+
items:
|
|
15819
|
+
$ref: '#/components/schemas/SyntheticsConfigVariable'
|
|
15820
|
+
type: array
|
|
15821
|
+
type: object
|
|
15822
|
+
SyntheticsMobileTestInitialApplicationArguments:
|
|
15823
|
+
additionalProperties:
|
|
15824
|
+
description: A single application argument.
|
|
15825
|
+
type: string
|
|
15826
|
+
description: Initial application arguments for a mobile test.
|
|
15827
|
+
type: object
|
|
15828
|
+
SyntheticsMobileTestOptions:
|
|
15829
|
+
description: Object describing the extra options for a Synthetic test.
|
|
15830
|
+
properties:
|
|
15831
|
+
allowApplicationCrash:
|
|
15832
|
+
description: A boolean to set if an application crash would mark the test
|
|
15833
|
+
as failed.
|
|
15834
|
+
type: boolean
|
|
15835
|
+
bindings:
|
|
15836
|
+
description: Array of bindings used for the mobile test.
|
|
15837
|
+
items:
|
|
15838
|
+
$ref: '#/components/schemas/SyntheticsTestRestrictionPolicyBinding'
|
|
15839
|
+
type: array
|
|
15840
|
+
ci:
|
|
15841
|
+
$ref: '#/components/schemas/SyntheticsTestCiOptions'
|
|
15842
|
+
defaultStepTimeout:
|
|
15843
|
+
description: The default timeout for steps in the test (in seconds).
|
|
15844
|
+
format: int32
|
|
15845
|
+
maximum: 300
|
|
15846
|
+
minimum: 1
|
|
15847
|
+
type: integer
|
|
15848
|
+
device_ids:
|
|
15849
|
+
description: For mobile test, array with the different device IDs used to
|
|
15850
|
+
run the test.
|
|
15851
|
+
example:
|
|
15852
|
+
- synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16
|
|
15853
|
+
items:
|
|
15854
|
+
$ref: '#/components/schemas/SyntheticsMobileDeviceID'
|
|
15855
|
+
type: array
|
|
15856
|
+
disableAutoAcceptAlert:
|
|
15857
|
+
description: A boolean to disable auto accepting alerts.
|
|
15858
|
+
type: boolean
|
|
15859
|
+
min_failure_duration:
|
|
15860
|
+
description: Minimum amount of time in failure required to trigger an alert.
|
|
15861
|
+
format: int64
|
|
15862
|
+
maximum: 7200
|
|
15863
|
+
minimum: 0
|
|
15864
|
+
type: integer
|
|
15865
|
+
mobileApplication:
|
|
15866
|
+
$ref: '#/components/schemas/SyntheticsMobileTestsMobileApplication'
|
|
15867
|
+
monitor_name:
|
|
15868
|
+
description: The monitor name is used for the alert title as well as for
|
|
15869
|
+
all monitor dashboard widgets and SLOs.
|
|
15870
|
+
type: string
|
|
15871
|
+
monitor_options:
|
|
15872
|
+
$ref: '#/components/schemas/SyntheticsTestOptionsMonitorOptions'
|
|
15873
|
+
monitor_priority:
|
|
15874
|
+
description: Integer from 1 (high) to 5 (low) indicating alert severity.
|
|
15875
|
+
format: int32
|
|
15876
|
+
maximum: 5
|
|
15877
|
+
minimum: 1
|
|
15878
|
+
type: integer
|
|
15879
|
+
noScreenshot:
|
|
15880
|
+
description: A boolean set to not take a screenshot for the step.
|
|
15881
|
+
type: boolean
|
|
15882
|
+
restricted_roles:
|
|
15883
|
+
$ref: '#/components/schemas/SyntheticsRestrictedRoles'
|
|
15884
|
+
retry:
|
|
15885
|
+
$ref: '#/components/schemas/SyntheticsTestOptionsRetry'
|
|
15886
|
+
scheduling:
|
|
15887
|
+
$ref: '#/components/schemas/SyntheticsTestOptionsScheduling'
|
|
15888
|
+
tick_every:
|
|
15889
|
+
description: The frequency at which to run the Synthetic test (in seconds).
|
|
15890
|
+
example: 300
|
|
15891
|
+
format: int64
|
|
15892
|
+
maximum: 604800
|
|
15893
|
+
minimum: 300
|
|
15894
|
+
type: integer
|
|
15895
|
+
verbosity:
|
|
15896
|
+
description: The level of verbosity for the mobile test.
|
|
15897
|
+
format: int32
|
|
15898
|
+
maximum: 5
|
|
15899
|
+
minimum: 0
|
|
15900
|
+
type: integer
|
|
15901
|
+
required:
|
|
15902
|
+
- device_ids
|
|
15903
|
+
- tick_every
|
|
15904
|
+
- mobileApplication
|
|
15905
|
+
type: object
|
|
15906
|
+
SyntheticsMobileTestType:
|
|
15907
|
+
default: mobile
|
|
15908
|
+
description: Type of the Synthetic test, `mobile`.
|
|
15909
|
+
enum:
|
|
15910
|
+
- mobile
|
|
15911
|
+
example: mobile
|
|
15912
|
+
type: string
|
|
15913
|
+
x-enum-varnames:
|
|
15914
|
+
- MOBILE
|
|
15915
|
+
SyntheticsMobileTestsMobileApplication:
|
|
15916
|
+
description: Mobile application for mobile synthetics test.
|
|
15917
|
+
properties:
|
|
15918
|
+
applicationId:
|
|
15919
|
+
description: Application ID of the mobile application.
|
|
15920
|
+
example: 00000000-0000-0000-0000-aaaaaaaaaaaa
|
|
15921
|
+
maxLength: 1500
|
|
15922
|
+
type: string
|
|
15923
|
+
referenceId:
|
|
15924
|
+
description: Reference ID of the mobile application.
|
|
15925
|
+
example: 00000000-0000-0000-0000-aaaaaaaaaaab
|
|
15926
|
+
maxLength: 1500
|
|
15927
|
+
type: string
|
|
15928
|
+
referenceType:
|
|
15929
|
+
$ref: '#/components/schemas/SyntheticsMobileTestsMobileApplicationReferenceType'
|
|
15930
|
+
required:
|
|
15931
|
+
- applicationId
|
|
15932
|
+
- referenceId
|
|
15933
|
+
- referenceType
|
|
15934
|
+
type: object
|
|
15935
|
+
SyntheticsMobileTestsMobileApplicationReferenceType:
|
|
15936
|
+
description: Reference type for the mobile application for a mobile synthetics
|
|
15937
|
+
test.
|
|
15938
|
+
enum:
|
|
15939
|
+
- latest
|
|
15940
|
+
- version
|
|
15941
|
+
example: latest
|
|
15942
|
+
type: string
|
|
15943
|
+
x-enum-varnames:
|
|
15944
|
+
- LATEST
|
|
15945
|
+
- VERSION
|
|
15946
|
+
SyntheticsParsingOptions:
|
|
15947
|
+
description: Parsing options for variables to extract.
|
|
15948
|
+
example: {}
|
|
15949
|
+
properties:
|
|
15950
|
+
field:
|
|
15951
|
+
description: When type is `http_header` or `grpc_metadata`, name of the
|
|
15952
|
+
header or metadatum to extract.
|
|
15953
|
+
example: content-type
|
|
15954
|
+
type: string
|
|
15955
|
+
name:
|
|
15956
|
+
description: Name of the variable to extract.
|
|
15957
|
+
type: string
|
|
15958
|
+
parser:
|
|
15959
|
+
$ref: '#/components/schemas/SyntheticsVariableParser'
|
|
15960
|
+
secure:
|
|
15961
|
+
description: Determines whether or not the extracted value will be obfuscated.
|
|
15962
|
+
type: boolean
|
|
15963
|
+
type:
|
|
15964
|
+
$ref: '#/components/schemas/SyntheticsLocalVariableParsingOptionsType'
|
|
15965
|
+
type: object
|
|
15966
|
+
SyntheticsPatchTestBody:
|
|
15967
|
+
description: Wrapper around an array of [JSON Patch](https://jsonpatch.com)
|
|
15968
|
+
operations to perform on the test
|
|
15969
|
+
properties:
|
|
15970
|
+
data:
|
|
15971
|
+
description: Array of [JSON Patch](https://jsonpatch.com) operations to
|
|
15972
|
+
perform on the test
|
|
15973
|
+
example:
|
|
15974
|
+
- op: replace
|
|
15975
|
+
path: /name
|
|
15976
|
+
value: New test name
|
|
15977
|
+
- op: remove
|
|
15978
|
+
path: /config/assertions/0
|
|
15979
|
+
items:
|
|
15980
|
+
$ref: '#/components/schemas/SyntheticsPatchTestOperation'
|
|
15981
|
+
type: array
|
|
15982
|
+
type: object
|
|
15983
|
+
SyntheticsPatchTestOperation:
|
|
15984
|
+
description: A single [JSON Patch](https://jsonpatch.com) operation to perform
|
|
15985
|
+
on the test
|
|
15986
|
+
properties:
|
|
15987
|
+
op:
|
|
15988
|
+
$ref: '#/components/schemas/SyntheticsPatchTestOperationName'
|
|
15989
|
+
path:
|
|
15990
|
+
description: The path to the value to modify
|
|
15991
|
+
example: /name
|
|
15992
|
+
type: string
|
|
15993
|
+
value:
|
|
15994
|
+
description: A value to use in a [JSON Patch](https://jsonpatch.com) operation
|
|
15995
|
+
example: New Test Name
|
|
15996
|
+
type: object
|
|
15997
|
+
SyntheticsPatchTestOperationName:
|
|
15998
|
+
description: The operation to perform
|
|
15999
|
+
enum:
|
|
16000
|
+
- add
|
|
16001
|
+
- remove
|
|
16002
|
+
- replace
|
|
16003
|
+
- move
|
|
16004
|
+
- copy
|
|
16005
|
+
- test
|
|
16006
|
+
example: replace
|
|
16007
|
+
type: string
|
|
16008
|
+
x-enum-varnames:
|
|
16009
|
+
- ADD
|
|
16010
|
+
- REMOVE
|
|
16011
|
+
- REPLACE
|
|
16012
|
+
- MOVE
|
|
16013
|
+
- COPY
|
|
16014
|
+
- TEST
|
|
16015
|
+
SyntheticsPlayingTab:
|
|
16016
|
+
description: Navigate between different tabs for your browser test.
|
|
16017
|
+
enum:
|
|
16018
|
+
- -1
|
|
16019
|
+
- 0
|
|
16020
|
+
- 1
|
|
16021
|
+
- 2
|
|
16022
|
+
- 3
|
|
16023
|
+
format: int64
|
|
16024
|
+
type: integer
|
|
16025
|
+
x-enum-varnames:
|
|
16026
|
+
- MAIN_TAB
|
|
16027
|
+
- NEW_TAB
|
|
16028
|
+
- TAB_1
|
|
16029
|
+
- TAB_2
|
|
16030
|
+
- TAB_3
|
|
16031
|
+
SyntheticsPrivateLocation:
|
|
16032
|
+
description: Object containing information about the private location to create.
|
|
16033
|
+
properties:
|
|
16034
|
+
description:
|
|
16035
|
+
description: Description of the private location.
|
|
16036
|
+
example: Description of private location
|
|
16037
|
+
type: string
|
|
16038
|
+
id:
|
|
16039
|
+
description: Unique identifier of the private location.
|
|
16040
|
+
readOnly: true
|
|
16041
|
+
type: string
|
|
16042
|
+
metadata:
|
|
16043
|
+
$ref: '#/components/schemas/SyntheticsPrivateLocationMetadata'
|
|
16044
|
+
name:
|
|
16045
|
+
description: Name of the private location.
|
|
16046
|
+
example: New private location
|
|
16047
|
+
type: string
|
|
16048
|
+
secrets:
|
|
16049
|
+
$ref: '#/components/schemas/SyntheticsPrivateLocationSecrets'
|
|
16050
|
+
tags:
|
|
16051
|
+
description: Array of tags attached to the private location.
|
|
16052
|
+
example:
|
|
16053
|
+
- team:front
|
|
16054
|
+
items:
|
|
16055
|
+
description: A tag attached to the private location.
|
|
16056
|
+
example: team:front
|
|
16057
|
+
type: string
|
|
16058
|
+
type: array
|
|
16059
|
+
required:
|
|
16060
|
+
- name
|
|
16061
|
+
- description
|
|
16062
|
+
- tags
|
|
16063
|
+
type: object
|
|
16064
|
+
SyntheticsPrivateLocationCreationResponse:
|
|
16065
|
+
description: Object that contains the new private location, the public key for
|
|
16066
|
+
result encryption, and the configuration skeleton.
|
|
16067
|
+
properties:
|
|
16068
|
+
config:
|
|
16069
|
+
description: Configuration skeleton for the private location. See installation
|
|
16070
|
+
instructions of the private location on how to use this configuration.
|
|
16071
|
+
type: object
|
|
16072
|
+
private_location:
|
|
16073
|
+
$ref: '#/components/schemas/SyntheticsPrivateLocation'
|
|
16074
|
+
result_encryption:
|
|
16075
|
+
$ref: '#/components/schemas/SyntheticsPrivateLocationCreationResponseResultEncryption'
|
|
16076
|
+
type: object
|
|
16077
|
+
SyntheticsPrivateLocationCreationResponseResultEncryption:
|
|
16078
|
+
description: Public key for the result encryption.
|
|
16079
|
+
properties:
|
|
16080
|
+
id:
|
|
16081
|
+
description: Fingerprint for the encryption key.
|
|
16082
|
+
type: string
|
|
16083
|
+
key:
|
|
16084
|
+
description: Public key for result encryption.
|
|
16085
|
+
type: string
|
|
16086
|
+
type: object
|
|
16087
|
+
SyntheticsPrivateLocationMetadata:
|
|
16088
|
+
description: Object containing metadata about the private location.
|
|
16089
|
+
properties:
|
|
16090
|
+
restricted_roles:
|
|
16091
|
+
$ref: '#/components/schemas/SyntheticsRestrictedRoles'
|
|
16092
|
+
type: object
|
|
16093
|
+
SyntheticsPrivateLocationSecrets:
|
|
16094
|
+
description: Secrets for the private location. Only present in the response
|
|
16095
|
+
when creating the private location.
|
|
16096
|
+
properties:
|
|
16097
|
+
authentication:
|
|
16098
|
+
$ref: '#/components/schemas/SyntheticsPrivateLocationSecretsAuthentication'
|
|
16099
|
+
config_decryption:
|
|
16100
|
+
$ref: '#/components/schemas/SyntheticsPrivateLocationSecretsConfigDecryption'
|
|
16101
|
+
readOnly: true
|
|
16102
|
+
type: object
|
|
16103
|
+
SyntheticsPrivateLocationSecretsAuthentication:
|
|
16104
|
+
description: Authentication part of the secrets.
|
|
16105
|
+
properties:
|
|
16106
|
+
id:
|
|
16107
|
+
description: Access key for the private location.
|
|
16108
|
+
readOnly: true
|
|
16109
|
+
type: string
|
|
16110
|
+
key:
|
|
16111
|
+
description: Secret access key for the private location.
|
|
16112
|
+
readOnly: true
|
|
16113
|
+
type: string
|
|
16114
|
+
type: object
|
|
16115
|
+
SyntheticsPrivateLocationSecretsConfigDecryption:
|
|
16116
|
+
description: Private key for the private location.
|
|
16117
|
+
properties:
|
|
16118
|
+
key:
|
|
15634
16119
|
description: Private key for the private location.
|
|
15635
16120
|
readOnly: true
|
|
15636
16121
|
type: string
|
|
@@ -15736,24 +16221,19 @@ components:
|
|
|
15736
16221
|
description: Subject Alternative Name associated with the certificate.
|
|
15737
16222
|
type: string
|
|
15738
16223
|
type: object
|
|
15739
|
-
SyntheticsStatus:
|
|
15740
|
-
description: Determines whether or not the batch has passed, failed, or is in
|
|
15741
|
-
progress.
|
|
15742
|
-
enum:
|
|
15743
|
-
- passed
|
|
15744
|
-
- skipped
|
|
15745
|
-
- failed
|
|
15746
|
-
type: string
|
|
15747
|
-
x-enum-varnames:
|
|
15748
|
-
- PASSED
|
|
15749
|
-
- skipped
|
|
15750
|
-
- failed
|
|
15751
16224
|
SyntheticsStep:
|
|
15752
16225
|
description: The steps used in a Synthetic browser test.
|
|
15753
16226
|
properties:
|
|
15754
16227
|
allowFailure:
|
|
15755
16228
|
description: A boolean set to allow this step to fail.
|
|
15756
16229
|
type: boolean
|
|
16230
|
+
alwaysExecute:
|
|
16231
|
+
description: A boolean set to always execute this step even if the previous
|
|
16232
|
+
step failed or was skipped.
|
|
16233
|
+
type: boolean
|
|
16234
|
+
exitIfSucceed:
|
|
16235
|
+
description: A boolean set to exit the test if the step succeeds.
|
|
16236
|
+
type: boolean
|
|
15757
16237
|
isCritical:
|
|
15758
16238
|
description: A boolean to use in addition to `allowFailure` to determine
|
|
15759
16239
|
if the test should be marked as failed when the step fails.
|
|
@@ -15762,7 +16242,7 @@ components:
|
|
|
15762
16242
|
description: The name of the step.
|
|
15763
16243
|
type: string
|
|
15764
16244
|
noScreenshot:
|
|
15765
|
-
description: A boolean set to
|
|
16245
|
+
description: A boolean set to skip taking a screenshot for the step.
|
|
15766
16246
|
type: boolean
|
|
15767
16247
|
params:
|
|
15768
16248
|
description: The parameters of the step.
|
|
@@ -15777,6 +16257,9 @@ components:
|
|
|
15777
16257
|
SyntheticsStepDetail:
|
|
15778
16258
|
description: Object describing a step for a Synthetic test.
|
|
15779
16259
|
properties:
|
|
16260
|
+
allowFailure:
|
|
16261
|
+
description: Whether or not the step was allowed to fail.
|
|
16262
|
+
type: boolean
|
|
15780
16263
|
browserErrors:
|
|
15781
16264
|
description: Array of errors collected for a browser test.
|
|
15782
16265
|
items:
|
|
@@ -15794,6 +16277,8 @@ components:
|
|
|
15794
16277
|
error:
|
|
15795
16278
|
description: Error returned by the test.
|
|
15796
16279
|
type: string
|
|
16280
|
+
failure:
|
|
16281
|
+
$ref: '#/components/schemas/SyntheticsBrowserTestResultFailure'
|
|
15797
16282
|
playingTab:
|
|
15798
16283
|
$ref: '#/components/schemas/SyntheticsPlayingTab'
|
|
15799
16284
|
screenshotBucketKey:
|
|
@@ -15922,6 +16407,8 @@ components:
|
|
|
15922
16407
|
properties:
|
|
15923
16408
|
executionRule:
|
|
15924
16409
|
$ref: '#/components/schemas/SyntheticsTestExecutionRule'
|
|
16410
|
+
required:
|
|
16411
|
+
- executionRule
|
|
15925
16412
|
type: object
|
|
15926
16413
|
SyntheticsTestConfig:
|
|
15927
16414
|
description: Configuration object for a Synthetic test.
|
|
@@ -16028,16 +16515,19 @@ components:
|
|
|
16028
16515
|
enum:
|
|
16029
16516
|
- api
|
|
16030
16517
|
- browser
|
|
16518
|
+
- mobile
|
|
16031
16519
|
type: string
|
|
16032
16520
|
x-enum-varnames:
|
|
16033
16521
|
- API
|
|
16034
16522
|
- BROWSER
|
|
16523
|
+
- MOBILE
|
|
16035
16524
|
SyntheticsTestExecutionRule:
|
|
16036
16525
|
description: Execution rule for a Synthetic test.
|
|
16037
16526
|
enum:
|
|
16038
16527
|
- blocking
|
|
16039
16528
|
- non_blocking
|
|
16040
16529
|
- skipped
|
|
16530
|
+
example: blocking
|
|
16041
16531
|
type: string
|
|
16042
16532
|
x-enum-varnames:
|
|
16043
16533
|
- BLOCKING
|
|
@@ -16180,6 +16670,11 @@ components:
|
|
|
16180
16670
|
|
|
16181
16671
|
(for example, renotification).'
|
|
16182
16672
|
properties:
|
|
16673
|
+
escalation_message:
|
|
16674
|
+
description: Message to include in the escalation notification.
|
|
16675
|
+
type: string
|
|
16676
|
+
notification_preset_name:
|
|
16677
|
+
$ref: '#/components/schemas/SyntheticsTestOptionsMonitorOptionsNotificationPresetName'
|
|
16183
16678
|
renotify_interval:
|
|
16184
16679
|
description: 'Time interval before renotifying if the test is still failing
|
|
16185
16680
|
|
|
@@ -16187,7 +16682,24 @@ components:
|
|
|
16187
16682
|
format: int64
|
|
16188
16683
|
minimum: 0
|
|
16189
16684
|
type: integer
|
|
16685
|
+
renotify_occurrences:
|
|
16686
|
+
description: The number of times to renotify if the test is still failing.
|
|
16687
|
+
format: int64
|
|
16688
|
+
type: integer
|
|
16190
16689
|
type: object
|
|
16690
|
+
SyntheticsTestOptionsMonitorOptionsNotificationPresetName:
|
|
16691
|
+
description: The name of the preset for the notification for the monitor.
|
|
16692
|
+
enum:
|
|
16693
|
+
- show_all
|
|
16694
|
+
- hide_all
|
|
16695
|
+
- hide_query
|
|
16696
|
+
- hide_handles
|
|
16697
|
+
type: string
|
|
16698
|
+
x-enum-varnames:
|
|
16699
|
+
- SHOW_ALL
|
|
16700
|
+
- HIDE_ALL
|
|
16701
|
+
- HIDE_QUERY
|
|
16702
|
+
- HIDE_HANDLES
|
|
16191
16703
|
SyntheticsTestOptionsRetry:
|
|
16192
16704
|
description: Object describing the retry strategy to apply to a Synthetic test.
|
|
16193
16705
|
properties:
|
|
@@ -16226,6 +16738,9 @@ components:
|
|
|
16226
16738
|
description: Timezone in which the timeframe is based.
|
|
16227
16739
|
example: America/New_York
|
|
16228
16740
|
type: string
|
|
16741
|
+
required:
|
|
16742
|
+
- timeframes
|
|
16743
|
+
- timezone
|
|
16229
16744
|
type: object
|
|
16230
16745
|
SyntheticsTestOptionsSchedulingTimeframe:
|
|
16231
16746
|
description: Object describing a timeframe.
|
|
@@ -16245,6 +16760,10 @@ components:
|
|
|
16245
16760
|
description: The hour of the day on which scheduling ends.
|
|
16246
16761
|
example: '16:00'
|
|
16247
16762
|
type: string
|
|
16763
|
+
required:
|
|
16764
|
+
- day
|
|
16765
|
+
- from
|
|
16766
|
+
- to
|
|
16248
16767
|
type: object
|
|
16249
16768
|
SyntheticsTestPauseStatus:
|
|
16250
16769
|
description: 'Define whether you want to start (`live`) or pause (`paused`)
|
|
@@ -16352,8 +16871,7 @@ components:
|
|
|
16352
16871
|
description: Persist cookies across redirects.
|
|
16353
16872
|
type: boolean
|
|
16354
16873
|
port:
|
|
16355
|
-
|
|
16356
|
-
type: string
|
|
16874
|
+
$ref: '#/components/schemas/SyntheticsTestRequestPort'
|
|
16357
16875
|
proxy:
|
|
16358
16876
|
$ref: '#/components/schemas/SyntheticsTestRequestProxy'
|
|
16359
16877
|
query:
|
|
@@ -16457,6 +16975,15 @@ components:
|
|
|
16457
16975
|
description: Date of update of the certificate or key, ISO format.
|
|
16458
16976
|
type: string
|
|
16459
16977
|
type: object
|
|
16978
|
+
SyntheticsTestRequestNumericalPort:
|
|
16979
|
+
description: Integer Port number to use when performing the test.
|
|
16980
|
+
format: int64
|
|
16981
|
+
type: integer
|
|
16982
|
+
SyntheticsTestRequestPort:
|
|
16983
|
+
description: Port to use when performing the test.
|
|
16984
|
+
oneOf:
|
|
16985
|
+
- $ref: '#/components/schemas/SyntheticsTestRequestNumericalPort'
|
|
16986
|
+
- $ref: '#/components/schemas/SyntheticsTestRequestVariablePort'
|
|
16460
16987
|
SyntheticsTestRequestProxy:
|
|
16461
16988
|
description: The proxy to perform the test.
|
|
16462
16989
|
properties:
|
|
@@ -16469,6 +16996,52 @@ components:
|
|
|
16469
16996
|
required:
|
|
16470
16997
|
- url
|
|
16471
16998
|
type: object
|
|
16999
|
+
SyntheticsTestRequestVariablePort:
|
|
17000
|
+
description: String Port number to use when performing the test. Supports templated
|
|
17001
|
+
variables.
|
|
17002
|
+
type: string
|
|
17003
|
+
SyntheticsTestRestrictionPolicyBinding:
|
|
17004
|
+
description: Objects describing the binding used for a mobile test.
|
|
17005
|
+
properties:
|
|
17006
|
+
principals:
|
|
17007
|
+
$ref: '#/components/schemas/SyntheticsTestRestrictionPolicyBindingPrincipals'
|
|
17008
|
+
relation:
|
|
17009
|
+
$ref: '#/components/schemas/SyntheticsTestRestrictionPolicyBindingRelation'
|
|
17010
|
+
type: object
|
|
17011
|
+
SyntheticsTestRestrictionPolicyBindingPrincipals:
|
|
17012
|
+
description: List of principals for a mobile test binding.
|
|
17013
|
+
items:
|
|
17014
|
+
description: A principal for a mobile test binding.
|
|
17015
|
+
maxLength: 1500
|
|
17016
|
+
type: string
|
|
17017
|
+
type: array
|
|
17018
|
+
SyntheticsTestRestrictionPolicyBindingRelation:
|
|
17019
|
+
description: The type of relation for the binding.
|
|
17020
|
+
enum:
|
|
17021
|
+
- editor
|
|
17022
|
+
- viewer
|
|
17023
|
+
type: string
|
|
17024
|
+
x-enum-varnames:
|
|
17025
|
+
- EDITOR
|
|
17026
|
+
- VIEWER
|
|
17027
|
+
SyntheticsTestUptime:
|
|
17028
|
+
description: Object containing the uptime for a Synthetic test ID.
|
|
17029
|
+
properties:
|
|
17030
|
+
from_ts:
|
|
17031
|
+
description: Timestamp in seconds for the start of uptime.
|
|
17032
|
+
format: int64
|
|
17033
|
+
type: integer
|
|
17034
|
+
overall:
|
|
17035
|
+
$ref: '#/components/schemas/SyntheticsUptime'
|
|
17036
|
+
public_id:
|
|
17037
|
+
description: A Synthetic test ID.
|
|
17038
|
+
example: abc-def-123
|
|
17039
|
+
type: string
|
|
17040
|
+
to_ts:
|
|
17041
|
+
description: Timestamp in seconds for the end of uptime.
|
|
17042
|
+
format: int64
|
|
17043
|
+
type: integer
|
|
17044
|
+
type: object
|
|
16472
17045
|
SyntheticsTiming:
|
|
16473
17046
|
description: 'Object containing all metrics and their values collected for a
|
|
16474
17047
|
Synthetic API test.
|
|
@@ -16592,6 +17165,62 @@ components:
|
|
|
16592
17165
|
new_status:
|
|
16593
17166
|
$ref: '#/components/schemas/SyntheticsTestPauseStatus'
|
|
16594
17167
|
type: object
|
|
17168
|
+
SyntheticsUptime:
|
|
17169
|
+
description: Object containing the uptime information.
|
|
17170
|
+
properties:
|
|
17171
|
+
errors:
|
|
17172
|
+
description: An array of error objects returned while querying the history
|
|
17173
|
+
data for the service level objective.
|
|
17174
|
+
items:
|
|
17175
|
+
$ref: '#/components/schemas/SLOHistoryResponseErrorWithType'
|
|
17176
|
+
nullable: true
|
|
17177
|
+
type: array
|
|
17178
|
+
group:
|
|
17179
|
+
description: The location name
|
|
17180
|
+
example: name
|
|
17181
|
+
type: string
|
|
17182
|
+
history:
|
|
17183
|
+
description: 'The state transition history for the monitor, represented
|
|
17184
|
+
as an array of
|
|
17185
|
+
|
|
17186
|
+
pairs. Each pair is an array where the first element is the transition
|
|
17187
|
+
timestamp
|
|
17188
|
+
|
|
17189
|
+
in Unix epoch format (integer) and the second element is the state (integer).
|
|
17190
|
+
|
|
17191
|
+
For the state, an integer value of `0` indicates uptime, `1` indicates
|
|
17192
|
+
downtime,
|
|
17193
|
+
|
|
17194
|
+
and `2` indicates no data.'
|
|
17195
|
+
example:
|
|
17196
|
+
- - 1579212382
|
|
17197
|
+
- 0
|
|
17198
|
+
items:
|
|
17199
|
+
description: An array of transitions
|
|
17200
|
+
example:
|
|
17201
|
+
- 1579212382
|
|
17202
|
+
- 0
|
|
17203
|
+
items:
|
|
17204
|
+
description: A timeseries data point which is a tuple of (timestamp,
|
|
17205
|
+
value).
|
|
17206
|
+
format: double
|
|
17207
|
+
type: number
|
|
17208
|
+
maxItems: 2
|
|
17209
|
+
minItems: 2
|
|
17210
|
+
type: array
|
|
17211
|
+
type: array
|
|
17212
|
+
span_precision:
|
|
17213
|
+
description: The number of decimal places to which the SLI value is accurate
|
|
17214
|
+
for the given from-to timestamps.
|
|
17215
|
+
example: 2.0
|
|
17216
|
+
format: double
|
|
17217
|
+
type: number
|
|
17218
|
+
uptime:
|
|
17219
|
+
description: The overall uptime.
|
|
17220
|
+
example: 99.99
|
|
17221
|
+
format: double
|
|
17222
|
+
type: number
|
|
17223
|
+
type: object
|
|
16595
17224
|
SyntheticsVariableParser:
|
|
16596
17225
|
description: Details of the parser to use for the global variable.
|
|
16597
17226
|
example:
|
|
@@ -16740,6 +17369,181 @@ components:
|
|
|
16740
17369
|
$ref: '#/components/schemas/LogQueryDefinition'
|
|
16741
17370
|
sort:
|
|
16742
17371
|
$ref: '#/components/schemas/WidgetSortBy'
|
|
17372
|
+
text_formats:
|
|
17373
|
+
description: List of text formats for columns produced by tags.
|
|
17374
|
+
items:
|
|
17375
|
+
$ref: '#/components/schemas/TableWidgetTextFormat'
|
|
17376
|
+
type: array
|
|
17377
|
+
type: object
|
|
17378
|
+
TableWidgetTextFormat:
|
|
17379
|
+
description: Text format rules for a tag-based column within a table widget.
|
|
17380
|
+
example:
|
|
17381
|
+
- match:
|
|
17382
|
+
type: is
|
|
17383
|
+
value: fruit
|
|
17384
|
+
replace:
|
|
17385
|
+
type: all
|
|
17386
|
+
with: vegetable
|
|
17387
|
+
- match:
|
|
17388
|
+
type: is
|
|
17389
|
+
value: cake
|
|
17390
|
+
palette: white_on_green
|
|
17391
|
+
items:
|
|
17392
|
+
$ref: '#/components/schemas/TableWidgetTextFormatRule'
|
|
17393
|
+
minItems: 1
|
|
17394
|
+
type: array
|
|
17395
|
+
TableWidgetTextFormatMatch:
|
|
17396
|
+
description: Match rule for the table widget text format.
|
|
17397
|
+
example:
|
|
17398
|
+
type: is
|
|
17399
|
+
value: fruit
|
|
17400
|
+
properties:
|
|
17401
|
+
type:
|
|
17402
|
+
$ref: '#/components/schemas/TableWidgetTextFormatMatchType'
|
|
17403
|
+
value:
|
|
17404
|
+
description: Table Widget Match String.
|
|
17405
|
+
example: Match Value
|
|
17406
|
+
type: string
|
|
17407
|
+
required:
|
|
17408
|
+
- type
|
|
17409
|
+
- value
|
|
17410
|
+
type: object
|
|
17411
|
+
TableWidgetTextFormatMatchType:
|
|
17412
|
+
description: Match or compare option.
|
|
17413
|
+
enum:
|
|
17414
|
+
- is
|
|
17415
|
+
- is_not
|
|
17416
|
+
- contains
|
|
17417
|
+
- does_not_contain
|
|
17418
|
+
- starts_with
|
|
17419
|
+
- ends_with
|
|
17420
|
+
example: is
|
|
17421
|
+
type: string
|
|
17422
|
+
x-enum-varnames:
|
|
17423
|
+
- IS
|
|
17424
|
+
- IS_NOT
|
|
17425
|
+
- CONTAINS
|
|
17426
|
+
- DOES_NOT_CONTAIN
|
|
17427
|
+
- STARTS_WITH
|
|
17428
|
+
- ENDS_WITH
|
|
17429
|
+
TableWidgetTextFormatPalette:
|
|
17430
|
+
default: white_on_green
|
|
17431
|
+
description: Color-on-color palette to highlight replaced text.
|
|
17432
|
+
enum:
|
|
17433
|
+
- white_on_red
|
|
17434
|
+
- white_on_yellow
|
|
17435
|
+
- white_on_green
|
|
17436
|
+
- black_on_light_red
|
|
17437
|
+
- black_on_light_yellow
|
|
17438
|
+
- black_on_light_green
|
|
17439
|
+
- red_on_white
|
|
17440
|
+
- yellow_on_white
|
|
17441
|
+
- green_on_white
|
|
17442
|
+
- custom_bg
|
|
17443
|
+
- custom_text
|
|
17444
|
+
type: string
|
|
17445
|
+
x-enum-varnames:
|
|
17446
|
+
- WHITE_ON_RED
|
|
17447
|
+
- WHITE_ON_YELLOW
|
|
17448
|
+
- WHITE_ON_GREEN
|
|
17449
|
+
- BLACK_ON_LIGHT_RED
|
|
17450
|
+
- BLACK_ON_LIGHT_YELLOW
|
|
17451
|
+
- BLACK_ON_LIGHT_GREEN
|
|
17452
|
+
- RED_ON_WHITE
|
|
17453
|
+
- YELLOW_ON_WHITE
|
|
17454
|
+
- GREEN_ON_WHITE
|
|
17455
|
+
- CUSTOM_BG
|
|
17456
|
+
- CUSTOM_TEXT
|
|
17457
|
+
TableWidgetTextFormatReplace:
|
|
17458
|
+
description: Replace rule for the table widget text format.
|
|
17459
|
+
example:
|
|
17460
|
+
type: all
|
|
17461
|
+
with: vegetable
|
|
17462
|
+
oneOf:
|
|
17463
|
+
- $ref: '#/components/schemas/TableWidgetTextFormatReplaceAll'
|
|
17464
|
+
- $ref: '#/components/schemas/TableWidgetTextFormatReplaceSubstring'
|
|
17465
|
+
TableWidgetTextFormatReplaceAll:
|
|
17466
|
+
description: Match All definition.
|
|
17467
|
+
example:
|
|
17468
|
+
type: all
|
|
17469
|
+
with: vegetable
|
|
17470
|
+
properties:
|
|
17471
|
+
type:
|
|
17472
|
+
$ref: '#/components/schemas/TableWidgetTextFormatReplaceAllType'
|
|
17473
|
+
with:
|
|
17474
|
+
description: Replace All type.
|
|
17475
|
+
example: all
|
|
17476
|
+
type: string
|
|
17477
|
+
required:
|
|
17478
|
+
- type
|
|
17479
|
+
- with
|
|
17480
|
+
type: object
|
|
17481
|
+
TableWidgetTextFormatReplaceAllType:
|
|
17482
|
+
description: Table widget text format replace all type.
|
|
17483
|
+
enum:
|
|
17484
|
+
- all
|
|
17485
|
+
example: all
|
|
17486
|
+
type: string
|
|
17487
|
+
x-enum-varnames:
|
|
17488
|
+
- ALL
|
|
17489
|
+
TableWidgetTextFormatReplaceSubstring:
|
|
17490
|
+
description: Match Sub-string definition.
|
|
17491
|
+
example:
|
|
17492
|
+
substring: fruit
|
|
17493
|
+
type: substring
|
|
17494
|
+
with: vegetable
|
|
17495
|
+
properties:
|
|
17496
|
+
substring:
|
|
17497
|
+
description: Text that will be replaced.
|
|
17498
|
+
example: string to replace
|
|
17499
|
+
type: string
|
|
17500
|
+
type:
|
|
17501
|
+
$ref: '#/components/schemas/TableWidgetTextFormatReplaceSubstringType'
|
|
17502
|
+
with:
|
|
17503
|
+
description: Text that will replace original sub-string.
|
|
17504
|
+
example: replacement
|
|
17505
|
+
type: string
|
|
17506
|
+
required:
|
|
17507
|
+
- type
|
|
17508
|
+
- with
|
|
17509
|
+
- substring
|
|
17510
|
+
type: object
|
|
17511
|
+
TableWidgetTextFormatReplaceSubstringType:
|
|
17512
|
+
description: Table widget text format replace sub-string type.
|
|
17513
|
+
enum:
|
|
17514
|
+
- substring
|
|
17515
|
+
example: substring
|
|
17516
|
+
type: string
|
|
17517
|
+
x-enum-varnames:
|
|
17518
|
+
- SUBSTRING
|
|
17519
|
+
TableWidgetTextFormatRule:
|
|
17520
|
+
description: Text format rules.
|
|
17521
|
+
example:
|
|
17522
|
+
match:
|
|
17523
|
+
type: is
|
|
17524
|
+
value: apple
|
|
17525
|
+
replace:
|
|
17526
|
+
type: all
|
|
17527
|
+
with: vegetable
|
|
17528
|
+
properties:
|
|
17529
|
+
custom_bg_color:
|
|
17530
|
+
description: Hex representation of the custom background color. Used with
|
|
17531
|
+
custom background palette option.
|
|
17532
|
+
example: '#632ca6'
|
|
17533
|
+
type: string
|
|
17534
|
+
custom_fg_color:
|
|
17535
|
+
description: Hex representation of the custom text color. Used with custom
|
|
17536
|
+
text palette option.
|
|
17537
|
+
example: '#632ca6'
|
|
17538
|
+
type: string
|
|
17539
|
+
match:
|
|
17540
|
+
$ref: '#/components/schemas/TableWidgetTextFormatMatch'
|
|
17541
|
+
palette:
|
|
17542
|
+
$ref: '#/components/schemas/TableWidgetTextFormatPalette'
|
|
17543
|
+
replace:
|
|
17544
|
+
$ref: '#/components/schemas/TableWidgetTextFormatReplace'
|
|
17545
|
+
required:
|
|
17546
|
+
- match
|
|
16743
17547
|
type: object
|
|
16744
17548
|
TagToHosts:
|
|
16745
17549
|
description: In this object, the key is the tag, the value is a list of host
|
|
@@ -17099,7 +17903,6 @@ components:
|
|
|
17099
17903
|
$ref: '#/components/schemas/ToplistWidgetStackedType'
|
|
17100
17904
|
required:
|
|
17101
17905
|
- type
|
|
17102
|
-
- legend
|
|
17103
17906
|
type: object
|
|
17104
17907
|
ToplistWidgetStackedType:
|
|
17105
17908
|
default: stacked
|
|
@@ -18973,6 +19776,16 @@ components:
|
|
|
18973
19776
|
events over all hours in the current date for the given org.
|
|
18974
19777
|
format: int64
|
|
18975
19778
|
type: integer
|
|
19779
|
+
code_analysis_sa_committers_hwm:
|
|
19780
|
+
description: Shows the high-water mark of all Static Analysis committers
|
|
19781
|
+
over all hours in the current date for the given org.
|
|
19782
|
+
format: int64
|
|
19783
|
+
type: integer
|
|
19784
|
+
code_analysis_sca_committers_hwm:
|
|
19785
|
+
description: Shows the high-water mark of all static Software Composition
|
|
19786
|
+
Analysis committers over all hours in the current date for the given org.
|
|
19787
|
+
format: int64
|
|
19788
|
+
type: integer
|
|
18976
19789
|
container_avg:
|
|
18977
19790
|
description: Shows the average of all distinct containers over all hours
|
|
18978
19791
|
in the current date for all organizations.
|
|
@@ -19096,6 +19909,11 @@ components:
|
|
|
19096
19909
|
over all hours in the current date for all organizations.
|
|
19097
19910
|
format: int64
|
|
19098
19911
|
type: integer
|
|
19912
|
+
data_jobs_monitoring_host_hr_sum:
|
|
19913
|
+
description: Shows the sum of all Data Jobs Monitoring hosts over all hours
|
|
19914
|
+
in the current date for the given org.
|
|
19915
|
+
format: int64
|
|
19916
|
+
type: integer
|
|
19099
19917
|
date:
|
|
19100
19918
|
description: The date for the usage.
|
|
19101
19919
|
format: date-time
|
|
@@ -19288,6 +20106,16 @@ components:
|
|
|
19288
20106
|
hours in the current date for the given org.
|
|
19289
20107
|
format: int64
|
|
19290
20108
|
type: integer
|
|
20109
|
+
oci_host_sum:
|
|
20110
|
+
description: Shows the sum of all Oracle Cloud Infrastructure hosts over
|
|
20111
|
+
all hours in the current date for the given org.
|
|
20112
|
+
format: int64
|
|
20113
|
+
type: integer
|
|
20114
|
+
oci_host_top99p:
|
|
20115
|
+
description: Shows the 99th percentile of all Oracle Cloud Infrastructure
|
|
20116
|
+
hosts over all hours in the current date for the given org.
|
|
20117
|
+
format: int64
|
|
20118
|
+
type: integer
|
|
19291
20119
|
online_archive_events_count_sum:
|
|
19292
20120
|
description: Sum of all online archived events over all hours in the current
|
|
19293
20121
|
date for all organizations.
|
|
@@ -19698,6 +20526,16 @@ components:
|
|
|
19698
20526
|
events over all hours in the current date for the given org.
|
|
19699
20527
|
format: int64
|
|
19700
20528
|
type: integer
|
|
20529
|
+
code_analysis_sa_committers_hwm:
|
|
20530
|
+
description: Shows the high-water mark of all Static Analysis committers
|
|
20531
|
+
over all hours in the current date for the given org.
|
|
20532
|
+
format: int64
|
|
20533
|
+
type: integer
|
|
20534
|
+
code_analysis_sca_committers_hwm:
|
|
20535
|
+
description: Shows the high-water mark of all static Software Composition
|
|
20536
|
+
Analysis committers over all hours in the current date for the given org.
|
|
20537
|
+
format: int64
|
|
20538
|
+
type: integer
|
|
19701
20539
|
container_avg:
|
|
19702
20540
|
description: Shows the average of all distinct containers over all hours
|
|
19703
20541
|
in the current date for the given org.
|
|
@@ -19831,6 +20669,11 @@ components:
|
|
|
19831
20669
|
over all hours in the current date for the given org.
|
|
19832
20670
|
format: int64
|
|
19833
20671
|
type: integer
|
|
20672
|
+
data_jobs_monitoring_host_hr_sum:
|
|
20673
|
+
description: Shows the sum of all Data Jobs Monitoring hosts over all hours
|
|
20674
|
+
in the current date for the given org.
|
|
20675
|
+
format: int64
|
|
20676
|
+
type: integer
|
|
19834
20677
|
dbm_host_top99p_sum:
|
|
19835
20678
|
description: Shows the 99th percentile of all Database Monitoring hosts
|
|
19836
20679
|
over all hours in the current month for the given org.
|
|
@@ -20022,6 +20865,16 @@ components:
|
|
|
20022
20865
|
hours in the current date for the given org.
|
|
20023
20866
|
format: int64
|
|
20024
20867
|
type: integer
|
|
20868
|
+
oci_host_sum:
|
|
20869
|
+
description: Shows the sum of all Oracle Cloud Infrastructure hosts over
|
|
20870
|
+
all hours in the current date for the given org.
|
|
20871
|
+
format: int64
|
|
20872
|
+
type: integer
|
|
20873
|
+
oci_host_top99p:
|
|
20874
|
+
description: Shows the 99th percentile of all Oracle Cloud Infrastructure
|
|
20875
|
+
hosts over all hours in the current date for the given org.
|
|
20876
|
+
format: int64
|
|
20877
|
+
type: integer
|
|
20025
20878
|
online_archive_events_count_sum:
|
|
20026
20879
|
description: Sum of all online archived events over all hours in the current
|
|
20027
20880
|
date for the given org.
|
|
@@ -20434,6 +21287,16 @@ components:
|
|
|
20434
21287
|
events over all hours in the current month for all organizations.
|
|
20435
21288
|
format: int64
|
|
20436
21289
|
type: integer
|
|
21290
|
+
code_analysis_sa_committers_hwm_sum:
|
|
21291
|
+
description: Shows the high-water mark of all Static Analysis committers
|
|
21292
|
+
over all hours in the current month for all organizations.
|
|
21293
|
+
format: int64
|
|
21294
|
+
type: integer
|
|
21295
|
+
code_analysis_sca_committers_hwm_sum:
|
|
21296
|
+
description: Shows the high-water mark of all static Software Composition
|
|
21297
|
+
Analysis committers over all hours in the current month for all organizations.
|
|
21298
|
+
format: int64
|
|
21299
|
+
type: integer
|
|
20437
21300
|
container_avg_sum:
|
|
20438
21301
|
description: Shows the average of all distinct containers over all hours
|
|
20439
21302
|
in the current month for all organizations.
|
|
@@ -20565,6 +21428,11 @@ components:
|
|
|
20565
21428
|
over all hours in the current month for all organizations.
|
|
20566
21429
|
format: int64
|
|
20567
21430
|
type: integer
|
|
21431
|
+
data_jobs_monitoring_host_hr_agg_sum:
|
|
21432
|
+
description: Shows the sum of Data Jobs Monitoring hosts over all hours
|
|
21433
|
+
in the current months for all organizations
|
|
21434
|
+
format: int64
|
|
21435
|
+
type: integer
|
|
20568
21436
|
dbm_host_top99p_sum:
|
|
20569
21437
|
description: Shows the 99th percentile of all Database Monitoring hosts
|
|
20570
21438
|
over all hours in the current month for all organizations.
|
|
@@ -20779,6 +21647,16 @@ components:
|
|
|
20779
21647
|
hours in the current month for all organizations.
|
|
20780
21648
|
format: int64
|
|
20781
21649
|
type: integer
|
|
21650
|
+
oci_host_agg_sum:
|
|
21651
|
+
description: Shows the sum of Oracle Cloud Infrastructure hosts over all
|
|
21652
|
+
hours in the current months for all organizations
|
|
21653
|
+
format: int64
|
|
21654
|
+
type: integer
|
|
21655
|
+
oci_host_top99p_sum:
|
|
21656
|
+
description: Shows the 99th percentile of Oracle Cloud Infrastructure hosts
|
|
21657
|
+
over all hours in the current months for all organizations
|
|
21658
|
+
format: int64
|
|
21659
|
+
type: integer
|
|
20782
21660
|
online_archive_events_count_agg_sum:
|
|
20783
21661
|
description: Sum of all online archived events over all hours in the current
|
|
20784
21662
|
month for all organizations.
|
|
@@ -22395,6 +23273,7 @@ components:
|
|
|
22395
23273
|
access to the cloud cost data source in dashboards and notebooks.
|
|
22396
23274
|
cloud_cost_management_write: Configure cloud cost accounts and global
|
|
22397
23275
|
customizations.
|
|
23276
|
+
code_analysis_read: View Code Analysis.
|
|
22398
23277
|
continuous_profiler_pgo_read: Read and query Continuous Profiler data
|
|
22399
23278
|
for Profile-Guided Optimization (PGO).
|
|
22400
23279
|
create_webhooks: Create webhooks integrations.
|
|
@@ -22409,6 +23288,7 @@ components:
|
|
|
22409
23288
|
incident_notification_settings_write: Configure Incidents Notification
|
|
22410
23289
|
settings.
|
|
22411
23290
|
incident_read: View incidents in Datadog.
|
|
23291
|
+
incident_settings_read: View Incident Settings.
|
|
22412
23292
|
incident_settings_write: Configure Incident Settings.
|
|
22413
23293
|
incident_write: Create, view, and manage incidents in Datadog.
|
|
22414
23294
|
metrics_read: View custom metrics.
|
|
@@ -22430,6 +23310,8 @@ components:
|
|
|
22430
23310
|
security_monitoring_signals_read: View Security Signals.
|
|
22431
23311
|
security_monitoring_suppressions_read: Read Rule Suppressions.
|
|
22432
23312
|
security_monitoring_suppressions_write: Write Rule Suppressions.
|
|
23313
|
+
security_pipelines_read: View Security Pipelines.
|
|
23314
|
+
security_pipelines_write: Create, edit, and delete CSM Security Pipelines.
|
|
22433
23315
|
slos_corrections: Apply, edit, and delete SLO status corrections. A user
|
|
22434
23316
|
with this permission can make status corrections, even if they do not
|
|
22435
23317
|
have permission to edit those SLOs.
|
|
@@ -22565,6 +23447,10 @@ paths:
|
|
|
22565
23447
|
summary: Get all API keys
|
|
22566
23448
|
tags:
|
|
22567
23449
|
- Key Management
|
|
23450
|
+
x-permission:
|
|
23451
|
+
operator: OR
|
|
23452
|
+
permissions:
|
|
23453
|
+
- api_keys_read
|
|
22568
23454
|
post:
|
|
22569
23455
|
description: Creates an API key with a given name.
|
|
22570
23456
|
operationId: CreateAPIKey
|
|
@@ -22599,6 +23485,10 @@ paths:
|
|
|
22599
23485
|
tags:
|
|
22600
23486
|
- Key Management
|
|
22601
23487
|
x-codegen-request-body-name: body
|
|
23488
|
+
x-permission:
|
|
23489
|
+
operator: OR
|
|
23490
|
+
permissions:
|
|
23491
|
+
- api_keys_write
|
|
22602
23492
|
/api/v1/api_key/{key}:
|
|
22603
23493
|
delete:
|
|
22604
23494
|
description: Delete a given API key.
|
|
@@ -22640,6 +23530,10 @@ paths:
|
|
|
22640
23530
|
summary: Delete an API key
|
|
22641
23531
|
tags:
|
|
22642
23532
|
- Key Management
|
|
23533
|
+
x-permission:
|
|
23534
|
+
operator: OR
|
|
23535
|
+
permissions:
|
|
23536
|
+
- api_keys_delete
|
|
22643
23537
|
get:
|
|
22644
23538
|
description: Get a given API key.
|
|
22645
23539
|
operationId: GetAPIKey
|
|
@@ -22674,6 +23568,10 @@ paths:
|
|
|
22674
23568
|
summary: Get API key
|
|
22675
23569
|
tags:
|
|
22676
23570
|
- Key Management
|
|
23571
|
+
x-permission:
|
|
23572
|
+
operator: OR
|
|
23573
|
+
permissions:
|
|
23574
|
+
- api_keys_read
|
|
22677
23575
|
put:
|
|
22678
23576
|
description: Edit an API key name.
|
|
22679
23577
|
operationId: UpdateAPIKey
|
|
@@ -22721,6 +23619,10 @@ paths:
|
|
|
22721
23619
|
tags:
|
|
22722
23620
|
- Key Management
|
|
22723
23621
|
x-codegen-request-body-name: body
|
|
23622
|
+
x-permission:
|
|
23623
|
+
operator: OR
|
|
23624
|
+
permissions:
|
|
23625
|
+
- api_keys_write
|
|
22724
23626
|
/api/v1/application_key:
|
|
22725
23627
|
get:
|
|
22726
23628
|
description: Get all application keys available for your Datadog account.
|
|
@@ -22743,6 +23645,11 @@ paths:
|
|
|
22743
23645
|
summary: Get all application keys
|
|
22744
23646
|
tags:
|
|
22745
23647
|
- Key Management
|
|
23648
|
+
x-permission:
|
|
23649
|
+
operator: OR
|
|
23650
|
+
permissions:
|
|
23651
|
+
- org_app_keys_read
|
|
23652
|
+
- user_app_keys
|
|
22746
23653
|
post:
|
|
22747
23654
|
description: Create an application key with a given name.
|
|
22748
23655
|
operationId: CreateApplicationKey
|
|
@@ -22783,6 +23690,10 @@ paths:
|
|
|
22783
23690
|
tags:
|
|
22784
23691
|
- Key Management
|
|
22785
23692
|
x-codegen-request-body-name: body
|
|
23693
|
+
x-permission:
|
|
23694
|
+
operator: OR
|
|
23695
|
+
permissions:
|
|
23696
|
+
- user_app_keys
|
|
22786
23697
|
/api/v1/application_key/{key}:
|
|
22787
23698
|
delete:
|
|
22788
23699
|
description: Delete a given application key.
|
|
@@ -22818,6 +23729,11 @@ paths:
|
|
|
22818
23729
|
summary: Delete an application key
|
|
22819
23730
|
tags:
|
|
22820
23731
|
- Key Management
|
|
23732
|
+
x-permission:
|
|
23733
|
+
operator: OR
|
|
23734
|
+
permissions:
|
|
23735
|
+
- org_app_keys_write
|
|
23736
|
+
- user_app_keys
|
|
22821
23737
|
get:
|
|
22822
23738
|
description: Get a given application key.
|
|
22823
23739
|
operationId: GetApplicationKey
|
|
@@ -22852,6 +23768,11 @@ paths:
|
|
|
22852
23768
|
summary: Get an application key
|
|
22853
23769
|
tags:
|
|
22854
23770
|
- Key Management
|
|
23771
|
+
x-permission:
|
|
23772
|
+
operator: OR
|
|
23773
|
+
permissions:
|
|
23774
|
+
- org_app_keys_read
|
|
23775
|
+
- user_app_keys
|
|
22855
23776
|
put:
|
|
22856
23777
|
description: Edit an application key name.
|
|
22857
23778
|
operationId: UpdateApplicationKey
|
|
@@ -22905,6 +23826,11 @@ paths:
|
|
|
22905
23826
|
tags:
|
|
22906
23827
|
- Key Management
|
|
22907
23828
|
x-codegen-request-body-name: body
|
|
23829
|
+
x-permission:
|
|
23830
|
+
operator: OR
|
|
23831
|
+
permissions:
|
|
23832
|
+
- org_app_keys_write
|
|
23833
|
+
- user_app_keys
|
|
22908
23834
|
/api/v1/check_run:
|
|
22909
23835
|
post:
|
|
22910
23836
|
description: 'Submit a list of Service Checks.
|
|
@@ -23022,6 +23948,10 @@ paths:
|
|
|
23022
23948
|
summary: Get the list of available daily custom reports
|
|
23023
23949
|
tags:
|
|
23024
23950
|
- Usage Metering
|
|
23951
|
+
x-permission:
|
|
23952
|
+
operator: OR
|
|
23953
|
+
permissions:
|
|
23954
|
+
- usage_read
|
|
23025
23955
|
/api/v1/daily_custom_reports/{report_id}:
|
|
23026
23956
|
get:
|
|
23027
23957
|
deprecated: true
|
|
@@ -23067,6 +23997,10 @@ paths:
|
|
|
23067
23997
|
summary: Get specified daily custom reports
|
|
23068
23998
|
tags:
|
|
23069
23999
|
- Usage Metering
|
|
24000
|
+
x-permission:
|
|
24001
|
+
operator: OR
|
|
24002
|
+
permissions:
|
|
24003
|
+
- usage_read
|
|
23070
24004
|
/api/v1/dashboard:
|
|
23071
24005
|
delete:
|
|
23072
24006
|
description: Delete dashboards using the specified IDs. If there are any failures,
|
|
@@ -23119,6 +24053,10 @@ paths:
|
|
|
23119
24053
|
tags:
|
|
23120
24054
|
- Dashboards
|
|
23121
24055
|
x-codegen-request-body-name: body
|
|
24056
|
+
x-permission:
|
|
24057
|
+
operator: OR
|
|
24058
|
+
permissions:
|
|
24059
|
+
- dashboards_write
|
|
23122
24060
|
get:
|
|
23123
24061
|
description: 'Get all dashboards.
|
|
23124
24062
|
|
|
@@ -23186,6 +24124,10 @@ paths:
|
|
|
23186
24124
|
limitParam: count
|
|
23187
24125
|
pageOffsetParam: start
|
|
23188
24126
|
resultsPath: dashboards
|
|
24127
|
+
x-permission:
|
|
24128
|
+
operator: OR
|
|
24129
|
+
permissions:
|
|
24130
|
+
- dashboards_read
|
|
23189
24131
|
patch:
|
|
23190
24132
|
description: Restore dashboards using the specified IDs. If there are any failures,
|
|
23191
24133
|
no dashboards will be restored (partial success is not allowed).
|
|
@@ -23237,6 +24179,10 @@ paths:
|
|
|
23237
24179
|
tags:
|
|
23238
24180
|
- Dashboards
|
|
23239
24181
|
x-codegen-request-body-name: body
|
|
24182
|
+
x-permission:
|
|
24183
|
+
operator: OR
|
|
24184
|
+
permissions:
|
|
24185
|
+
- dashboards_write
|
|
23240
24186
|
post:
|
|
23241
24187
|
description: 'Create a dashboard using the specified options. When defining
|
|
23242
24188
|
queries in your widgets, take note of which queries should have the `as_count()`
|
|
@@ -23282,6 +24228,10 @@ paths:
|
|
|
23282
24228
|
tags:
|
|
23283
24229
|
- Dashboards
|
|
23284
24230
|
x-codegen-request-body-name: body
|
|
24231
|
+
x-permission:
|
|
24232
|
+
operator: OR
|
|
24233
|
+
permissions:
|
|
24234
|
+
- dashboards_write
|
|
23285
24235
|
/api/v1/dashboard/lists/manual:
|
|
23286
24236
|
get:
|
|
23287
24237
|
description: Fetch all of your existing dashboard list definitions.
|
|
@@ -23309,6 +24259,10 @@ paths:
|
|
|
23309
24259
|
summary: Get all dashboard lists
|
|
23310
24260
|
tags:
|
|
23311
24261
|
- Dashboard Lists
|
|
24262
|
+
x-permission:
|
|
24263
|
+
operator: OR
|
|
24264
|
+
permissions:
|
|
24265
|
+
- dashboards_read
|
|
23312
24266
|
post:
|
|
23313
24267
|
description: Create an empty dashboard list.
|
|
23314
24268
|
operationId: CreateDashboardList
|
|
@@ -23349,6 +24303,10 @@ paths:
|
|
|
23349
24303
|
tags:
|
|
23350
24304
|
- Dashboard Lists
|
|
23351
24305
|
x-codegen-request-body-name: body
|
|
24306
|
+
x-permission:
|
|
24307
|
+
operator: OR
|
|
24308
|
+
permissions:
|
|
24309
|
+
- dashboards_write
|
|
23352
24310
|
/api/v1/dashboard/lists/manual/{list_id}:
|
|
23353
24311
|
delete:
|
|
23354
24312
|
description: Delete a dashboard list.
|
|
@@ -23390,6 +24348,10 @@ paths:
|
|
|
23390
24348
|
summary: Delete a dashboard list
|
|
23391
24349
|
tags:
|
|
23392
24350
|
- Dashboard Lists
|
|
24351
|
+
x-permission:
|
|
24352
|
+
operator: OR
|
|
24353
|
+
permissions:
|
|
24354
|
+
- dashboards_write
|
|
23393
24355
|
get:
|
|
23394
24356
|
description: Fetch an existing dashboard list's definition.
|
|
23395
24357
|
operationId: GetDashboardList
|
|
@@ -23430,6 +24392,10 @@ paths:
|
|
|
23430
24392
|
summary: Get a dashboard list
|
|
23431
24393
|
tags:
|
|
23432
24394
|
- Dashboard Lists
|
|
24395
|
+
x-permission:
|
|
24396
|
+
operator: OR
|
|
24397
|
+
permissions:
|
|
24398
|
+
- dashboards_read
|
|
23433
24399
|
put:
|
|
23434
24400
|
description: Update the name of a dashboard list.
|
|
23435
24401
|
operationId: UpdateDashboardList
|
|
@@ -23484,6 +24450,10 @@ paths:
|
|
|
23484
24450
|
tags:
|
|
23485
24451
|
- Dashboard Lists
|
|
23486
24452
|
x-codegen-request-body-name: body
|
|
24453
|
+
x-permission:
|
|
24454
|
+
operator: OR
|
|
24455
|
+
permissions:
|
|
24456
|
+
- dashboards_write
|
|
23487
24457
|
/api/v1/dashboard/public:
|
|
23488
24458
|
post:
|
|
23489
24459
|
description: Share a specified private dashboard, generating a URL at which
|
|
@@ -23538,6 +24508,10 @@ paths:
|
|
|
23538
24508
|
tags:
|
|
23539
24509
|
- Dashboards
|
|
23540
24510
|
x-codegen-request-body-name: body
|
|
24511
|
+
x-permission:
|
|
24512
|
+
operator: OR
|
|
24513
|
+
permissions:
|
|
24514
|
+
- dashboards_public_share
|
|
23541
24515
|
/api/v1/dashboard/public/{token}:
|
|
23542
24516
|
delete:
|
|
23543
24517
|
description: Revoke the public URL for a dashboard (rendering it private) associated
|
|
@@ -23579,6 +24553,10 @@ paths:
|
|
|
23579
24553
|
summary: Revoke a shared dashboard URL
|
|
23580
24554
|
tags:
|
|
23581
24555
|
- Dashboards
|
|
24556
|
+
x-permission:
|
|
24557
|
+
operator: OR
|
|
24558
|
+
permissions:
|
|
24559
|
+
- dashboards_public_share
|
|
23582
24560
|
get:
|
|
23583
24561
|
description: Fetch an existing shared dashboard's sharing metadata associated
|
|
23584
24562
|
with the specified token.
|
|
@@ -23620,6 +24598,10 @@ paths:
|
|
|
23620
24598
|
summary: Get a shared dashboard
|
|
23621
24599
|
tags:
|
|
23622
24600
|
- Dashboards
|
|
24601
|
+
x-permission:
|
|
24602
|
+
operator: OR
|
|
24603
|
+
permissions:
|
|
24604
|
+
- dashboards_read
|
|
23623
24605
|
put:
|
|
23624
24606
|
description: Update a shared dashboard associated with the specified token.
|
|
23625
24607
|
operationId: UpdatePublicDashboard
|
|
@@ -23689,6 +24671,10 @@ paths:
|
|
|
23689
24671
|
tags:
|
|
23690
24672
|
- Dashboards
|
|
23691
24673
|
x-codegen-request-body-name: body
|
|
24674
|
+
x-permission:
|
|
24675
|
+
operator: OR
|
|
24676
|
+
permissions:
|
|
24677
|
+
- dashboards_public_share
|
|
23692
24678
|
/api/v1/dashboard/public/{token}/invitation:
|
|
23693
24679
|
delete:
|
|
23694
24680
|
description: Revoke previously sent invitation emails and active sessions used
|
|
@@ -23741,6 +24727,10 @@ paths:
|
|
|
23741
24727
|
tags:
|
|
23742
24728
|
- Dashboards
|
|
23743
24729
|
x-codegen-request-body-name: body
|
|
24730
|
+
x-permission:
|
|
24731
|
+
operator: OR
|
|
24732
|
+
permissions:
|
|
24733
|
+
- dashboards_public_share
|
|
23744
24734
|
get:
|
|
23745
24735
|
description: Describe the invitations that exist for the given shared dashboard
|
|
23746
24736
|
(paginated).
|
|
@@ -23795,6 +24785,10 @@ paths:
|
|
|
23795
24785
|
summary: Get all invitations for a shared dashboard
|
|
23796
24786
|
tags:
|
|
23797
24787
|
- Dashboards
|
|
24788
|
+
x-permission:
|
|
24789
|
+
operator: OR
|
|
24790
|
+
permissions:
|
|
24791
|
+
- dashboards_public_share
|
|
23798
24792
|
post:
|
|
23799
24793
|
description: Send emails to specified email addresses containing links to access
|
|
23800
24794
|
a given authenticated shared dashboard. Email addresses must already belong
|
|
@@ -23857,6 +24851,10 @@ paths:
|
|
|
23857
24851
|
tags:
|
|
23858
24852
|
- Dashboards
|
|
23859
24853
|
x-codegen-request-body-name: body
|
|
24854
|
+
x-permission:
|
|
24855
|
+
operator: OR
|
|
24856
|
+
permissions:
|
|
24857
|
+
- dashboards_public_share
|
|
23860
24858
|
/api/v1/dashboard/{dashboard_id}:
|
|
23861
24859
|
delete:
|
|
23862
24860
|
description: Delete a dashboard using the specified ID.
|
|
@@ -23897,6 +24895,10 @@ paths:
|
|
|
23897
24895
|
summary: Delete a dashboard
|
|
23898
24896
|
tags:
|
|
23899
24897
|
- Dashboards
|
|
24898
|
+
x-permission:
|
|
24899
|
+
operator: OR
|
|
24900
|
+
permissions:
|
|
24901
|
+
- dashboards_write
|
|
23900
24902
|
get:
|
|
23901
24903
|
description: Get a dashboard using the specified ID.
|
|
23902
24904
|
operationId: GetDashboard
|
|
@@ -23936,6 +24938,10 @@ paths:
|
|
|
23936
24938
|
summary: Get a dashboard
|
|
23937
24939
|
tags:
|
|
23938
24940
|
- Dashboards
|
|
24941
|
+
x-permission:
|
|
24942
|
+
operator: OR
|
|
24943
|
+
permissions:
|
|
24944
|
+
- dashboards_read
|
|
23939
24945
|
put:
|
|
23940
24946
|
description: Update a dashboard using the specified ID.
|
|
23941
24947
|
operationId: UpdateDashboard
|
|
@@ -23989,6 +24995,10 @@ paths:
|
|
|
23989
24995
|
tags:
|
|
23990
24996
|
- Dashboards
|
|
23991
24997
|
x-codegen-request-body-name: body
|
|
24998
|
+
x-permission:
|
|
24999
|
+
operator: OR
|
|
25000
|
+
permissions:
|
|
25001
|
+
- dashboards_write
|
|
23992
25002
|
/api/v1/distribution_points:
|
|
23993
25003
|
post:
|
|
23994
25004
|
description: "The distribution points end-point allows you to post distribution
|
|
@@ -24098,6 +25108,10 @@ paths:
|
|
|
24098
25108
|
summary: Get all downtimes
|
|
24099
25109
|
tags:
|
|
24100
25110
|
- Downtimes
|
|
25111
|
+
x-permission:
|
|
25112
|
+
operator: OR
|
|
25113
|
+
permissions:
|
|
25114
|
+
- monitors_read
|
|
24101
25115
|
post:
|
|
24102
25116
|
deprecated: true
|
|
24103
25117
|
description: Schedule a downtime. **Note:** This endpoint has been deprecated.
|
|
@@ -24140,6 +25154,10 @@ paths:
|
|
|
24140
25154
|
tags:
|
|
24141
25155
|
- Downtimes
|
|
24142
25156
|
x-codegen-request-body-name: body
|
|
25157
|
+
x-permission:
|
|
25158
|
+
operator: OR
|
|
25159
|
+
permissions:
|
|
25160
|
+
- monitors_downtime
|
|
24143
25161
|
/api/v1/downtime/cancel/by_scope:
|
|
24144
25162
|
post:
|
|
24145
25163
|
deprecated: true
|
|
@@ -24191,6 +25209,10 @@ paths:
|
|
|
24191
25209
|
tags:
|
|
24192
25210
|
- Downtimes
|
|
24193
25211
|
x-codegen-request-body-name: body
|
|
25212
|
+
x-permission:
|
|
25213
|
+
operator: OR
|
|
25214
|
+
permissions:
|
|
25215
|
+
- monitors_downtime
|
|
24194
25216
|
/api/v1/downtime/{downtime_id}:
|
|
24195
25217
|
delete:
|
|
24196
25218
|
deprecated: true
|
|
@@ -24231,6 +25253,10 @@ paths:
|
|
|
24231
25253
|
summary: Cancel a downtime
|
|
24232
25254
|
tags:
|
|
24233
25255
|
- Downtimes
|
|
25256
|
+
x-permission:
|
|
25257
|
+
operator: OR
|
|
25258
|
+
permissions:
|
|
25259
|
+
- monitors_downtime
|
|
24234
25260
|
get:
|
|
24235
25261
|
deprecated: true
|
|
24236
25262
|
description: Get downtime detail by `downtime_id`. **Note:** This endpoint has
|
|
@@ -24274,6 +25300,10 @@ paths:
|
|
|
24274
25300
|
summary: Get a downtime
|
|
24275
25301
|
tags:
|
|
24276
25302
|
- Downtimes
|
|
25303
|
+
x-permission:
|
|
25304
|
+
operator: OR
|
|
25305
|
+
permissions:
|
|
25306
|
+
- monitors_read
|
|
24277
25307
|
put:
|
|
24278
25308
|
deprecated: true
|
|
24279
25309
|
description: Update a single downtime by `downtime_id`. **Note:** This endpoint
|
|
@@ -24332,6 +25362,10 @@ paths:
|
|
|
24332
25362
|
tags:
|
|
24333
25363
|
- Downtimes
|
|
24334
25364
|
x-codegen-request-body-name: body
|
|
25365
|
+
x-permission:
|
|
25366
|
+
operator: OR
|
|
25367
|
+
permissions:
|
|
25368
|
+
- monitors_downtime
|
|
24335
25369
|
/api/v1/events:
|
|
24336
25370
|
get:
|
|
24337
25371
|
description: "The event stream can be queried and filtered by time, priority,
|
|
@@ -24442,6 +25476,10 @@ paths:
|
|
|
24442
25476
|
summary: Get a list of events
|
|
24443
25477
|
tags:
|
|
24444
25478
|
- Events
|
|
25479
|
+
x-permission:
|
|
25480
|
+
operator: OR
|
|
25481
|
+
permissions:
|
|
25482
|
+
- events_read
|
|
24445
25483
|
post:
|
|
24446
25484
|
description: 'This endpoint allows you to post events to the stream.
|
|
24447
25485
|
|
|
@@ -24518,6 +25556,10 @@ paths:
|
|
|
24518
25556
|
summary: Get an event
|
|
24519
25557
|
tags:
|
|
24520
25558
|
- Events
|
|
25559
|
+
x-permission:
|
|
25560
|
+
operator: OR
|
|
25561
|
+
permissions:
|
|
25562
|
+
- events_read
|
|
24521
25563
|
/api/v1/graph/snapshot:
|
|
24522
25564
|
get:
|
|
24523
25565
|
description: 'Take graph snapshots.
|
|
@@ -24613,6 +25655,9 @@ paths:
|
|
|
24613
25655
|
summary: Take graph snapshots
|
|
24614
25656
|
tags:
|
|
24615
25657
|
- Snapshots
|
|
25658
|
+
x-permission:
|
|
25659
|
+
operator: OPEN
|
|
25660
|
+
permissions: []
|
|
24616
25661
|
/api/v1/host/{host_name}/mute:
|
|
24617
25662
|
post:
|
|
24618
25663
|
description: Mute a host. **Note:** This creates a [Downtime V2](https://docs.datadoghq.com/api/latest/downtimes/#schedule-a-downtime)
|
|
@@ -24789,6 +25834,10 @@ paths:
|
|
|
24789
25834
|
summary: Get all hosts for your organization
|
|
24790
25835
|
tags:
|
|
24791
25836
|
- Hosts
|
|
25837
|
+
x-permission:
|
|
25838
|
+
operator: OR
|
|
25839
|
+
permissions:
|
|
25840
|
+
- hosts_read
|
|
24792
25841
|
/api/v1/hosts/totals:
|
|
24793
25842
|
get:
|
|
24794
25843
|
description: 'This endpoint returns the total number of active and up hosts
|
|
@@ -24835,6 +25884,10 @@ paths:
|
|
|
24835
25884
|
summary: Get the total number of active hosts
|
|
24836
25885
|
tags:
|
|
24837
25886
|
- Hosts
|
|
25887
|
+
x-permission:
|
|
25888
|
+
operator: OR
|
|
25889
|
+
permissions:
|
|
25890
|
+
- hosts_read
|
|
24838
25891
|
/api/v1/integration/aws:
|
|
24839
25892
|
delete:
|
|
24840
25893
|
description: Delete a Datadog-AWS integration matching the specified `account_id`
|
|
@@ -24878,6 +25931,10 @@ paths:
|
|
|
24878
25931
|
tags:
|
|
24879
25932
|
- AWS Integration
|
|
24880
25933
|
x-codegen-request-body-name: body
|
|
25934
|
+
x-permission:
|
|
25935
|
+
operator: OR
|
|
25936
|
+
permissions:
|
|
25937
|
+
- aws_configurations_manage
|
|
24881
25938
|
get:
|
|
24882
25939
|
description: List all Datadog-AWS integrations available in your Datadog organization.
|
|
24883
25940
|
operationId: ListAWSAccounts
|
|
@@ -24924,6 +25981,10 @@ paths:
|
|
|
24924
25981
|
summary: List all AWS integrations
|
|
24925
25982
|
tags:
|
|
24926
25983
|
- AWS Integration
|
|
25984
|
+
x-permission:
|
|
25985
|
+
operator: OR
|
|
25986
|
+
permissions:
|
|
25987
|
+
- aws_configuration_read
|
|
24927
25988
|
post:
|
|
24928
25989
|
description: 'Create a Datadog-Amazon Web Services integration.
|
|
24929
25990
|
|
|
@@ -24971,6 +26032,10 @@ paths:
|
|
|
24971
26032
|
tags:
|
|
24972
26033
|
- AWS Integration
|
|
24973
26034
|
x-codegen-request-body-name: body
|
|
26035
|
+
x-permission:
|
|
26036
|
+
operator: OR
|
|
26037
|
+
permissions:
|
|
26038
|
+
- aws_configurations_manage
|
|
24974
26039
|
put:
|
|
24975
26040
|
description: Update a Datadog-Amazon Web Services integration.
|
|
24976
26041
|
operationId: UpdateAWSAccount
|
|
@@ -25035,6 +26100,10 @@ paths:
|
|
|
25035
26100
|
tags:
|
|
25036
26101
|
- AWS Integration
|
|
25037
26102
|
x-codegen-request-body-name: body
|
|
26103
|
+
x-permission:
|
|
26104
|
+
operator: OR
|
|
26105
|
+
permissions:
|
|
26106
|
+
- aws_configuration_edit
|
|
25038
26107
|
/api/v1/integration/aws/available_namespace_rules:
|
|
25039
26108
|
get:
|
|
25040
26109
|
description: List all namespace rules for a given Datadog-AWS integration. This
|
|
@@ -25064,6 +26133,10 @@ paths:
|
|
|
25064
26133
|
summary: List namespace rules
|
|
25065
26134
|
tags:
|
|
25066
26135
|
- AWS Integration
|
|
26136
|
+
x-permission:
|
|
26137
|
+
operator: OR
|
|
26138
|
+
permissions:
|
|
26139
|
+
- aws_configuration_read
|
|
25067
26140
|
/api/v1/integration/aws/event_bridge:
|
|
25068
26141
|
delete:
|
|
25069
26142
|
description: Delete an Amazon EventBridge source.
|
|
@@ -25101,6 +26174,10 @@ paths:
|
|
|
25101
26174
|
tags:
|
|
25102
26175
|
- AWS Integration
|
|
25103
26176
|
x-codegen-request-body-name: body
|
|
26177
|
+
x-permission:
|
|
26178
|
+
operator: OR
|
|
26179
|
+
permissions:
|
|
26180
|
+
- manage_integrations
|
|
25104
26181
|
get:
|
|
25105
26182
|
description: Get all Amazon EventBridge sources.
|
|
25106
26183
|
operationId: ListAWSEventBridgeSources
|
|
@@ -25129,6 +26206,9 @@ paths:
|
|
|
25129
26206
|
summary: Get all Amazon EventBridge sources
|
|
25130
26207
|
tags:
|
|
25131
26208
|
- AWS Integration
|
|
26209
|
+
x-permission:
|
|
26210
|
+
operator: OPEN
|
|
26211
|
+
permissions: []
|
|
25132
26212
|
post:
|
|
25133
26213
|
description: Create an Amazon EventBridge source.
|
|
25134
26214
|
operationId: CreateAWSEventBridgeSource
|
|
@@ -25165,6 +26245,10 @@ paths:
|
|
|
25165
26245
|
tags:
|
|
25166
26246
|
- AWS Integration
|
|
25167
26247
|
x-codegen-request-body-name: body
|
|
26248
|
+
x-permission:
|
|
26249
|
+
operator: OR
|
|
26250
|
+
permissions:
|
|
26251
|
+
- manage_integrations
|
|
25168
26252
|
/api/v1/integration/aws/filtering:
|
|
25169
26253
|
delete:
|
|
25170
26254
|
description: Delete a tag filtering entry.
|
|
@@ -25203,6 +26287,10 @@ paths:
|
|
|
25203
26287
|
tags:
|
|
25204
26288
|
- AWS Integration
|
|
25205
26289
|
x-codegen-request-body-name: body
|
|
26290
|
+
x-permission:
|
|
26291
|
+
operator: OR
|
|
26292
|
+
permissions:
|
|
26293
|
+
- aws_configuration_edit
|
|
25206
26294
|
get:
|
|
25207
26295
|
description: Get all AWS tag filters.
|
|
25208
26296
|
operationId: ListAWSTagFilters
|
|
@@ -25237,6 +26325,10 @@ paths:
|
|
|
25237
26325
|
summary: Get all AWS tag filters
|
|
25238
26326
|
tags:
|
|
25239
26327
|
- AWS Integration
|
|
26328
|
+
x-permission:
|
|
26329
|
+
operator: OR
|
|
26330
|
+
permissions:
|
|
26331
|
+
- aws_configuration_read
|
|
25240
26332
|
post:
|
|
25241
26333
|
description: Set an AWS tag filter.
|
|
25242
26334
|
operationId: CreateAWSTagFilter
|
|
@@ -25277,6 +26369,10 @@ paths:
|
|
|
25277
26369
|
tags:
|
|
25278
26370
|
- AWS Integration
|
|
25279
26371
|
x-codegen-request-body-name: body
|
|
26372
|
+
x-permission:
|
|
26373
|
+
operator: OR
|
|
26374
|
+
permissions:
|
|
26375
|
+
- aws_configuration_edit
|
|
25280
26376
|
/api/v1/integration/aws/generate_new_external_id:
|
|
25281
26377
|
put:
|
|
25282
26378
|
description: Generate a new AWS external ID for a given AWS account ID and role
|
|
@@ -25318,6 +26414,10 @@ paths:
|
|
|
25318
26414
|
tags:
|
|
25319
26415
|
- AWS Integration
|
|
25320
26416
|
x-codegen-request-body-name: body
|
|
26417
|
+
x-permission:
|
|
26418
|
+
operator: OR
|
|
26419
|
+
permissions:
|
|
26420
|
+
- aws_configuration_edit
|
|
25321
26421
|
/api/v1/integration/aws/logs:
|
|
25322
26422
|
delete:
|
|
25323
26423
|
description: Delete a Datadog-AWS logs configuration by removing the specific
|
|
@@ -25355,6 +26455,10 @@ paths:
|
|
|
25355
26455
|
tags:
|
|
25356
26456
|
- AWS Logs Integration
|
|
25357
26457
|
x-codegen-request-body-name: body
|
|
26458
|
+
x-permission:
|
|
26459
|
+
operator: OR
|
|
26460
|
+
permissions:
|
|
26461
|
+
- aws_configuration_edit
|
|
25358
26462
|
get:
|
|
25359
26463
|
description: List all Datadog-AWS Logs integrations configured in your Datadog
|
|
25360
26464
|
account.
|
|
@@ -25395,6 +26499,10 @@ paths:
|
|
|
25395
26499
|
summary: List all AWS Logs integrations
|
|
25396
26500
|
tags:
|
|
25397
26501
|
- AWS Logs Integration
|
|
26502
|
+
x-permission:
|
|
26503
|
+
operator: OR
|
|
26504
|
+
permissions:
|
|
26505
|
+
- aws_configuration_read
|
|
25398
26506
|
post:
|
|
25399
26507
|
description: Attach the Lambda ARN of the Lambda created for the Datadog-AWS
|
|
25400
26508
|
log collection to your AWS account ID to enable log collection.
|
|
@@ -25431,6 +26539,10 @@ paths:
|
|
|
25431
26539
|
tags:
|
|
25432
26540
|
- AWS Logs Integration
|
|
25433
26541
|
x-codegen-request-body-name: body
|
|
26542
|
+
x-permission:
|
|
26543
|
+
operator: OR
|
|
26544
|
+
permissions:
|
|
26545
|
+
- aws_configuration_edit
|
|
25434
26546
|
/api/v1/integration/aws/logs/check_async:
|
|
25435
26547
|
post:
|
|
25436
26548
|
description: 'Test if permissions are present to add a log-forwarding triggers
|
|
@@ -25483,6 +26595,10 @@ paths:
|
|
|
25483
26595
|
tags:
|
|
25484
26596
|
- AWS Logs Integration
|
|
25485
26597
|
x-codegen-request-body-name: body
|
|
26598
|
+
x-permission:
|
|
26599
|
+
operator: OR
|
|
26600
|
+
permissions:
|
|
26601
|
+
- aws_configuration_read
|
|
25486
26602
|
/api/v1/integration/aws/logs/services:
|
|
25487
26603
|
get:
|
|
25488
26604
|
description: Get the list of current AWS services that Datadog offers automatic
|
|
@@ -25522,6 +26638,10 @@ paths:
|
|
|
25522
26638
|
summary: Get list of AWS log ready services
|
|
25523
26639
|
tags:
|
|
25524
26640
|
- AWS Logs Integration
|
|
26641
|
+
x-permission:
|
|
26642
|
+
operator: OR
|
|
26643
|
+
permissions:
|
|
26644
|
+
- aws_configuration_read
|
|
25525
26645
|
post:
|
|
25526
26646
|
description: Enable automatic log collection for a list of services. This should
|
|
25527
26647
|
be run after running `CreateAWSLambdaARN` to save the configuration.
|
|
@@ -25558,6 +26678,10 @@ paths:
|
|
|
25558
26678
|
tags:
|
|
25559
26679
|
- AWS Logs Integration
|
|
25560
26680
|
x-codegen-request-body-name: body
|
|
26681
|
+
x-permission:
|
|
26682
|
+
operator: OR
|
|
26683
|
+
permissions:
|
|
26684
|
+
- aws_configuration_edit
|
|
25561
26685
|
/api/v1/integration/aws/logs/services_async:
|
|
25562
26686
|
post:
|
|
25563
26687
|
description: "Test if permissions are present to add log-forwarding triggers
|
|
@@ -25600,6 +26724,10 @@ paths:
|
|
|
25600
26724
|
tags:
|
|
25601
26725
|
- AWS Logs Integration
|
|
25602
26726
|
x-codegen-request-body-name: body
|
|
26727
|
+
x-permission:
|
|
26728
|
+
operator: OR
|
|
26729
|
+
permissions:
|
|
26730
|
+
- aws_configuration_read
|
|
25603
26731
|
/api/v1/integration/azure:
|
|
25604
26732
|
delete:
|
|
25605
26733
|
description: Delete a given Datadog-Azure integration from your Datadog account.
|
|
@@ -25637,6 +26765,10 @@ paths:
|
|
|
25637
26765
|
tags:
|
|
25638
26766
|
- Azure Integration
|
|
25639
26767
|
x-codegen-request-body-name: body
|
|
26768
|
+
x-permission:
|
|
26769
|
+
operator: OR
|
|
26770
|
+
permissions:
|
|
26771
|
+
- azure_configurations_manage
|
|
25640
26772
|
get:
|
|
25641
26773
|
description: List all Datadog-Azure integrations configured in your Datadog
|
|
25642
26774
|
account.
|
|
@@ -25665,6 +26797,10 @@ paths:
|
|
|
25665
26797
|
summary: List all Azure integrations
|
|
25666
26798
|
tags:
|
|
25667
26799
|
- Azure Integration
|
|
26800
|
+
x-permission:
|
|
26801
|
+
operator: OR
|
|
26802
|
+
permissions:
|
|
26803
|
+
- azure_configuration_read
|
|
25668
26804
|
post:
|
|
25669
26805
|
description: 'Create a Datadog-Azure integration.
|
|
25670
26806
|
|
|
@@ -25714,6 +26850,10 @@ paths:
|
|
|
25714
26850
|
tags:
|
|
25715
26851
|
- Azure Integration
|
|
25716
26852
|
x-codegen-request-body-name: body
|
|
26853
|
+
x-permission:
|
|
26854
|
+
operator: OR
|
|
26855
|
+
permissions:
|
|
26856
|
+
- azure_configurations_manage
|
|
25717
26857
|
put:
|
|
25718
26858
|
description: 'Update a Datadog-Azure integration. Requires an existing `tenant_name`
|
|
25719
26859
|
and `client_id`.
|
|
@@ -25757,6 +26897,10 @@ paths:
|
|
|
25757
26897
|
tags:
|
|
25758
26898
|
- Azure Integration
|
|
25759
26899
|
x-codegen-request-body-name: body
|
|
26900
|
+
x-permission:
|
|
26901
|
+
operator: OR
|
|
26902
|
+
permissions:
|
|
26903
|
+
- azure_configuration_edit
|
|
25760
26904
|
/api/v1/integration/azure/host_filters:
|
|
25761
26905
|
post:
|
|
25762
26906
|
description: Update the defined list of host filters for a given Datadog-Azure
|
|
@@ -25795,6 +26939,10 @@ paths:
|
|
|
25795
26939
|
tags:
|
|
25796
26940
|
- Azure Integration
|
|
25797
26941
|
x-codegen-request-body-name: body
|
|
26942
|
+
x-permission:
|
|
26943
|
+
operator: OR
|
|
26944
|
+
permissions:
|
|
26945
|
+
- azure_configuration_edit
|
|
25798
26946
|
/api/v1/integration/gcp:
|
|
25799
26947
|
delete:
|
|
25800
26948
|
deprecated: true
|
|
@@ -25834,6 +26982,10 @@ paths:
|
|
|
25834
26982
|
tags:
|
|
25835
26983
|
- GCP Integration
|
|
25836
26984
|
x-codegen-request-body-name: body
|
|
26985
|
+
x-permission:
|
|
26986
|
+
operator: OR
|
|
26987
|
+
permissions:
|
|
26988
|
+
- gcp_configurations_manage
|
|
25837
26989
|
get:
|
|
25838
26990
|
deprecated: true
|
|
25839
26991
|
description: "This endpoint is deprecated \u2013 use the V2 endpoints instead.
|
|
@@ -25863,6 +27015,10 @@ paths:
|
|
|
25863
27015
|
summary: List all GCP integrations
|
|
25864
27016
|
tags:
|
|
25865
27017
|
- GCP Integration
|
|
27018
|
+
x-permission:
|
|
27019
|
+
operator: OR
|
|
27020
|
+
permissions:
|
|
27021
|
+
- gcp_configuration_read
|
|
25866
27022
|
post:
|
|
25867
27023
|
deprecated: true
|
|
25868
27024
|
description: "This endpoint is deprecated \u2013 use the V2 endpoints instead.
|
|
@@ -25901,6 +27057,10 @@ paths:
|
|
|
25901
27057
|
tags:
|
|
25902
27058
|
- GCP Integration
|
|
25903
27059
|
x-codegen-request-body-name: body
|
|
27060
|
+
x-permission:
|
|
27061
|
+
operator: OR
|
|
27062
|
+
permissions:
|
|
27063
|
+
- gcp_configurations_manage
|
|
25904
27064
|
put:
|
|
25905
27065
|
deprecated: true
|
|
25906
27066
|
description: "This endpoint is deprecated \u2013 use the V2 endpoints instead.
|
|
@@ -25942,6 +27102,10 @@ paths:
|
|
|
25942
27102
|
tags:
|
|
25943
27103
|
- GCP Integration
|
|
25944
27104
|
x-codegen-request-body-name: body
|
|
27105
|
+
x-permission:
|
|
27106
|
+
operator: OR
|
|
27107
|
+
permissions:
|
|
27108
|
+
- gcp_configuration_edit
|
|
25945
27109
|
/api/v1/integration/pagerduty/configuration/services:
|
|
25946
27110
|
post:
|
|
25947
27111
|
description: Create a new service object in the PagerDuty integration.
|
|
@@ -25978,6 +27142,10 @@ paths:
|
|
|
25978
27142
|
tags:
|
|
25979
27143
|
- PagerDuty Integration
|
|
25980
27144
|
x-codegen-request-body-name: body
|
|
27145
|
+
x-permission:
|
|
27146
|
+
operator: OR
|
|
27147
|
+
permissions:
|
|
27148
|
+
- manage_integrations
|
|
25981
27149
|
/api/v1/integration/pagerduty/configuration/services/{service_name}:
|
|
25982
27150
|
delete:
|
|
25983
27151
|
description: Delete a single service object in the Datadog-PagerDuty integration.
|
|
@@ -26009,6 +27177,10 @@ paths:
|
|
|
26009
27177
|
summary: Delete a single service object
|
|
26010
27178
|
tags:
|
|
26011
27179
|
- PagerDuty Integration
|
|
27180
|
+
x-permission:
|
|
27181
|
+
operator: OR
|
|
27182
|
+
permissions:
|
|
27183
|
+
- manage_integrations
|
|
26012
27184
|
get:
|
|
26013
27185
|
description: Get service name in the Datadog-PagerDuty integration.
|
|
26014
27186
|
operationId: GetPagerDutyIntegrationService
|
|
@@ -26043,6 +27215,10 @@ paths:
|
|
|
26043
27215
|
summary: Get a single service object
|
|
26044
27216
|
tags:
|
|
26045
27217
|
- PagerDuty Integration
|
|
27218
|
+
x-permission:
|
|
27219
|
+
operator: OR
|
|
27220
|
+
permissions:
|
|
27221
|
+
- integrations_read
|
|
26046
27222
|
put:
|
|
26047
27223
|
description: Update a single service object in the Datadog-PagerDuty integration.
|
|
26048
27224
|
operationId: UpdatePagerDutyIntegrationService
|
|
@@ -26087,6 +27263,10 @@ paths:
|
|
|
26087
27263
|
tags:
|
|
26088
27264
|
- PagerDuty Integration
|
|
26089
27265
|
x-codegen-request-body-name: body
|
|
27266
|
+
x-permission:
|
|
27267
|
+
operator: OR
|
|
27268
|
+
permissions:
|
|
27269
|
+
- manage_integrations
|
|
26090
27270
|
/api/v1/integration/slack/configuration/accounts/{account_name}/channels:
|
|
26091
27271
|
get:
|
|
26092
27272
|
description: Get a list of all channels configured for your Datadog-Slack integration.
|
|
@@ -26123,6 +27303,10 @@ paths:
|
|
|
26123
27303
|
summary: Get all channels in a Slack integration
|
|
26124
27304
|
tags:
|
|
26125
27305
|
- Slack Integration
|
|
27306
|
+
x-permission:
|
|
27307
|
+
operator: OR
|
|
27308
|
+
permissions:
|
|
27309
|
+
- integrations_read
|
|
26126
27310
|
post:
|
|
26127
27311
|
description: Add a channel to your Datadog-Slack integration.
|
|
26128
27312
|
operationId: CreateSlackIntegrationChannel
|
|
@@ -26166,6 +27350,10 @@ paths:
|
|
|
26166
27350
|
tags:
|
|
26167
27351
|
- Slack Integration
|
|
26168
27352
|
x-codegen-request-body-name: body
|
|
27353
|
+
x-permission:
|
|
27354
|
+
operator: OR
|
|
27355
|
+
permissions:
|
|
27356
|
+
- manage_integrations
|
|
26169
27357
|
/api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name}:
|
|
26170
27358
|
delete:
|
|
26171
27359
|
description: Remove a channel from your Datadog-Slack integration.
|
|
@@ -26199,6 +27387,10 @@ paths:
|
|
|
26199
27387
|
summary: Remove a Slack integration channel
|
|
26200
27388
|
tags:
|
|
26201
27389
|
- Slack Integration
|
|
27390
|
+
x-permission:
|
|
27391
|
+
operator: OR
|
|
27392
|
+
permissions:
|
|
27393
|
+
- manage_integrations
|
|
26202
27394
|
get:
|
|
26203
27395
|
description: Get a channel configured for your Datadog-Slack integration.
|
|
26204
27396
|
operationId: GetSlackIntegrationChannel
|
|
@@ -26235,6 +27427,10 @@ paths:
|
|
|
26235
27427
|
summary: Get a Slack integration channel
|
|
26236
27428
|
tags:
|
|
26237
27429
|
- Slack Integration
|
|
27430
|
+
x-permission:
|
|
27431
|
+
operator: OR
|
|
27432
|
+
permissions:
|
|
27433
|
+
- integrations_read
|
|
26238
27434
|
patch:
|
|
26239
27435
|
description: Update a channel used in your Datadog-Slack integration.
|
|
26240
27436
|
operationId: UpdateSlackIntegrationChannel
|
|
@@ -26279,6 +27475,10 @@ paths:
|
|
|
26279
27475
|
tags:
|
|
26280
27476
|
- Slack Integration
|
|
26281
27477
|
x-codegen-request-body-name: body
|
|
27478
|
+
x-permission:
|
|
27479
|
+
operator: OR
|
|
27480
|
+
permissions:
|
|
27481
|
+
- manage_integrations
|
|
26282
27482
|
/api/v1/integration/webhooks/configuration/custom-variables:
|
|
26283
27483
|
post:
|
|
26284
27484
|
description: Creates an endpoint with the name `<CUSTOM_VARIABLE_NAME>`.
|
|
@@ -26315,6 +27515,10 @@ paths:
|
|
|
26315
27515
|
tags:
|
|
26316
27516
|
- Webhooks Integration
|
|
26317
27517
|
x-codegen-request-body-name: body
|
|
27518
|
+
x-permission:
|
|
27519
|
+
operator: OR
|
|
27520
|
+
permissions:
|
|
27521
|
+
- manage_integrations
|
|
26318
27522
|
/api/v1/integration/webhooks/configuration/custom-variables/{custom_variable_name}:
|
|
26319
27523
|
delete:
|
|
26320
27524
|
description: Deletes the endpoint with the name `<CUSTOM_VARIABLE_NAME>`.
|
|
@@ -26346,6 +27550,10 @@ paths:
|
|
|
26346
27550
|
summary: Delete a custom variable
|
|
26347
27551
|
tags:
|
|
26348
27552
|
- Webhooks Integration
|
|
27553
|
+
x-permission:
|
|
27554
|
+
operator: OR
|
|
27555
|
+
permissions:
|
|
27556
|
+
- manage_integrations
|
|
26349
27557
|
get:
|
|
26350
27558
|
description: 'Shows the content of the custom variable with the name `<CUSTOM_VARIABLE_NAME>`.
|
|
26351
27559
|
|
|
@@ -26391,6 +27599,10 @@ paths:
|
|
|
26391
27599
|
summary: Get a custom variable
|
|
26392
27600
|
tags:
|
|
26393
27601
|
- Webhooks Integration
|
|
27602
|
+
x-permission:
|
|
27603
|
+
operator: OR
|
|
27604
|
+
permissions:
|
|
27605
|
+
- integrations_read
|
|
26394
27606
|
put:
|
|
26395
27607
|
description: Updates the endpoint with the name `<CUSTOM_VARIABLE_NAME>`.
|
|
26396
27608
|
operationId: UpdateWebhooksIntegrationCustomVariable
|
|
@@ -26439,6 +27651,10 @@ paths:
|
|
|
26439
27651
|
tags:
|
|
26440
27652
|
- Webhooks Integration
|
|
26441
27653
|
x-codegen-request-body-name: body
|
|
27654
|
+
x-permission:
|
|
27655
|
+
operator: OR
|
|
27656
|
+
permissions:
|
|
27657
|
+
- manage_integrations
|
|
26442
27658
|
/api/v1/integration/webhooks/configuration/webhooks:
|
|
26443
27659
|
post:
|
|
26444
27660
|
description: Creates an endpoint with the name `<WEBHOOK_NAME>`.
|
|
@@ -26480,6 +27696,10 @@ paths:
|
|
|
26480
27696
|
tags:
|
|
26481
27697
|
- Webhooks Integration
|
|
26482
27698
|
x-codegen-request-body-name: body
|
|
27699
|
+
x-permission:
|
|
27700
|
+
operator: OR
|
|
27701
|
+
permissions:
|
|
27702
|
+
- create_webhooks
|
|
26483
27703
|
/api/v1/integration/webhooks/configuration/webhooks/{webhook_name}:
|
|
26484
27704
|
delete:
|
|
26485
27705
|
description: Deletes the endpoint with the name `<WEBHOOK NAME>`.
|
|
@@ -26511,6 +27731,10 @@ paths:
|
|
|
26511
27731
|
summary: Delete a webhook
|
|
26512
27732
|
tags:
|
|
26513
27733
|
- Webhooks Integration
|
|
27734
|
+
x-permission:
|
|
27735
|
+
operator: OR
|
|
27736
|
+
permissions:
|
|
27737
|
+
- manage_integrations
|
|
26514
27738
|
get:
|
|
26515
27739
|
description: Gets the content of the webhook with the name `<WEBHOOK_NAME>`.
|
|
26516
27740
|
operationId: GetWebhooksIntegration
|
|
@@ -26551,6 +27775,10 @@ paths:
|
|
|
26551
27775
|
summary: Get a webhook integration
|
|
26552
27776
|
tags:
|
|
26553
27777
|
- Webhooks Integration
|
|
27778
|
+
x-permission:
|
|
27779
|
+
operator: OR
|
|
27780
|
+
permissions:
|
|
27781
|
+
- integrations_read
|
|
26554
27782
|
put:
|
|
26555
27783
|
description: Updates the endpoint with the name `<WEBHOOK_NAME>`.
|
|
26556
27784
|
operationId: UpdateWebhooksIntegration
|
|
@@ -26599,6 +27827,10 @@ paths:
|
|
|
26599
27827
|
tags:
|
|
26600
27828
|
- Webhooks Integration
|
|
26601
27829
|
x-codegen-request-body-name: body
|
|
27830
|
+
x-permission:
|
|
27831
|
+
operator: OR
|
|
27832
|
+
permissions:
|
|
27833
|
+
- manage_integrations
|
|
26602
27834
|
/api/v1/logs-queries/list:
|
|
26603
27835
|
post:
|
|
26604
27836
|
description: 'List endpoint returns logs that match a log search query.
|
|
@@ -26649,6 +27881,10 @@ paths:
|
|
|
26649
27881
|
tags:
|
|
26650
27882
|
- Logs
|
|
26651
27883
|
x-codegen-request-body-name: body
|
|
27884
|
+
x-permission:
|
|
27885
|
+
operator: OR
|
|
27886
|
+
permissions:
|
|
27887
|
+
- logs_read_data
|
|
26652
27888
|
/api/v1/logs/config/index-order:
|
|
26653
27889
|
get:
|
|
26654
27890
|
description: Get the current order of your log indexes. This endpoint takes
|
|
@@ -26672,6 +27908,9 @@ paths:
|
|
|
26672
27908
|
summary: Get indexes order
|
|
26673
27909
|
tags:
|
|
26674
27910
|
- Logs Indexes
|
|
27911
|
+
x-permission:
|
|
27912
|
+
operator: OPEN
|
|
27913
|
+
permissions: []
|
|
26675
27914
|
put:
|
|
26676
27915
|
description: 'This endpoint updates the index order of your organization.
|
|
26677
27916
|
|
|
@@ -26710,6 +27949,10 @@ paths:
|
|
|
26710
27949
|
tags:
|
|
26711
27950
|
- Logs Indexes
|
|
26712
27951
|
x-codegen-request-body-name: body
|
|
27952
|
+
x-permission:
|
|
27953
|
+
operator: OR
|
|
27954
|
+
permissions:
|
|
27955
|
+
- logs_modify_indexes
|
|
26713
27956
|
/api/v1/logs/config/indexes:
|
|
26714
27957
|
get:
|
|
26715
27958
|
description: 'The Index object describes the configuration of a log index.
|
|
@@ -26738,6 +27981,9 @@ paths:
|
|
|
26738
27981
|
summary: Get all indexes
|
|
26739
27982
|
tags:
|
|
26740
27983
|
- Logs Indexes
|
|
27984
|
+
x-permission:
|
|
27985
|
+
operator: OPEN
|
|
27986
|
+
permissions: []
|
|
26741
27987
|
post:
|
|
26742
27988
|
description: Creates a new index. Returns the Index object passed in the request
|
|
26743
27989
|
body when the request is successful.
|
|
@@ -26774,6 +28020,10 @@ paths:
|
|
|
26774
28020
|
tags:
|
|
26775
28021
|
- Logs Indexes
|
|
26776
28022
|
x-codegen-request-body-name: body
|
|
28023
|
+
x-permission:
|
|
28024
|
+
operator: OR
|
|
28025
|
+
permissions:
|
|
28026
|
+
- logs_modify_indexes
|
|
26777
28027
|
/api/v1/logs/config/indexes/{name}:
|
|
26778
28028
|
get:
|
|
26779
28029
|
description: Get one log index from your organization. This endpoint takes no
|
|
@@ -26883,6 +28133,9 @@ paths:
|
|
|
26883
28133
|
summary: Get pipeline order
|
|
26884
28134
|
tags:
|
|
26885
28135
|
- Logs Pipelines
|
|
28136
|
+
x-permission:
|
|
28137
|
+
operator: OPEN
|
|
28138
|
+
permissions: []
|
|
26886
28139
|
put:
|
|
26887
28140
|
description: 'Update the order of your pipelines. Since logs are processed sequentially,
|
|
26888
28141
|
reordering a pipeline may change
|
|
@@ -26934,6 +28187,10 @@ paths:
|
|
|
26934
28187
|
tags:
|
|
26935
28188
|
- Logs Pipelines
|
|
26936
28189
|
x-codegen-request-body-name: body
|
|
28190
|
+
x-permission:
|
|
28191
|
+
operator: OR
|
|
28192
|
+
permissions:
|
|
28193
|
+
- logs_write_pipelines
|
|
26937
28194
|
/api/v1/logs/config/pipelines:
|
|
26938
28195
|
get:
|
|
26939
28196
|
description: 'Get all pipelines from your organization.
|
|
@@ -26958,6 +28215,9 @@ paths:
|
|
|
26958
28215
|
summary: Get all pipelines
|
|
26959
28216
|
tags:
|
|
26960
28217
|
- Logs Pipelines
|
|
28218
|
+
x-permission:
|
|
28219
|
+
operator: OPEN
|
|
28220
|
+
permissions: []
|
|
26961
28221
|
post:
|
|
26962
28222
|
description: Create a pipeline in your organization.
|
|
26963
28223
|
operationId: CreateLogsPipeline
|
|
@@ -26993,6 +28253,10 @@ paths:
|
|
|
26993
28253
|
tags:
|
|
26994
28254
|
- Logs Pipelines
|
|
26995
28255
|
x-codegen-request-body-name: body
|
|
28256
|
+
x-permission:
|
|
28257
|
+
operator: OR
|
|
28258
|
+
permissions:
|
|
28259
|
+
- logs_write_pipelines
|
|
26996
28260
|
/api/v1/logs/config/pipelines/{pipeline_id}:
|
|
26997
28261
|
delete:
|
|
26998
28262
|
description: 'Delete a given pipeline from your organization.
|
|
@@ -27026,6 +28290,10 @@ paths:
|
|
|
27026
28290
|
summary: Delete a pipeline
|
|
27027
28291
|
tags:
|
|
27028
28292
|
- Logs Pipelines
|
|
28293
|
+
x-permission:
|
|
28294
|
+
operator: OR
|
|
28295
|
+
permissions:
|
|
28296
|
+
- logs_write_pipelines
|
|
27029
28297
|
get:
|
|
27030
28298
|
description: 'Get a specific pipeline from your organization.
|
|
27031
28299
|
|
|
@@ -27062,6 +28330,9 @@ paths:
|
|
|
27062
28330
|
summary: Get a pipeline
|
|
27063
28331
|
tags:
|
|
27064
28332
|
- Logs Pipelines
|
|
28333
|
+
x-permission:
|
|
28334
|
+
operator: OPEN
|
|
28335
|
+
permissions: []
|
|
27065
28336
|
put:
|
|
27066
28337
|
description: "Update a given pipeline configuration to change it\u2019s processors
|
|
27067
28338
|
or their order.\n\n**Note**: Using this method updates your pipeline configuration
|
|
@@ -27107,6 +28378,10 @@ paths:
|
|
|
27107
28378
|
tags:
|
|
27108
28379
|
- Logs Pipelines
|
|
27109
28380
|
x-codegen-request-body-name: body
|
|
28381
|
+
x-permission:
|
|
28382
|
+
operator: OR
|
|
28383
|
+
permissions:
|
|
28384
|
+
- logs_write_pipelines
|
|
27110
28385
|
/api/v1/metrics:
|
|
27111
28386
|
get:
|
|
27112
28387
|
description: Get the list of actively reporting metrics from a given time until
|
|
@@ -27167,6 +28442,10 @@ paths:
|
|
|
27167
28442
|
summary: Get active metrics list
|
|
27168
28443
|
tags:
|
|
27169
28444
|
- Metrics
|
|
28445
|
+
x-permission:
|
|
28446
|
+
operator: OR
|
|
28447
|
+
permissions:
|
|
28448
|
+
- metrics_read
|
|
27170
28449
|
/api/v1/metrics/{metric_name}:
|
|
27171
28450
|
get:
|
|
27172
28451
|
description: Get metadata about a specific metric.
|
|
@@ -27207,6 +28486,10 @@ paths:
|
|
|
27207
28486
|
summary: Get metric metadata
|
|
27208
28487
|
tags:
|
|
27209
28488
|
- Metrics
|
|
28489
|
+
x-permission:
|
|
28490
|
+
operator: OR
|
|
28491
|
+
permissions:
|
|
28492
|
+
- metrics_read
|
|
27210
28493
|
put:
|
|
27211
28494
|
description: Edit metadata of a specific metric. Find out more about [supported
|
|
27212
28495
|
types](https://docs.datadoghq.com/developers/metrics).
|
|
@@ -27256,6 +28539,10 @@ paths:
|
|
|
27256
28539
|
tags:
|
|
27257
28540
|
- Metrics
|
|
27258
28541
|
x-codegen-request-body-name: body
|
|
28542
|
+
x-permission:
|
|
28543
|
+
operator: OR
|
|
28544
|
+
permissions:
|
|
28545
|
+
- metrics_metadata_write
|
|
27259
28546
|
/api/v1/monitor:
|
|
27260
28547
|
get:
|
|
27261
28548
|
description: Get details about the specified monitor from your organization.
|
|
@@ -27370,6 +28657,10 @@ paths:
|
|
|
27370
28657
|
x-pagination:
|
|
27371
28658
|
limitParam: page_size
|
|
27372
28659
|
pageParam: page
|
|
28660
|
+
x-permission:
|
|
28661
|
+
operator: OR
|
|
28662
|
+
permissions:
|
|
28663
|
+
- monitors_read
|
|
27373
28664
|
post:
|
|
27374
28665
|
description: 'Create a monitor using the specified options.
|
|
27375
28666
|
|
|
@@ -27422,6 +28713,8 @@ paths:
|
|
|
27422
28713
|
|
|
27423
28714
|
- network-performance: `network-performance alert`
|
|
27424
28715
|
|
|
28716
|
+
- cloud cost: `cost alert`
|
|
28717
|
+
|
|
27425
28718
|
|
|
27426
28719
|
**Notes**:
|
|
27427
28720
|
|
|
@@ -27692,21 +28985,27 @@ paths:
|
|
|
27692
28985
|
##### Error Tracking Alert Query
|
|
27693
28986
|
|
|
27694
28987
|
|
|
27695
|
-
|
|
27696
|
-
operator #`
|
|
28988
|
+
"New issue" example: `error-tracking(query).source(issue_source).new().rollup(rollup_method[,
|
|
28989
|
+
measure]).by(group_by).last(time_window) operator #`
|
|
27697
28990
|
|
|
27698
|
-
|
|
27699
|
-
measure]).last(time_window) operator #`
|
|
28991
|
+
"High impact issue" example: `error-tracking(query).source(issue_source).impact().rollup(rollup_method[,
|
|
28992
|
+
measure]).by(group_by).last(time_window) operator #`
|
|
27700
28993
|
|
|
27701
28994
|
|
|
27702
28995
|
- `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).
|
|
27703
28996
|
|
|
28997
|
+
- `issue_source` The issue source - supports `all`, `browser`, `mobile` and
|
|
28998
|
+
`backend` and defaults to `all` if omitted.
|
|
28999
|
+
|
|
27704
29000
|
- `rollup_method` The stats roll-up method - supports `count`, `avg`, and
|
|
27705
|
-
`cardinality
|
|
29001
|
+
`cardinality` and defaults to `count` if omitted.
|
|
27706
29002
|
|
|
27707
29003
|
- `measure` For `avg` and cardinality `rollup_method` - specify the measure
|
|
27708
29004
|
or the facet name you want to use.
|
|
27709
29005
|
|
|
29006
|
+
- `group by` Comma-separated list of attributes to group by - should contain
|
|
29007
|
+
at least `issue.id`.
|
|
29008
|
+
|
|
27710
29009
|
- `time_window` #m (between 1 and 2880), #h (between 1 and 48).
|
|
27711
29010
|
|
|
27712
29011
|
- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.
|
|
@@ -27807,6 +29106,10 @@ paths:
|
|
|
27807
29106
|
tags:
|
|
27808
29107
|
- Monitors
|
|
27809
29108
|
x-codegen-request-body-name: body
|
|
29109
|
+
x-permission:
|
|
29110
|
+
operator: OR
|
|
29111
|
+
permissions:
|
|
29112
|
+
- monitors_write
|
|
27810
29113
|
/api/v1/monitor/can_delete:
|
|
27811
29114
|
get:
|
|
27812
29115
|
description: Check if the given monitors can be deleted.
|
|
@@ -27859,6 +29162,10 @@ paths:
|
|
|
27859
29162
|
summary: Check if a monitor can be deleted
|
|
27860
29163
|
tags:
|
|
27861
29164
|
- Monitors
|
|
29165
|
+
x-permission:
|
|
29166
|
+
operator: OR
|
|
29167
|
+
permissions:
|
|
29168
|
+
- monitors_read
|
|
27862
29169
|
/api/v1/monitor/groups/search:
|
|
27863
29170
|
get:
|
|
27864
29171
|
description: Search and filter your monitor groups details.
|
|
@@ -27943,6 +29250,10 @@ paths:
|
|
|
27943
29250
|
summary: Monitors group search
|
|
27944
29251
|
tags:
|
|
27945
29252
|
- Monitors
|
|
29253
|
+
x-permission:
|
|
29254
|
+
operator: OR
|
|
29255
|
+
permissions:
|
|
29256
|
+
- monitors_read
|
|
27946
29257
|
/api/v1/monitor/search:
|
|
27947
29258
|
get:
|
|
27948
29259
|
description: Search and filter your monitors details.
|
|
@@ -28029,6 +29340,10 @@ paths:
|
|
|
28029
29340
|
summary: Monitors search
|
|
28030
29341
|
tags:
|
|
28031
29342
|
- Monitors
|
|
29343
|
+
x-permission:
|
|
29344
|
+
operator: OR
|
|
29345
|
+
permissions:
|
|
29346
|
+
- monitors_read
|
|
28032
29347
|
/api/v1/monitor/validate:
|
|
28033
29348
|
post:
|
|
28034
29349
|
description: 'Validate the monitor provided in the request.
|
|
@@ -28074,6 +29389,10 @@ paths:
|
|
|
28074
29389
|
tags:
|
|
28075
29390
|
- Monitors
|
|
28076
29391
|
x-codegen-request-body-name: body
|
|
29392
|
+
x-permission:
|
|
29393
|
+
operator: OR
|
|
29394
|
+
permissions:
|
|
29395
|
+
- monitors_write
|
|
28077
29396
|
/api/v1/monitor/{monitor_id}:
|
|
28078
29397
|
delete:
|
|
28079
29398
|
description: Delete the specified monitor
|
|
@@ -28136,6 +29455,10 @@ paths:
|
|
|
28136
29455
|
summary: Delete a monitor
|
|
28137
29456
|
tags:
|
|
28138
29457
|
- Monitors
|
|
29458
|
+
x-permission:
|
|
29459
|
+
operator: OR
|
|
29460
|
+
permissions:
|
|
29461
|
+
- monitors_write
|
|
28139
29462
|
get:
|
|
28140
29463
|
description: Get details about the specified monitor from your organization.
|
|
28141
29464
|
operationId: GetMonitor
|
|
@@ -28197,6 +29520,10 @@ paths:
|
|
|
28197
29520
|
summary: Get a monitor's details
|
|
28198
29521
|
tags:
|
|
28199
29522
|
- Monitors
|
|
29523
|
+
x-permission:
|
|
29524
|
+
operator: OR
|
|
29525
|
+
permissions:
|
|
29526
|
+
- monitors_read
|
|
28200
29527
|
put:
|
|
28201
29528
|
description: Edit the specified monitor.
|
|
28202
29529
|
operationId: UpdateMonitor
|
|
@@ -28258,6 +29585,10 @@ paths:
|
|
|
28258
29585
|
tags:
|
|
28259
29586
|
- Monitors
|
|
28260
29587
|
x-codegen-request-body-name: body
|
|
29588
|
+
x-permission:
|
|
29589
|
+
operator: OR
|
|
29590
|
+
permissions:
|
|
29591
|
+
- monitors_write
|
|
28261
29592
|
/api/v1/monitor/{monitor_id}/downtimes:
|
|
28262
29593
|
get:
|
|
28263
29594
|
deprecated: true
|
|
@@ -28304,6 +29635,10 @@ paths:
|
|
|
28304
29635
|
tags:
|
|
28305
29636
|
- Downtimes
|
|
28306
29637
|
x-codegen-request-body-name: body
|
|
29638
|
+
x-permission:
|
|
29639
|
+
operator: OR
|
|
29640
|
+
permissions:
|
|
29641
|
+
- monitors_read
|
|
28307
29642
|
/api/v1/monitor/{monitor_id}/validate:
|
|
28308
29643
|
post:
|
|
28309
29644
|
description: Validate the monitor provided in the request.
|
|
@@ -28355,6 +29690,10 @@ paths:
|
|
|
28355
29690
|
tags:
|
|
28356
29691
|
- Monitors
|
|
28357
29692
|
x-codegen-request-body-name: body
|
|
29693
|
+
x-permission:
|
|
29694
|
+
operator: OR
|
|
29695
|
+
permissions:
|
|
29696
|
+
- monitors_write
|
|
28358
29697
|
/api/v1/monthly_custom_reports:
|
|
28359
29698
|
get:
|
|
28360
29699
|
deprecated: true
|
|
@@ -28415,6 +29754,10 @@ paths:
|
|
|
28415
29754
|
summary: Get the list of available monthly custom reports
|
|
28416
29755
|
tags:
|
|
28417
29756
|
- Usage Metering
|
|
29757
|
+
x-permission:
|
|
29758
|
+
operator: OR
|
|
29759
|
+
permissions:
|
|
29760
|
+
- usage_read
|
|
28418
29761
|
/api/v1/monthly_custom_reports/{report_id}:
|
|
28419
29762
|
get:
|
|
28420
29763
|
deprecated: true
|
|
@@ -28466,6 +29809,10 @@ paths:
|
|
|
28466
29809
|
summary: Get specified monthly custom reports
|
|
28467
29810
|
tags:
|
|
28468
29811
|
- Usage Metering
|
|
29812
|
+
x-permission:
|
|
29813
|
+
operator: OR
|
|
29814
|
+
permissions:
|
|
29815
|
+
- usage_read
|
|
28469
29816
|
/api/v1/notebooks:
|
|
28470
29817
|
get:
|
|
28471
29818
|
description: 'Get all notebooks. This can also be used to search for notebooks
|
|
@@ -28593,6 +29940,10 @@ paths:
|
|
|
28593
29940
|
limitParam: count
|
|
28594
29941
|
pageOffsetParam: start
|
|
28595
29942
|
resultsPath: data
|
|
29943
|
+
x-permission:
|
|
29944
|
+
operator: OR
|
|
29945
|
+
permissions:
|
|
29946
|
+
- notebooks_read
|
|
28596
29947
|
post:
|
|
28597
29948
|
description: Create a notebook using the specified options.
|
|
28598
29949
|
operationId: CreateNotebook
|
|
@@ -28665,6 +30016,10 @@ paths:
|
|
|
28665
30016
|
tags:
|
|
28666
30017
|
- Notebooks
|
|
28667
30018
|
x-codegen-request-body-name: body
|
|
30019
|
+
x-permission:
|
|
30020
|
+
operator: OR
|
|
30021
|
+
permissions:
|
|
30022
|
+
- notebooks_write
|
|
28668
30023
|
/api/v1/notebooks/{notebook_id}:
|
|
28669
30024
|
delete:
|
|
28670
30025
|
description: Delete a notebook using the specified ID.
|
|
@@ -28703,6 +30058,10 @@ paths:
|
|
|
28703
30058
|
summary: Delete a notebook
|
|
28704
30059
|
tags:
|
|
28705
30060
|
- Notebooks
|
|
30061
|
+
x-permission:
|
|
30062
|
+
operator: OR
|
|
30063
|
+
permissions:
|
|
30064
|
+
- notebooks_write
|
|
28706
30065
|
get:
|
|
28707
30066
|
description: Get a notebook using the specified notebook ID.
|
|
28708
30067
|
operationId: GetNotebook
|
|
@@ -28744,6 +30103,10 @@ paths:
|
|
|
28744
30103
|
summary: Get a notebook
|
|
28745
30104
|
tags:
|
|
28746
30105
|
- Notebooks
|
|
30106
|
+
x-permission:
|
|
30107
|
+
operator: OR
|
|
30108
|
+
permissions:
|
|
30109
|
+
- notebooks_read
|
|
28747
30110
|
put:
|
|
28748
30111
|
description: Update a notebook using the specified ID.
|
|
28749
30112
|
operationId: UpdateNotebook
|
|
@@ -28837,6 +30200,10 @@ paths:
|
|
|
28837
30200
|
tags:
|
|
28838
30201
|
- Notebooks
|
|
28839
30202
|
x-codegen-request-body-name: body
|
|
30203
|
+
x-permission:
|
|
30204
|
+
operator: OR
|
|
30205
|
+
permissions:
|
|
30206
|
+
- notebooks_write
|
|
28840
30207
|
/api/v1/org:
|
|
28841
30208
|
get:
|
|
28842
30209
|
description: This endpoint returns data on your top-level organization.
|
|
@@ -28859,6 +30226,10 @@ paths:
|
|
|
28859
30226
|
summary: List your managed organizations
|
|
28860
30227
|
tags:
|
|
28861
30228
|
- Organizations
|
|
30229
|
+
x-permission:
|
|
30230
|
+
operator: OR
|
|
30231
|
+
permissions:
|
|
30232
|
+
- org_management
|
|
28862
30233
|
post:
|
|
28863
30234
|
description: 'Create a child organization.
|
|
28864
30235
|
|
|
@@ -28910,6 +30281,10 @@ paths:
|
|
|
28910
30281
|
tags:
|
|
28911
30282
|
- Organizations
|
|
28912
30283
|
x-codegen-request-body-name: body
|
|
30284
|
+
x-permission:
|
|
30285
|
+
operator: OR
|
|
30286
|
+
permissions:
|
|
30287
|
+
- org_management
|
|
28913
30288
|
/api/v1/org/{public_id}:
|
|
28914
30289
|
get:
|
|
28915
30290
|
description: Get organization information.
|
|
@@ -29138,6 +30513,10 @@ paths:
|
|
|
29138
30513
|
summary: Query timeseries points
|
|
29139
30514
|
tags:
|
|
29140
30515
|
- Metrics
|
|
30516
|
+
x-permission:
|
|
30517
|
+
operator: OR
|
|
30518
|
+
permissions:
|
|
30519
|
+
- timeseries_query
|
|
29141
30520
|
/api/v1/search:
|
|
29142
30521
|
get:
|
|
29143
30522
|
description: Search for metrics from the last 24 hours in Datadog.
|
|
@@ -29178,6 +30557,9 @@ paths:
|
|
|
29178
30557
|
summary: Search metrics
|
|
29179
30558
|
tags:
|
|
29180
30559
|
- Metrics
|
|
30560
|
+
x-permission:
|
|
30561
|
+
operator: OPEN
|
|
30562
|
+
permissions: []
|
|
29181
30563
|
/api/v1/security_analytics/signals/{signal_id}/add_to_incident:
|
|
29182
30564
|
patch:
|
|
29183
30565
|
description: Add a security signal to an incident. This makes it possible to
|
|
@@ -29224,6 +30606,10 @@ paths:
|
|
|
29224
30606
|
tags:
|
|
29225
30607
|
- Security Monitoring
|
|
29226
30608
|
x-codegen-request-body-name: body
|
|
30609
|
+
x-permission:
|
|
30610
|
+
operator: OR
|
|
30611
|
+
permissions:
|
|
30612
|
+
- security_monitoring_signals_write
|
|
29227
30613
|
/api/v1/security_analytics/signals/{signal_id}/assignee:
|
|
29228
30614
|
patch:
|
|
29229
30615
|
description: Modify the triage assignee of a security signal.
|
|
@@ -29268,6 +30654,10 @@ paths:
|
|
|
29268
30654
|
tags:
|
|
29269
30655
|
- Security Monitoring
|
|
29270
30656
|
x-codegen-request-body-name: body
|
|
30657
|
+
x-permission:
|
|
30658
|
+
operator: OR
|
|
30659
|
+
permissions:
|
|
30660
|
+
- security_monitoring_signals_write
|
|
29271
30661
|
/api/v1/security_analytics/signals/{signal_id}/state:
|
|
29272
30662
|
patch:
|
|
29273
30663
|
description: Change the triage state of a security signal.
|
|
@@ -29312,6 +30702,10 @@ paths:
|
|
|
29312
30702
|
tags:
|
|
29313
30703
|
- Security Monitoring
|
|
29314
30704
|
x-codegen-request-body-name: body
|
|
30705
|
+
x-permission:
|
|
30706
|
+
operator: OR
|
|
30707
|
+
permissions:
|
|
30708
|
+
- security_monitoring_signals_write
|
|
29315
30709
|
/api/v1/series:
|
|
29316
30710
|
post:
|
|
29317
30711
|
description: "The metrics end-point allows you to post time-series data that
|
|
@@ -29473,6 +30867,10 @@ paths:
|
|
|
29473
30867
|
limitParam: limit
|
|
29474
30868
|
pageOffsetParam: offset
|
|
29475
30869
|
resultsPath: data
|
|
30870
|
+
x-permission:
|
|
30871
|
+
operator: OR
|
|
30872
|
+
permissions:
|
|
30873
|
+
- slos_read
|
|
29476
30874
|
post:
|
|
29477
30875
|
description: Create a service level objective object.
|
|
29478
30876
|
operationId: CreateSLO
|
|
@@ -29513,6 +30911,10 @@ paths:
|
|
|
29513
30911
|
tags:
|
|
29514
30912
|
- Service Level Objectives
|
|
29515
30913
|
x-codegen-request-body-name: body
|
|
30914
|
+
x-permission:
|
|
30915
|
+
operator: OR
|
|
30916
|
+
permissions:
|
|
30917
|
+
- slos_write
|
|
29516
30918
|
/api/v1/slo/bulk_delete:
|
|
29517
30919
|
post:
|
|
29518
30920
|
description: 'Delete (or partially delete) multiple service level objective
|
|
@@ -29563,6 +30965,10 @@ paths:
|
|
|
29563
30965
|
tags:
|
|
29564
30966
|
- Service Level Objectives
|
|
29565
30967
|
x-codegen-request-body-name: body
|
|
30968
|
+
x-permission:
|
|
30969
|
+
operator: OR
|
|
30970
|
+
permissions:
|
|
30971
|
+
- slos_write
|
|
29566
30972
|
/api/v1/slo/can_delete:
|
|
29567
30973
|
get:
|
|
29568
30974
|
description: 'Check if an SLO can be safely deleted. For example,
|
|
@@ -29613,6 +31019,10 @@ paths:
|
|
|
29613
31019
|
summary: Check if SLOs can be safely deleted
|
|
29614
31020
|
tags:
|
|
29615
31021
|
- Service Level Objectives
|
|
31022
|
+
x-permission:
|
|
31023
|
+
operator: OR
|
|
31024
|
+
permissions:
|
|
31025
|
+
- slos_read
|
|
29616
31026
|
/api/v1/slo/correction:
|
|
29617
31027
|
get:
|
|
29618
31028
|
description: Get all Service Level Objective corrections.
|
|
@@ -29661,6 +31071,10 @@ paths:
|
|
|
29661
31071
|
limitParam: limit
|
|
29662
31072
|
pageOffsetParam: offset
|
|
29663
31073
|
resultsPath: data
|
|
31074
|
+
x-permission:
|
|
31075
|
+
operator: OR
|
|
31076
|
+
permissions:
|
|
31077
|
+
- slos_read
|
|
29664
31078
|
post:
|
|
29665
31079
|
description: Create an SLO Correction.
|
|
29666
31080
|
operationId: CreateSLOCorrection
|
|
@@ -29707,6 +31121,10 @@ paths:
|
|
|
29707
31121
|
tags:
|
|
29708
31122
|
- Service Level Objective Corrections
|
|
29709
31123
|
x-codegen-request-body-name: body
|
|
31124
|
+
x-permission:
|
|
31125
|
+
operator: OR
|
|
31126
|
+
permissions:
|
|
31127
|
+
- slos_corrections
|
|
29710
31128
|
/api/v1/slo/correction/{slo_correction_id}:
|
|
29711
31129
|
delete:
|
|
29712
31130
|
description: Permanently delete the specified SLO correction object.
|
|
@@ -29885,6 +31303,10 @@ paths:
|
|
|
29885
31303
|
summary: Search for SLOs
|
|
29886
31304
|
tags:
|
|
29887
31305
|
- Service Level Objectives
|
|
31306
|
+
x-permission:
|
|
31307
|
+
operator: OR
|
|
31308
|
+
permissions:
|
|
31309
|
+
- slos_read
|
|
29888
31310
|
/api/v1/slo/{slo_id}:
|
|
29889
31311
|
delete:
|
|
29890
31312
|
description: 'Permanently delete the specified service level objective object.
|
|
@@ -29943,6 +31365,10 @@ paths:
|
|
|
29943
31365
|
summary: Delete an SLO
|
|
29944
31366
|
tags:
|
|
29945
31367
|
- Service Level Objectives
|
|
31368
|
+
x-permission:
|
|
31369
|
+
operator: OR
|
|
31370
|
+
permissions:
|
|
31371
|
+
- slos_write
|
|
29946
31372
|
get:
|
|
29947
31373
|
description: Get a service level objective object.
|
|
29948
31374
|
operationId: GetSLO
|
|
@@ -29989,6 +31415,10 @@ paths:
|
|
|
29989
31415
|
summary: Get an SLO's details
|
|
29990
31416
|
tags:
|
|
29991
31417
|
- Service Level Objectives
|
|
31418
|
+
x-permission:
|
|
31419
|
+
operator: OR
|
|
31420
|
+
permissions:
|
|
31421
|
+
- slos_read
|
|
29992
31422
|
put:
|
|
29993
31423
|
description: Update the specified service level objective object.
|
|
29994
31424
|
operationId: UpdateSLO
|
|
@@ -30042,6 +31472,10 @@ paths:
|
|
|
30042
31472
|
tags:
|
|
30043
31473
|
- Service Level Objectives
|
|
30044
31474
|
x-codegen-request-body-name: body
|
|
31475
|
+
x-permission:
|
|
31476
|
+
operator: OR
|
|
31477
|
+
permissions:
|
|
31478
|
+
- slos_write
|
|
30045
31479
|
/api/v1/slo/{slo_id}/corrections:
|
|
30046
31480
|
get:
|
|
30047
31481
|
description: Get corrections applied to an SLO
|
|
@@ -30088,6 +31522,10 @@ paths:
|
|
|
30088
31522
|
summary: Get Corrections For an SLO
|
|
30089
31523
|
tags:
|
|
30090
31524
|
- Service Level Objectives
|
|
31525
|
+
x-permission:
|
|
31526
|
+
operator: OR
|
|
31527
|
+
permissions:
|
|
31528
|
+
- slos_read
|
|
30091
31529
|
/api/v1/slo/{slo_id}/history:
|
|
30092
31530
|
get:
|
|
30093
31531
|
description: "Get a specific SLO\u2019s history, regardless of its SLO type.\n\nThe
|
|
@@ -30174,6 +31612,10 @@ paths:
|
|
|
30174
31612
|
summary: Get an SLO's history
|
|
30175
31613
|
tags:
|
|
30176
31614
|
- Service Level Objectives
|
|
31615
|
+
x-permission:
|
|
31616
|
+
operator: OR
|
|
31617
|
+
permissions:
|
|
31618
|
+
- slos_read
|
|
30177
31619
|
/api/v1/synthetics/ci/batch/{batch_id}:
|
|
30178
31620
|
get:
|
|
30179
31621
|
description: Get a batch's updated details.
|
|
@@ -30208,6 +31650,10 @@ paths:
|
|
|
30208
31650
|
summary: Get details of batch
|
|
30209
31651
|
tags:
|
|
30210
31652
|
- Synthetics
|
|
31653
|
+
x-permission:
|
|
31654
|
+
operator: OR
|
|
31655
|
+
permissions:
|
|
31656
|
+
- synthetics_read
|
|
30211
31657
|
/api/v1/synthetics/locations:
|
|
30212
31658
|
get:
|
|
30213
31659
|
description: 'Get the list of public and private locations available for Synthetic
|
|
@@ -30231,6 +31677,10 @@ paths:
|
|
|
30231
31677
|
summary: Get all locations (public and private)
|
|
30232
31678
|
tags:
|
|
30233
31679
|
- Synthetics
|
|
31680
|
+
x-permission:
|
|
31681
|
+
operator: OR
|
|
31682
|
+
permissions:
|
|
31683
|
+
- synthetics_private_location_read
|
|
30234
31684
|
/api/v1/synthetics/private-locations:
|
|
30235
31685
|
post:
|
|
30236
31686
|
description: Create a new Synthetic private location.
|
|
@@ -30272,6 +31722,10 @@ paths:
|
|
|
30272
31722
|
tags:
|
|
30273
31723
|
- Synthetics
|
|
30274
31724
|
x-codegen-request-body-name: body
|
|
31725
|
+
x-permission:
|
|
31726
|
+
operator: OR
|
|
31727
|
+
permissions:
|
|
31728
|
+
- synthetics_private_location_write
|
|
30275
31729
|
/api/v1/synthetics/private-locations/{location_id}:
|
|
30276
31730
|
delete:
|
|
30277
31731
|
description: Delete a Synthetic private location.
|
|
@@ -30304,6 +31758,10 @@ paths:
|
|
|
30304
31758
|
summary: Delete a private location
|
|
30305
31759
|
tags:
|
|
30306
31760
|
- Synthetics
|
|
31761
|
+
x-permission:
|
|
31762
|
+
operator: OR
|
|
31763
|
+
permissions:
|
|
31764
|
+
- synthetics_private_location_write
|
|
30307
31765
|
get:
|
|
30308
31766
|
description: Get a Synthetic private location.
|
|
30309
31767
|
operationId: GetPrivateLocation
|
|
@@ -30339,6 +31797,10 @@ paths:
|
|
|
30339
31797
|
summary: Get a private location
|
|
30340
31798
|
tags:
|
|
30341
31799
|
- Synthetics
|
|
31800
|
+
x-permission:
|
|
31801
|
+
operator: OR
|
|
31802
|
+
permissions:
|
|
31803
|
+
- synthetics_private_location_read
|
|
30342
31804
|
put:
|
|
30343
31805
|
description: Edit a Synthetic private location.
|
|
30344
31806
|
operationId: UpdatePrivateLocation
|
|
@@ -30382,6 +31844,10 @@ paths:
|
|
|
30382
31844
|
tags:
|
|
30383
31845
|
- Synthetics
|
|
30384
31846
|
x-codegen-request-body-name: body
|
|
31847
|
+
x-permission:
|
|
31848
|
+
operator: OR
|
|
31849
|
+
permissions:
|
|
31850
|
+
- synthetics_private_location_write
|
|
30385
31851
|
/api/v1/synthetics/settings/default_locations:
|
|
30386
31852
|
get:
|
|
30387
31853
|
description: Get the default locations settings.
|
|
@@ -30398,6 +31864,10 @@ paths:
|
|
|
30398
31864
|
summary: Get the default locations
|
|
30399
31865
|
tags:
|
|
30400
31866
|
- Synthetics
|
|
31867
|
+
x-permission:
|
|
31868
|
+
operator: OR
|
|
31869
|
+
permissions:
|
|
31870
|
+
- synthetics_default_settings_read
|
|
30401
31871
|
/api/v1/synthetics/tests:
|
|
30402
31872
|
get:
|
|
30403
31873
|
description: Get the list of all Synthetic tests.
|
|
@@ -30452,6 +31922,10 @@ paths:
|
|
|
30452
31922
|
limitParam: page_size
|
|
30453
31923
|
pageParam: page_number
|
|
30454
31924
|
resultsPath: tests
|
|
31925
|
+
x-permission:
|
|
31926
|
+
operator: OR
|
|
31927
|
+
permissions:
|
|
31928
|
+
- synthetics_read
|
|
30455
31929
|
/api/v1/synthetics/tests/api:
|
|
30456
31930
|
post:
|
|
30457
31931
|
description: Create a Synthetic API test.
|
|
@@ -30620,6 +32094,10 @@ paths:
|
|
|
30620
32094
|
tags:
|
|
30621
32095
|
- Synthetics
|
|
30622
32096
|
x-codegen-request-body-name: body
|
|
32097
|
+
x-permission:
|
|
32098
|
+
operator: OR
|
|
32099
|
+
permissions:
|
|
32100
|
+
- synthetics_write
|
|
30623
32101
|
/api/v1/synthetics/tests/api/{public_id}:
|
|
30624
32102
|
get:
|
|
30625
32103
|
description: 'Get the detailed configuration associated with
|
|
@@ -30664,6 +32142,10 @@ paths:
|
|
|
30664
32142
|
summary: Get an API test
|
|
30665
32143
|
tags:
|
|
30666
32144
|
- Synthetics
|
|
32145
|
+
x-permission:
|
|
32146
|
+
operator: OR
|
|
32147
|
+
permissions:
|
|
32148
|
+
- synthetics_read
|
|
30667
32149
|
put:
|
|
30668
32150
|
description: Edit the configuration of a Synthetic API test.
|
|
30669
32151
|
operationId: UpdateAPITest
|
|
@@ -30723,6 +32205,10 @@ paths:
|
|
|
30723
32205
|
tags:
|
|
30724
32206
|
- Synthetics
|
|
30725
32207
|
x-codegen-request-body-name: body
|
|
32208
|
+
x-permission:
|
|
32209
|
+
operator: OR
|
|
32210
|
+
permissions:
|
|
32211
|
+
- synthetics_write
|
|
30726
32212
|
/api/v1/synthetics/tests/browser:
|
|
30727
32213
|
post:
|
|
30728
32214
|
description: Create a Synthetic browser test.
|
|
@@ -30772,6 +32258,10 @@ paths:
|
|
|
30772
32258
|
tags:
|
|
30773
32259
|
- Synthetics
|
|
30774
32260
|
x-codegen-request-body-name: body
|
|
32261
|
+
x-permission:
|
|
32262
|
+
operator: OR
|
|
32263
|
+
permissions:
|
|
32264
|
+
- synthetics_write
|
|
30775
32265
|
/api/v1/synthetics/tests/browser/{public_id}:
|
|
30776
32266
|
get:
|
|
30777
32267
|
description: 'Get the detailed configuration (including steps) associated with
|
|
@@ -30816,6 +32306,10 @@ paths:
|
|
|
30816
32306
|
summary: Get a browser test
|
|
30817
32307
|
tags:
|
|
30818
32308
|
- Synthetics
|
|
32309
|
+
x-permission:
|
|
32310
|
+
operator: OR
|
|
32311
|
+
permissions:
|
|
32312
|
+
- synthetics_read
|
|
30819
32313
|
put:
|
|
30820
32314
|
description: Edit the configuration of a Synthetic browser test.
|
|
30821
32315
|
operationId: UpdateBrowserTest
|
|
@@ -30875,6 +32369,10 @@ paths:
|
|
|
30875
32369
|
tags:
|
|
30876
32370
|
- Synthetics
|
|
30877
32371
|
x-codegen-request-body-name: body
|
|
32372
|
+
x-permission:
|
|
32373
|
+
operator: OR
|
|
32374
|
+
permissions:
|
|
32375
|
+
- synthetics_write
|
|
30878
32376
|
/api/v1/synthetics/tests/browser/{public_id}/results:
|
|
30879
32377
|
get:
|
|
30880
32378
|
description: Get the last 150 test results summaries for a given Synthetic browser
|
|
@@ -30943,6 +32441,10 @@ paths:
|
|
|
30943
32441
|
tags:
|
|
30944
32442
|
- Synthetics
|
|
30945
32443
|
x-codegen-request-body-name: body
|
|
32444
|
+
x-permission:
|
|
32445
|
+
operator: OR
|
|
32446
|
+
permissions:
|
|
32447
|
+
- synthetics_read
|
|
30946
32448
|
/api/v1/synthetics/tests/browser/{public_id}/results/{result_id}:
|
|
30947
32449
|
get:
|
|
30948
32450
|
description: Get a specific full result from a given Synthetic browser test.
|
|
@@ -30993,6 +32495,10 @@ paths:
|
|
|
30993
32495
|
summary: Get a browser test result
|
|
30994
32496
|
tags:
|
|
30995
32497
|
- Synthetics
|
|
32498
|
+
x-permission:
|
|
32499
|
+
operator: OR
|
|
32500
|
+
permissions:
|
|
32501
|
+
- synthetics_read
|
|
30996
32502
|
/api/v1/synthetics/tests/delete:
|
|
30997
32503
|
post:
|
|
30998
32504
|
description: Delete multiple Synthetic tests by ID.
|
|
@@ -31047,6 +32553,174 @@ paths:
|
|
|
31047
32553
|
tags:
|
|
31048
32554
|
- Synthetics
|
|
31049
32555
|
x-codegen-request-body-name: body
|
|
32556
|
+
x-permission:
|
|
32557
|
+
operator: OR
|
|
32558
|
+
permissions:
|
|
32559
|
+
- synthetics_write
|
|
32560
|
+
/api/v1/synthetics/tests/mobile:
|
|
32561
|
+
post:
|
|
32562
|
+
description: Create a Synthetic mobile test.
|
|
32563
|
+
operationId: CreateSyntheticsMobileTest
|
|
32564
|
+
requestBody:
|
|
32565
|
+
content:
|
|
32566
|
+
application/json:
|
|
32567
|
+
schema:
|
|
32568
|
+
$ref: '#/components/schemas/SyntheticsMobileTest'
|
|
32569
|
+
description: Details of the test to create.
|
|
32570
|
+
required: true
|
|
32571
|
+
responses:
|
|
32572
|
+
'200':
|
|
32573
|
+
content:
|
|
32574
|
+
application/json:
|
|
32575
|
+
schema:
|
|
32576
|
+
$ref: '#/components/schemas/SyntheticsMobileTest'
|
|
32577
|
+
description: OK - Returns the created test details.
|
|
32578
|
+
'400':
|
|
32579
|
+
content:
|
|
32580
|
+
application/json:
|
|
32581
|
+
schema:
|
|
32582
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
32583
|
+
description: '- JSON format is wrong
|
|
32584
|
+
|
|
32585
|
+
- Creation failed'
|
|
32586
|
+
'402':
|
|
32587
|
+
content:
|
|
32588
|
+
application/json:
|
|
32589
|
+
schema:
|
|
32590
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
32591
|
+
description: Test quota is reached
|
|
32592
|
+
'403':
|
|
32593
|
+
content:
|
|
32594
|
+
application/json:
|
|
32595
|
+
schema:
|
|
32596
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
32597
|
+
description: Forbidden
|
|
32598
|
+
'429':
|
|
32599
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
32600
|
+
security:
|
|
32601
|
+
- apiKeyAuth: []
|
|
32602
|
+
appKeyAuth: []
|
|
32603
|
+
- AuthZ:
|
|
32604
|
+
- synthetics_write
|
|
32605
|
+
summary: Create a mobile test
|
|
32606
|
+
tags:
|
|
32607
|
+
- Synthetics
|
|
32608
|
+
x-codegen-request-body-name: body
|
|
32609
|
+
x-permission:
|
|
32610
|
+
operator: OR
|
|
32611
|
+
permissions:
|
|
32612
|
+
- synthetics_write
|
|
32613
|
+
/api/v1/synthetics/tests/mobile/{public_id}:
|
|
32614
|
+
get:
|
|
32615
|
+
description: 'Get the detailed configuration associated with
|
|
32616
|
+
|
|
32617
|
+
a Synthetic Mobile test.'
|
|
32618
|
+
operationId: GetMobileTest
|
|
32619
|
+
parameters:
|
|
32620
|
+
- description: The public ID of the test to get details from.
|
|
32621
|
+
in: path
|
|
32622
|
+
name: public_id
|
|
32623
|
+
required: true
|
|
32624
|
+
schema:
|
|
32625
|
+
type: string
|
|
32626
|
+
responses:
|
|
32627
|
+
'200':
|
|
32628
|
+
content:
|
|
32629
|
+
application/json:
|
|
32630
|
+
schema:
|
|
32631
|
+
$ref: '#/components/schemas/SyntheticsMobileTest'
|
|
32632
|
+
description: OK
|
|
32633
|
+
'403':
|
|
32634
|
+
content:
|
|
32635
|
+
application/json:
|
|
32636
|
+
schema:
|
|
32637
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
32638
|
+
description: Forbidden
|
|
32639
|
+
'404':
|
|
32640
|
+
content:
|
|
32641
|
+
application/json:
|
|
32642
|
+
schema:
|
|
32643
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
32644
|
+
description: '- Synthetic Monitoring is not activated for the user
|
|
32645
|
+
|
|
32646
|
+
- Test is not owned by the user'
|
|
32647
|
+
'429':
|
|
32648
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
32649
|
+
security:
|
|
32650
|
+
- apiKeyAuth: []
|
|
32651
|
+
appKeyAuth: []
|
|
32652
|
+
- AuthZ:
|
|
32653
|
+
- synthetics_read
|
|
32654
|
+
summary: Get a Mobile test
|
|
32655
|
+
tags:
|
|
32656
|
+
- Synthetics
|
|
32657
|
+
x-permission:
|
|
32658
|
+
operator: OR
|
|
32659
|
+
permissions:
|
|
32660
|
+
- synthetics_read
|
|
32661
|
+
put:
|
|
32662
|
+
description: Edit the configuration of a Synthetic Mobile test.
|
|
32663
|
+
operationId: UpdateMobileTest
|
|
32664
|
+
parameters:
|
|
32665
|
+
- description: The public ID of the test to get details from.
|
|
32666
|
+
in: path
|
|
32667
|
+
name: public_id
|
|
32668
|
+
required: true
|
|
32669
|
+
schema:
|
|
32670
|
+
type: string
|
|
32671
|
+
requestBody:
|
|
32672
|
+
content:
|
|
32673
|
+
application/json:
|
|
32674
|
+
schema:
|
|
32675
|
+
$ref: '#/components/schemas/SyntheticsMobileTest'
|
|
32676
|
+
description: New test details to be saved.
|
|
32677
|
+
required: true
|
|
32678
|
+
responses:
|
|
32679
|
+
'200':
|
|
32680
|
+
content:
|
|
32681
|
+
application/json:
|
|
32682
|
+
schema:
|
|
32683
|
+
$ref: '#/components/schemas/SyntheticsMobileTest'
|
|
32684
|
+
description: OK
|
|
32685
|
+
'400':
|
|
32686
|
+
content:
|
|
32687
|
+
application/json:
|
|
32688
|
+
schema:
|
|
32689
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
32690
|
+
description: '- JSON format is wrong
|
|
32691
|
+
|
|
32692
|
+
- Updating sub-type is forbidden'
|
|
32693
|
+
'403':
|
|
32694
|
+
content:
|
|
32695
|
+
application/json:
|
|
32696
|
+
schema:
|
|
32697
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
32698
|
+
description: Forbidden
|
|
32699
|
+
'404':
|
|
32700
|
+
content:
|
|
32701
|
+
application/json:
|
|
32702
|
+
schema:
|
|
32703
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
32704
|
+
description: '- Synthetic Monitoring is not activated for the user
|
|
32705
|
+
|
|
32706
|
+
- Test is not owned by the user
|
|
32707
|
+
|
|
32708
|
+
- Test can''t be found'
|
|
32709
|
+
'429':
|
|
32710
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
32711
|
+
security:
|
|
32712
|
+
- apiKeyAuth: []
|
|
32713
|
+
appKeyAuth: []
|
|
32714
|
+
- AuthZ:
|
|
32715
|
+
- synthetics_write
|
|
32716
|
+
summary: Edit a Mobile test
|
|
32717
|
+
tags:
|
|
32718
|
+
- Synthetics
|
|
32719
|
+
x-codegen-request-body-name: body
|
|
32720
|
+
x-permission:
|
|
32721
|
+
operator: OR
|
|
32722
|
+
permissions:
|
|
32723
|
+
- synthetics_write
|
|
31050
32724
|
/api/v1/synthetics/tests/trigger:
|
|
31051
32725
|
post:
|
|
31052
32726
|
description: Trigger a set of Synthetic tests.
|
|
@@ -31082,6 +32756,10 @@ paths:
|
|
|
31082
32756
|
tags:
|
|
31083
32757
|
- Synthetics
|
|
31084
32758
|
x-codegen-request-body-name: body
|
|
32759
|
+
x-permission:
|
|
32760
|
+
operator: OR
|
|
32761
|
+
permissions:
|
|
32762
|
+
- synthetics_write
|
|
31085
32763
|
/api/v1/synthetics/tests/trigger/ci:
|
|
31086
32764
|
post:
|
|
31087
32765
|
description: Trigger a set of Synthetic tests for continuous integration.
|
|
@@ -31117,6 +32795,57 @@ paths:
|
|
|
31117
32795
|
tags:
|
|
31118
32796
|
- Synthetics
|
|
31119
32797
|
x-codegen-request-body-name: body
|
|
32798
|
+
x-permission:
|
|
32799
|
+
operator: OR
|
|
32800
|
+
permissions:
|
|
32801
|
+
- synthetics_write
|
|
32802
|
+
/api/v1/synthetics/tests/uptimes:
|
|
32803
|
+
post:
|
|
32804
|
+
description: Fetch uptime for multiple Synthetic tests by ID.
|
|
32805
|
+
operationId: FetchUptimes
|
|
32806
|
+
requestBody:
|
|
32807
|
+
content:
|
|
32808
|
+
application/json:
|
|
32809
|
+
schema:
|
|
32810
|
+
$ref: '#/components/schemas/SyntheticsFetchUptimesPayload'
|
|
32811
|
+
description: Public ID list of the Synthetic tests and timeframe.
|
|
32812
|
+
required: true
|
|
32813
|
+
responses:
|
|
32814
|
+
'200':
|
|
32815
|
+
content:
|
|
32816
|
+
application/json:
|
|
32817
|
+
schema:
|
|
32818
|
+
items:
|
|
32819
|
+
$ref: '#/components/schemas/SyntheticsTestUptime'
|
|
32820
|
+
type: array
|
|
32821
|
+
description: OK.
|
|
32822
|
+
'400':
|
|
32823
|
+
content:
|
|
32824
|
+
application/json:
|
|
32825
|
+
schema:
|
|
32826
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
32827
|
+
description: '- JSON format is wrong'
|
|
32828
|
+
'403':
|
|
32829
|
+
content:
|
|
32830
|
+
application/json:
|
|
32831
|
+
schema:
|
|
32832
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
32833
|
+
description: Forbidden
|
|
32834
|
+
'429':
|
|
32835
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
32836
|
+
security:
|
|
32837
|
+
- apiKeyAuth: []
|
|
32838
|
+
appKeyAuth: []
|
|
32839
|
+
- AuthZ:
|
|
32840
|
+
- synthetics_read
|
|
32841
|
+
summary: Fetch uptime for multiple tests
|
|
32842
|
+
tags:
|
|
32843
|
+
- Synthetics
|
|
32844
|
+
x-codegen-request-body-name: body
|
|
32845
|
+
x-permission:
|
|
32846
|
+
operator: OR
|
|
32847
|
+
permissions:
|
|
32848
|
+
- synthetics_read
|
|
31120
32849
|
/api/v1/synthetics/tests/{public_id}:
|
|
31121
32850
|
get:
|
|
31122
32851
|
description: Get the detailed configuration associated with a Synthetic test.
|
|
@@ -31159,6 +32888,10 @@ paths:
|
|
|
31159
32888
|
summary: Get a test configuration
|
|
31160
32889
|
tags:
|
|
31161
32890
|
- Synthetics
|
|
32891
|
+
x-permission:
|
|
32892
|
+
operator: OR
|
|
32893
|
+
permissions:
|
|
32894
|
+
- synthetics_read
|
|
31162
32895
|
patch:
|
|
31163
32896
|
description: Patch the configuration of a Synthetic test with partial data.
|
|
31164
32897
|
operationId: PatchTest
|
|
@@ -31218,6 +32951,10 @@ paths:
|
|
|
31218
32951
|
tags:
|
|
31219
32952
|
- Synthetics
|
|
31220
32953
|
x-codegen-request-body-name: body
|
|
32954
|
+
x-permission:
|
|
32955
|
+
operator: OR
|
|
32956
|
+
permissions:
|
|
32957
|
+
- synthetics_write
|
|
31221
32958
|
/api/v1/synthetics/tests/{public_id}/results:
|
|
31222
32959
|
get:
|
|
31223
32960
|
description: Get the last 150 test results summaries for a given Synthetic API
|
|
@@ -31284,6 +33021,10 @@ paths:
|
|
|
31284
33021
|
tags:
|
|
31285
33022
|
- Synthetics
|
|
31286
33023
|
x-codegen-request-body-name: body
|
|
33024
|
+
x-permission:
|
|
33025
|
+
operator: OR
|
|
33026
|
+
permissions:
|
|
33027
|
+
- synthetics_read
|
|
31287
33028
|
/api/v1/synthetics/tests/{public_id}/results/{result_id}:
|
|
31288
33029
|
get:
|
|
31289
33030
|
description: Get a specific full result from a given Synthetic API test.
|
|
@@ -31332,6 +33073,10 @@ paths:
|
|
|
31332
33073
|
summary: Get an API test result
|
|
31333
33074
|
tags:
|
|
31334
33075
|
- Synthetics
|
|
33076
|
+
x-permission:
|
|
33077
|
+
operator: OR
|
|
33078
|
+
permissions:
|
|
33079
|
+
- synthetics_read
|
|
31335
33080
|
/api/v1/synthetics/tests/{public_id}/status:
|
|
31336
33081
|
put:
|
|
31337
33082
|
description: Pause or start a Synthetic test by changing the status.
|
|
@@ -31388,6 +33133,10 @@ paths:
|
|
|
31388
33133
|
tags:
|
|
31389
33134
|
- Synthetics
|
|
31390
33135
|
x-codegen-request-body-name: body
|
|
33136
|
+
x-permission:
|
|
33137
|
+
operator: OR
|
|
33138
|
+
permissions:
|
|
33139
|
+
- synthetics_write
|
|
31391
33140
|
/api/v1/synthetics/variables:
|
|
31392
33141
|
get:
|
|
31393
33142
|
description: Get the list of all Synthetic global variables.
|
|
@@ -31415,6 +33164,10 @@ paths:
|
|
|
31415
33164
|
summary: Get all global variables
|
|
31416
33165
|
tags:
|
|
31417
33166
|
- Synthetics
|
|
33167
|
+
x-permission:
|
|
33168
|
+
operator: OR
|
|
33169
|
+
permissions:
|
|
33170
|
+
- synthetics_global_variable_read
|
|
31418
33171
|
post:
|
|
31419
33172
|
description: Create a Synthetic global variable.
|
|
31420
33173
|
operationId: CreateGlobalVariable
|
|
@@ -31461,6 +33214,10 @@ paths:
|
|
|
31461
33214
|
tags:
|
|
31462
33215
|
- Synthetics
|
|
31463
33216
|
x-codegen-request-body-name: body
|
|
33217
|
+
x-permission:
|
|
33218
|
+
operator: OR
|
|
33219
|
+
permissions:
|
|
33220
|
+
- synthetics_global_variable_write
|
|
31464
33221
|
/api/v1/synthetics/variables/{variable_id}:
|
|
31465
33222
|
delete:
|
|
31466
33223
|
description: Delete a Synthetic global variable.
|
|
@@ -31503,6 +33260,10 @@ paths:
|
|
|
31503
33260
|
summary: Delete a global variable
|
|
31504
33261
|
tags:
|
|
31505
33262
|
- Synthetics
|
|
33263
|
+
x-permission:
|
|
33264
|
+
operator: OR
|
|
33265
|
+
permissions:
|
|
33266
|
+
- synthetics_global_variable_write
|
|
31506
33267
|
get:
|
|
31507
33268
|
description: Get the detailed configuration of a global variable.
|
|
31508
33269
|
operationId: GetGlobalVariable
|
|
@@ -31589,6 +33350,10 @@ paths:
|
|
|
31589
33350
|
tags:
|
|
31590
33351
|
- Synthetics
|
|
31591
33352
|
x-codegen-request-body-name: body
|
|
33353
|
+
x-permission:
|
|
33354
|
+
operator: OR
|
|
33355
|
+
permissions:
|
|
33356
|
+
- synthetics_global_variable_write
|
|
31592
33357
|
/api/v1/tags/hosts:
|
|
31593
33358
|
get:
|
|
31594
33359
|
description: Return a mapping of tags to hosts for your whole infrastructure.
|
|
@@ -31629,6 +33394,9 @@ paths:
|
|
|
31629
33394
|
summary: Get Tags
|
|
31630
33395
|
tags:
|
|
31631
33396
|
- Tags
|
|
33397
|
+
x-permission:
|
|
33398
|
+
operator: OPEN
|
|
33399
|
+
permissions: []
|
|
31632
33400
|
/api/v1/tags/hosts/{host_name}:
|
|
31633
33401
|
delete:
|
|
31634
33402
|
description: 'This endpoint allows you to remove all user-assigned tags
|
|
@@ -31881,6 +33649,10 @@ paths:
|
|
|
31881
33649
|
summary: Get hourly usage for analyzed logs
|
|
31882
33650
|
tags:
|
|
31883
33651
|
- Usage Metering
|
|
33652
|
+
x-permission:
|
|
33653
|
+
operator: OR
|
|
33654
|
+
permissions:
|
|
33655
|
+
- usage_read
|
|
31884
33656
|
/api/v1/usage/audit_logs:
|
|
31885
33657
|
get:
|
|
31886
33658
|
deprecated: true
|
|
@@ -31940,6 +33712,10 @@ paths:
|
|
|
31940
33712
|
summary: Get hourly usage for audit logs
|
|
31941
33713
|
tags:
|
|
31942
33714
|
- Usage Metering
|
|
33715
|
+
x-permission:
|
|
33716
|
+
operator: OR
|
|
33717
|
+
permissions:
|
|
33718
|
+
- usage_read
|
|
31943
33719
|
/api/v1/usage/aws_lambda:
|
|
31944
33720
|
get:
|
|
31945
33721
|
deprecated: true
|
|
@@ -32000,6 +33776,10 @@ paths:
|
|
|
32000
33776
|
summary: Get hourly usage for Lambda
|
|
32001
33777
|
tags:
|
|
32002
33778
|
- Usage Metering
|
|
33779
|
+
x-permission:
|
|
33780
|
+
operator: OR
|
|
33781
|
+
permissions:
|
|
33782
|
+
- usage_read
|
|
32003
33783
|
/api/v1/usage/billable-summary:
|
|
32004
33784
|
get:
|
|
32005
33785
|
description: 'Get billable usage across your account.
|
|
@@ -32058,6 +33838,10 @@ paths:
|
|
|
32058
33838
|
summary: Get billable usage across your account
|
|
32059
33839
|
tags:
|
|
32060
33840
|
- Usage Metering
|
|
33841
|
+
x-permission:
|
|
33842
|
+
operator: OR
|
|
33843
|
+
permissions:
|
|
33844
|
+
- usage_read
|
|
32061
33845
|
/api/v1/usage/ci-app:
|
|
32062
33846
|
get:
|
|
32063
33847
|
deprecated: true
|
|
@@ -32120,6 +33904,10 @@ paths:
|
|
|
32120
33904
|
summary: Get hourly usage for CI visibility
|
|
32121
33905
|
tags:
|
|
32122
33906
|
- Usage Metering
|
|
33907
|
+
x-permission:
|
|
33908
|
+
operator: OR
|
|
33909
|
+
permissions:
|
|
33910
|
+
- usage_read
|
|
32123
33911
|
/api/v1/usage/cspm:
|
|
32124
33912
|
get:
|
|
32125
33913
|
deprecated: true
|
|
@@ -32182,6 +33970,10 @@ paths:
|
|
|
32182
33970
|
summary: Get hourly usage for CSM Pro
|
|
32183
33971
|
tags:
|
|
32184
33972
|
- Usage Metering
|
|
33973
|
+
x-permission:
|
|
33974
|
+
operator: OR
|
|
33975
|
+
permissions:
|
|
33976
|
+
- usage_read
|
|
32185
33977
|
/api/v1/usage/cws:
|
|
32186
33978
|
get:
|
|
32187
33979
|
deprecated: true
|
|
@@ -32244,6 +34036,10 @@ paths:
|
|
|
32244
34036
|
summary: Get hourly usage for cloud workload security
|
|
32245
34037
|
tags:
|
|
32246
34038
|
- Usage Metering
|
|
34039
|
+
x-permission:
|
|
34040
|
+
operator: OR
|
|
34041
|
+
permissions:
|
|
34042
|
+
- usage_read
|
|
32247
34043
|
/api/v1/usage/dbm:
|
|
32248
34044
|
get:
|
|
32249
34045
|
deprecated: true
|
|
@@ -32306,6 +34102,10 @@ paths:
|
|
|
32306
34102
|
summary: Get hourly usage for database monitoring
|
|
32307
34103
|
tags:
|
|
32308
34104
|
- Usage Metering
|
|
34105
|
+
x-permission:
|
|
34106
|
+
operator: OR
|
|
34107
|
+
permissions:
|
|
34108
|
+
- usage_read
|
|
32309
34109
|
/api/v1/usage/fargate:
|
|
32310
34110
|
get:
|
|
32311
34111
|
deprecated: true
|
|
@@ -32366,6 +34166,10 @@ paths:
|
|
|
32366
34166
|
summary: Get hourly usage for Fargate
|
|
32367
34167
|
tags:
|
|
32368
34168
|
- Usage Metering
|
|
34169
|
+
x-permission:
|
|
34170
|
+
operator: OR
|
|
34171
|
+
permissions:
|
|
34172
|
+
- usage_read
|
|
32369
34173
|
/api/v1/usage/hosts:
|
|
32370
34174
|
get:
|
|
32371
34175
|
deprecated: true
|
|
@@ -32426,6 +34230,10 @@ paths:
|
|
|
32426
34230
|
summary: Get hourly usage for hosts and containers
|
|
32427
34231
|
tags:
|
|
32428
34232
|
- Usage Metering
|
|
34233
|
+
x-permission:
|
|
34234
|
+
operator: OR
|
|
34235
|
+
permissions:
|
|
34236
|
+
- usage_read
|
|
32429
34237
|
/api/v1/usage/hourly-attribution:
|
|
32430
34238
|
get:
|
|
32431
34239
|
description: "Get hourly usage attribution. Multi-region data is available starting
|
|
@@ -32514,6 +34322,10 @@ paths:
|
|
|
32514
34322
|
summary: Get hourly usage attribution
|
|
32515
34323
|
tags:
|
|
32516
34324
|
- Usage Metering
|
|
34325
|
+
x-permission:
|
|
34326
|
+
operator: OR
|
|
34327
|
+
permissions:
|
|
34328
|
+
- usage_read
|
|
32517
34329
|
/api/v1/usage/incident-management:
|
|
32518
34330
|
get:
|
|
32519
34331
|
deprecated: true
|
|
@@ -32576,6 +34388,10 @@ paths:
|
|
|
32576
34388
|
summary: Get hourly usage for incident management
|
|
32577
34389
|
tags:
|
|
32578
34390
|
- Usage Metering
|
|
34391
|
+
x-permission:
|
|
34392
|
+
operator: OR
|
|
34393
|
+
permissions:
|
|
34394
|
+
- usage_read
|
|
32579
34395
|
/api/v1/usage/indexed-spans:
|
|
32580
34396
|
get:
|
|
32581
34397
|
deprecated: true
|
|
@@ -32636,6 +34452,10 @@ paths:
|
|
|
32636
34452
|
summary: Get hourly usage for indexed spans
|
|
32637
34453
|
tags:
|
|
32638
34454
|
- Usage Metering
|
|
34455
|
+
x-permission:
|
|
34456
|
+
operator: OR
|
|
34457
|
+
permissions:
|
|
34458
|
+
- usage_read
|
|
32639
34459
|
/api/v1/usage/ingested-spans:
|
|
32640
34460
|
get:
|
|
32641
34461
|
deprecated: true
|
|
@@ -32698,6 +34518,10 @@ paths:
|
|
|
32698
34518
|
summary: Get hourly usage for ingested spans
|
|
32699
34519
|
tags:
|
|
32700
34520
|
- Usage Metering
|
|
34521
|
+
x-permission:
|
|
34522
|
+
operator: OR
|
|
34523
|
+
permissions:
|
|
34524
|
+
- usage_read
|
|
32701
34525
|
/api/v1/usage/iot:
|
|
32702
34526
|
get:
|
|
32703
34527
|
deprecated: true
|
|
@@ -32760,6 +34584,10 @@ paths:
|
|
|
32760
34584
|
summary: Get hourly usage for IoT
|
|
32761
34585
|
tags:
|
|
32762
34586
|
- Usage Metering
|
|
34587
|
+
x-permission:
|
|
34588
|
+
operator: OR
|
|
34589
|
+
permissions:
|
|
34590
|
+
- usage_read
|
|
32763
34591
|
/api/v1/usage/logs:
|
|
32764
34592
|
get:
|
|
32765
34593
|
deprecated: true
|
|
@@ -32820,6 +34648,10 @@ paths:
|
|
|
32820
34648
|
summary: Get hourly usage for logs
|
|
32821
34649
|
tags:
|
|
32822
34650
|
- Usage Metering
|
|
34651
|
+
x-permission:
|
|
34652
|
+
operator: OR
|
|
34653
|
+
permissions:
|
|
34654
|
+
- usage_read
|
|
32823
34655
|
/api/v1/usage/logs-by-retention:
|
|
32824
34656
|
get:
|
|
32825
34657
|
deprecated: true
|
|
@@ -32882,6 +34714,10 @@ paths:
|
|
|
32882
34714
|
summary: Get hourly logs usage by retention
|
|
32883
34715
|
tags:
|
|
32884
34716
|
- Usage Metering
|
|
34717
|
+
x-permission:
|
|
34718
|
+
operator: OR
|
|
34719
|
+
permissions:
|
|
34720
|
+
- usage_read
|
|
32885
34721
|
/api/v1/usage/logs_by_index:
|
|
32886
34722
|
get:
|
|
32887
34723
|
description: Get hourly usage for logs by index.
|
|
@@ -32944,6 +34780,10 @@ paths:
|
|
|
32944
34780
|
summary: Get hourly usage for logs by index
|
|
32945
34781
|
tags:
|
|
32946
34782
|
- Usage Metering
|
|
34783
|
+
x-permission:
|
|
34784
|
+
operator: OR
|
|
34785
|
+
permissions:
|
|
34786
|
+
- usage_read
|
|
32947
34787
|
/api/v1/usage/monthly-attribution:
|
|
32948
34788
|
get:
|
|
32949
34789
|
description: "Get monthly usage attribution. Multi-region data is available
|
|
@@ -33045,6 +34885,10 @@ paths:
|
|
|
33045
34885
|
summary: Get monthly usage attribution
|
|
33046
34886
|
tags:
|
|
33047
34887
|
- Usage Metering
|
|
34888
|
+
x-permission:
|
|
34889
|
+
operator: OR
|
|
34890
|
+
permissions:
|
|
34891
|
+
- usage_read
|
|
33048
34892
|
/api/v1/usage/network_flows:
|
|
33049
34893
|
get:
|
|
33050
34894
|
deprecated: true
|
|
@@ -33107,6 +34951,10 @@ paths:
|
|
|
33107
34951
|
summary: get hourly usage for network flows
|
|
33108
34952
|
tags:
|
|
33109
34953
|
- Usage Metering
|
|
34954
|
+
x-permission:
|
|
34955
|
+
operator: OR
|
|
34956
|
+
permissions:
|
|
34957
|
+
- usage_read
|
|
33110
34958
|
/api/v1/usage/network_hosts:
|
|
33111
34959
|
get:
|
|
33112
34960
|
deprecated: true
|
|
@@ -33167,6 +35015,10 @@ paths:
|
|
|
33167
35015
|
summary: Get hourly usage for network hosts
|
|
33168
35016
|
tags:
|
|
33169
35017
|
- Usage Metering
|
|
35018
|
+
x-permission:
|
|
35019
|
+
operator: OR
|
|
35020
|
+
permissions:
|
|
35021
|
+
- usage_read
|
|
33170
35022
|
/api/v1/usage/online-archive:
|
|
33171
35023
|
get:
|
|
33172
35024
|
deprecated: true
|
|
@@ -33229,6 +35081,10 @@ paths:
|
|
|
33229
35081
|
summary: Get hourly usage for online archive
|
|
33230
35082
|
tags:
|
|
33231
35083
|
- Usage Metering
|
|
35084
|
+
x-permission:
|
|
35085
|
+
operator: OR
|
|
35086
|
+
permissions:
|
|
35087
|
+
- usage_read
|
|
33232
35088
|
/api/v1/usage/profiling:
|
|
33233
35089
|
get:
|
|
33234
35090
|
deprecated: true
|
|
@@ -33291,6 +35147,10 @@ paths:
|
|
|
33291
35147
|
summary: Get hourly usage for profiled hosts
|
|
33292
35148
|
tags:
|
|
33293
35149
|
- Usage Metering
|
|
35150
|
+
x-permission:
|
|
35151
|
+
operator: OR
|
|
35152
|
+
permissions:
|
|
35153
|
+
- usage_read
|
|
33294
35154
|
/api/v1/usage/rum:
|
|
33295
35155
|
get:
|
|
33296
35156
|
deprecated: true
|
|
@@ -33352,6 +35212,10 @@ paths:
|
|
|
33352
35212
|
summary: Get hourly usage for RUM units
|
|
33353
35213
|
tags:
|
|
33354
35214
|
- Usage Metering
|
|
35215
|
+
x-permission:
|
|
35216
|
+
operator: OR
|
|
35217
|
+
permissions:
|
|
35218
|
+
- usage_read
|
|
33355
35219
|
/api/v1/usage/rum_sessions:
|
|
33356
35220
|
get:
|
|
33357
35221
|
deprecated: true
|
|
@@ -33419,6 +35283,10 @@ paths:
|
|
|
33419
35283
|
summary: Get hourly usage for RUM sessions
|
|
33420
35284
|
tags:
|
|
33421
35285
|
- Usage Metering
|
|
35286
|
+
x-permission:
|
|
35287
|
+
operator: OR
|
|
35288
|
+
permissions:
|
|
35289
|
+
- usage_read
|
|
33422
35290
|
/api/v1/usage/sds:
|
|
33423
35291
|
get:
|
|
33424
35292
|
deprecated: true
|
|
@@ -33481,6 +35349,10 @@ paths:
|
|
|
33481
35349
|
summary: Get hourly usage for sensitive data scanner
|
|
33482
35350
|
tags:
|
|
33483
35351
|
- Usage Metering
|
|
35352
|
+
x-permission:
|
|
35353
|
+
operator: OR
|
|
35354
|
+
permissions:
|
|
35355
|
+
- usage_read
|
|
33484
35356
|
/api/v1/usage/snmp:
|
|
33485
35357
|
get:
|
|
33486
35358
|
deprecated: true
|
|
@@ -33543,6 +35415,10 @@ paths:
|
|
|
33543
35415
|
summary: Get hourly usage for SNMP devices
|
|
33544
35416
|
tags:
|
|
33545
35417
|
- Usage Metering
|
|
35418
|
+
x-permission:
|
|
35419
|
+
operator: OR
|
|
35420
|
+
permissions:
|
|
35421
|
+
- usage_read
|
|
33546
35422
|
/api/v1/usage/summary:
|
|
33547
35423
|
get:
|
|
33548
35424
|
description: 'Get all usage across your account.
|
|
@@ -33617,6 +35493,10 @@ paths:
|
|
|
33617
35493
|
summary: Get usage across your account
|
|
33618
35494
|
tags:
|
|
33619
35495
|
- Usage Metering
|
|
35496
|
+
x-permission:
|
|
35497
|
+
operator: OR
|
|
35498
|
+
permissions:
|
|
35499
|
+
- usage_read
|
|
33620
35500
|
/api/v1/usage/synthetics:
|
|
33621
35501
|
get:
|
|
33622
35502
|
deprecated: true
|
|
@@ -33677,6 +35557,10 @@ paths:
|
|
|
33677
35557
|
summary: Get hourly usage for synthetics checks
|
|
33678
35558
|
tags:
|
|
33679
35559
|
- Usage Metering
|
|
35560
|
+
x-permission:
|
|
35561
|
+
operator: OR
|
|
35562
|
+
permissions:
|
|
35563
|
+
- usage_read
|
|
33680
35564
|
/api/v1/usage/synthetics_api:
|
|
33681
35565
|
get:
|
|
33682
35566
|
deprecated: true
|
|
@@ -33737,6 +35621,10 @@ paths:
|
|
|
33737
35621
|
summary: Get hourly usage for synthetics API checks
|
|
33738
35622
|
tags:
|
|
33739
35623
|
- Usage Metering
|
|
35624
|
+
x-permission:
|
|
35625
|
+
operator: OR
|
|
35626
|
+
permissions:
|
|
35627
|
+
- usage_read
|
|
33740
35628
|
/api/v1/usage/synthetics_browser:
|
|
33741
35629
|
get:
|
|
33742
35630
|
deprecated: true
|
|
@@ -33797,6 +35685,10 @@ paths:
|
|
|
33797
35685
|
summary: Get hourly usage for synthetics browser checks
|
|
33798
35686
|
tags:
|
|
33799
35687
|
- Usage Metering
|
|
35688
|
+
x-permission:
|
|
35689
|
+
operator: OR
|
|
35690
|
+
permissions:
|
|
35691
|
+
- usage_read
|
|
33800
35692
|
/api/v1/usage/timeseries:
|
|
33801
35693
|
get:
|
|
33802
35694
|
deprecated: true
|
|
@@ -33857,6 +35749,10 @@ paths:
|
|
|
33857
35749
|
summary: Get hourly usage for custom metrics
|
|
33858
35750
|
tags:
|
|
33859
35751
|
- Usage Metering
|
|
35752
|
+
x-permission:
|
|
35753
|
+
operator: OR
|
|
35754
|
+
permissions:
|
|
35755
|
+
- usage_read
|
|
33860
35756
|
/api/v1/usage/top_avg_metrics:
|
|
33861
35757
|
get:
|
|
33862
35758
|
description: Get all [custom metrics](https://docs.datadoghq.com/developers/metrics/custom_metrics/)
|
|
@@ -33940,6 +35836,10 @@ paths:
|
|
|
33940
35836
|
summary: Get all custom metrics by hourly average
|
|
33941
35837
|
tags:
|
|
33942
35838
|
- Usage Metering
|
|
35839
|
+
x-permission:
|
|
35840
|
+
operator: OR
|
|
35841
|
+
permissions:
|
|
35842
|
+
- usage_read
|
|
33943
35843
|
/api/v1/user:
|
|
33944
35844
|
get:
|
|
33945
35845
|
description: List all users for your organization.
|
|
@@ -33967,6 +35867,10 @@ paths:
|
|
|
33967
35867
|
summary: List all users
|
|
33968
35868
|
tags:
|
|
33969
35869
|
- Users
|
|
35870
|
+
x-permission:
|
|
35871
|
+
operator: OR
|
|
35872
|
+
permissions:
|
|
35873
|
+
- user_access_read
|
|
33970
35874
|
post:
|
|
33971
35875
|
description: 'Create a user for your organization.
|
|
33972
35876
|
|
|
@@ -34013,6 +35917,10 @@ paths:
|
|
|
34013
35917
|
tags:
|
|
34014
35918
|
- Users
|
|
34015
35919
|
x-codegen-request-body-name: body
|
|
35920
|
+
x-permission:
|
|
35921
|
+
operator: OR
|
|
35922
|
+
permissions:
|
|
35923
|
+
- user_access_invite
|
|
34016
35924
|
/api/v1/user/{user_handle}:
|
|
34017
35925
|
delete:
|
|
34018
35926
|
description: 'Delete a user from an organization.
|
|
@@ -34172,6 +36080,9 @@ paths:
|
|
|
34172
36080
|
summary: Validate API key
|
|
34173
36081
|
tags:
|
|
34174
36082
|
- Authentication
|
|
36083
|
+
x-permission:
|
|
36084
|
+
operator: OPEN
|
|
36085
|
+
permissions: []
|
|
34175
36086
|
/v1/input:
|
|
34176
36087
|
post:
|
|
34177
36088
|
deprecated: true
|