datadog_api_client 2.15.0 → 2.17.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.apigentools-info +6 -6
- data/.generator/schemas/v1/openapi.yaml +1316 -153
- data/.generator/schemas/v2/openapi.yaml +3367 -685
- data/.generator/src/generator/formatter.py +4 -0
- data/.generator/src/generator/openapi.py +2 -0
- data/.generator/src/generator/templates/api_client.j2 +22 -1
- data/.generator/src/generator/templates/inflector.j2 +1 -1
- data/.generator/src/generator/templates/model_base.j2 +5 -0
- data/CHANGELOG.md +59 -0
- data/Gemfile +1 -0
- data/LICENSE-3rdparty.csv +1 -0
- data/datadog_api_client.gemspec +2 -0
- data/examples/v1/aws-integration/CreateAWSAccount.rb +1 -1
- data/examples/v1/aws-integration/CreateAWSEventBridgeSource.rb +12 -0
- data/examples/v1/aws-integration/CreateAWSTagFilter.rb +1 -1
- data/examples/v1/aws-integration/CreateNewAWSExternalID.rb +1 -1
- data/examples/v1/aws-integration/DeleteAWSAccount.rb +1 -1
- data/examples/v1/aws-integration/DeleteAWSEventBridgeSource.rb +11 -0
- data/examples/v1/aws-integration/ListAWSEventBridgeSources.rb +5 -0
- data/examples/v1/azure-integration/CreateAzureIntegration.rb +1 -0
- data/examples/v1/azure-integration/DeleteAzureIntegration.rb +1 -0
- data/examples/v1/azure-integration/UpdateAzureHostFilters.rb +1 -0
- data/examples/v1/azure-integration/UpdateAzureIntegration.rb +1 -0
- data/examples/v1/dashboards/CreateDashboard_1213075383.rb +7 -0
- data/examples/v1/dashboards/CreateDashboard_1754992756.rb +44 -0
- data/examples/v1/dashboards/CreateDashboard_2278756614.rb +91 -0
- data/examples/v1/monitors/CreateMonitor_1539578087.rb +35 -0
- data/examples/v1/synthetics/CreateSyntheticsBrowserTest.rb +1 -1
- data/examples/v1/synthetics/CreateSyntheticsBrowserTest_2932742688.rb +1 -1
- data/examples/v1/synthetics/CreateSyntheticsBrowserTest_397420811.rb +1 -1
- data/examples/v1/usage-metering/GetUsageCIApp.rb +4 -1
- data/examples/v1/usage-metering/GetUsageCWS.rb +4 -1
- data/examples/v1/usage-metering/GetUsageCloudSecurityPostureManagement.rb +1 -1
- data/examples/v2/apm-retention-filters/CreateApmRetentionFilter.rb +20 -0
- data/examples/v2/apm-retention-filters/DeleteApmRetentionFilter.rb +8 -0
- data/examples/v2/apm-retention-filters/GetApmRetentionFilter.rb +8 -0
- data/examples/v2/apm-retention-filters/ListApmRetentionFilters.rb +5 -0
- data/examples/v2/apm-retention-filters/ReorderApmRetentionFilters.rb +18 -0
- data/examples/v2/apm-retention-filters/UpdateApmRetentionFilter.rb +24 -0
- data/examples/v2/ci-visibility-pipelines/CreateCIAppPipelineEvent_129899466.rb +0 -5
- data/examples/v2/confluent-cloud/DeleteConfluentAccount.rb +4 -1
- data/examples/v2/confluent-cloud/DeleteConfluentResource.rb +5 -0
- data/examples/v2/container-images/ListContainerImages.rb +8 -0
- data/examples/v2/container-images/ListContainerImages_3088586393.rb +11 -0
- data/examples/v2/container-images/ListContainerImages_3974828736.rb +11 -0
- data/examples/v2/containers/ListContainers.rb +8 -0
- data/examples/v2/containers/ListContainers_2175733917.rb +11 -0
- data/examples/v2/containers/ListContainers_931009654.rb +11 -0
- data/examples/v2/downtimes/ListMonitorDowntimes.rb +1 -1
- data/examples/v2/gcp-integration/CreateGCPSTSAccount_109518525.rb +19 -0
- data/examples/v2/key-management/CreateCurrentUserApplicationKey.rb +2 -7
- data/examples/v2/key-management/DeleteApplicationKey.rb +4 -1
- data/examples/v2/key-management/DeleteCurrentUserApplicationKey.rb +4 -1
- data/examples/v2/powerpack/CreatePowerpack.rb +48 -0
- data/examples/v2/powerpack/DeletePowerpack.rb +8 -0
- data/examples/v2/powerpack/GetPowerpack.rb +8 -0
- data/examples/v2/powerpack/ListPowerpacks.rb +8 -0
- data/examples/v2/powerpack/ListPowerpacks_1173755071.rb +8 -0
- data/examples/v2/powerpack/UpdatePowerpack.rb +51 -0
- data/examples/v2/rum/CreateRUMApplication.rb +1 -1
- data/examples/v2/security-monitoring/MuteFindings.rb +29 -0
- data/examples/v2/service-accounts/CreateServiceAccountApplicationKey.rb +5 -7
- data/examples/v2/service-accounts/DeleteServiceAccountApplicationKey.rb +7 -1
- data/examples/v2/service-accounts/GetServiceAccountApplicationKey.rb +7 -1
- data/examples/v2/service-accounts/ListServiceAccountApplicationKeys.rb +4 -1
- data/examples/v2/service-accounts/UpdateServiceAccountApplicationKey.rb +11 -9
- data/examples/v2/service-definition/CreateOrUpdateServiceDefinitions.rb +23 -12
- data/examples/v2/service-definition/CreateOrUpdateServiceDefinitions_2621709423.rb +53 -0
- data/examples/v2/service-scorecards/CreateScorecardOutcomesBatch.rb +27 -0
- data/examples/v2/service-scorecards/CreateScorecardRule.rb +19 -0
- data/examples/v2/service-scorecards/DeleteScorecardRule.rb +11 -0
- data/examples/v2/service-scorecards/ListScorecardOutcomes.rb +8 -0
- data/examples/v2/service-scorecards/ListScorecardOutcomes_2663454275.rb +13 -0
- data/examples/v2/service-scorecards/ListScorecardRules.rb +8 -0
- data/examples/v2/service-scorecards/ListScorecardRules_4057666343.rb +13 -0
- data/examples/v2/synthetics/SetOnDemandConcurrencyCap.rb +3 -1
- data/examples/v2/teams/ListTeams_3429963470.rb +12 -0
- data/examples/v2/usage-metering/GetUsageApplicationSecurityMonitoring.rb +4 -1
- data/examples/v2/usage-metering/GetUsageLambdaTracedInvocations.rb +4 -1
- data/examples/v2/usage-metering/GetUsageObservabilityPipelines.rb +4 -1
- data/examples/v2/users/GetUser.rb +5 -2
- data/lib/datadog_api_client/api_client.rb +22 -1
- data/lib/datadog_api_client/configuration.rb +8 -1
- data/lib/datadog_api_client/inflector.rb +156 -9
- data/lib/datadog_api_client/v1/api/aws_integration_api.rb +194 -0
- data/lib/datadog_api_client/v1/api/monitors_api.rb +6 -21
- data/lib/datadog_api_client/v1/api/usage_metering_api.rb +6 -6
- data/lib/datadog_api_client/v1/api/webhooks_integration_api.rb +1 -1
- data/lib/datadog_api_client/v1/model_base.rb +5 -0
- data/lib/datadog_api_client/v1/models/aws_account.rb +2 -1
- data/lib/datadog_api_client/v1/models/aws_event_bridge_account_configuration.rb +105 -0
- data/lib/datadog_api_client/v1/models/aws_event_bridge_create_request.rb +112 -0
- data/lib/datadog_api_client/v1/models/aws_event_bridge_create_response.rb +110 -0
- data/lib/datadog_api_client/v1/models/aws_event_bridge_create_status.rb +26 -0
- data/lib/datadog_api_client/v1/models/aws_event_bridge_delete_request.rb +100 -0
- data/lib/datadog_api_client/v1/models/aws_event_bridge_delete_response.rb +80 -0
- data/lib/datadog_api_client/v1/models/aws_event_bridge_delete_status.rb +26 -0
- data/lib/datadog_api_client/v1/models/aws_event_bridge_list_response.rb +92 -0
- data/lib/datadog_api_client/v1/models/aws_event_bridge_source.rb +90 -0
- data/lib/datadog_api_client/v1/models/azure_account.rb +12 -1
- data/lib/datadog_api_client/v1/models/hourly_usage_attribution_usage_type.rb +27 -4
- data/lib/datadog_api_client/v1/models/ip_prefixes_global.rb +94 -0
- data/lib/datadog_api_client/v1/models/ip_ranges.rb +11 -1
- data/lib/datadog_api_client/v1/models/monitor_options.rb +1 -1
- data/lib/datadog_api_client/v1/models/monitor_options_custom_schedule.rb +82 -0
- data/lib/datadog_api_client/v1/models/monitor_options_custom_schedule_recurrence.rb +100 -0
- data/lib/datadog_api_client/v1/models/monitor_options_scheduling_options.rb +11 -1
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_supported_metrics.rb +46 -0
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_values.rb +465 -5
- data/lib/datadog_api_client/v1/models/powerpack_template_variable_contents.rb +131 -0
- data/lib/datadog_api_client/v1/models/powerpack_template_variables.rb +94 -0
- data/lib/datadog_api_client/v1/models/powerpack_widget_definition.rb +169 -0
- data/lib/datadog_api_client/v1/models/powerpack_widget_definition_type.rb +26 -0
- data/lib/datadog_api_client/v1/models/split_config.rb +181 -0
- data/lib/datadog_api_client/v1/models/split_config_sort_compute.rb +119 -0
- data/lib/datadog_api_client/v1/models/split_dimension.rb +98 -0
- data/lib/datadog_api_client/v1/models/split_graph_source_widget_definition.rb +70 -0
- data/lib/datadog_api_client/v1/models/split_graph_viz_size.rb +29 -0
- data/lib/datadog_api_client/v1/models/split_graph_widget_definition.rb +191 -0
- data/lib/datadog_api_client/v1/models/split_graph_widget_definition_type.rb +26 -0
- data/lib/datadog_api_client/v1/models/split_sort.rb +108 -0
- data/lib/datadog_api_client/v1/models/split_vector_entry_item.rb +125 -0
- data/lib/datadog_api_client/v1/models/toplist_widget_definition.rb +11 -1
- data/lib/datadog_api_client/v1/models/toplist_widget_display.rb +63 -0
- data/lib/datadog_api_client/v1/models/toplist_widget_flat.rb +98 -0
- data/lib/datadog_api_client/v1/models/toplist_widget_flat_type.rb +26 -0
- data/lib/datadog_api_client/v1/models/toplist_widget_legend.rb +28 -0
- data/lib/datadog_api_client/v1/models/toplist_widget_scaling.rb +27 -0
- data/lib/datadog_api_client/v1/models/toplist_widget_stacked.rb +119 -0
- data/lib/datadog_api_client/v1/models/toplist_widget_stacked_type.rb +26 -0
- data/lib/datadog_api_client/v1/models/toplist_widget_style.rb +90 -0
- data/lib/datadog_api_client/v1/models/usage_attribution_values.rb +4 -4
- data/lib/datadog_api_client/v1/models/usage_cloud_security_posture_management_hour.rb +8 -8
- data/lib/datadog_api_client/v1/models/usage_cloud_security_posture_management_response.rb +2 -2
- data/lib/datadog_api_client/v1/models/usage_summary_date.rb +158 -8
- data/lib/datadog_api_client/v1/models/usage_summary_date_org.rb +158 -8
- data/lib/datadog_api_client/v1/models/usage_summary_response.rb +158 -8
- data/lib/datadog_api_client/v1/models/widget_definition.rb +8 -6
- data/lib/datadog_api_client/v2/api/apm_retention_filters_api.rb +423 -0
- data/lib/datadog_api_client/v2/api/ci_visibility_pipelines_api.rb +4 -4
- data/lib/datadog_api_client/v2/api/ci_visibility_tests_api.rb +3 -3
- data/lib/datadog_api_client/v2/api/container_images_api.rb +129 -0
- data/lib/datadog_api_client/v2/api/containers_api.rb +129 -0
- data/lib/datadog_api_client/v2/api/incidents_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/key_management_api.rb +8 -0
- data/lib/datadog_api_client/v2/api/metrics_api.rb +6 -3
- data/lib/datadog_api_client/v2/api/powerpack_api.rb +383 -0
- data/lib/datadog_api_client/v2/api/roles_api.rb +2 -0
- data/lib/datadog_api_client/v2/api/security_monitoring_api.rb +66 -72
- data/lib/datadog_api_client/v2/api/service_definition_api.rb +2 -2
- data/lib/datadog_api_client/v2/api/service_scorecards_api.rb +457 -0
- data/lib/datadog_api_client/v2/api/teams_api.rb +2 -0
- data/lib/datadog_api_client/v2/api/usage_metering_api.rb +1 -1
- data/lib/datadog_api_client/v2/model_base.rb +5 -0
- data/lib/datadog_api_client/v2/models/apm_retention_filter_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/{mute_finding_request.rb → bulk_mute_findings_request.rb} +6 -6
- data/lib/datadog_api_client/v2/models/{mute_finding_request_attributes.rb → bulk_mute_findings_request_attributes.rb} +5 -5
- data/lib/datadog_api_client/v2/models/bulk_mute_findings_request_data.rb +161 -0
- data/lib/datadog_api_client/v2/models/bulk_mute_findings_request_meta.rb +82 -0
- data/lib/datadog_api_client/v2/models/bulk_mute_findings_request_meta_findings.rb +80 -0
- data/lib/datadog_api_client/v2/models/{mute_finding_request_properties.rb → bulk_mute_findings_request_properties.rb} +6 -6
- data/lib/datadog_api_client/v2/models/{mute_finding_response.rb → bulk_mute_findings_response.rb} +5 -5
- data/lib/datadog_api_client/v2/models/bulk_mute_findings_response_data.rb +90 -0
- data/lib/datadog_api_client/v2/models/{mute_finding_response_data.rb → container.rb} +9 -9
- data/lib/datadog_api_client/v2/models/container_attributes.rb +183 -0
- data/lib/datadog_api_client/v2/models/container_group.rb +110 -0
- data/lib/datadog_api_client/v2/models/container_group_attributes.rb +90 -0
- data/lib/datadog_api_client/v2/models/container_group_relationships.rb +80 -0
- data/lib/datadog_api_client/v2/models/container_group_relationships_link.rb +92 -0
- data/lib/datadog_api_client/v2/models/container_group_relationships_links.rb +80 -0
- data/lib/datadog_api_client/v2/models/container_group_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/container_image.rb +100 -0
- data/lib/datadog_api_client/v2/models/container_image_attributes.rb +261 -0
- data/lib/datadog_api_client/v2/models/container_image_flavor.rb +120 -0
- data/lib/datadog_api_client/v2/models/container_image_group.rb +110 -0
- data/lib/datadog_api_client/v2/models/container_image_group_attributes.rb +100 -0
- data/lib/datadog_api_client/v2/models/container_image_group_images_relationships_link.rb +92 -0
- data/lib/datadog_api_client/v2/models/container_image_group_relationships.rb +80 -0
- data/lib/datadog_api_client/v2/models/container_image_group_relationships_links.rb +80 -0
- data/lib/datadog_api_client/v2/models/container_image_group_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/container_image_item.rb +63 -0
- data/lib/datadog_api_client/v2/models/container_image_meta.rb +80 -0
- data/lib/datadog_api_client/v2/models/container_image_meta_page.rb +160 -0
- data/lib/datadog_api_client/v2/models/container_image_meta_page_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/container_image_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/container_image_vulnerabilities.rb +140 -0
- data/lib/datadog_api_client/v2/models/container_images_response.rb +102 -0
- data/lib/datadog_api_client/v2/models/container_images_response_links.rb +130 -0
- data/lib/datadog_api_client/v2/models/container_item.rb +63 -0
- data/lib/datadog_api_client/v2/models/container_meta.rb +80 -0
- data/lib/datadog_api_client/v2/models/container_meta_page.rb +160 -0
- data/lib/datadog_api_client/v2/models/container_meta_page_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/container_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/containers_response.rb +102 -0
- data/lib/datadog_api_client/v2/models/containers_response_links.rb +130 -0
- data/lib/datadog_api_client/v2/models/create_rule_request.rb +80 -0
- data/lib/datadog_api_client/v2/models/create_rule_request_data.rb +90 -0
- data/lib/datadog_api_client/v2/models/create_rule_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/create_rule_response_data.rb +110 -0
- data/lib/datadog_api_client/v2/models/data_scalar_column.rb +2 -2
- data/lib/datadog_api_client/v2/models/gcpsts_service_account_attributes.rb +13 -1
- data/lib/datadog_api_client/v2/models/group_scalar_column.rb +2 -2
- data/lib/datadog_api_client/v2/models/list_powerpacks_response.rb +114 -0
- data/lib/datadog_api_client/v2/models/list_rules_response.rb +92 -0
- data/lib/datadog_api_client/v2/models/list_rules_response_data_item.rb +110 -0
- data/lib/datadog_api_client/v2/models/list_rules_response_links.rb +80 -0
- data/lib/datadog_api_client/v2/models/metric_bulk_tag_config_create_attributes.rb +13 -1
- data/lib/datadog_api_client/v2/models/metric_bulk_tag_config_status_attributes.rb +12 -1
- data/lib/datadog_api_client/v2/models/metric_tag_configuration_attributes.rb +13 -1
- data/lib/datadog_api_client/v2/models/metric_tag_configuration_create_attributes.rb +13 -1
- data/lib/datadog_api_client/v2/models/metric_tag_configuration_update_attributes.rb +13 -1
- data/lib/datadog_api_client/v2/models/outcome_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/outcomes_batch_attributes.rb +82 -0
- data/lib/datadog_api_client/v2/models/outcomes_batch_request.rb +80 -0
- data/lib/datadog_api_client/v2/models/outcomes_batch_request_data.rb +90 -0
- data/lib/datadog_api_client/v2/models/outcomes_batch_request_item.rb +150 -0
- data/lib/datadog_api_client/v2/models/outcomes_batch_response.rb +121 -0
- data/lib/datadog_api_client/v2/models/outcomes_batch_response_attributes.rb +120 -0
- data/lib/datadog_api_client/v2/models/outcomes_batch_response_meta.rb +90 -0
- data/lib/datadog_api_client/v2/models/outcomes_batch_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/outcomes_response.rb +104 -0
- data/lib/datadog_api_client/v2/models/outcomes_response_data_item.rb +110 -0
- data/lib/datadog_api_client/v2/models/outcomes_response_included_item.rb +100 -0
- data/lib/datadog_api_client/v2/models/outcomes_response_included_rule_attributes.rb +90 -0
- data/lib/datadog_api_client/v2/models/outcomes_response_links.rb +80 -0
- data/lib/datadog_api_client/v2/models/powerpack.rb +80 -0
- data/lib/datadog_api_client/v2/models/powerpack_attributes.rb +164 -0
- data/lib/datadog_api_client/v2/models/powerpack_data.rb +110 -0
- data/lib/datadog_api_client/v2/models/powerpack_group_widget.rb +118 -0
- data/lib/datadog_api_client/v2/models/powerpack_group_widget_definition.rb +162 -0
- data/lib/datadog_api_client/v2/models/powerpack_group_widget_layout.rb +177 -0
- data/lib/datadog_api_client/v2/models/powerpack_inner_widget_layout.rb +177 -0
- data/lib/datadog_api_client/v2/models/powerpack_inner_widgets.rb +108 -0
- data/lib/datadog_api_client/v2/models/powerpack_relationships.rb +80 -0
- data/lib/datadog_api_client/v2/models/powerpack_response.rb +92 -0
- data/lib/datadog_api_client/v2/models/powerpack_response_links.rb +129 -0
- data/lib/datadog_api_client/v2/models/powerpack_template_variable.rb +110 -0
- data/lib/datadog_api_client/v2/models/powerpacks_response_meta.rb +80 -0
- data/lib/datadog_api_client/v2/models/powerpacks_response_meta_pagination.rb +150 -0
- data/lib/datadog_api_client/v2/models/relationship_to_outcome.rb +80 -0
- data/lib/datadog_api_client/v2/models/relationship_to_outcome_data.rb +90 -0
- data/lib/datadog_api_client/v2/models/relationship_to_rule.rb +80 -0
- data/lib/datadog_api_client/v2/models/relationship_to_rule_data.rb +80 -0
- data/lib/datadog_api_client/v2/models/relationship_to_rule_data_object.rb +90 -0
- data/lib/datadog_api_client/v2/models/reorder_retention_filters_request.rb +100 -0
- data/lib/datadog_api_client/v2/models/restriction_policy_binding.rb +1 -1
- data/lib/datadog_api_client/v2/models/{mute_finding_request_data.rb → retention_filter.rb} +9 -9
- data/lib/datadog_api_client/v2/models/retention_filter_all.rb +140 -0
- data/lib/datadog_api_client/v2/models/retention_filter_all_attributes.rb +181 -0
- data/lib/datadog_api_client/v2/models/retention_filter_all_type.rb +28 -0
- data/lib/datadog_api_client/v2/models/retention_filter_attributes.rb +181 -0
- data/lib/datadog_api_client/v2/models/retention_filter_create_attributes.rb +183 -0
- data/lib/datadog_api_client/v2/models/retention_filter_create_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/retention_filter_create_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/retention_filter_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/retention_filter_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/retention_filter_update_data.rb +140 -0
- data/lib/datadog_api_client/v2/models/retention_filter_update_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/retention_filter_without_attributes.rb +119 -0
- data/lib/datadog_api_client/v2/models/retention_filters_response.rb +100 -0
- data/lib/datadog_api_client/v2/models/rule_attributes.rb +160 -0
- data/lib/datadog_api_client/v2/models/rule_outcome_relationships.rb +80 -0
- data/lib/datadog_api_client/v2/models/rule_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/scalar_column_type_group.rb +26 -0
- data/lib/datadog_api_client/v2/models/scalar_column_type_number.rb +26 -0
- data/lib/datadog_api_client/v2/models/scalar_meta.rb +8 -0
- data/lib/datadog_api_client/v2/models/scorecard_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_attributes.rb +7 -7
- data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_query.rb +11 -1
- data/lib/datadog_api_client/v2/models/service_definition_schema.rb +2 -1
- data/lib/datadog_api_client/v2/models/service_definition_schema_versions.rb +1 -0
- data/lib/datadog_api_client/v2/models/service_definition_v2_dot2.rb +247 -0
- data/lib/datadog_api_client/v2/models/service_definition_v2_dot2_contact.rb +129 -0
- data/lib/datadog_api_client/v2/models/service_definition_v2_dot2_integrations.rb +90 -0
- data/lib/datadog_api_client/v2/models/service_definition_v2_dot2_link.rb +150 -0
- data/lib/datadog_api_client/v2/models/service_definition_v2_dot2_opsgenie.rb +108 -0
- data/lib/datadog_api_client/v2/models/service_definition_v2_dot2_opsgenie_region.rb +27 -0
- data/lib/datadog_api_client/v2/models/service_definition_v2_dot2_pagerduty.rb +80 -0
- data/lib/datadog_api_client/v2/models/service_definition_v2_dot2_type.rb +32 -0
- data/lib/datadog_api_client/v2/models/service_definition_v2_dot2_version.rb +26 -0
- data/lib/datadog_api_client/v2/models/service_definitions_create_request.rb +1 -0
- data/lib/datadog_api_client/v2/models/spans_filter.rb +80 -0
- data/lib/datadog_api_client/v2/models/spans_filter_create.rb +98 -0
- data/lib/datadog_api_client/v2/models/state.rb +28 -0
- data/lib/datadog_api_client/v2/models/teams_field.rb +40 -0
- data/lib/datadog_api_client/v2/models/user_team_permission_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/widget_live_span.rb +40 -0
- data/lib/datadog_api_client/version.rb +1 -1
- data/run-tests.sh +6 -5
- metadata +213 -32
- data/examples/v1/usage-metering/GetUsageCIApp_1064440884.rb +0 -8
- data/examples/v1/usage-metering/GetUsageCWS_736958514.rb +0 -8
- data/examples/v2/confluent-cloud/DeleteConfluentAccount_2919241291.rb +0 -8
- data/examples/v2/downtimes/ListMonitorDowntimes_128979780.rb +0 -5
- data/examples/v2/key-management/CreateCurrentUserApplicationKey_1999509896.rb +0 -14
- data/examples/v2/key-management/DeleteApplicationKey_771691550.rb +0 -8
- data/examples/v2/key-management/DeleteCurrentUserApplicationKey_1266687064.rb +0 -8
- data/examples/v2/key-management/GetCurrentUserApplicationKey_1060640890.rb +0 -8
- data/examples/v2/key-management/ListApplicationKeys_2237010090.rb +0 -5
- data/examples/v2/key-management/ListCurrentUserApplicationKeys_1503860964.rb +0 -5
- data/examples/v2/security-monitoring/UpdateFinding.rb +0 -23
- data/examples/v2/service-accounts/CreateServiceAccountApplicationKey_1761876297.rb +0 -17
- data/examples/v2/service-accounts/DeleteServiceAccountApplicationKey_992091161.rb +0 -11
- data/examples/v2/service-accounts/GetServiceAccountApplicationKey_819075131.rb +0 -11
- data/examples/v2/service-accounts/ListServiceAccountApplicationKeys_1268914341.rb +0 -8
- data/examples/v2/service-accounts/UpdateServiceAccountApplicationKey_768415790.rb +0 -22
- data/examples/v2/synthetics/GetOnDemandConcurrencyCap_2633566918.rb +0 -5
- data/examples/v2/synthetics/SetOnDemandConcurrencyCap_2850884405.rb +0 -9
- data/examples/v2/usage-metering/GetUsageApplicationSecurityMonitoring_3959166796.rb +0 -8
- data/examples/v2/usage-metering/GetUsageLambdaTracedInvocations_1436752065.rb +0 -8
- data/examples/v2/usage-metering/GetUsageObservabilityPipelines_970725512.rb +0 -8
- data/examples/v2/users/GetUser_3047557953.rb +0 -8
- data/lib/datadog_api_client/v2/models/mute_finding_response_attributes.rb +0 -191
- data/lib/datadog_api_client/v2/models/mute_finding_response_properties.rb +0 -114
|
@@ -4,6 +4,13 @@ components:
|
|
|
4
4
|
headers: {}
|
|
5
5
|
links: {}
|
|
6
6
|
parameters:
|
|
7
|
+
APIKeyCategoryParameter:
|
|
8
|
+
description: Filter API keys by category.
|
|
9
|
+
in: query
|
|
10
|
+
name: filter[category]
|
|
11
|
+
required: false
|
|
12
|
+
schema:
|
|
13
|
+
type: string
|
|
7
14
|
APIKeyFilterCreatedAtEndParameter:
|
|
8
15
|
description: Only include API keys created on or before the specified date.
|
|
9
16
|
in: query
|
|
@@ -59,6 +66,13 @@ components:
|
|
|
59
66
|
schema:
|
|
60
67
|
example: created_by,modified_by
|
|
61
68
|
type: string
|
|
69
|
+
APIKeyReadConfigReadEnabledParameter:
|
|
70
|
+
description: Filter API keys by remote config read enabled status.
|
|
71
|
+
in: query
|
|
72
|
+
name: filter[remote_config_read_enabled]
|
|
73
|
+
required: false
|
|
74
|
+
schema:
|
|
75
|
+
type: boolean
|
|
62
76
|
APIKeysSortParameter:
|
|
63
77
|
description: 'API key attribute used to sort results. Sort order is ascending
|
|
64
78
|
|
|
@@ -234,21 +248,13 @@ components:
|
|
|
234
248
|
schema:
|
|
235
249
|
$ref: '#/components/schemas/IncidentRelatedObject'
|
|
236
250
|
IncidentSearchQueryQueryParameter:
|
|
237
|
-
description: 'Specifies which incidents should be returned.
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
use the query parameter value in the URL of the page as the value for this
|
|
241
|
-
parameter.
|
|
251
|
+
description: 'Specifies which incidents should be returned. The query can contain
|
|
252
|
+
any number of incident facets
|
|
242
253
|
|
|
254
|
+
joined by `ANDs`, along with multiple values for each of those facets joined
|
|
255
|
+
by `OR`s. For
|
|
243
256
|
|
|
244
|
-
|
|
245
|
-
with multiple values for each of
|
|
246
|
-
|
|
247
|
-
those facets joined by `OR`s, for instance: `query="state:active AND severity:(SEV-2
|
|
248
|
-
OR SEV-1)"`.
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
[1]: https://app.datadoghq.com/incidents'
|
|
257
|
+
example: `state:active AND severity:(SEV-2 OR SEV-1)`.'
|
|
252
258
|
explode: false
|
|
253
259
|
in: query
|
|
254
260
|
name: query
|
|
@@ -377,6 +383,13 @@ components:
|
|
|
377
383
|
required: true
|
|
378
384
|
schema:
|
|
379
385
|
type: string
|
|
386
|
+
RetentionFilterIdParam:
|
|
387
|
+
description: The ID of the retention filter.
|
|
388
|
+
in: path
|
|
389
|
+
name: filter_id
|
|
390
|
+
required: true
|
|
391
|
+
schema:
|
|
392
|
+
type: string
|
|
380
393
|
RoleID:
|
|
381
394
|
description: The unique identifier of the role.
|
|
382
395
|
in: path
|
|
@@ -384,6 +397,13 @@ components:
|
|
|
384
397
|
required: true
|
|
385
398
|
schema:
|
|
386
399
|
type: string
|
|
400
|
+
RuleId:
|
|
401
|
+
description: The ID of the rule/scorecard.
|
|
402
|
+
in: path
|
|
403
|
+
name: rule_id
|
|
404
|
+
required: true
|
|
405
|
+
schema:
|
|
406
|
+
type: string
|
|
387
407
|
SchemaVersion:
|
|
388
408
|
description: The schema version desired in the response.
|
|
389
409
|
in: query
|
|
@@ -701,6 +721,15 @@ components:
|
|
|
701
721
|
type: string
|
|
702
722
|
x-enum-varnames:
|
|
703
723
|
- API_KEYS
|
|
724
|
+
ApmRetentionFilterType:
|
|
725
|
+
default: apm_retention_filter
|
|
726
|
+
description: The type of the resource.
|
|
727
|
+
enum:
|
|
728
|
+
- apm_retention_filter
|
|
729
|
+
example: apm_retention_filter
|
|
730
|
+
type: string
|
|
731
|
+
x-enum-varnames:
|
|
732
|
+
- apm_retention_filter
|
|
704
733
|
ApplicationKeyCreateAttributes:
|
|
705
734
|
description: Attributes used to create an application Key.
|
|
706
735
|
properties:
|
|
@@ -1261,6 +1290,104 @@ components:
|
|
|
1261
1290
|
type: string
|
|
1262
1291
|
x-enum-varnames:
|
|
1263
1292
|
- AUTHN_MAPPINGS
|
|
1293
|
+
BulkMuteFindingsRequest:
|
|
1294
|
+
description: The new bulk mute finding request.
|
|
1295
|
+
properties:
|
|
1296
|
+
data:
|
|
1297
|
+
$ref: '#/components/schemas/BulkMuteFindingsRequestData'
|
|
1298
|
+
required:
|
|
1299
|
+
- data
|
|
1300
|
+
type: object
|
|
1301
|
+
BulkMuteFindingsRequestAttributes:
|
|
1302
|
+
additionalProperties: false
|
|
1303
|
+
description: The mute properties to be updated.
|
|
1304
|
+
properties:
|
|
1305
|
+
mute:
|
|
1306
|
+
$ref: '#/components/schemas/BulkMuteFindingsRequestProperties'
|
|
1307
|
+
required:
|
|
1308
|
+
- mute
|
|
1309
|
+
type: object
|
|
1310
|
+
BulkMuteFindingsRequestData:
|
|
1311
|
+
description: Data object containing the new bulk mute properties of the finding.
|
|
1312
|
+
properties:
|
|
1313
|
+
attributes:
|
|
1314
|
+
$ref: '#/components/schemas/BulkMuteFindingsRequestAttributes'
|
|
1315
|
+
id:
|
|
1316
|
+
description: UUID to identify the request
|
|
1317
|
+
example: dbe5f567-192b-4404-b908-29b70e1c9f76
|
|
1318
|
+
type: string
|
|
1319
|
+
meta:
|
|
1320
|
+
$ref: '#/components/schemas/BulkMuteFindingsRequestMeta'
|
|
1321
|
+
type:
|
|
1322
|
+
$ref: '#/components/schemas/FindingType'
|
|
1323
|
+
required:
|
|
1324
|
+
- id
|
|
1325
|
+
- type
|
|
1326
|
+
- attributes
|
|
1327
|
+
- meta
|
|
1328
|
+
type: object
|
|
1329
|
+
BulkMuteFindingsRequestMeta:
|
|
1330
|
+
description: Meta object containing the findings to be updated.
|
|
1331
|
+
properties:
|
|
1332
|
+
findings:
|
|
1333
|
+
description: Array of findings.
|
|
1334
|
+
items:
|
|
1335
|
+
$ref: '#/components/schemas/BulkMuteFindingsRequestMetaFindings'
|
|
1336
|
+
type: array
|
|
1337
|
+
type: object
|
|
1338
|
+
BulkMuteFindingsRequestMetaFindings:
|
|
1339
|
+
description: Finding object containing the finding information.
|
|
1340
|
+
properties:
|
|
1341
|
+
finding_id:
|
|
1342
|
+
$ref: '#/components/schemas/FindingID'
|
|
1343
|
+
type: object
|
|
1344
|
+
BulkMuteFindingsRequestProperties:
|
|
1345
|
+
additionalProperties: false
|
|
1346
|
+
description: Object containing the new mute properties of the findings.
|
|
1347
|
+
properties:
|
|
1348
|
+
description:
|
|
1349
|
+
description: Additional information about the reason why those findings
|
|
1350
|
+
are muted or unmuted. This field has a maximum limit of 280 characters.
|
|
1351
|
+
type: string
|
|
1352
|
+
expiration_date:
|
|
1353
|
+
description: 'The expiration date of the mute or unmute action (Unix ms).
|
|
1354
|
+
It must be set to a value greater than the current timestamp.
|
|
1355
|
+
|
|
1356
|
+
If this field is not provided, the finding will be muted or unmuted indefinitely,
|
|
1357
|
+
which is equivalent to setting the expiration date to 9999999999999.
|
|
1358
|
+
|
|
1359
|
+
'
|
|
1360
|
+
example: 1778721573794
|
|
1361
|
+
format: int64
|
|
1362
|
+
type: integer
|
|
1363
|
+
muted:
|
|
1364
|
+
description: Whether those findings should be muted or unmuted.
|
|
1365
|
+
example: true
|
|
1366
|
+
type: boolean
|
|
1367
|
+
reason:
|
|
1368
|
+
$ref: '#/components/schemas/FindingMuteReason'
|
|
1369
|
+
required:
|
|
1370
|
+
- muted
|
|
1371
|
+
- reason
|
|
1372
|
+
type: object
|
|
1373
|
+
BulkMuteFindingsResponse:
|
|
1374
|
+
description: The expected response schema.
|
|
1375
|
+
properties:
|
|
1376
|
+
data:
|
|
1377
|
+
$ref: '#/components/schemas/BulkMuteFindingsResponseData'
|
|
1378
|
+
required:
|
|
1379
|
+
- data
|
|
1380
|
+
type: object
|
|
1381
|
+
BulkMuteFindingsResponseData:
|
|
1382
|
+
description: Data object containing the ID of the request that was updated.
|
|
1383
|
+
properties:
|
|
1384
|
+
id:
|
|
1385
|
+
description: UUID used to identify the request
|
|
1386
|
+
example: 93bfeb70-af47-424d-908a-948d3f08e37f
|
|
1387
|
+
type: string
|
|
1388
|
+
type:
|
|
1389
|
+
$ref: '#/components/schemas/FindingType'
|
|
1390
|
+
type: object
|
|
1264
1391
|
CIAppAggregateBucketValue:
|
|
1265
1392
|
description: A bucket value, can either be a timeseries or a single value.
|
|
1266
1393
|
oneOf:
|
|
@@ -1760,7 +1887,6 @@ components:
|
|
|
1760
1887
|
- end
|
|
1761
1888
|
- status
|
|
1762
1889
|
- url
|
|
1763
|
-
- git
|
|
1764
1890
|
type: object
|
|
1765
1891
|
CIAppPipelineEventJobLevel:
|
|
1766
1892
|
default: job
|
|
@@ -1913,7 +2039,6 @@ components:
|
|
|
1913
2039
|
- end
|
|
1914
2040
|
- status
|
|
1915
2041
|
- partial_retry
|
|
1916
|
-
- git
|
|
1917
2042
|
type: object
|
|
1918
2043
|
CIAppPipelineEventPipelineLevel:
|
|
1919
2044
|
default: pipeline
|
|
@@ -2029,7 +2154,6 @@ components:
|
|
|
2029
2154
|
- start
|
|
2030
2155
|
- end
|
|
2031
2156
|
- status
|
|
2032
|
-
- git
|
|
2033
2157
|
type: object
|
|
2034
2158
|
CIAppPipelineEventStageLevel:
|
|
2035
2159
|
default: stage
|
|
@@ -2129,7 +2253,6 @@ components:
|
|
|
2129
2253
|
- start
|
|
2130
2254
|
- end
|
|
2131
2255
|
- status
|
|
2132
|
-
- git
|
|
2133
2256
|
type: object
|
|
2134
2257
|
CIAppPipelineEventStepLevel:
|
|
2135
2258
|
default: step
|
|
@@ -3437,148 +3560,691 @@ components:
|
|
|
3437
3560
|
$ref: '#/components/schemas/ConfluentResourceResponseData'
|
|
3438
3561
|
type: array
|
|
3439
3562
|
type: object
|
|
3440
|
-
|
|
3441
|
-
description:
|
|
3442
|
-
enum:
|
|
3443
|
-
- identity
|
|
3444
|
-
- gzip
|
|
3445
|
-
- deflate
|
|
3446
|
-
type: string
|
|
3447
|
-
x-enum-varnames:
|
|
3448
|
-
- IDENTITY
|
|
3449
|
-
- GZIP
|
|
3450
|
-
- DEFLATE
|
|
3451
|
-
CostByOrg:
|
|
3452
|
-
description: Cost data.
|
|
3563
|
+
Container:
|
|
3564
|
+
description: Container object.
|
|
3453
3565
|
properties:
|
|
3454
3566
|
attributes:
|
|
3455
|
-
$ref: '#/components/schemas/
|
|
3567
|
+
$ref: '#/components/schemas/ContainerAttributes'
|
|
3456
3568
|
id:
|
|
3457
|
-
description:
|
|
3569
|
+
description: Container ID.
|
|
3458
3570
|
type: string
|
|
3459
3571
|
type:
|
|
3460
|
-
$ref: '#/components/schemas/
|
|
3572
|
+
$ref: '#/components/schemas/ContainerType'
|
|
3461
3573
|
type: object
|
|
3462
|
-
|
|
3463
|
-
description:
|
|
3574
|
+
ContainerAttributes:
|
|
3575
|
+
description: Attributes for a container.
|
|
3464
3576
|
properties:
|
|
3465
|
-
|
|
3466
|
-
description:
|
|
3577
|
+
container_id:
|
|
3578
|
+
description: The ID of the container.
|
|
3579
|
+
type: string
|
|
3580
|
+
created_at:
|
|
3581
|
+
description: Time the container was created.
|
|
3582
|
+
type: string
|
|
3583
|
+
host:
|
|
3584
|
+
description: Hostname of the host running the container.
|
|
3585
|
+
type: string
|
|
3586
|
+
image_digest:
|
|
3587
|
+
description: Digest of the compressed image manifest.
|
|
3588
|
+
nullable: true
|
|
3589
|
+
type: string
|
|
3590
|
+
image_name:
|
|
3591
|
+
description: Name of the associated container image.
|
|
3592
|
+
type: string
|
|
3593
|
+
image_tags:
|
|
3594
|
+
description: List of image tags associated with the container image.
|
|
3467
3595
|
items:
|
|
3468
|
-
|
|
3596
|
+
type: string
|
|
3597
|
+
nullable: true
|
|
3469
3598
|
type: array
|
|
3470
|
-
|
|
3471
|
-
description:
|
|
3472
|
-
format: date-time
|
|
3599
|
+
name:
|
|
3600
|
+
description: Name of the container.
|
|
3473
3601
|
type: string
|
|
3474
|
-
|
|
3475
|
-
description:
|
|
3602
|
+
started_at:
|
|
3603
|
+
description: Time the container was started.
|
|
3476
3604
|
type: string
|
|
3477
|
-
|
|
3478
|
-
description:
|
|
3605
|
+
state:
|
|
3606
|
+
description: State of the container. This depends on the container runtime.
|
|
3479
3607
|
type: string
|
|
3480
|
-
|
|
3481
|
-
description:
|
|
3482
|
-
|
|
3608
|
+
tags:
|
|
3609
|
+
description: List of tags associated with the container.
|
|
3610
|
+
items:
|
|
3611
|
+
type: string
|
|
3612
|
+
type: array
|
|
3613
|
+
type: object
|
|
3614
|
+
ContainerGroup:
|
|
3615
|
+
description: Container group object.
|
|
3616
|
+
properties:
|
|
3617
|
+
attributes:
|
|
3618
|
+
$ref: '#/components/schemas/ContainerGroupAttributes'
|
|
3619
|
+
id:
|
|
3620
|
+
description: Container Group ID.
|
|
3483
3621
|
type: string
|
|
3484
|
-
|
|
3485
|
-
|
|
3486
|
-
|
|
3487
|
-
|
|
3622
|
+
relationships:
|
|
3623
|
+
$ref: '#/components/schemas/ContainerGroupRelationships'
|
|
3624
|
+
type:
|
|
3625
|
+
$ref: '#/components/schemas/ContainerGroupType'
|
|
3488
3626
|
type: object
|
|
3489
|
-
|
|
3490
|
-
description:
|
|
3627
|
+
ContainerGroupAttributes:
|
|
3628
|
+
description: Attributes for a container group.
|
|
3629
|
+
properties:
|
|
3630
|
+
count:
|
|
3631
|
+
description: Number of containers in the group.
|
|
3632
|
+
format: int64
|
|
3633
|
+
type: integer
|
|
3634
|
+
tags:
|
|
3635
|
+
description: Tags from the group name parsed in key/value format.
|
|
3636
|
+
type: object
|
|
3637
|
+
type: object
|
|
3638
|
+
ContainerGroupRelationships:
|
|
3639
|
+
description: Relationships to containers inside a container group.
|
|
3640
|
+
properties:
|
|
3641
|
+
containers:
|
|
3642
|
+
$ref: '#/components/schemas/ContainerGroupRelationshipsLink'
|
|
3643
|
+
type: object
|
|
3644
|
+
ContainerGroupRelationshipsData:
|
|
3645
|
+
description: Links data.
|
|
3646
|
+
items:
|
|
3647
|
+
description: A link data.
|
|
3648
|
+
type: string
|
|
3649
|
+
type: array
|
|
3650
|
+
ContainerGroupRelationshipsLink:
|
|
3651
|
+
description: Relationships to Containers inside a Container Group.
|
|
3491
3652
|
properties:
|
|
3492
3653
|
data:
|
|
3493
|
-
|
|
3494
|
-
|
|
3495
|
-
|
|
3496
|
-
type: array
|
|
3654
|
+
$ref: '#/components/schemas/ContainerGroupRelationshipsData'
|
|
3655
|
+
links:
|
|
3656
|
+
$ref: '#/components/schemas/ContainerGroupRelationshipsLinks'
|
|
3497
3657
|
type: object
|
|
3498
|
-
|
|
3499
|
-
|
|
3500
|
-
|
|
3658
|
+
ContainerGroupRelationshipsLinks:
|
|
3659
|
+
description: Links attributes.
|
|
3660
|
+
properties:
|
|
3661
|
+
related:
|
|
3662
|
+
description: Link to related containers.
|
|
3663
|
+
type: string
|
|
3664
|
+
type: object
|
|
3665
|
+
ContainerGroupType:
|
|
3666
|
+
default: container_group
|
|
3667
|
+
description: Type of container group.
|
|
3501
3668
|
enum:
|
|
3502
|
-
-
|
|
3503
|
-
example:
|
|
3669
|
+
- container_group
|
|
3670
|
+
example: container_group
|
|
3504
3671
|
type: string
|
|
3505
3672
|
x-enum-varnames:
|
|
3506
|
-
-
|
|
3507
|
-
|
|
3508
|
-
description:
|
|
3673
|
+
- CONTAINER_GROUP
|
|
3674
|
+
ContainerImage:
|
|
3675
|
+
description: Container Image object.
|
|
3509
3676
|
properties:
|
|
3510
|
-
|
|
3511
|
-
|
|
3512
|
-
|
|
3513
|
-
|
|
3514
|
-
description: Handle of the creator.
|
|
3515
|
-
type: string
|
|
3516
|
-
name:
|
|
3517
|
-
description: Name of the creator.
|
|
3518
|
-
nullable: true
|
|
3677
|
+
attributes:
|
|
3678
|
+
$ref: '#/components/schemas/ContainerImageAttributes'
|
|
3679
|
+
id:
|
|
3680
|
+
description: Container Image ID.
|
|
3519
3681
|
type: string
|
|
3682
|
+
type:
|
|
3683
|
+
$ref: '#/components/schemas/ContainerImageType'
|
|
3520
3684
|
type: object
|
|
3521
|
-
|
|
3522
|
-
description:
|
|
3685
|
+
ContainerImageAttributes:
|
|
3686
|
+
description: Attributes for a Container Image.
|
|
3523
3687
|
properties:
|
|
3524
|
-
|
|
3525
|
-
description:
|
|
3688
|
+
container_count:
|
|
3689
|
+
description: Number of containers running the image.
|
|
3690
|
+
format: int64
|
|
3691
|
+
type: integer
|
|
3692
|
+
image_flavors:
|
|
3693
|
+
description: 'List of platform-specific images associated with the image
|
|
3694
|
+
record.
|
|
3695
|
+
|
|
3696
|
+
The list contains more than 1 entry for multi-architecture images.'
|
|
3526
3697
|
items:
|
|
3527
|
-
$ref: '#/components/schemas/
|
|
3698
|
+
$ref: '#/components/schemas/ContainerImageFlavor'
|
|
3528
3699
|
type: array
|
|
3529
|
-
|
|
3530
|
-
|
|
3531
|
-
description: Response containing a list of added dashboards.
|
|
3532
|
-
properties:
|
|
3533
|
-
added_dashboards_to_list:
|
|
3534
|
-
description: List of dashboards added to the dashboard list.
|
|
3700
|
+
image_tags:
|
|
3701
|
+
description: List of image tags associated with the Container Image.
|
|
3535
3702
|
items:
|
|
3536
|
-
|
|
3703
|
+
description: An image tag associated with the Container Image.
|
|
3704
|
+
type: string
|
|
3537
3705
|
type: array
|
|
3538
|
-
|
|
3539
|
-
|
|
3540
|
-
|
|
3541
|
-
|
|
3542
|
-
dashboards:
|
|
3543
|
-
description: List of dashboards to delete from the dashboard list.
|
|
3706
|
+
images_built_at:
|
|
3707
|
+
description: 'List of build times associated with the Container Image.
|
|
3708
|
+
|
|
3709
|
+
The list contains more than 1 entry for multi-architecture images.'
|
|
3544
3710
|
items:
|
|
3545
|
-
|
|
3711
|
+
description: Time the platform-specific Container Image was built.
|
|
3712
|
+
type: string
|
|
3546
3713
|
type: array
|
|
3547
|
-
|
|
3548
|
-
|
|
3549
|
-
|
|
3550
|
-
|
|
3551
|
-
|
|
3552
|
-
|
|
3714
|
+
name:
|
|
3715
|
+
description: Name of the Container Image.
|
|
3716
|
+
type: string
|
|
3717
|
+
os_architectures:
|
|
3718
|
+
description: List of Operating System architectures supported by the Container
|
|
3719
|
+
Image.
|
|
3553
3720
|
items:
|
|
3554
|
-
|
|
3721
|
+
description: Operating System architecture supported by the Container
|
|
3722
|
+
Image.
|
|
3723
|
+
example: amd64
|
|
3724
|
+
type: string
|
|
3555
3725
|
type: array
|
|
3556
|
-
|
|
3557
|
-
|
|
3558
|
-
|
|
3559
|
-
|
|
3560
|
-
|
|
3561
|
-
|
|
3562
|
-
|
|
3563
|
-
|
|
3564
|
-
|
|
3565
|
-
|
|
3726
|
+
os_names:
|
|
3727
|
+
description: List of Operating System names supported by the Container Image.
|
|
3728
|
+
items:
|
|
3729
|
+
description: Operating System supported by the Container Image.
|
|
3730
|
+
example: linux
|
|
3731
|
+
type: string
|
|
3732
|
+
type: array
|
|
3733
|
+
os_versions:
|
|
3734
|
+
description: List of Operating System versions supported by the Container
|
|
3735
|
+
Image.
|
|
3736
|
+
items:
|
|
3737
|
+
description: Operating System version supported by the Container Image.
|
|
3738
|
+
type: string
|
|
3739
|
+
type: array
|
|
3740
|
+
published_at:
|
|
3741
|
+
description: Time the image was pushed to the container registry.
|
|
3566
3742
|
type: string
|
|
3567
|
-
|
|
3568
|
-
description:
|
|
3569
|
-
nullable: true
|
|
3570
|
-
readOnly: true
|
|
3743
|
+
registry:
|
|
3744
|
+
description: Registry the Container Image was pushed to.
|
|
3571
3745
|
type: string
|
|
3572
|
-
|
|
3573
|
-
description:
|
|
3574
|
-
example: q5j-nti-fv6
|
|
3746
|
+
repo_digest:
|
|
3747
|
+
description: Digest of the compressed image manifest.
|
|
3575
3748
|
type: string
|
|
3576
|
-
|
|
3577
|
-
description:
|
|
3578
|
-
nullable: true
|
|
3579
|
-
readOnly: true
|
|
3749
|
+
repository:
|
|
3750
|
+
description: Repository where the Container Image is stored in.
|
|
3580
3751
|
type: string
|
|
3581
|
-
|
|
3752
|
+
short_image:
|
|
3753
|
+
description: Short version of the Container Image name.
|
|
3754
|
+
type: string
|
|
3755
|
+
sizes:
|
|
3756
|
+
description: 'List of size for each platform-specific image associated with
|
|
3757
|
+
the image record.
|
|
3758
|
+
|
|
3759
|
+
The list contains more than 1 entry for multi-architecture images.'
|
|
3760
|
+
items:
|
|
3761
|
+
description: Size of the platform-specific Container Image.
|
|
3762
|
+
format: int64
|
|
3763
|
+
type: integer
|
|
3764
|
+
type: array
|
|
3765
|
+
sources:
|
|
3766
|
+
description: List of sources where the Container Image was collected from.
|
|
3767
|
+
items:
|
|
3768
|
+
description: Source where the Container Image was collected from.
|
|
3769
|
+
type: string
|
|
3770
|
+
type: array
|
|
3771
|
+
tags:
|
|
3772
|
+
description: List of tags associated with the Container Image.
|
|
3773
|
+
items:
|
|
3774
|
+
description: A tag associated with the Container Image.
|
|
3775
|
+
type: string
|
|
3776
|
+
type: array
|
|
3777
|
+
vulnerability_count:
|
|
3778
|
+
$ref: '#/components/schemas/ContainerImageVulnerabilities'
|
|
3779
|
+
type: object
|
|
3780
|
+
ContainerImageFlavor:
|
|
3781
|
+
description: Container Image breakdown by supported platform.
|
|
3782
|
+
properties:
|
|
3783
|
+
built_at:
|
|
3784
|
+
description: Time the platform-specific Container Image was built.
|
|
3785
|
+
type: string
|
|
3786
|
+
os_architecture:
|
|
3787
|
+
description: Operating System architecture supported by the Container Image.
|
|
3788
|
+
type: string
|
|
3789
|
+
os_name:
|
|
3790
|
+
description: Operating System name supported by the Container Image.
|
|
3791
|
+
type: string
|
|
3792
|
+
os_version:
|
|
3793
|
+
description: Operating System version supported by the Container Image.
|
|
3794
|
+
type: string
|
|
3795
|
+
size:
|
|
3796
|
+
description: Size of the platform-specific Container Image.
|
|
3797
|
+
format: int64
|
|
3798
|
+
type: integer
|
|
3799
|
+
type: object
|
|
3800
|
+
ContainerImageGroup:
|
|
3801
|
+
description: Container Image Group object.
|
|
3802
|
+
properties:
|
|
3803
|
+
attributes:
|
|
3804
|
+
$ref: '#/components/schemas/ContainerImageGroupAttributes'
|
|
3805
|
+
id:
|
|
3806
|
+
description: Container Image Group ID.
|
|
3807
|
+
type: string
|
|
3808
|
+
relationships:
|
|
3809
|
+
$ref: '#/components/schemas/ContainerImageGroupRelationships'
|
|
3810
|
+
type:
|
|
3811
|
+
$ref: '#/components/schemas/ContainerImageGroupType'
|
|
3812
|
+
type: object
|
|
3813
|
+
ContainerImageGroupAttributes:
|
|
3814
|
+
description: Attributes for a Container Image Group.
|
|
3815
|
+
properties:
|
|
3816
|
+
count:
|
|
3817
|
+
description: Number of Container Images in the group.
|
|
3818
|
+
format: int64
|
|
3819
|
+
type: integer
|
|
3820
|
+
name:
|
|
3821
|
+
description: Name of the Container Image group.
|
|
3822
|
+
type: string
|
|
3823
|
+
tags:
|
|
3824
|
+
description: Tags from the group name parsed in key/value format.
|
|
3825
|
+
type: object
|
|
3826
|
+
type: object
|
|
3827
|
+
ContainerImageGroupImagesRelationshipsLink:
|
|
3828
|
+
description: Relationships to Container Images inside a Container Image Group.
|
|
3829
|
+
properties:
|
|
3830
|
+
data:
|
|
3831
|
+
$ref: '#/components/schemas/ContainerImageGroupRelationshipsData'
|
|
3832
|
+
links:
|
|
3833
|
+
$ref: '#/components/schemas/ContainerImageGroupRelationshipsLinks'
|
|
3834
|
+
type: object
|
|
3835
|
+
ContainerImageGroupRelationships:
|
|
3836
|
+
description: Relationships inside a Container Image Group.
|
|
3837
|
+
properties:
|
|
3838
|
+
container_images:
|
|
3839
|
+
$ref: '#/components/schemas/ContainerImageGroupImagesRelationshipsLink'
|
|
3840
|
+
type: object
|
|
3841
|
+
ContainerImageGroupRelationshipsData:
|
|
3842
|
+
description: Links data.
|
|
3843
|
+
items:
|
|
3844
|
+
description: A link data.
|
|
3845
|
+
type: string
|
|
3846
|
+
type: array
|
|
3847
|
+
ContainerImageGroupRelationshipsLinks:
|
|
3848
|
+
description: Links attributes.
|
|
3849
|
+
properties:
|
|
3850
|
+
related:
|
|
3851
|
+
description: Link to related Container Images.
|
|
3852
|
+
type: string
|
|
3853
|
+
type: object
|
|
3854
|
+
ContainerImageGroupType:
|
|
3855
|
+
default: container_image_group
|
|
3856
|
+
description: Type of Container Image Group.
|
|
3857
|
+
enum:
|
|
3858
|
+
- container_image_group
|
|
3859
|
+
example: container_image_group
|
|
3860
|
+
type: string
|
|
3861
|
+
x-enum-varnames:
|
|
3862
|
+
- CONTAINER_IMAGE_GROUP
|
|
3863
|
+
ContainerImageItem:
|
|
3864
|
+
description: Possible Container Image models.
|
|
3865
|
+
oneOf:
|
|
3866
|
+
- $ref: '#/components/schemas/ContainerImage'
|
|
3867
|
+
- $ref: '#/components/schemas/ContainerImageGroup'
|
|
3868
|
+
ContainerImageMeta:
|
|
3869
|
+
description: Response metadata object.
|
|
3870
|
+
properties:
|
|
3871
|
+
pagination:
|
|
3872
|
+
$ref: '#/components/schemas/ContainerImageMetaPage'
|
|
3873
|
+
type: object
|
|
3874
|
+
ContainerImageMetaPage:
|
|
3875
|
+
description: Paging attributes.
|
|
3876
|
+
properties:
|
|
3877
|
+
cursor:
|
|
3878
|
+
description: The cursor used to get the current results, if any.
|
|
3879
|
+
type: string
|
|
3880
|
+
limit:
|
|
3881
|
+
description: Number of results returned
|
|
3882
|
+
format: int32
|
|
3883
|
+
maximum: 10000
|
|
3884
|
+
minimum: 0
|
|
3885
|
+
type: integer
|
|
3886
|
+
next_cursor:
|
|
3887
|
+
description: The cursor used to get the next results, if any.
|
|
3888
|
+
type: string
|
|
3889
|
+
prev_cursor:
|
|
3890
|
+
description: The cursor used to get the previous results, if any.
|
|
3891
|
+
nullable: true
|
|
3892
|
+
type: string
|
|
3893
|
+
total:
|
|
3894
|
+
description: Total number of records that match the query.
|
|
3895
|
+
format: int64
|
|
3896
|
+
type: integer
|
|
3897
|
+
type:
|
|
3898
|
+
$ref: '#/components/schemas/ContainerImageMetaPageType'
|
|
3899
|
+
type: object
|
|
3900
|
+
ContainerImageMetaPageType:
|
|
3901
|
+
default: cursor_limit
|
|
3902
|
+
description: Type of Container Image pagination.
|
|
3903
|
+
enum:
|
|
3904
|
+
- cursor_limit
|
|
3905
|
+
example: cursor_limit
|
|
3906
|
+
type: string
|
|
3907
|
+
x-enum-varnames:
|
|
3908
|
+
- CURSOR_LIMIT
|
|
3909
|
+
ContainerImageType:
|
|
3910
|
+
default: container_image
|
|
3911
|
+
description: Type of Container Image.
|
|
3912
|
+
enum:
|
|
3913
|
+
- container_image
|
|
3914
|
+
example: container_image
|
|
3915
|
+
type: string
|
|
3916
|
+
x-enum-varnames:
|
|
3917
|
+
- CONTAINER_IMAGE
|
|
3918
|
+
ContainerImageVulnerabilities:
|
|
3919
|
+
description: Vulnerability counts associated with the Container Image.
|
|
3920
|
+
properties:
|
|
3921
|
+
asset_id:
|
|
3922
|
+
description: ID of the Container Image.
|
|
3923
|
+
type: string
|
|
3924
|
+
critical:
|
|
3925
|
+
description: Number of vulnerabilities with CVSS Critical severity.
|
|
3926
|
+
format: int64
|
|
3927
|
+
type: integer
|
|
3928
|
+
high:
|
|
3929
|
+
description: Number of vulnerabilities with CVSS High severity.
|
|
3930
|
+
format: int64
|
|
3931
|
+
type: integer
|
|
3932
|
+
low:
|
|
3933
|
+
description: Number of vulnerabilities with CVSS Low severity.
|
|
3934
|
+
format: int64
|
|
3935
|
+
type: integer
|
|
3936
|
+
medium:
|
|
3937
|
+
description: Number of vulnerabilities with CVSS Medium severity.
|
|
3938
|
+
format: int64
|
|
3939
|
+
type: integer
|
|
3940
|
+
none:
|
|
3941
|
+
description: Number of vulnerabilities with CVSS None severity.
|
|
3942
|
+
format: int64
|
|
3943
|
+
type: integer
|
|
3944
|
+
unknown:
|
|
3945
|
+
description: Number of vulnerabilities with an unknown CVSS severity.
|
|
3946
|
+
format: int64
|
|
3947
|
+
type: integer
|
|
3948
|
+
type: object
|
|
3949
|
+
ContainerImagesResponse:
|
|
3950
|
+
description: List of Container Images.
|
|
3951
|
+
properties:
|
|
3952
|
+
data:
|
|
3953
|
+
description: Array of Container Image objects.
|
|
3954
|
+
items:
|
|
3955
|
+
$ref: '#/components/schemas/ContainerImageItem'
|
|
3956
|
+
type: array
|
|
3957
|
+
links:
|
|
3958
|
+
$ref: '#/components/schemas/ContainerImagesResponseLinks'
|
|
3959
|
+
meta:
|
|
3960
|
+
$ref: '#/components/schemas/ContainerImageMeta'
|
|
3961
|
+
type: object
|
|
3962
|
+
ContainerImagesResponseLinks:
|
|
3963
|
+
description: Pagination links.
|
|
3964
|
+
properties:
|
|
3965
|
+
first:
|
|
3966
|
+
description: Link to the first page.
|
|
3967
|
+
type: string
|
|
3968
|
+
last:
|
|
3969
|
+
description: Link to the last page.
|
|
3970
|
+
nullable: true
|
|
3971
|
+
type: string
|
|
3972
|
+
next:
|
|
3973
|
+
description: Link to the next page.
|
|
3974
|
+
nullable: true
|
|
3975
|
+
type: string
|
|
3976
|
+
prev:
|
|
3977
|
+
description: Link to previous page.
|
|
3978
|
+
nullable: true
|
|
3979
|
+
type: string
|
|
3980
|
+
self:
|
|
3981
|
+
description: Link to current page.
|
|
3982
|
+
type: string
|
|
3983
|
+
type: object
|
|
3984
|
+
ContainerItem:
|
|
3985
|
+
description: Possible Container models.
|
|
3986
|
+
oneOf:
|
|
3987
|
+
- $ref: '#/components/schemas/Container'
|
|
3988
|
+
- $ref: '#/components/schemas/ContainerGroup'
|
|
3989
|
+
ContainerMeta:
|
|
3990
|
+
description: Response metadata object.
|
|
3991
|
+
properties:
|
|
3992
|
+
pagination:
|
|
3993
|
+
$ref: '#/components/schemas/ContainerMetaPage'
|
|
3994
|
+
type: object
|
|
3995
|
+
ContainerMetaPage:
|
|
3996
|
+
description: Paging attributes.
|
|
3997
|
+
properties:
|
|
3998
|
+
cursor:
|
|
3999
|
+
description: The cursor used to get the current results, if any.
|
|
4000
|
+
type: string
|
|
4001
|
+
limit:
|
|
4002
|
+
description: Number of results returned
|
|
4003
|
+
format: int32
|
|
4004
|
+
maximum: 10000
|
|
4005
|
+
minimum: 0
|
|
4006
|
+
type: integer
|
|
4007
|
+
next_cursor:
|
|
4008
|
+
description: The cursor used to get the next results, if any.
|
|
4009
|
+
type: string
|
|
4010
|
+
prev_cursor:
|
|
4011
|
+
description: The cursor used to get the previous results, if any.
|
|
4012
|
+
nullable: true
|
|
4013
|
+
type: string
|
|
4014
|
+
total:
|
|
4015
|
+
description: Total number of records that match the query.
|
|
4016
|
+
format: int64
|
|
4017
|
+
type: integer
|
|
4018
|
+
type:
|
|
4019
|
+
$ref: '#/components/schemas/ContainerMetaPageType'
|
|
4020
|
+
type: object
|
|
4021
|
+
ContainerMetaPageType:
|
|
4022
|
+
default: cursor_limit
|
|
4023
|
+
description: Type of Container pagination.
|
|
4024
|
+
enum:
|
|
4025
|
+
- cursor_limit
|
|
4026
|
+
example: cursor_limit
|
|
4027
|
+
type: string
|
|
4028
|
+
x-enum-varnames:
|
|
4029
|
+
- CURSOR_LIMIT
|
|
4030
|
+
ContainerType:
|
|
4031
|
+
default: container
|
|
4032
|
+
description: Type of container.
|
|
4033
|
+
enum:
|
|
4034
|
+
- container
|
|
4035
|
+
example: container
|
|
4036
|
+
type: string
|
|
4037
|
+
x-enum-varnames:
|
|
4038
|
+
- CONTAINER
|
|
4039
|
+
ContainersResponse:
|
|
4040
|
+
description: List of containers.
|
|
4041
|
+
properties:
|
|
4042
|
+
data:
|
|
4043
|
+
description: Array of Container objects.
|
|
4044
|
+
items:
|
|
4045
|
+
$ref: '#/components/schemas/ContainerItem'
|
|
4046
|
+
type: array
|
|
4047
|
+
links:
|
|
4048
|
+
$ref: '#/components/schemas/ContainersResponseLinks'
|
|
4049
|
+
meta:
|
|
4050
|
+
$ref: '#/components/schemas/ContainerMeta'
|
|
4051
|
+
type: object
|
|
4052
|
+
ContainersResponseLinks:
|
|
4053
|
+
description: Pagination links.
|
|
4054
|
+
properties:
|
|
4055
|
+
first:
|
|
4056
|
+
description: Link to the first page.
|
|
4057
|
+
type: string
|
|
4058
|
+
last:
|
|
4059
|
+
description: Link to the last page.
|
|
4060
|
+
nullable: true
|
|
4061
|
+
type: string
|
|
4062
|
+
next:
|
|
4063
|
+
description: Link to the next page.
|
|
4064
|
+
nullable: true
|
|
4065
|
+
type: string
|
|
4066
|
+
prev:
|
|
4067
|
+
description: Link to previous page.
|
|
4068
|
+
nullable: true
|
|
4069
|
+
type: string
|
|
4070
|
+
self:
|
|
4071
|
+
description: Link to current page.
|
|
4072
|
+
type: string
|
|
4073
|
+
type: object
|
|
4074
|
+
ContentEncoding:
|
|
4075
|
+
description: HTTP header used to compress the media-type.
|
|
4076
|
+
enum:
|
|
4077
|
+
- identity
|
|
4078
|
+
- gzip
|
|
4079
|
+
- deflate
|
|
4080
|
+
type: string
|
|
4081
|
+
x-enum-varnames:
|
|
4082
|
+
- IDENTITY
|
|
4083
|
+
- GZIP
|
|
4084
|
+
- DEFLATE
|
|
4085
|
+
CostByOrg:
|
|
4086
|
+
description: Cost data.
|
|
4087
|
+
properties:
|
|
4088
|
+
attributes:
|
|
4089
|
+
$ref: '#/components/schemas/CostByOrgAttributes'
|
|
4090
|
+
id:
|
|
4091
|
+
description: Unique ID of the response.
|
|
4092
|
+
type: string
|
|
4093
|
+
type:
|
|
4094
|
+
$ref: '#/components/schemas/CostByOrgType'
|
|
4095
|
+
type: object
|
|
4096
|
+
CostByOrgAttributes:
|
|
4097
|
+
description: Cost attributes data.
|
|
4098
|
+
properties:
|
|
4099
|
+
charges:
|
|
4100
|
+
description: List of charges data reported for the requested month.
|
|
4101
|
+
items:
|
|
4102
|
+
$ref: '#/components/schemas/ChargebackBreakdown'
|
|
4103
|
+
type: array
|
|
4104
|
+
date:
|
|
4105
|
+
description: The month requested.
|
|
4106
|
+
format: date-time
|
|
4107
|
+
type: string
|
|
4108
|
+
org_name:
|
|
4109
|
+
description: The organization name.
|
|
4110
|
+
type: string
|
|
4111
|
+
public_id:
|
|
4112
|
+
description: The organization public ID.
|
|
4113
|
+
type: string
|
|
4114
|
+
region:
|
|
4115
|
+
description: The region of the Datadog instance that the organization belongs
|
|
4116
|
+
to.
|
|
4117
|
+
type: string
|
|
4118
|
+
total_cost:
|
|
4119
|
+
description: The total cost of products for the month.
|
|
4120
|
+
format: double
|
|
4121
|
+
type: number
|
|
4122
|
+
type: object
|
|
4123
|
+
CostByOrgResponse:
|
|
4124
|
+
description: Chargeback Summary response.
|
|
4125
|
+
properties:
|
|
4126
|
+
data:
|
|
4127
|
+
description: Response containing Chargeback Summary.
|
|
4128
|
+
items:
|
|
4129
|
+
$ref: '#/components/schemas/CostByOrg'
|
|
4130
|
+
type: array
|
|
4131
|
+
type: object
|
|
4132
|
+
CostByOrgType:
|
|
4133
|
+
default: cost_by_org
|
|
4134
|
+
description: Type of cost data.
|
|
4135
|
+
enum:
|
|
4136
|
+
- cost_by_org
|
|
4137
|
+
example: cost_by_org
|
|
4138
|
+
type: string
|
|
4139
|
+
x-enum-varnames:
|
|
4140
|
+
- COST_BY_ORG
|
|
4141
|
+
CreateRuleRequest:
|
|
4142
|
+
description: Scorecard create rule request.
|
|
4143
|
+
properties:
|
|
4144
|
+
data:
|
|
4145
|
+
$ref: '#/components/schemas/CreateRuleRequestData'
|
|
4146
|
+
type: object
|
|
4147
|
+
CreateRuleRequestData:
|
|
4148
|
+
description: Scorecard create rule request data.
|
|
4149
|
+
properties:
|
|
4150
|
+
attributes:
|
|
4151
|
+
$ref: '#/components/schemas/RuleAttributes'
|
|
4152
|
+
type:
|
|
4153
|
+
$ref: '#/components/schemas/RuleType'
|
|
4154
|
+
type: object
|
|
4155
|
+
CreateRuleResponse:
|
|
4156
|
+
description: Created rule in response.
|
|
4157
|
+
properties:
|
|
4158
|
+
data:
|
|
4159
|
+
$ref: '#/components/schemas/CreateRuleResponseData'
|
|
4160
|
+
type: object
|
|
4161
|
+
CreateRuleResponseData:
|
|
4162
|
+
description: Create rule response data.
|
|
4163
|
+
properties:
|
|
4164
|
+
attributes:
|
|
4165
|
+
$ref: '#/components/schemas/RuleAttributes'
|
|
4166
|
+
id:
|
|
4167
|
+
$ref: '#/components/schemas/RuleId'
|
|
4168
|
+
relationships:
|
|
4169
|
+
$ref: '#/components/schemas/RelationshipToRule'
|
|
4170
|
+
type:
|
|
4171
|
+
$ref: '#/components/schemas/RuleType'
|
|
4172
|
+
type: object
|
|
4173
|
+
Creator:
|
|
4174
|
+
description: Creator of the object.
|
|
4175
|
+
properties:
|
|
4176
|
+
email:
|
|
4177
|
+
description: Email of the creator.
|
|
4178
|
+
type: string
|
|
4179
|
+
handle:
|
|
4180
|
+
description: Handle of the creator.
|
|
4181
|
+
type: string
|
|
4182
|
+
name:
|
|
4183
|
+
description: Name of the creator.
|
|
4184
|
+
nullable: true
|
|
4185
|
+
type: string
|
|
4186
|
+
type: object
|
|
4187
|
+
DashboardListAddItemsRequest:
|
|
4188
|
+
description: Request containing a list of dashboards to add.
|
|
4189
|
+
properties:
|
|
4190
|
+
dashboards:
|
|
4191
|
+
description: List of dashboards to add the dashboard list.
|
|
4192
|
+
items:
|
|
4193
|
+
$ref: '#/components/schemas/DashboardListItemRequest'
|
|
4194
|
+
type: array
|
|
4195
|
+
type: object
|
|
4196
|
+
DashboardListAddItemsResponse:
|
|
4197
|
+
description: Response containing a list of added dashboards.
|
|
4198
|
+
properties:
|
|
4199
|
+
added_dashboards_to_list:
|
|
4200
|
+
description: List of dashboards added to the dashboard list.
|
|
4201
|
+
items:
|
|
4202
|
+
$ref: '#/components/schemas/DashboardListItemResponse'
|
|
4203
|
+
type: array
|
|
4204
|
+
type: object
|
|
4205
|
+
DashboardListDeleteItemsRequest:
|
|
4206
|
+
description: Request containing a list of dashboards to delete.
|
|
4207
|
+
properties:
|
|
4208
|
+
dashboards:
|
|
4209
|
+
description: List of dashboards to delete from the dashboard list.
|
|
4210
|
+
items:
|
|
4211
|
+
$ref: '#/components/schemas/DashboardListItemRequest'
|
|
4212
|
+
type: array
|
|
4213
|
+
type: object
|
|
4214
|
+
DashboardListDeleteItemsResponse:
|
|
4215
|
+
description: Response containing a list of deleted dashboards.
|
|
4216
|
+
properties:
|
|
4217
|
+
deleted_dashboards_from_list:
|
|
4218
|
+
description: List of dashboards deleted from the dashboard list.
|
|
4219
|
+
items:
|
|
4220
|
+
$ref: '#/components/schemas/DashboardListItemResponse'
|
|
4221
|
+
type: array
|
|
4222
|
+
type: object
|
|
4223
|
+
DashboardListItem:
|
|
4224
|
+
description: A dashboard within a list.
|
|
4225
|
+
properties:
|
|
4226
|
+
author:
|
|
4227
|
+
$ref: '#/components/schemas/Creator'
|
|
4228
|
+
created:
|
|
4229
|
+
description: Date of creation of the dashboard.
|
|
4230
|
+
format: date-time
|
|
4231
|
+
readOnly: true
|
|
4232
|
+
type: string
|
|
4233
|
+
icon:
|
|
4234
|
+
description: URL to the icon of the dashboard.
|
|
4235
|
+
nullable: true
|
|
4236
|
+
readOnly: true
|
|
4237
|
+
type: string
|
|
4238
|
+
id:
|
|
4239
|
+
description: ID of the dashboard.
|
|
4240
|
+
example: q5j-nti-fv6
|
|
4241
|
+
type: string
|
|
4242
|
+
integration_id:
|
|
4243
|
+
description: The short name of the integration.
|
|
4244
|
+
nullable: true
|
|
4245
|
+
readOnly: true
|
|
4246
|
+
type: string
|
|
4247
|
+
is_favorite:
|
|
3582
4248
|
description: Whether or not the dashboard is in the favorites.
|
|
3583
4249
|
readOnly: true
|
|
3584
4250
|
type: boolean
|
|
@@ -3712,9 +4378,7 @@ components:
|
|
|
3712
4378
|
example: a
|
|
3713
4379
|
type: string
|
|
3714
4380
|
type:
|
|
3715
|
-
|
|
3716
|
-
example: number
|
|
3717
|
-
type: string
|
|
4381
|
+
$ref: '#/components/schemas/ScalarColumnTypeNumber'
|
|
3718
4382
|
values:
|
|
3719
4383
|
description: The array of numerical values for one formula or query.
|
|
3720
4384
|
example:
|
|
@@ -3723,6 +4387,7 @@ components:
|
|
|
3723
4387
|
description: An individual value for a given column and group-by.
|
|
3724
4388
|
example: 0.5
|
|
3725
4389
|
format: double
|
|
4390
|
+
nullable: true
|
|
3726
4391
|
type: number
|
|
3727
4392
|
type: array
|
|
3728
4393
|
type: object
|
|
@@ -5118,7 +5783,7 @@ components:
|
|
|
5118
5783
|
type: integer
|
|
5119
5784
|
FindingID:
|
|
5120
5785
|
description: The unique ID for this finding.
|
|
5121
|
-
example:
|
|
5786
|
+
example: ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==
|
|
5122
5787
|
type: string
|
|
5123
5788
|
FindingMute:
|
|
5124
5789
|
additionalProperties: false
|
|
@@ -5388,6 +6053,13 @@ components:
|
|
|
5388
6053
|
GCPSTSServiceAccountAttributes:
|
|
5389
6054
|
description: Attributes associated with your service account.
|
|
5390
6055
|
properties:
|
|
6056
|
+
account_tags:
|
|
6057
|
+
description: Tags to be associated with GCP metrics and service checks from
|
|
6058
|
+
your account.
|
|
6059
|
+
items:
|
|
6060
|
+
description: Account Level Tag
|
|
6061
|
+
type: string
|
|
6062
|
+
type: array
|
|
5391
6063
|
automute:
|
|
5392
6064
|
description: Silence monitors for expected GCE instance shutdowns.
|
|
5393
6065
|
type: boolean
|
|
@@ -5509,9 +6181,7 @@ components:
|
|
|
5509
6181
|
example: env
|
|
5510
6182
|
type: string
|
|
5511
6183
|
type:
|
|
5512
|
-
|
|
5513
|
-
example: group
|
|
5514
|
-
type: string
|
|
6184
|
+
$ref: '#/components/schemas/ScalarColumnTypeGroup'
|
|
5515
6185
|
values:
|
|
5516
6186
|
description: The array of tag values for each group found for the results
|
|
5517
6187
|
of the formulas or queries.
|
|
@@ -7651,6 +8321,57 @@ components:
|
|
|
7651
8321
|
- data
|
|
7652
8322
|
- meta
|
|
7653
8323
|
type: object
|
|
8324
|
+
ListPowerpacksResponse:
|
|
8325
|
+
description: Response object which includes all powerpack configurations.
|
|
8326
|
+
properties:
|
|
8327
|
+
data:
|
|
8328
|
+
description: List of powerpack definitions.
|
|
8329
|
+
items:
|
|
8330
|
+
$ref: '#/components/schemas/PowerpackData'
|
|
8331
|
+
type: array
|
|
8332
|
+
included:
|
|
8333
|
+
description: Array of objects related to the users.
|
|
8334
|
+
items:
|
|
8335
|
+
$ref: '#/components/schemas/User'
|
|
8336
|
+
type: array
|
|
8337
|
+
links:
|
|
8338
|
+
$ref: '#/components/schemas/PowerpackResponseLinks'
|
|
8339
|
+
meta:
|
|
8340
|
+
$ref: '#/components/schemas/PowerpacksResponseMeta'
|
|
8341
|
+
type: object
|
|
8342
|
+
ListRulesResponse:
|
|
8343
|
+
description: Scorecard rules response.
|
|
8344
|
+
properties:
|
|
8345
|
+
data:
|
|
8346
|
+
$ref: '#/components/schemas/ListRulesResponseData'
|
|
8347
|
+
links:
|
|
8348
|
+
$ref: '#/components/schemas/ListRulesResponseLinks'
|
|
8349
|
+
type: object
|
|
8350
|
+
ListRulesResponseData:
|
|
8351
|
+
description: Array of rule details.
|
|
8352
|
+
items:
|
|
8353
|
+
$ref: '#/components/schemas/ListRulesResponseDataItem'
|
|
8354
|
+
type: array
|
|
8355
|
+
ListRulesResponseDataItem:
|
|
8356
|
+
description: Rule details.
|
|
8357
|
+
properties:
|
|
8358
|
+
attributes:
|
|
8359
|
+
$ref: '#/components/schemas/RuleAttributes'
|
|
8360
|
+
id:
|
|
8361
|
+
$ref: '#/components/schemas/RuleId'
|
|
8362
|
+
relationships:
|
|
8363
|
+
$ref: '#/components/schemas/RelationshipToRule'
|
|
8364
|
+
type:
|
|
8365
|
+
$ref: '#/components/schemas/RuleType'
|
|
8366
|
+
type: object
|
|
8367
|
+
ListRulesResponseLinks:
|
|
8368
|
+
description: Links attributes.
|
|
8369
|
+
properties:
|
|
8370
|
+
next:
|
|
8371
|
+
description: Link for the next set of rules.
|
|
8372
|
+
example: /api/v2/scorecard/rules?page%5Blimit%5D=2&page%5Boffset%5D=2&page%5Bsize%5D=2
|
|
8373
|
+
type: string
|
|
8374
|
+
type: object
|
|
7654
8375
|
ListTeamsInclude:
|
|
7655
8376
|
description: Included related resources optionally requested.
|
|
7656
8377
|
enum:
|
|
@@ -8881,6 +9602,15 @@ components:
|
|
|
8881
9602
|
properties:
|
|
8882
9603
|
emails:
|
|
8883
9604
|
$ref: '#/components/schemas/MetricBulkTagConfigEmailList'
|
|
9605
|
+
exclude_tags_mode:
|
|
9606
|
+
description: 'When set to true, the configuration will exclude the configured
|
|
9607
|
+
tags and include any other submitted tags.
|
|
9608
|
+
|
|
9609
|
+
When set to false, the configuration will include the configured tags
|
|
9610
|
+
and exclude any other submitted tags.
|
|
9611
|
+
|
|
9612
|
+
Defaults to false.'
|
|
9613
|
+
type: boolean
|
|
8884
9614
|
tags:
|
|
8885
9615
|
$ref: '#/components/schemas/MetricBulkTagConfigTagNameList'
|
|
8886
9616
|
type: object
|
|
@@ -8961,6 +9691,13 @@ components:
|
|
|
8961
9691
|
properties:
|
|
8962
9692
|
emails:
|
|
8963
9693
|
$ref: '#/components/schemas/MetricBulkTagConfigEmailList'
|
|
9694
|
+
exclude_tags_mode:
|
|
9695
|
+
description: 'When set to true, the configuration will exclude the configured
|
|
9696
|
+
tags and include any other submitted tags.
|
|
9697
|
+
|
|
9698
|
+
When set to false, the configuration will include the configured tags
|
|
9699
|
+
and exclude any other submitted tags.'
|
|
9700
|
+
type: boolean
|
|
8964
9701
|
status:
|
|
8965
9702
|
description: The status of the request.
|
|
8966
9703
|
example: Accepted
|
|
@@ -9425,6 +10162,15 @@ components:
|
|
|
9425
10162
|
example: '2020-03-25T09:48:37.463835Z'
|
|
9426
10163
|
format: date-time
|
|
9427
10164
|
type: string
|
|
10165
|
+
exclude_tags_mode:
|
|
10166
|
+
description: 'When set to true, the configuration will exclude the configured
|
|
10167
|
+
tags and include any other submitted tags.
|
|
10168
|
+
|
|
10169
|
+
When set to false, the configuration will include the configured tags
|
|
10170
|
+
and exclude any other submitted tags.
|
|
10171
|
+
|
|
10172
|
+
Defaults to false. Requires `tags` property.'
|
|
10173
|
+
type: boolean
|
|
9428
10174
|
include_percentiles:
|
|
9429
10175
|
description: 'Toggle to include or exclude percentile aggregations for distribution
|
|
9430
10176
|
metrics.
|
|
@@ -9455,6 +10201,15 @@ components:
|
|
|
9455
10201
|
properties:
|
|
9456
10202
|
aggregations:
|
|
9457
10203
|
$ref: '#/components/schemas/MetricCustomAggregations'
|
|
10204
|
+
exclude_tags_mode:
|
|
10205
|
+
description: 'When set to true, the configuration will exclude the configured
|
|
10206
|
+
tags and include any other submitted tags.
|
|
10207
|
+
|
|
10208
|
+
When set to false, the configuration will include the configured tags
|
|
10209
|
+
and exclude any other submitted tags.
|
|
10210
|
+
|
|
10211
|
+
Defaults to false. Requires `tags` property.'
|
|
10212
|
+
type: boolean
|
|
9458
10213
|
include_percentiles:
|
|
9459
10214
|
description: 'Toggle to include/exclude percentiles for a distribution metric.
|
|
9460
10215
|
|
|
@@ -9546,6 +10301,15 @@ components:
|
|
|
9546
10301
|
properties:
|
|
9547
10302
|
aggregations:
|
|
9548
10303
|
$ref: '#/components/schemas/MetricCustomAggregations'
|
|
10304
|
+
exclude_tags_mode:
|
|
10305
|
+
description: 'When set to true, the configuration will exclude the configured
|
|
10306
|
+
tags and include any other submitted tags.
|
|
10307
|
+
|
|
10308
|
+
When set to false, the configuration will include the configured tags
|
|
10309
|
+
and exclude any other submitted tags.
|
|
10310
|
+
|
|
10311
|
+
Defaults to false. Requires `tags` property.'
|
|
10312
|
+
type: boolean
|
|
9549
10313
|
include_percentiles:
|
|
9550
10314
|
description: 'Toggle to include/exclude percentiles for a distribution metric.
|
|
9551
10315
|
|
|
@@ -9963,164 +10727,31 @@ components:
|
|
|
9963
10727
|
message:
|
|
9964
10728
|
description: The monitor message.
|
|
9965
10729
|
type: string
|
|
9966
|
-
modified:
|
|
9967
|
-
description: The monitor's last-modified timestamp.
|
|
9968
|
-
format: int64
|
|
9969
|
-
type: integer
|
|
9970
|
-
name:
|
|
9971
|
-
description: The monitor name.
|
|
9972
|
-
type: string
|
|
9973
|
-
query:
|
|
9974
|
-
description: The query that triggers the alert.
|
|
9975
|
-
type: string
|
|
9976
|
-
tags:
|
|
9977
|
-
description: A list of tags attached to the monitor.
|
|
9978
|
-
example:
|
|
9979
|
-
- environment:test
|
|
9980
|
-
items:
|
|
9981
|
-
description: A tag.
|
|
9982
|
-
type: string
|
|
9983
|
-
type: array
|
|
9984
|
-
templated_name:
|
|
9985
|
-
description: The templated name of the monitor before resolving any template
|
|
9986
|
-
variables.
|
|
9987
|
-
type: string
|
|
9988
|
-
type:
|
|
9989
|
-
description: The monitor type.
|
|
9990
|
-
type: string
|
|
9991
|
-
type: object
|
|
9992
|
-
MuteFindingRequest:
|
|
9993
|
-
description: The new mute finding request.
|
|
9994
|
-
properties:
|
|
9995
|
-
data:
|
|
9996
|
-
$ref: '#/components/schemas/MuteFindingRequestData'
|
|
9997
|
-
required:
|
|
9998
|
-
- data
|
|
9999
|
-
type: object
|
|
10000
|
-
MuteFindingRequestAttributes:
|
|
10001
|
-
additionalProperties: false
|
|
10002
|
-
description: The mute properties to be updated.
|
|
10003
|
-
properties:
|
|
10004
|
-
mute:
|
|
10005
|
-
$ref: '#/components/schemas/MuteFindingRequestProperties'
|
|
10006
|
-
required:
|
|
10007
|
-
- mute
|
|
10008
|
-
type: object
|
|
10009
|
-
MuteFindingRequestData:
|
|
10010
|
-
description: Data object containing the new mute properties of the finding.
|
|
10011
|
-
properties:
|
|
10012
|
-
attributes:
|
|
10013
|
-
$ref: '#/components/schemas/MuteFindingRequestAttributes'
|
|
10014
|
-
id:
|
|
10015
|
-
$ref: '#/components/schemas/FindingID'
|
|
10016
|
-
type:
|
|
10017
|
-
$ref: '#/components/schemas/FindingType'
|
|
10018
|
-
required:
|
|
10019
|
-
- id
|
|
10020
|
-
- type
|
|
10021
|
-
- attributes
|
|
10022
|
-
type: object
|
|
10023
|
-
MuteFindingRequestProperties:
|
|
10024
|
-
additionalProperties: false
|
|
10025
|
-
description: Object containing the new mute properties of the finding.
|
|
10026
|
-
properties:
|
|
10027
|
-
description:
|
|
10028
|
-
description: Additional information about the reason why this finding is
|
|
10029
|
-
muted or unmuted. This field has a maximum limit of 280 characters.
|
|
10030
|
-
example: To be resolved later
|
|
10031
|
-
type: string
|
|
10032
|
-
expiration_date:
|
|
10033
|
-
description: 'The expiration date of the mute or unmute action (Unix ms).
|
|
10034
|
-
It must be set to a value greater than the current timestamp.
|
|
10035
|
-
|
|
10036
|
-
If this field is not provided, the finding will be muted or unmuted indefinitely,
|
|
10037
|
-
which is equivalent to setting the expiration date to 9999999999999.
|
|
10038
|
-
|
|
10039
|
-
'
|
|
10040
|
-
example: 1778721573794
|
|
10041
|
-
format: int64
|
|
10042
|
-
type: integer
|
|
10043
|
-
muted:
|
|
10044
|
-
description: Whether this finding is muted or unmuted.
|
|
10045
|
-
example: true
|
|
10046
|
-
type: boolean
|
|
10047
|
-
reason:
|
|
10048
|
-
$ref: '#/components/schemas/FindingMuteReason'
|
|
10049
|
-
required:
|
|
10050
|
-
- muted
|
|
10051
|
-
- reason
|
|
10052
|
-
type: object
|
|
10053
|
-
MuteFindingResponse:
|
|
10054
|
-
description: The expected response schema.
|
|
10055
|
-
properties:
|
|
10056
|
-
data:
|
|
10057
|
-
$ref: '#/components/schemas/MuteFindingResponseData'
|
|
10058
|
-
required:
|
|
10059
|
-
- data
|
|
10060
|
-
type: object
|
|
10061
|
-
MuteFindingResponseAttributes:
|
|
10062
|
-
description: The JSON:API attributes of the finding.
|
|
10063
|
-
properties:
|
|
10064
|
-
evaluation:
|
|
10065
|
-
$ref: '#/components/schemas/FindingEvaluation'
|
|
10066
|
-
evaluation_changed_at:
|
|
10067
|
-
$ref: '#/components/schemas/FindingEvaluationChangedAt'
|
|
10068
|
-
mute:
|
|
10069
|
-
$ref: '#/components/schemas/MuteFindingResponseProperties'
|
|
10070
|
-
resource:
|
|
10071
|
-
$ref: '#/components/schemas/FindingResource'
|
|
10072
|
-
resource_discovery_date:
|
|
10073
|
-
$ref: '#/components/schemas/FindingResourceDiscoveryDate'
|
|
10074
|
-
resource_type:
|
|
10075
|
-
$ref: '#/components/schemas/FindingResourceType'
|
|
10076
|
-
rule:
|
|
10077
|
-
$ref: '#/components/schemas/FindingRule'
|
|
10078
|
-
status:
|
|
10079
|
-
$ref: '#/components/schemas/FindingStatus'
|
|
10080
|
-
tags:
|
|
10081
|
-
$ref: '#/components/schemas/FindingTags'
|
|
10082
|
-
type: object
|
|
10083
|
-
MuteFindingResponseData:
|
|
10084
|
-
description: Data object containing the updated finding.
|
|
10085
|
-
properties:
|
|
10086
|
-
attributes:
|
|
10087
|
-
$ref: '#/components/schemas/MuteFindingResponseAttributes'
|
|
10088
|
-
id:
|
|
10089
|
-
$ref: '#/components/schemas/FindingID'
|
|
10090
|
-
type:
|
|
10091
|
-
$ref: '#/components/schemas/FindingType'
|
|
10092
|
-
type: object
|
|
10093
|
-
MuteFindingResponseProperties:
|
|
10094
|
-
additionalProperties: false
|
|
10095
|
-
description: Information about the mute status of this finding.
|
|
10096
|
-
properties:
|
|
10097
|
-
description:
|
|
10098
|
-
description: 'Additional information about the reason why this finding is
|
|
10099
|
-
muted or unmuted.
|
|
10100
|
-
|
|
10101
|
-
This attribute will not be included in the response if the description
|
|
10102
|
-
is not provided in the request body.
|
|
10103
|
-
|
|
10104
|
-
'
|
|
10105
|
-
example: To be resolved later
|
|
10106
|
-
type: string
|
|
10107
|
-
expiration_date:
|
|
10108
|
-
description: 'The expiration date of the mute or unmute action.
|
|
10109
|
-
|
|
10110
|
-
If the expiration date is not provided in the request body, this attribute
|
|
10111
|
-
will not be included in the response and the finding will be muted or
|
|
10112
|
-
unmuted indefinitely.
|
|
10113
|
-
|
|
10114
|
-
'
|
|
10115
|
-
example: 1778721573794
|
|
10730
|
+
modified:
|
|
10731
|
+
description: The monitor's last-modified timestamp.
|
|
10116
10732
|
format: int64
|
|
10117
10733
|
type: integer
|
|
10118
|
-
|
|
10119
|
-
description:
|
|
10120
|
-
|
|
10121
|
-
|
|
10122
|
-
|
|
10123
|
-
|
|
10734
|
+
name:
|
|
10735
|
+
description: The monitor name.
|
|
10736
|
+
type: string
|
|
10737
|
+
query:
|
|
10738
|
+
description: The query that triggers the alert.
|
|
10739
|
+
type: string
|
|
10740
|
+
tags:
|
|
10741
|
+
description: A list of tags attached to the monitor.
|
|
10742
|
+
example:
|
|
10743
|
+
- environment:test
|
|
10744
|
+
items:
|
|
10745
|
+
description: A tag.
|
|
10746
|
+
type: string
|
|
10747
|
+
type: array
|
|
10748
|
+
templated_name:
|
|
10749
|
+
description: The templated name of the monitor before resolving any template
|
|
10750
|
+
variables.
|
|
10751
|
+
type: string
|
|
10752
|
+
type:
|
|
10753
|
+
description: The monitor type.
|
|
10754
|
+
type: string
|
|
10124
10755
|
type: object
|
|
10125
10756
|
NullableRelationshipToUser:
|
|
10126
10757
|
description: Relationship to user.
|
|
@@ -10393,6 +11024,185 @@ components:
|
|
|
10393
11024
|
type: string
|
|
10394
11025
|
x-enum-varnames:
|
|
10395
11026
|
- ORGS
|
|
11027
|
+
OutcomeType:
|
|
11028
|
+
default: outcome
|
|
11029
|
+
description: The JSON:API type for an outcome.
|
|
11030
|
+
enum:
|
|
11031
|
+
- outcome
|
|
11032
|
+
example: outcome
|
|
11033
|
+
type: string
|
|
11034
|
+
x-enum-varnames:
|
|
11035
|
+
- OUTCOME
|
|
11036
|
+
OutcomesBatchAttributes:
|
|
11037
|
+
description: The JSON:API attributes for a batched set of scorecard outcomes.
|
|
11038
|
+
properties:
|
|
11039
|
+
results:
|
|
11040
|
+
description: Set of scorecard outcomes to update.
|
|
11041
|
+
items:
|
|
11042
|
+
$ref: '#/components/schemas/OutcomesBatchRequestItem'
|
|
11043
|
+
type: array
|
|
11044
|
+
type: object
|
|
11045
|
+
OutcomesBatchRequest:
|
|
11046
|
+
description: Scorecard outcomes batch request.
|
|
11047
|
+
properties:
|
|
11048
|
+
data:
|
|
11049
|
+
$ref: '#/components/schemas/OutcomesBatchRequestData'
|
|
11050
|
+
type: object
|
|
11051
|
+
OutcomesBatchRequestData:
|
|
11052
|
+
description: Scorecard outcomes batch request data.
|
|
11053
|
+
properties:
|
|
11054
|
+
attributes:
|
|
11055
|
+
$ref: '#/components/schemas/OutcomesBatchAttributes'
|
|
11056
|
+
type:
|
|
11057
|
+
$ref: '#/components/schemas/OutcomesBatchType'
|
|
11058
|
+
type: object
|
|
11059
|
+
OutcomesBatchRequestItem:
|
|
11060
|
+
description: Scorecard outcome for a specific rule, for a given service within
|
|
11061
|
+
a batched update.
|
|
11062
|
+
properties:
|
|
11063
|
+
remarks:
|
|
11064
|
+
description: Any remarks regarding the scorecard rule's evaluation, and
|
|
11065
|
+
supports HTML hyperlinks.
|
|
11066
|
+
example: 'See: <a href="https://app.datadoghq.com/services">Services</a>'
|
|
11067
|
+
type: string
|
|
11068
|
+
rule_id:
|
|
11069
|
+
$ref: '#/components/schemas/RuleId'
|
|
11070
|
+
service_name:
|
|
11071
|
+
description: The unique name for a service in the catalog.
|
|
11072
|
+
example: my-service
|
|
11073
|
+
type: string
|
|
11074
|
+
state:
|
|
11075
|
+
$ref: '#/components/schemas/State'
|
|
11076
|
+
required:
|
|
11077
|
+
- rule_id
|
|
11078
|
+
- service_name
|
|
11079
|
+
- state
|
|
11080
|
+
type: object
|
|
11081
|
+
OutcomesBatchResponse:
|
|
11082
|
+
description: Scorecard outcomes batch response.
|
|
11083
|
+
properties:
|
|
11084
|
+
data:
|
|
11085
|
+
$ref: '#/components/schemas/OutcomesBatchResponseData'
|
|
11086
|
+
meta:
|
|
11087
|
+
$ref: '#/components/schemas/OutcomesBatchResponseMeta'
|
|
11088
|
+
required:
|
|
11089
|
+
- data
|
|
11090
|
+
- meta
|
|
11091
|
+
type: object
|
|
11092
|
+
OutcomesBatchResponseAttributes:
|
|
11093
|
+
description: The JSON:API attributes for an outcome.
|
|
11094
|
+
properties:
|
|
11095
|
+
created_at:
|
|
11096
|
+
description: Creation time of the rule outcome.
|
|
11097
|
+
format: date-time
|
|
11098
|
+
type: string
|
|
11099
|
+
modified_at:
|
|
11100
|
+
description: Time of last rule outcome modification.
|
|
11101
|
+
format: date-time
|
|
11102
|
+
type: string
|
|
11103
|
+
remarks:
|
|
11104
|
+
description: Any remarks regarding the scorecard rule's evaluation, and
|
|
11105
|
+
supports HTML hyperlinks.
|
|
11106
|
+
example: 'See: <a href="https://app.datadoghq.com/services">Services</a>'
|
|
11107
|
+
type: string
|
|
11108
|
+
service_name:
|
|
11109
|
+
description: The unique name for a service in the catalog.
|
|
11110
|
+
example: my-service
|
|
11111
|
+
type: string
|
|
11112
|
+
state:
|
|
11113
|
+
$ref: '#/components/schemas/State'
|
|
11114
|
+
type: object
|
|
11115
|
+
OutcomesBatchResponseData:
|
|
11116
|
+
description: List of rule outcomes which were affected during the bulk operation.
|
|
11117
|
+
items:
|
|
11118
|
+
$ref: '#/components/schemas/OutcomesResponseDataItem'
|
|
11119
|
+
type: array
|
|
11120
|
+
OutcomesBatchResponseMeta:
|
|
11121
|
+
description: Metadata pertaining to the bulk operation.
|
|
11122
|
+
properties:
|
|
11123
|
+
total_received:
|
|
11124
|
+
description: Total number of scorecard results received during the bulk
|
|
11125
|
+
operation.
|
|
11126
|
+
format: int64
|
|
11127
|
+
type: integer
|
|
11128
|
+
total_updated:
|
|
11129
|
+
description: Total number of scorecard results modified during the bulk
|
|
11130
|
+
operation.
|
|
11131
|
+
format: int64
|
|
11132
|
+
type: integer
|
|
11133
|
+
type: object
|
|
11134
|
+
OutcomesBatchType:
|
|
11135
|
+
default: batched-outcome
|
|
11136
|
+
description: The JSON:API type for scorecard outcomes.
|
|
11137
|
+
enum:
|
|
11138
|
+
- batched-outcome
|
|
11139
|
+
example: batched-outcome
|
|
11140
|
+
type: string
|
|
11141
|
+
x-enum-varnames:
|
|
11142
|
+
- BATCHED_OUTCOME
|
|
11143
|
+
OutcomesResponse:
|
|
11144
|
+
description: Scorecard outcomes - the result of a rule for a service.
|
|
11145
|
+
properties:
|
|
11146
|
+
data:
|
|
11147
|
+
$ref: '#/components/schemas/OutcomesResponseData'
|
|
11148
|
+
included:
|
|
11149
|
+
$ref: '#/components/schemas/OutcomesResponseIncluded'
|
|
11150
|
+
links:
|
|
11151
|
+
$ref: '#/components/schemas/OutcomesResponseLinks'
|
|
11152
|
+
type: object
|
|
11153
|
+
OutcomesResponseData:
|
|
11154
|
+
description: List of rule outcomes.
|
|
11155
|
+
items:
|
|
11156
|
+
$ref: '#/components/schemas/OutcomesResponseDataItem'
|
|
11157
|
+
type: array
|
|
11158
|
+
OutcomesResponseDataItem:
|
|
11159
|
+
description: A single rule outcome.
|
|
11160
|
+
properties:
|
|
11161
|
+
attributes:
|
|
11162
|
+
$ref: '#/components/schemas/OutcomesBatchResponseAttributes'
|
|
11163
|
+
id:
|
|
11164
|
+
description: The unique ID for a rule outcome.
|
|
11165
|
+
type: string
|
|
11166
|
+
relationships:
|
|
11167
|
+
$ref: '#/components/schemas/RuleOutcomeRelationships'
|
|
11168
|
+
type:
|
|
11169
|
+
$ref: '#/components/schemas/OutcomeType'
|
|
11170
|
+
type: object
|
|
11171
|
+
OutcomesResponseIncluded:
|
|
11172
|
+
description: Array of rule details.
|
|
11173
|
+
items:
|
|
11174
|
+
$ref: '#/components/schemas/OutcomesResponseIncludedItem'
|
|
11175
|
+
type: array
|
|
11176
|
+
OutcomesResponseIncludedItem:
|
|
11177
|
+
description: Attributes of the included rule.
|
|
11178
|
+
properties:
|
|
11179
|
+
attributes:
|
|
11180
|
+
$ref: '#/components/schemas/OutcomesResponseIncludedRuleAttributes'
|
|
11181
|
+
id:
|
|
11182
|
+
$ref: '#/components/schemas/RuleId'
|
|
11183
|
+
type:
|
|
11184
|
+
$ref: '#/components/schemas/RuleType'
|
|
11185
|
+
type: object
|
|
11186
|
+
OutcomesResponseIncludedRuleAttributes:
|
|
11187
|
+
description: Details of a rule.
|
|
11188
|
+
properties:
|
|
11189
|
+
name:
|
|
11190
|
+
description: Name of the rule.
|
|
11191
|
+
example: Team Defined
|
|
11192
|
+
type: string
|
|
11193
|
+
scorecard_name:
|
|
11194
|
+
description: The scorecard name to which this rule must belong.
|
|
11195
|
+
example: Observability Best Practices
|
|
11196
|
+
type: string
|
|
11197
|
+
type: object
|
|
11198
|
+
OutcomesResponseLinks:
|
|
11199
|
+
description: Links attributes.
|
|
11200
|
+
properties:
|
|
11201
|
+
next:
|
|
11202
|
+
description: Link for the next set of results.
|
|
11203
|
+
example: /api/v2/scorecard/outcomes?include=rule&page%5Blimit%5D=100&page%5Boffset%5D=100
|
|
11204
|
+
type: string
|
|
11205
|
+
type: object
|
|
10396
11206
|
Pagination:
|
|
10397
11207
|
description: Pagination object.
|
|
10398
11208
|
properties:
|
|
@@ -10533,28 +11343,323 @@ components:
|
|
|
10533
11343
|
name:
|
|
10534
11344
|
description: Name of the permission.
|
|
10535
11345
|
type: string
|
|
10536
|
-
restricted:
|
|
10537
|
-
description: Whether or not the permission is restricted.
|
|
10538
|
-
type: boolean
|
|
11346
|
+
restricted:
|
|
11347
|
+
description: Whether or not the permission is restricted.
|
|
11348
|
+
type: boolean
|
|
11349
|
+
type: object
|
|
11350
|
+
PermissionsResponse:
|
|
11351
|
+
description: Payload with API-returned permissions.
|
|
11352
|
+
properties:
|
|
11353
|
+
data:
|
|
11354
|
+
description: Array of permissions.
|
|
11355
|
+
items:
|
|
11356
|
+
$ref: '#/components/schemas/Permission'
|
|
11357
|
+
type: array
|
|
11358
|
+
type: object
|
|
11359
|
+
PermissionsType:
|
|
11360
|
+
default: permissions
|
|
11361
|
+
description: Permissions resource type.
|
|
11362
|
+
enum:
|
|
11363
|
+
- permissions
|
|
11364
|
+
example: permissions
|
|
11365
|
+
type: string
|
|
11366
|
+
x-enum-varnames:
|
|
11367
|
+
- PERMISSIONS
|
|
11368
|
+
Powerpack:
|
|
11369
|
+
description: Powerpacks are templated groups of dashboard widgets you can save
|
|
11370
|
+
from an existing dashboard and turn into reusable packs in the widget tray.
|
|
11371
|
+
properties:
|
|
11372
|
+
data:
|
|
11373
|
+
$ref: '#/components/schemas/PowerpackData'
|
|
11374
|
+
type: object
|
|
11375
|
+
PowerpackAttributes:
|
|
11376
|
+
description: Powerpack attribute object.
|
|
11377
|
+
properties:
|
|
11378
|
+
description:
|
|
11379
|
+
description: Description of this powerpack.
|
|
11380
|
+
example: Powerpack for ABC
|
|
11381
|
+
type: string
|
|
11382
|
+
group_widget:
|
|
11383
|
+
$ref: '#/components/schemas/PowerpackGroupWidget'
|
|
11384
|
+
name:
|
|
11385
|
+
description: Name of the powerpack.
|
|
11386
|
+
example: Sample Powerpack
|
|
11387
|
+
type: string
|
|
11388
|
+
tags:
|
|
11389
|
+
description: List of tags to identify this powerpack.
|
|
11390
|
+
example:
|
|
11391
|
+
- tag:foo1
|
|
11392
|
+
items:
|
|
11393
|
+
maxLength: 80
|
|
11394
|
+
type: string
|
|
11395
|
+
maxItems: 8
|
|
11396
|
+
type: array
|
|
11397
|
+
template_variables:
|
|
11398
|
+
description: List of template variables for this powerpack.
|
|
11399
|
+
example:
|
|
11400
|
+
- defaults:
|
|
11401
|
+
- '*'
|
|
11402
|
+
name: test
|
|
11403
|
+
items:
|
|
11404
|
+
$ref: '#/components/schemas/PowerpackTemplateVariable'
|
|
11405
|
+
type: array
|
|
11406
|
+
required:
|
|
11407
|
+
- group_widget
|
|
11408
|
+
- name
|
|
11409
|
+
type: object
|
|
11410
|
+
PowerpackData:
|
|
11411
|
+
description: Powerpack data object.
|
|
11412
|
+
properties:
|
|
11413
|
+
attributes:
|
|
11414
|
+
$ref: '#/components/schemas/PowerpackAttributes'
|
|
11415
|
+
id:
|
|
11416
|
+
description: ID of the powerpack.
|
|
11417
|
+
type: string
|
|
11418
|
+
relationships:
|
|
11419
|
+
$ref: '#/components/schemas/PowerpackRelationships'
|
|
11420
|
+
type:
|
|
11421
|
+
description: Type of widget, must be powerpack.
|
|
11422
|
+
example: powerpack
|
|
11423
|
+
type: string
|
|
11424
|
+
type: object
|
|
11425
|
+
PowerpackGroupWidget:
|
|
11426
|
+
description: Powerpack group widget definition object.
|
|
11427
|
+
properties:
|
|
11428
|
+
definition:
|
|
11429
|
+
$ref: '#/components/schemas/PowerpackGroupWidgetDefinition'
|
|
11430
|
+
layout:
|
|
11431
|
+
$ref: '#/components/schemas/PowerpackGroupWidgetLayout'
|
|
11432
|
+
live_span:
|
|
11433
|
+
$ref: '#/components/schemas/WidgetLiveSpan'
|
|
11434
|
+
required:
|
|
11435
|
+
- definition
|
|
11436
|
+
type: object
|
|
11437
|
+
PowerpackGroupWidgetDefinition:
|
|
11438
|
+
description: Powerpack group widget object.
|
|
11439
|
+
properties:
|
|
11440
|
+
layout_type:
|
|
11441
|
+
description: Layout type of widgets.
|
|
11442
|
+
example: ordered
|
|
11443
|
+
type: string
|
|
11444
|
+
show_title:
|
|
11445
|
+
description: Boolean indicating whether powerpack group title should be
|
|
11446
|
+
visible or not.
|
|
11447
|
+
example: true
|
|
11448
|
+
type: boolean
|
|
11449
|
+
title:
|
|
11450
|
+
description: Name for the group widget.
|
|
11451
|
+
example: Sample Powerpack
|
|
11452
|
+
type: string
|
|
11453
|
+
type:
|
|
11454
|
+
description: Type of widget, must be group.
|
|
11455
|
+
example: group
|
|
11456
|
+
type: string
|
|
11457
|
+
widgets:
|
|
11458
|
+
description: Widgets inside the powerpack.
|
|
11459
|
+
example:
|
|
11460
|
+
- definition:
|
|
11461
|
+
content: example
|
|
11462
|
+
type: note
|
|
11463
|
+
layout:
|
|
11464
|
+
height: 5
|
|
11465
|
+
width: 10
|
|
11466
|
+
x: 0
|
|
11467
|
+
y: 0
|
|
11468
|
+
items:
|
|
11469
|
+
$ref: '#/components/schemas/PowerpackInnerWidgets'
|
|
11470
|
+
type: array
|
|
11471
|
+
required:
|
|
11472
|
+
- widgets
|
|
11473
|
+
- layout_type
|
|
11474
|
+
- type
|
|
11475
|
+
type: object
|
|
11476
|
+
PowerpackGroupWidgetLayout:
|
|
11477
|
+
description: Powerpack group widget layout.
|
|
11478
|
+
properties:
|
|
11479
|
+
height:
|
|
11480
|
+
description: The height of the widget. Should be a non-negative integer.
|
|
11481
|
+
example: 0
|
|
11482
|
+
format: int64
|
|
11483
|
+
minimum: 0
|
|
11484
|
+
type: integer
|
|
11485
|
+
width:
|
|
11486
|
+
description: The width of the widget. Should be a non-negative integer.
|
|
11487
|
+
example: 0
|
|
11488
|
+
format: int64
|
|
11489
|
+
minimum: 0
|
|
11490
|
+
type: integer
|
|
11491
|
+
x:
|
|
11492
|
+
description: The position of the widget on the x (horizontal) axis. Should
|
|
11493
|
+
be a non-negative integer.
|
|
11494
|
+
example: 0
|
|
11495
|
+
format: int64
|
|
11496
|
+
minimum: 0
|
|
11497
|
+
type: integer
|
|
11498
|
+
y:
|
|
11499
|
+
description: The position of the widget on the y (vertical) axis. Should
|
|
11500
|
+
be a non-negative integer.
|
|
11501
|
+
example: 0
|
|
11502
|
+
format: int64
|
|
11503
|
+
minimum: 0
|
|
11504
|
+
type: integer
|
|
11505
|
+
required:
|
|
11506
|
+
- x
|
|
11507
|
+
- y
|
|
11508
|
+
- width
|
|
11509
|
+
- height
|
|
11510
|
+
type: object
|
|
11511
|
+
PowerpackInnerWidgetLayout:
|
|
11512
|
+
description: Powerpack inner widget layout.
|
|
11513
|
+
properties:
|
|
11514
|
+
height:
|
|
11515
|
+
description: The height of the widget. Should be a non-negative integer.
|
|
11516
|
+
example: 0
|
|
11517
|
+
format: int64
|
|
11518
|
+
minimum: 0
|
|
11519
|
+
type: integer
|
|
11520
|
+
width:
|
|
11521
|
+
description: The width of the widget. Should be a non-negative integer.
|
|
11522
|
+
example: 0
|
|
11523
|
+
format: int64
|
|
11524
|
+
minimum: 0
|
|
11525
|
+
type: integer
|
|
11526
|
+
x:
|
|
11527
|
+
description: The position of the widget on the x (horizontal) axis. Should
|
|
11528
|
+
be a non-negative integer.
|
|
11529
|
+
example: 0
|
|
11530
|
+
format: int64
|
|
11531
|
+
minimum: 0
|
|
11532
|
+
type: integer
|
|
11533
|
+
y:
|
|
11534
|
+
description: The position of the widget on the y (vertical) axis. Should
|
|
11535
|
+
be a non-negative integer.
|
|
11536
|
+
example: 0
|
|
11537
|
+
format: int64
|
|
11538
|
+
minimum: 0
|
|
11539
|
+
type: integer
|
|
11540
|
+
required:
|
|
11541
|
+
- x
|
|
11542
|
+
- y
|
|
11543
|
+
- width
|
|
11544
|
+
- height
|
|
11545
|
+
type: object
|
|
11546
|
+
PowerpackInnerWidgets:
|
|
11547
|
+
description: Powerpack group widget definition of individual widgets.
|
|
11548
|
+
properties:
|
|
11549
|
+
definition:
|
|
11550
|
+
additionalProperties: {}
|
|
11551
|
+
description: Information about widget.
|
|
11552
|
+
example:
|
|
11553
|
+
definition:
|
|
11554
|
+
content: example
|
|
11555
|
+
type: note
|
|
11556
|
+
type: object
|
|
11557
|
+
layout:
|
|
11558
|
+
$ref: '#/components/schemas/PowerpackInnerWidgetLayout'
|
|
11559
|
+
required:
|
|
11560
|
+
- definition
|
|
11561
|
+
type: object
|
|
11562
|
+
PowerpackRelationships:
|
|
11563
|
+
description: Powerpack relationship object.
|
|
11564
|
+
properties:
|
|
11565
|
+
author:
|
|
11566
|
+
$ref: '#/components/schemas/Creator'
|
|
11567
|
+
type: object
|
|
11568
|
+
PowerpackResponse:
|
|
11569
|
+
description: Response object which includes a single powerpack configuration.
|
|
11570
|
+
properties:
|
|
11571
|
+
data:
|
|
11572
|
+
$ref: '#/components/schemas/PowerpackData'
|
|
11573
|
+
included:
|
|
11574
|
+
description: Array of objects related to the users.
|
|
11575
|
+
items:
|
|
11576
|
+
$ref: '#/components/schemas/User'
|
|
11577
|
+
type: array
|
|
11578
|
+
readOnly: true
|
|
11579
|
+
type: object
|
|
11580
|
+
PowerpackResponseLinks:
|
|
11581
|
+
description: Links attributes.
|
|
11582
|
+
properties:
|
|
11583
|
+
first:
|
|
11584
|
+
description: Link to last page.
|
|
11585
|
+
type: string
|
|
11586
|
+
last:
|
|
11587
|
+
description: Link to first page.
|
|
11588
|
+
example: https://app.datadoghq.com/api/v2/powerpacks?page[offset]=0&page[limit]=25
|
|
11589
|
+
nullable: true
|
|
11590
|
+
type: string
|
|
11591
|
+
next:
|
|
11592
|
+
description: Link for the next set of results.
|
|
11593
|
+
example: https://app.datadoghq.com/api/v2/powerpacks?page[offset]=25&page[limit]=25
|
|
11594
|
+
type: string
|
|
11595
|
+
prev:
|
|
11596
|
+
description: Link for the previous set of results.
|
|
11597
|
+
nullable: true
|
|
11598
|
+
type: string
|
|
11599
|
+
self:
|
|
11600
|
+
description: Link to current page.
|
|
11601
|
+
example: https://app.datadoghq.com/api/v2/powerpacks
|
|
11602
|
+
type: string
|
|
10539
11603
|
type: object
|
|
10540
|
-
|
|
10541
|
-
description:
|
|
11604
|
+
PowerpackTemplateVariable:
|
|
11605
|
+
description: Powerpack template variables.
|
|
10542
11606
|
properties:
|
|
10543
|
-
|
|
10544
|
-
description:
|
|
11607
|
+
defaults:
|
|
11608
|
+
description: One or many template variable default values within the saved
|
|
11609
|
+
view, which are unioned together using `OR` if more than one is specified.
|
|
10545
11610
|
items:
|
|
10546
|
-
|
|
11611
|
+
description: One or many default values of the template variable.
|
|
11612
|
+
minLength: 1
|
|
11613
|
+
type: string
|
|
10547
11614
|
type: array
|
|
11615
|
+
name:
|
|
11616
|
+
description: The name of the variable.
|
|
11617
|
+
example: datacenter
|
|
11618
|
+
type: string
|
|
11619
|
+
required:
|
|
11620
|
+
- name
|
|
11621
|
+
type: object
|
|
11622
|
+
PowerpacksResponseMeta:
|
|
11623
|
+
description: Powerpack response metadata.
|
|
11624
|
+
properties:
|
|
11625
|
+
pagination:
|
|
11626
|
+
$ref: '#/components/schemas/PowerpacksResponseMetaPagination'
|
|
11627
|
+
type: object
|
|
11628
|
+
PowerpacksResponseMetaPagination:
|
|
11629
|
+
description: Powerpack response pagination metadata.
|
|
11630
|
+
properties:
|
|
11631
|
+
first_offset:
|
|
11632
|
+
description: The first offset.
|
|
11633
|
+
format: int64
|
|
11634
|
+
type: integer
|
|
11635
|
+
last_offset:
|
|
11636
|
+
description: The last offset.
|
|
11637
|
+
format: int64
|
|
11638
|
+
type: integer
|
|
11639
|
+
limit:
|
|
11640
|
+
description: Pagination limit.
|
|
11641
|
+
format: int64
|
|
11642
|
+
type: integer
|
|
11643
|
+
next_offset:
|
|
11644
|
+
description: The next offset.
|
|
11645
|
+
format: int64
|
|
11646
|
+
type: integer
|
|
11647
|
+
offset:
|
|
11648
|
+
description: The offset.
|
|
11649
|
+
format: int64
|
|
11650
|
+
type: integer
|
|
11651
|
+
prev_offset:
|
|
11652
|
+
description: The previous offset.
|
|
11653
|
+
format: int64
|
|
11654
|
+
type: integer
|
|
11655
|
+
total:
|
|
11656
|
+
description: Total results.
|
|
11657
|
+
format: int64
|
|
11658
|
+
type: integer
|
|
11659
|
+
type:
|
|
11660
|
+
description: Offset type.
|
|
11661
|
+
type: string
|
|
10548
11662
|
type: object
|
|
10549
|
-
PermissionsType:
|
|
10550
|
-
default: permissions
|
|
10551
|
-
description: Permissions resource type.
|
|
10552
|
-
enum:
|
|
10553
|
-
- permissions
|
|
10554
|
-
example: permissions
|
|
10555
|
-
type: string
|
|
10556
|
-
x-enum-varnames:
|
|
10557
|
-
- PERMISSIONS
|
|
10558
11663
|
ProcessSummariesMeta:
|
|
10559
11664
|
description: Response metadata object.
|
|
10560
11665
|
properties:
|
|
@@ -11553,6 +12658,21 @@ components:
|
|
|
11553
12658
|
required:
|
|
11554
12659
|
- data
|
|
11555
12660
|
type: object
|
|
12661
|
+
RelationshipToOutcome:
|
|
12662
|
+
description: The JSON:API relationship to a scorecard outcome.
|
|
12663
|
+
properties:
|
|
12664
|
+
data:
|
|
12665
|
+
$ref: '#/components/schemas/RelationshipToOutcomeData'
|
|
12666
|
+
type: object
|
|
12667
|
+
RelationshipToOutcomeData:
|
|
12668
|
+
description: The JSON:API relationship to an outcome, which returns the related
|
|
12669
|
+
rule id.
|
|
12670
|
+
properties:
|
|
12671
|
+
id:
|
|
12672
|
+
$ref: '#/components/schemas/RuleId'
|
|
12673
|
+
type:
|
|
12674
|
+
$ref: '#/components/schemas/RuleType'
|
|
12675
|
+
type: object
|
|
11556
12676
|
RelationshipToPermission:
|
|
11557
12677
|
description: Relationship to a permissions object.
|
|
11558
12678
|
properties:
|
|
@@ -11602,6 +12722,28 @@ components:
|
|
|
11602
12722
|
$ref: '#/components/schemas/RelationshipToRoleData'
|
|
11603
12723
|
type: array
|
|
11604
12724
|
type: object
|
|
12725
|
+
RelationshipToRule:
|
|
12726
|
+
description: Scorecard create rule response relationship.
|
|
12727
|
+
properties:
|
|
12728
|
+
scorecard:
|
|
12729
|
+
$ref: '#/components/schemas/RelationshipToRuleData'
|
|
12730
|
+
type: object
|
|
12731
|
+
RelationshipToRuleData:
|
|
12732
|
+
description: Relationship data for a rule.
|
|
12733
|
+
properties:
|
|
12734
|
+
data:
|
|
12735
|
+
$ref: '#/components/schemas/RelationshipToRuleDataObject'
|
|
12736
|
+
type: object
|
|
12737
|
+
RelationshipToRuleDataObject:
|
|
12738
|
+
description: Rule relationship data.
|
|
12739
|
+
properties:
|
|
12740
|
+
id:
|
|
12741
|
+
description: The unique ID for a scorecard.
|
|
12742
|
+
example: 00000000-0000-beef-0000-000000000000
|
|
12743
|
+
type: string
|
|
12744
|
+
type:
|
|
12745
|
+
$ref: '#/components/schemas/ScorecardType'
|
|
12746
|
+
type: object
|
|
11605
12747
|
RelationshipToSAMLAssertionAttribute:
|
|
11606
12748
|
description: AuthN Mapping relationship to SAML Assertion Attribute.
|
|
11607
12749
|
properties:
|
|
@@ -11722,6 +12864,17 @@ components:
|
|
|
11722
12864
|
required:
|
|
11723
12865
|
- data
|
|
11724
12866
|
type: object
|
|
12867
|
+
ReorderRetentionFiltersRequest:
|
|
12868
|
+
description: A list of retention filters to reorder.
|
|
12869
|
+
properties:
|
|
12870
|
+
data:
|
|
12871
|
+
description: A list of retention filters objects.
|
|
12872
|
+
items:
|
|
12873
|
+
$ref: '#/components/schemas/RetentionFilterWithoutAttributes'
|
|
12874
|
+
type: array
|
|
12875
|
+
required:
|
|
12876
|
+
- data
|
|
12877
|
+
type: object
|
|
11725
12878
|
ResponseMetaAttributes:
|
|
11726
12879
|
description: Object describing meta attributes of response.
|
|
11727
12880
|
properties:
|
|
@@ -11765,8 +12918,8 @@ components:
|
|
|
11765
12918
|
description: 'An array of principals. A principal is a subject or group
|
|
11766
12919
|
of subjects.
|
|
11767
12920
|
|
|
11768
|
-
Each principal is formatted as `type:id`. Supported types: `role`, `team
|
|
11769
|
-
|
|
12921
|
+
Each principal is formatted as `type:id`. Supported types: `role`, `team`,
|
|
12922
|
+
`user`, and `org`.
|
|
11770
12923
|
|
|
11771
12924
|
The org ID can be obtained through the api/v2/current_user API.
|
|
11772
12925
|
|
|
@@ -11777,7 +12930,7 @@ components:
|
|
|
11777
12930
|
description: 'Subject or group of subjects. Each principal is formatted
|
|
11778
12931
|
as `type:id`.
|
|
11779
12932
|
|
|
11780
|
-
Supported types: `role`, `team
|
|
12933
|
+
Supported types: `role`, `team`, `user`, and `org`.
|
|
11781
12934
|
|
|
11782
12935
|
The org ID can be obtained through the api/v2/current_user API.
|
|
11783
12936
|
|
|
@@ -11817,6 +12970,255 @@ components:
|
|
|
11817
12970
|
required:
|
|
11818
12971
|
- data
|
|
11819
12972
|
type: object
|
|
12973
|
+
RetentionFilter:
|
|
12974
|
+
description: The definition of the retention filter.
|
|
12975
|
+
properties:
|
|
12976
|
+
attributes:
|
|
12977
|
+
$ref: '#/components/schemas/RetentionFilterAttributes'
|
|
12978
|
+
id:
|
|
12979
|
+
description: The ID of the retention filter.
|
|
12980
|
+
example: 7RBOb7dLSYWI01yc3pIH8w
|
|
12981
|
+
type: string
|
|
12982
|
+
type:
|
|
12983
|
+
$ref: '#/components/schemas/ApmRetentionFilterType'
|
|
12984
|
+
required:
|
|
12985
|
+
- id
|
|
12986
|
+
- type
|
|
12987
|
+
- attributes
|
|
12988
|
+
type: object
|
|
12989
|
+
RetentionFilterAll:
|
|
12990
|
+
description: The definition of the retention filter.
|
|
12991
|
+
properties:
|
|
12992
|
+
attributes:
|
|
12993
|
+
$ref: '#/components/schemas/RetentionFilterAllAttributes'
|
|
12994
|
+
id:
|
|
12995
|
+
description: The ID of the retention filter.
|
|
12996
|
+
example: 7RBOb7dLSYWI01yc3pIH8w
|
|
12997
|
+
type: string
|
|
12998
|
+
type:
|
|
12999
|
+
$ref: '#/components/schemas/ApmRetentionFilterType'
|
|
13000
|
+
required:
|
|
13001
|
+
- id
|
|
13002
|
+
- type
|
|
13003
|
+
- attributes
|
|
13004
|
+
type: object
|
|
13005
|
+
RetentionFilterAllAttributes:
|
|
13006
|
+
description: The attributes of the retention filter.
|
|
13007
|
+
properties:
|
|
13008
|
+
created_at:
|
|
13009
|
+
description: The creation timestamp of the retention filter.
|
|
13010
|
+
format: int64
|
|
13011
|
+
type: integer
|
|
13012
|
+
created_by:
|
|
13013
|
+
description: The creator of the retention filter.
|
|
13014
|
+
type: string
|
|
13015
|
+
editable:
|
|
13016
|
+
description: Shows whether the filter can be edited.
|
|
13017
|
+
example: true
|
|
13018
|
+
type: boolean
|
|
13019
|
+
enabled:
|
|
13020
|
+
description: The status of the retention filter (Enabled/Disabled).
|
|
13021
|
+
example: true
|
|
13022
|
+
type: boolean
|
|
13023
|
+
execution_order:
|
|
13024
|
+
description: The execution order of the retention filter.
|
|
13025
|
+
format: int64
|
|
13026
|
+
type: integer
|
|
13027
|
+
filter:
|
|
13028
|
+
$ref: '#/components/schemas/SpansFilter'
|
|
13029
|
+
filter_type:
|
|
13030
|
+
$ref: '#/components/schemas/RetentionFilterAllType'
|
|
13031
|
+
modified_at:
|
|
13032
|
+
description: The modification timestamp of the retention filter.
|
|
13033
|
+
format: int64
|
|
13034
|
+
type: integer
|
|
13035
|
+
modified_by:
|
|
13036
|
+
description: The modifier of the retention filter.
|
|
13037
|
+
type: string
|
|
13038
|
+
name:
|
|
13039
|
+
description: The name of the retention filter.
|
|
13040
|
+
example: my retention filter
|
|
13041
|
+
type: string
|
|
13042
|
+
rate:
|
|
13043
|
+
description: 'Sample rate to apply to spans going through this retention
|
|
13044
|
+
filter,
|
|
13045
|
+
|
|
13046
|
+
a value of 1.0 keeps all spans matching the query.'
|
|
13047
|
+
example: 1.0
|
|
13048
|
+
format: double
|
|
13049
|
+
type: number
|
|
13050
|
+
type: object
|
|
13051
|
+
RetentionFilterAllType:
|
|
13052
|
+
default: spans-sampling-processor
|
|
13053
|
+
description: The type of retention filter.
|
|
13054
|
+
enum:
|
|
13055
|
+
- spans-sampling-processor
|
|
13056
|
+
- spans-errors-sampling-processor
|
|
13057
|
+
- spans-appsec-sampling-processor
|
|
13058
|
+
type: string
|
|
13059
|
+
x-enum-varnames:
|
|
13060
|
+
- SPANS_SAMPLING_PROCESSOR
|
|
13061
|
+
- SPANS_ERRORS_SAMPLING_PROCESSOR
|
|
13062
|
+
- SPANS_APPSEC_SAMPLING_PROCESSOR
|
|
13063
|
+
RetentionFilterAttributes:
|
|
13064
|
+
description: The attributes of the retention filter.
|
|
13065
|
+
properties:
|
|
13066
|
+
created_at:
|
|
13067
|
+
description: The creation timestamp of the retention filter.
|
|
13068
|
+
format: int64
|
|
13069
|
+
type: integer
|
|
13070
|
+
created_by:
|
|
13071
|
+
description: The creator of the retention filter.
|
|
13072
|
+
type: string
|
|
13073
|
+
editable:
|
|
13074
|
+
description: Shows whether the filter can be edited.
|
|
13075
|
+
example: true
|
|
13076
|
+
type: boolean
|
|
13077
|
+
enabled:
|
|
13078
|
+
description: The status of the retention filter (Enabled/Disabled).
|
|
13079
|
+
example: true
|
|
13080
|
+
type: boolean
|
|
13081
|
+
execution_order:
|
|
13082
|
+
description: The execution order of the retention filter.
|
|
13083
|
+
format: int64
|
|
13084
|
+
type: integer
|
|
13085
|
+
filter:
|
|
13086
|
+
$ref: '#/components/schemas/SpansFilter'
|
|
13087
|
+
filter_type:
|
|
13088
|
+
$ref: '#/components/schemas/RetentionFilterType'
|
|
13089
|
+
modified_at:
|
|
13090
|
+
description: The modification timestamp of the retention filter.
|
|
13091
|
+
format: int64
|
|
13092
|
+
type: integer
|
|
13093
|
+
modified_by:
|
|
13094
|
+
description: The modifier of the retention filter.
|
|
13095
|
+
type: string
|
|
13096
|
+
name:
|
|
13097
|
+
description: The name of the retention filter.
|
|
13098
|
+
example: my retention filter
|
|
13099
|
+
type: string
|
|
13100
|
+
rate:
|
|
13101
|
+
description: 'Sample rate to apply to spans going through this retention
|
|
13102
|
+
filter,
|
|
13103
|
+
|
|
13104
|
+
a value of 1.0 keeps all spans matching the query.'
|
|
13105
|
+
example: 1.0
|
|
13106
|
+
format: double
|
|
13107
|
+
type: number
|
|
13108
|
+
type: object
|
|
13109
|
+
RetentionFilterCreateAttributes:
|
|
13110
|
+
description: The object describing the configuration of the retention filter
|
|
13111
|
+
to create/update.
|
|
13112
|
+
properties:
|
|
13113
|
+
enabled:
|
|
13114
|
+
description: Enable/Disable the retention filter.
|
|
13115
|
+
example: true
|
|
13116
|
+
type: boolean
|
|
13117
|
+
filter:
|
|
13118
|
+
$ref: '#/components/schemas/SpansFilterCreate'
|
|
13119
|
+
filter_type:
|
|
13120
|
+
$ref: '#/components/schemas/RetentionFilterType'
|
|
13121
|
+
name:
|
|
13122
|
+
description: The name of the retention filter.
|
|
13123
|
+
example: my retention filter
|
|
13124
|
+
type: string
|
|
13125
|
+
rate:
|
|
13126
|
+
description: 'Sample rate to apply to spans going through this retention
|
|
13127
|
+
filter,
|
|
13128
|
+
|
|
13129
|
+
a value of 1.0 keeps all spans matching the query.'
|
|
13130
|
+
example: 1.0
|
|
13131
|
+
format: double
|
|
13132
|
+
type: number
|
|
13133
|
+
required:
|
|
13134
|
+
- name
|
|
13135
|
+
- filter
|
|
13136
|
+
- enabled
|
|
13137
|
+
- filter_type
|
|
13138
|
+
- rate
|
|
13139
|
+
type: object
|
|
13140
|
+
RetentionFilterCreateData:
|
|
13141
|
+
description: The body of the retention filter to be created.
|
|
13142
|
+
properties:
|
|
13143
|
+
attributes:
|
|
13144
|
+
$ref: '#/components/schemas/RetentionFilterCreateAttributes'
|
|
13145
|
+
type:
|
|
13146
|
+
$ref: '#/components/schemas/ApmRetentionFilterType'
|
|
13147
|
+
required:
|
|
13148
|
+
- attributes
|
|
13149
|
+
- type
|
|
13150
|
+
type: object
|
|
13151
|
+
RetentionFilterCreateRequest:
|
|
13152
|
+
description: The body of the retention filter to be created.
|
|
13153
|
+
properties:
|
|
13154
|
+
data:
|
|
13155
|
+
$ref: '#/components/schemas/RetentionFilterCreateData'
|
|
13156
|
+
required:
|
|
13157
|
+
- data
|
|
13158
|
+
type: object
|
|
13159
|
+
RetentionFilterResponse:
|
|
13160
|
+
description: The retention filters definition.
|
|
13161
|
+
properties:
|
|
13162
|
+
data:
|
|
13163
|
+
$ref: '#/components/schemas/RetentionFilter'
|
|
13164
|
+
type: object
|
|
13165
|
+
RetentionFilterType:
|
|
13166
|
+
default: spans-sampling-processor
|
|
13167
|
+
description: The type of retention filter. The value should always be spans-sampling-processor.
|
|
13168
|
+
enum:
|
|
13169
|
+
- spans-sampling-processor
|
|
13170
|
+
example: spans-sampling-processor
|
|
13171
|
+
type: string
|
|
13172
|
+
x-enum-varnames:
|
|
13173
|
+
- SPANS_SAMPLING_PROCESSOR
|
|
13174
|
+
RetentionFilterUpdateData:
|
|
13175
|
+
description: The body of the retention filter to be updated.
|
|
13176
|
+
properties:
|
|
13177
|
+
attributes:
|
|
13178
|
+
$ref: '#/components/schemas/RetentionFilterCreateAttributes'
|
|
13179
|
+
id:
|
|
13180
|
+
description: The ID of the retention filter.
|
|
13181
|
+
example: retention-filter-id
|
|
13182
|
+
type: string
|
|
13183
|
+
type:
|
|
13184
|
+
$ref: '#/components/schemas/ApmRetentionFilterType'
|
|
13185
|
+
required:
|
|
13186
|
+
- id
|
|
13187
|
+
- attributes
|
|
13188
|
+
- type
|
|
13189
|
+
type: object
|
|
13190
|
+
RetentionFilterUpdateRequest:
|
|
13191
|
+
description: The body of the retention filter to be updated.
|
|
13192
|
+
properties:
|
|
13193
|
+
data:
|
|
13194
|
+
$ref: '#/components/schemas/RetentionFilterUpdateData'
|
|
13195
|
+
required:
|
|
13196
|
+
- data
|
|
13197
|
+
type: object
|
|
13198
|
+
RetentionFilterWithoutAttributes:
|
|
13199
|
+
description: The retention filter object .
|
|
13200
|
+
properties:
|
|
13201
|
+
id:
|
|
13202
|
+
description: The ID of the retention filter.
|
|
13203
|
+
example: 7RBOb7dLSYWI01yc3pIH8w
|
|
13204
|
+
type: string
|
|
13205
|
+
type:
|
|
13206
|
+
$ref: '#/components/schemas/ApmRetentionFilterType'
|
|
13207
|
+
required:
|
|
13208
|
+
- id
|
|
13209
|
+
- type
|
|
13210
|
+
type: object
|
|
13211
|
+
RetentionFiltersResponse:
|
|
13212
|
+
description: An ordered list of retention filters.
|
|
13213
|
+
properties:
|
|
13214
|
+
data:
|
|
13215
|
+
description: A list of retention filters objects.
|
|
13216
|
+
items:
|
|
13217
|
+
$ref: '#/components/schemas/RetentionFilterAll'
|
|
13218
|
+
type: array
|
|
13219
|
+
required:
|
|
13220
|
+
- data
|
|
13221
|
+
type: object
|
|
11820
13222
|
Role:
|
|
11821
13223
|
description: Role object returned by the API.
|
|
11822
13224
|
properties:
|
|
@@ -12052,22 +13454,78 @@ components:
|
|
|
12052
13454
|
- user_count
|
|
12053
13455
|
- -user_count
|
|
12054
13456
|
type: string
|
|
12055
|
-
x-enum-varnames:
|
|
12056
|
-
- NAME_ASCENDING
|
|
12057
|
-
- NAME_DESCENDING
|
|
12058
|
-
- MODIFIED_AT_ASCENDING
|
|
12059
|
-
- MODIFIED_AT_DESCENDING
|
|
12060
|
-
- USER_COUNT_ASCENDING
|
|
12061
|
-
- USER_COUNT_DESCENDING
|
|
12062
|
-
RolesType:
|
|
12063
|
-
default: roles
|
|
12064
|
-
description: Roles type.
|
|
13457
|
+
x-enum-varnames:
|
|
13458
|
+
- NAME_ASCENDING
|
|
13459
|
+
- NAME_DESCENDING
|
|
13460
|
+
- MODIFIED_AT_ASCENDING
|
|
13461
|
+
- MODIFIED_AT_DESCENDING
|
|
13462
|
+
- USER_COUNT_ASCENDING
|
|
13463
|
+
- USER_COUNT_DESCENDING
|
|
13464
|
+
RolesType:
|
|
13465
|
+
default: roles
|
|
13466
|
+
description: Roles type.
|
|
13467
|
+
enum:
|
|
13468
|
+
- roles
|
|
13469
|
+
example: roles
|
|
13470
|
+
type: string
|
|
13471
|
+
x-enum-varnames:
|
|
13472
|
+
- ROLES
|
|
13473
|
+
RuleAttributes:
|
|
13474
|
+
description: Details of a rule.
|
|
13475
|
+
properties:
|
|
13476
|
+
category:
|
|
13477
|
+
deprecated: true
|
|
13478
|
+
description: The scorecard name to which this rule must belong.
|
|
13479
|
+
type: string
|
|
13480
|
+
created_at:
|
|
13481
|
+
description: Creation time of the rule outcome.
|
|
13482
|
+
format: date-time
|
|
13483
|
+
type: string
|
|
13484
|
+
custom:
|
|
13485
|
+
description: Defines if the rule is a custom rule.
|
|
13486
|
+
type: boolean
|
|
13487
|
+
description:
|
|
13488
|
+
description: Explanation of the rule.
|
|
13489
|
+
type: string
|
|
13490
|
+
enabled:
|
|
13491
|
+
description: If enabled, the rule is calculated as part of the score.
|
|
13492
|
+
example: true
|
|
13493
|
+
type: boolean
|
|
13494
|
+
modified_at:
|
|
13495
|
+
description: Time of the last rule outcome modification.
|
|
13496
|
+
format: date-time
|
|
13497
|
+
type: string
|
|
13498
|
+
name:
|
|
13499
|
+
description: Name of the rule.
|
|
13500
|
+
example: Team Defined
|
|
13501
|
+
type: string
|
|
13502
|
+
owner:
|
|
13503
|
+
description: Owner of the rule.
|
|
13504
|
+
type: string
|
|
13505
|
+
scorecard_name:
|
|
13506
|
+
description: The scorecard name to which this rule must belong.
|
|
13507
|
+
example: Deployments automated via Deployment Trains
|
|
13508
|
+
type: string
|
|
13509
|
+
type: object
|
|
13510
|
+
RuleId:
|
|
13511
|
+
description: The unique ID for a scorecard rule.
|
|
13512
|
+
example: 00000000-0000-beef-0000-000000000000
|
|
13513
|
+
type: string
|
|
13514
|
+
RuleOutcomeRelationships:
|
|
13515
|
+
description: The JSON:API relationship to a scorecard rule.
|
|
13516
|
+
properties:
|
|
13517
|
+
rule:
|
|
13518
|
+
$ref: '#/components/schemas/RelationshipToOutcome'
|
|
13519
|
+
type: object
|
|
13520
|
+
RuleType:
|
|
13521
|
+
default: rule
|
|
13522
|
+
description: The JSON:API type for scorecard rules.
|
|
12065
13523
|
enum:
|
|
12066
|
-
-
|
|
12067
|
-
example:
|
|
13524
|
+
- rule
|
|
13525
|
+
example: rule
|
|
12068
13526
|
type: string
|
|
12069
13527
|
x-enum-varnames:
|
|
12070
|
-
-
|
|
13528
|
+
- RULE
|
|
12071
13529
|
SAMLAssertionAttribute:
|
|
12072
13530
|
description: SAML assertion attribute.
|
|
12073
13531
|
properties:
|
|
@@ -12111,6 +13569,24 @@ components:
|
|
|
12111
13569
|
oneOf:
|
|
12112
13570
|
- $ref: '#/components/schemas/GroupScalarColumn'
|
|
12113
13571
|
- $ref: '#/components/schemas/DataScalarColumn'
|
|
13572
|
+
ScalarColumnTypeGroup:
|
|
13573
|
+
default: group
|
|
13574
|
+
description: The type of column present for groups.
|
|
13575
|
+
enum:
|
|
13576
|
+
- group
|
|
13577
|
+
example: group
|
|
13578
|
+
type: string
|
|
13579
|
+
x-enum-varnames:
|
|
13580
|
+
- GROUP
|
|
13581
|
+
ScalarColumnTypeNumber:
|
|
13582
|
+
default: number
|
|
13583
|
+
description: The type of column present for numbers.
|
|
13584
|
+
enum:
|
|
13585
|
+
- number
|
|
13586
|
+
example: number
|
|
13587
|
+
type: string
|
|
13588
|
+
x-enum-varnames:
|
|
13589
|
+
- NUMBER
|
|
12114
13590
|
ScalarFormulaQueryRequest:
|
|
12115
13591
|
description: A wrapper request around one scalar query to be executed.
|
|
12116
13592
|
properties:
|
|
@@ -12215,6 +13691,7 @@ components:
|
|
|
12215
13691
|
If the second element is not present, the API returns null.'
|
|
12216
13692
|
items:
|
|
12217
13693
|
$ref: '#/components/schemas/Unit'
|
|
13694
|
+
nullable: true
|
|
12218
13695
|
type: array
|
|
12219
13696
|
type: object
|
|
12220
13697
|
ScalarQuery:
|
|
@@ -12234,6 +13711,15 @@ components:
|
|
|
12234
13711
|
type:
|
|
12235
13712
|
$ref: '#/components/schemas/ScalarFormulaResponseType'
|
|
12236
13713
|
type: object
|
|
13714
|
+
ScorecardType:
|
|
13715
|
+
default: scorecard
|
|
13716
|
+
description: The JSON:API type for scorecard.
|
|
13717
|
+
enum:
|
|
13718
|
+
- scorecard
|
|
13719
|
+
example: scorecard
|
|
13720
|
+
type: string
|
|
13721
|
+
x-enum-varnames:
|
|
13722
|
+
- SCORECARD
|
|
12237
13723
|
SecurityFilter:
|
|
12238
13724
|
description: The security filter's properties.
|
|
12239
13725
|
properties:
|
|
@@ -12947,7 +14433,7 @@ components:
|
|
|
12947
14433
|
|
|
12948
14434
|
associated values.'
|
|
12949
14435
|
properties:
|
|
12950
|
-
|
|
14436
|
+
custom:
|
|
12951
14437
|
additionalProperties: {}
|
|
12952
14438
|
description: A JSON object of attributes in the security signal.
|
|
12953
14439
|
example:
|
|
@@ -13533,6 +15019,13 @@ components:
|
|
|
13533
15019
|
description: Field.
|
|
13534
15020
|
type: string
|
|
13535
15021
|
type: array
|
|
15022
|
+
hasOptionalGroupByFields:
|
|
15023
|
+
description: When false, events without a group-by value are ignored by
|
|
15024
|
+
the rule. When true, events with missing group-by fields are processed
|
|
15025
|
+
with `N/A`, replacing the missing values.
|
|
15026
|
+
example: false
|
|
15027
|
+
readOnly: true
|
|
15028
|
+
type: boolean
|
|
13536
15029
|
metric:
|
|
13537
15030
|
deprecated: true
|
|
13538
15031
|
description: '(Deprecated) The target field to aggregate over when using
|
|
@@ -14396,6 +15889,7 @@ components:
|
|
|
14396
15889
|
- $ref: '#/components/schemas/ServiceDefinitionV1'
|
|
14397
15890
|
- $ref: '#/components/schemas/ServiceDefinitionV2'
|
|
14398
15891
|
- $ref: '#/components/schemas/ServiceDefinitionV2Dot1'
|
|
15892
|
+
- $ref: '#/components/schemas/ServiceDefinitionV2Dot2'
|
|
14399
15893
|
type: object
|
|
14400
15894
|
ServiceDefinitionSchemaVersions:
|
|
14401
15895
|
description: Schema versions
|
|
@@ -14403,11 +15897,13 @@ components:
|
|
|
14403
15897
|
- v1
|
|
14404
15898
|
- v2
|
|
14405
15899
|
- v2.1
|
|
15900
|
+
- v2.2
|
|
14406
15901
|
type: string
|
|
14407
15902
|
x-enum-varnames:
|
|
14408
15903
|
- V1
|
|
14409
15904
|
- V2
|
|
14410
15905
|
- V2_1
|
|
15906
|
+
- V2_2
|
|
14411
15907
|
ServiceDefinitionV1:
|
|
14412
15908
|
deprecated: true
|
|
14413
15909
|
description: Deprecated - Service definition V1 for providing additional service
|
|
@@ -14712,36 +16208,271 @@ components:
|
|
|
14712
16208
|
properties:
|
|
14713
16209
|
contact:
|
|
14714
16210
|
description: Contact value.
|
|
14715
|
-
example: contact@datadoghq.com
|
|
14716
|
-
format: email
|
|
16211
|
+
example: contact@datadoghq.com
|
|
16212
|
+
format: email
|
|
16213
|
+
type: string
|
|
16214
|
+
name:
|
|
16215
|
+
description: Contact email.
|
|
16216
|
+
example: Team Email
|
|
16217
|
+
type: string
|
|
16218
|
+
type:
|
|
16219
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot1EmailType'
|
|
16220
|
+
required:
|
|
16221
|
+
- type
|
|
16222
|
+
- contact
|
|
16223
|
+
type: object
|
|
16224
|
+
ServiceDefinitionV2Dot1EmailType:
|
|
16225
|
+
description: Contact type.
|
|
16226
|
+
enum:
|
|
16227
|
+
- email
|
|
16228
|
+
example: email
|
|
16229
|
+
type: string
|
|
16230
|
+
x-enum-varnames:
|
|
16231
|
+
- EMAIL
|
|
16232
|
+
ServiceDefinitionV2Dot1Integrations:
|
|
16233
|
+
description: Third party integrations that Datadog supports.
|
|
16234
|
+
properties:
|
|
16235
|
+
opsgenie:
|
|
16236
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot1Opsgenie'
|
|
16237
|
+
pagerduty:
|
|
16238
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot1Pagerduty'
|
|
16239
|
+
type: object
|
|
16240
|
+
ServiceDefinitionV2Dot1Link:
|
|
16241
|
+
description: Service's external links.
|
|
16242
|
+
properties:
|
|
16243
|
+
name:
|
|
16244
|
+
description: Link name.
|
|
16245
|
+
example: Runbook
|
|
16246
|
+
type: string
|
|
16247
|
+
provider:
|
|
16248
|
+
description: Link provider.
|
|
16249
|
+
example: Github
|
|
16250
|
+
type: string
|
|
16251
|
+
type:
|
|
16252
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot1LinkType'
|
|
16253
|
+
url:
|
|
16254
|
+
description: Link URL.
|
|
16255
|
+
example: https://my-runbook
|
|
16256
|
+
type: string
|
|
16257
|
+
required:
|
|
16258
|
+
- name
|
|
16259
|
+
- type
|
|
16260
|
+
- url
|
|
16261
|
+
type: object
|
|
16262
|
+
ServiceDefinitionV2Dot1LinkType:
|
|
16263
|
+
description: Link type.
|
|
16264
|
+
enum:
|
|
16265
|
+
- doc
|
|
16266
|
+
- repo
|
|
16267
|
+
- runbook
|
|
16268
|
+
- dashboard
|
|
16269
|
+
- other
|
|
16270
|
+
example: runbook
|
|
16271
|
+
type: string
|
|
16272
|
+
x-enum-varnames:
|
|
16273
|
+
- DOC
|
|
16274
|
+
- REPO
|
|
16275
|
+
- RUNBOOK
|
|
16276
|
+
- DASHBOARD
|
|
16277
|
+
- OTHER
|
|
16278
|
+
ServiceDefinitionV2Dot1MSTeams:
|
|
16279
|
+
description: Service owner's Microsoft Teams.
|
|
16280
|
+
properties:
|
|
16281
|
+
contact:
|
|
16282
|
+
description: Contact value.
|
|
16283
|
+
example: https://teams.microsoft.com/myteam
|
|
16284
|
+
type: string
|
|
16285
|
+
name:
|
|
16286
|
+
description: Contact Microsoft Teams.
|
|
16287
|
+
example: My team channel
|
|
16288
|
+
type: string
|
|
16289
|
+
type:
|
|
16290
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot1MSTeamsType'
|
|
16291
|
+
required:
|
|
16292
|
+
- type
|
|
16293
|
+
- contact
|
|
16294
|
+
type: object
|
|
16295
|
+
ServiceDefinitionV2Dot1MSTeamsType:
|
|
16296
|
+
description: Contact type.
|
|
16297
|
+
enum:
|
|
16298
|
+
- microsoft-teams
|
|
16299
|
+
example: microsoft-teams
|
|
16300
|
+
type: string
|
|
16301
|
+
x-enum-varnames:
|
|
16302
|
+
- MICROSOFT_TEAMS
|
|
16303
|
+
ServiceDefinitionV2Dot1Opsgenie:
|
|
16304
|
+
description: Opsgenie integration for the service.
|
|
16305
|
+
properties:
|
|
16306
|
+
region:
|
|
16307
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot1OpsgenieRegion'
|
|
16308
|
+
service-url:
|
|
16309
|
+
description: Opsgenie service url.
|
|
16310
|
+
example: https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000
|
|
16311
|
+
type: string
|
|
16312
|
+
required:
|
|
16313
|
+
- service-url
|
|
16314
|
+
type: object
|
|
16315
|
+
ServiceDefinitionV2Dot1OpsgenieRegion:
|
|
16316
|
+
description: Opsgenie instance region.
|
|
16317
|
+
enum:
|
|
16318
|
+
- US
|
|
16319
|
+
- EU
|
|
16320
|
+
example: US
|
|
16321
|
+
type: string
|
|
16322
|
+
x-enum-varnames:
|
|
16323
|
+
- US
|
|
16324
|
+
- EU
|
|
16325
|
+
ServiceDefinitionV2Dot1Pagerduty:
|
|
16326
|
+
description: PagerDuty integration for the service.
|
|
16327
|
+
properties:
|
|
16328
|
+
service-url:
|
|
16329
|
+
description: PagerDuty service url.
|
|
16330
|
+
example: https://my-org.pagerduty.com/service-directory/PMyService
|
|
16331
|
+
type: string
|
|
16332
|
+
type: object
|
|
16333
|
+
ServiceDefinitionV2Dot1Slack:
|
|
16334
|
+
description: Service owner's Slack channel.
|
|
16335
|
+
properties:
|
|
16336
|
+
contact:
|
|
16337
|
+
description: Slack Channel.
|
|
16338
|
+
example: https://yourcompany.slack.com/archives/channel123
|
|
16339
|
+
type: string
|
|
16340
|
+
name:
|
|
16341
|
+
description: Contact Slack.
|
|
16342
|
+
example: Team Slack
|
|
16343
|
+
type: string
|
|
16344
|
+
type:
|
|
16345
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot1SlackType'
|
|
16346
|
+
required:
|
|
16347
|
+
- type
|
|
16348
|
+
- contact
|
|
16349
|
+
type: object
|
|
16350
|
+
ServiceDefinitionV2Dot1SlackType:
|
|
16351
|
+
description: Contact type.
|
|
16352
|
+
enum:
|
|
16353
|
+
- slack
|
|
16354
|
+
example: slack
|
|
16355
|
+
type: string
|
|
16356
|
+
x-enum-varnames:
|
|
16357
|
+
- SLACK
|
|
16358
|
+
ServiceDefinitionV2Dot1Version:
|
|
16359
|
+
default: v2.1
|
|
16360
|
+
description: Schema version being used.
|
|
16361
|
+
enum:
|
|
16362
|
+
- v2.1
|
|
16363
|
+
example: v2.1
|
|
16364
|
+
type: string
|
|
16365
|
+
x-enum-varnames:
|
|
16366
|
+
- V2_1
|
|
16367
|
+
ServiceDefinitionV2Dot2:
|
|
16368
|
+
description: Service definition v2.2 for providing service metadata and integrations.
|
|
16369
|
+
properties:
|
|
16370
|
+
application:
|
|
16371
|
+
description: Identifier for a group of related services serving a product
|
|
16372
|
+
feature, which the service is a part of.
|
|
16373
|
+
example: my-app
|
|
16374
|
+
type: string
|
|
16375
|
+
contacts:
|
|
16376
|
+
description: A list of contacts related to the services.
|
|
16377
|
+
items:
|
|
16378
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot2Contact'
|
|
16379
|
+
type: array
|
|
16380
|
+
dd-service:
|
|
16381
|
+
description: Unique identifier of the service. Must be unique across all
|
|
16382
|
+
services and is used to match with a service in Datadog.
|
|
16383
|
+
example: my-service
|
|
16384
|
+
type: string
|
|
16385
|
+
description:
|
|
16386
|
+
description: A short description of the service.
|
|
16387
|
+
example: My service description
|
|
16388
|
+
type: string
|
|
16389
|
+
extensions:
|
|
16390
|
+
additionalProperties: {}
|
|
16391
|
+
description: Extensions to v2.2 schema.
|
|
16392
|
+
example:
|
|
16393
|
+
myorg/extension: extensionValue
|
|
16394
|
+
type: object
|
|
16395
|
+
integrations:
|
|
16396
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot2Integrations'
|
|
16397
|
+
languages:
|
|
16398
|
+
description: 'The service''s programming language. Datadog recognizes the
|
|
16399
|
+
following languages: `dotnet`, `go`, `java`, `js`, `php`, `python`, `ruby`,
|
|
16400
|
+
and `c++`.'
|
|
16401
|
+
example:
|
|
16402
|
+
- dotnet
|
|
16403
|
+
- go
|
|
16404
|
+
- java
|
|
16405
|
+
- js
|
|
16406
|
+
- php
|
|
16407
|
+
- python
|
|
16408
|
+
- ruby
|
|
16409
|
+
- c++
|
|
16410
|
+
items:
|
|
16411
|
+
type: string
|
|
16412
|
+
type: array
|
|
16413
|
+
lifecycle:
|
|
16414
|
+
description: The current life cycle phase of the service.
|
|
16415
|
+
example: sandbox
|
|
16416
|
+
type: string
|
|
16417
|
+
links:
|
|
16418
|
+
description: A list of links related to the services.
|
|
16419
|
+
items:
|
|
16420
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot2Link'
|
|
16421
|
+
type: array
|
|
16422
|
+
schema-version:
|
|
16423
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot2Version'
|
|
16424
|
+
tags:
|
|
16425
|
+
description: A set of custom tags.
|
|
16426
|
+
example:
|
|
16427
|
+
- my:tag
|
|
16428
|
+
- service:tag
|
|
16429
|
+
items:
|
|
16430
|
+
type: string
|
|
16431
|
+
type: array
|
|
16432
|
+
team:
|
|
16433
|
+
description: Team that owns the service. It is used to locate a team defined
|
|
16434
|
+
in Datadog Teams if it exists.
|
|
16435
|
+
example: my-team
|
|
16436
|
+
type: string
|
|
16437
|
+
tier:
|
|
16438
|
+
description: Importance of the service.
|
|
16439
|
+
example: High
|
|
16440
|
+
type: string
|
|
16441
|
+
type:
|
|
16442
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot2Type'
|
|
16443
|
+
required:
|
|
16444
|
+
- schema-version
|
|
16445
|
+
- dd-service
|
|
16446
|
+
type: object
|
|
16447
|
+
ServiceDefinitionV2Dot2Contact:
|
|
16448
|
+
description: Service owner's contacts information.
|
|
16449
|
+
properties:
|
|
16450
|
+
contact:
|
|
16451
|
+
description: Contact value.
|
|
16452
|
+
example: https://teams.microsoft.com/myteam
|
|
14717
16453
|
type: string
|
|
14718
16454
|
name:
|
|
14719
|
-
description: Contact
|
|
14720
|
-
example:
|
|
16455
|
+
description: Contact Name.
|
|
16456
|
+
example: My team channel
|
|
14721
16457
|
type: string
|
|
14722
16458
|
type:
|
|
14723
|
-
|
|
16459
|
+
description: 'Contact type. Datadog recognizes the following types: `email`,
|
|
16460
|
+
`slack`, and `microsoft-teams`.'
|
|
16461
|
+
example: slack
|
|
16462
|
+
type: string
|
|
14724
16463
|
required:
|
|
14725
16464
|
- type
|
|
14726
16465
|
- contact
|
|
14727
16466
|
type: object
|
|
14728
|
-
|
|
14729
|
-
description: Contact type.
|
|
14730
|
-
enum:
|
|
14731
|
-
- email
|
|
14732
|
-
example: email
|
|
14733
|
-
type: string
|
|
14734
|
-
x-enum-varnames:
|
|
14735
|
-
- EMAIL
|
|
14736
|
-
ServiceDefinitionV2Dot1Integrations:
|
|
16467
|
+
ServiceDefinitionV2Dot2Integrations:
|
|
14737
16468
|
description: Third party integrations that Datadog supports.
|
|
14738
16469
|
properties:
|
|
14739
16470
|
opsgenie:
|
|
14740
|
-
$ref: '#/components/schemas/
|
|
16471
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot2Opsgenie'
|
|
14741
16472
|
pagerduty:
|
|
14742
|
-
$ref: '#/components/schemas/
|
|
16473
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot2Pagerduty'
|
|
14743
16474
|
type: object
|
|
14744
|
-
|
|
16475
|
+
ServiceDefinitionV2Dot2Link:
|
|
14745
16476
|
description: Service's external links.
|
|
14746
16477
|
properties:
|
|
14747
16478
|
name:
|
|
@@ -14753,7 +16484,10 @@ components:
|
|
|
14753
16484
|
example: Github
|
|
14754
16485
|
type: string
|
|
14755
16486
|
type:
|
|
14756
|
-
|
|
16487
|
+
description: 'Link type. Datadog recognizes the following types: `runbook`,
|
|
16488
|
+
`doc`, `repo`, `dashboard`, and `other`.'
|
|
16489
|
+
example: runbook
|
|
16490
|
+
type: string
|
|
14757
16491
|
url:
|
|
14758
16492
|
description: Link URL.
|
|
14759
16493
|
example: https://my-runbook
|
|
@@ -14763,52 +16497,11 @@ components:
|
|
|
14763
16497
|
- type
|
|
14764
16498
|
- url
|
|
14765
16499
|
type: object
|
|
14766
|
-
|
|
14767
|
-
description: Link type.
|
|
14768
|
-
enum:
|
|
14769
|
-
- doc
|
|
14770
|
-
- repo
|
|
14771
|
-
- runbook
|
|
14772
|
-
- dashboard
|
|
14773
|
-
- other
|
|
14774
|
-
example: runbook
|
|
14775
|
-
type: string
|
|
14776
|
-
x-enum-varnames:
|
|
14777
|
-
- DOC
|
|
14778
|
-
- REPO
|
|
14779
|
-
- RUNBOOK
|
|
14780
|
-
- DASHBOARD
|
|
14781
|
-
- OTHER
|
|
14782
|
-
ServiceDefinitionV2Dot1MSTeams:
|
|
14783
|
-
description: Service owner's Microsoft Teams.
|
|
14784
|
-
properties:
|
|
14785
|
-
contact:
|
|
14786
|
-
description: Contact value.
|
|
14787
|
-
example: https://teams.microsoft.com/myteam
|
|
14788
|
-
type: string
|
|
14789
|
-
name:
|
|
14790
|
-
description: Contact Microsoft Teams.
|
|
14791
|
-
example: My team channel
|
|
14792
|
-
type: string
|
|
14793
|
-
type:
|
|
14794
|
-
$ref: '#/components/schemas/ServiceDefinitionV2Dot1MSTeamsType'
|
|
14795
|
-
required:
|
|
14796
|
-
- type
|
|
14797
|
-
- contact
|
|
14798
|
-
type: object
|
|
14799
|
-
ServiceDefinitionV2Dot1MSTeamsType:
|
|
14800
|
-
description: Contact type.
|
|
14801
|
-
enum:
|
|
14802
|
-
- microsoft-teams
|
|
14803
|
-
example: microsoft-teams
|
|
14804
|
-
type: string
|
|
14805
|
-
x-enum-varnames:
|
|
14806
|
-
- MICROSOFT_TEAMS
|
|
14807
|
-
ServiceDefinitionV2Dot1Opsgenie:
|
|
16500
|
+
ServiceDefinitionV2Dot2Opsgenie:
|
|
14808
16501
|
description: Opsgenie integration for the service.
|
|
14809
16502
|
properties:
|
|
14810
16503
|
region:
|
|
14811
|
-
$ref: '#/components/schemas/
|
|
16504
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot2OpsgenieRegion'
|
|
14812
16505
|
service-url:
|
|
14813
16506
|
description: Opsgenie service url.
|
|
14814
16507
|
example: https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000
|
|
@@ -14816,7 +16509,7 @@ components:
|
|
|
14816
16509
|
required:
|
|
14817
16510
|
- service-url
|
|
14818
16511
|
type: object
|
|
14819
|
-
|
|
16512
|
+
ServiceDefinitionV2Dot2OpsgenieRegion:
|
|
14820
16513
|
description: Opsgenie instance region.
|
|
14821
16514
|
enum:
|
|
14822
16515
|
- US
|
|
@@ -14826,7 +16519,7 @@ components:
|
|
|
14826
16519
|
x-enum-varnames:
|
|
14827
16520
|
- US
|
|
14828
16521
|
- EU
|
|
14829
|
-
|
|
16522
|
+
ServiceDefinitionV2Dot2Pagerduty:
|
|
14830
16523
|
description: PagerDuty integration for the service.
|
|
14831
16524
|
properties:
|
|
14832
16525
|
service-url:
|
|
@@ -14834,40 +16527,35 @@ components:
|
|
|
14834
16527
|
example: https://my-org.pagerduty.com/service-directory/PMyService
|
|
14835
16528
|
type: string
|
|
14836
16529
|
type: object
|
|
14837
|
-
|
|
14838
|
-
description:
|
|
14839
|
-
properties:
|
|
14840
|
-
contact:
|
|
14841
|
-
description: Slack Channel.
|
|
14842
|
-
example: https://yourcompany.slack.com/archives/channel123
|
|
14843
|
-
type: string
|
|
14844
|
-
name:
|
|
14845
|
-
description: Contact Slack.
|
|
14846
|
-
example: Team Slack
|
|
14847
|
-
type: string
|
|
14848
|
-
type:
|
|
14849
|
-
$ref: '#/components/schemas/ServiceDefinitionV2Dot1SlackType'
|
|
14850
|
-
required:
|
|
14851
|
-
- type
|
|
14852
|
-
- contact
|
|
14853
|
-
type: object
|
|
14854
|
-
ServiceDefinitionV2Dot1SlackType:
|
|
14855
|
-
description: Contact type.
|
|
16530
|
+
ServiceDefinitionV2Dot2Type:
|
|
16531
|
+
description: The type of service.
|
|
14856
16532
|
enum:
|
|
14857
|
-
-
|
|
14858
|
-
|
|
16533
|
+
- web
|
|
16534
|
+
- db
|
|
16535
|
+
- cache
|
|
16536
|
+
- function
|
|
16537
|
+
- browser
|
|
16538
|
+
- mobile
|
|
16539
|
+
- custom
|
|
16540
|
+
example: web
|
|
14859
16541
|
type: string
|
|
14860
16542
|
x-enum-varnames:
|
|
14861
|
-
-
|
|
14862
|
-
|
|
14863
|
-
|
|
16543
|
+
- WEB
|
|
16544
|
+
- DB
|
|
16545
|
+
- CACHE
|
|
16546
|
+
- FUNCTION
|
|
16547
|
+
- BROSWER
|
|
16548
|
+
- MOBILE
|
|
16549
|
+
- CUSTOM
|
|
16550
|
+
ServiceDefinitionV2Dot2Version:
|
|
16551
|
+
default: v2.2
|
|
14864
16552
|
description: Schema version being used.
|
|
14865
16553
|
enum:
|
|
14866
|
-
- v2.
|
|
14867
|
-
example: v2.
|
|
16554
|
+
- v2.2
|
|
16555
|
+
example: v2.2
|
|
14868
16556
|
type: string
|
|
14869
16557
|
x-enum-varnames:
|
|
14870
|
-
-
|
|
16558
|
+
- V2_2
|
|
14871
16559
|
ServiceDefinitionV2Email:
|
|
14872
16560
|
description: Service owner's email.
|
|
14873
16561
|
properties:
|
|
@@ -15051,6 +16739,7 @@ components:
|
|
|
15051
16739
|
ServiceDefinitionsCreateRequest:
|
|
15052
16740
|
description: Create service definitions request.
|
|
15053
16741
|
oneOf:
|
|
16742
|
+
- $ref: '#/components/schemas/ServiceDefinitionV2Dot2'
|
|
15054
16743
|
- $ref: '#/components/schemas/ServiceDefinitionV2Dot1'
|
|
15055
16744
|
- $ref: '#/components/schemas/ServiceDefinitionV2'
|
|
15056
16745
|
- $ref: '#/components/schemas/ServiceDefinitionRaw'
|
|
@@ -15446,6 +17135,25 @@ components:
|
|
|
15446
17135
|
x-enum-varnames:
|
|
15447
17136
|
- TIMESERIES
|
|
15448
17137
|
- TOTAL
|
|
17138
|
+
SpansFilter:
|
|
17139
|
+
description: The spans filter used to index spans.
|
|
17140
|
+
properties:
|
|
17141
|
+
query:
|
|
17142
|
+
description: The search query - following the [span search syntax](https://docs.datadoghq.com/tracing/trace_explorer/query_syntax/).
|
|
17143
|
+
example: '@http.status_code:200 service:my-service'
|
|
17144
|
+
type: string
|
|
17145
|
+
type: object
|
|
17146
|
+
SpansFilterCreate:
|
|
17147
|
+
description: The spans filter. Spans matching this filter will be indexed and
|
|
17148
|
+
stored.
|
|
17149
|
+
properties:
|
|
17150
|
+
query:
|
|
17151
|
+
description: The search query - following the [span search syntax](https://docs.datadoghq.com/tracing/trace_explorer/query_syntax/).
|
|
17152
|
+
example: '@http.status_code:200 service:my-service'
|
|
17153
|
+
type: string
|
|
17154
|
+
required:
|
|
17155
|
+
- query
|
|
17156
|
+
type: object
|
|
15449
17157
|
SpansGroupBy:
|
|
15450
17158
|
description: A group by rule.
|
|
15451
17159
|
properties:
|
|
@@ -15945,6 +17653,18 @@ components:
|
|
|
15945
17653
|
from the other indexes
|
|
15946
17654
|
type: string
|
|
15947
17655
|
type: object
|
|
17656
|
+
State:
|
|
17657
|
+
description: The state of the rule evaluation.
|
|
17658
|
+
enum:
|
|
17659
|
+
- pass
|
|
17660
|
+
- fail
|
|
17661
|
+
- skip
|
|
17662
|
+
example: pass
|
|
17663
|
+
type: string
|
|
17664
|
+
x-enum-varnames:
|
|
17665
|
+
- PASS
|
|
17666
|
+
- FAIL
|
|
17667
|
+
- SKIP
|
|
15948
17668
|
TagsEventAttribute:
|
|
15949
17669
|
description: Array of tags associated with your event.
|
|
15950
17670
|
example:
|
|
@@ -16420,6 +18140,41 @@ components:
|
|
|
16420
18140
|
required:
|
|
16421
18141
|
- data
|
|
16422
18142
|
type: object
|
|
18143
|
+
TeamsField:
|
|
18144
|
+
description: Supported teams field.
|
|
18145
|
+
enum:
|
|
18146
|
+
- id
|
|
18147
|
+
- name
|
|
18148
|
+
- handle
|
|
18149
|
+
- summary
|
|
18150
|
+
- description
|
|
18151
|
+
- avatar
|
|
18152
|
+
- banner
|
|
18153
|
+
- visible_modules
|
|
18154
|
+
- hidden_modules
|
|
18155
|
+
- created_at
|
|
18156
|
+
- modified_at
|
|
18157
|
+
- user_count
|
|
18158
|
+
- link_count
|
|
18159
|
+
- team_links
|
|
18160
|
+
- user_team_permissions
|
|
18161
|
+
type: string
|
|
18162
|
+
x-enum-varnames:
|
|
18163
|
+
- ID
|
|
18164
|
+
- NAME
|
|
18165
|
+
- HANDLE
|
|
18166
|
+
- SUMMARY
|
|
18167
|
+
- DESCRIPTION
|
|
18168
|
+
- AVATAR
|
|
18169
|
+
- BANNER
|
|
18170
|
+
- VISIBLE_MODULES
|
|
18171
|
+
- HIDDEN_MODULES
|
|
18172
|
+
- CREATED_AT
|
|
18173
|
+
- MODIFIED_AT
|
|
18174
|
+
- USER_COUNT
|
|
18175
|
+
- LINK_COUNT
|
|
18176
|
+
- TEAM_LINKS
|
|
18177
|
+
- USER_TEAM_PERMISSIONS
|
|
16423
18178
|
TeamsResponse:
|
|
16424
18179
|
description: Response with multiple teams
|
|
16425
18180
|
properties:
|
|
@@ -17054,8 +18809,8 @@ components:
|
|
|
17054
18809
|
description: User team permission attributes
|
|
17055
18810
|
properties:
|
|
17056
18811
|
permissions:
|
|
17057
|
-
description: Object of team permission actions and boolean values
|
|
17058
|
-
|
|
18812
|
+
description: Object of team permission actions and boolean values that a
|
|
18813
|
+
logged in user can perform on this team.
|
|
17059
18814
|
readOnly: true
|
|
17060
18815
|
type: object
|
|
17061
18816
|
type: object
|
|
@@ -17208,6 +18963,42 @@ components:
|
|
|
17208
18963
|
type: string
|
|
17209
18964
|
x-enum-varnames:
|
|
17210
18965
|
- USERS
|
|
18966
|
+
WidgetLiveSpan:
|
|
18967
|
+
description: The available timeframes depend on the widget you are using.
|
|
18968
|
+
enum:
|
|
18969
|
+
- 1m
|
|
18970
|
+
- 5m
|
|
18971
|
+
- 10m
|
|
18972
|
+
- 15m
|
|
18973
|
+
- 30m
|
|
18974
|
+
- 1h
|
|
18975
|
+
- 4h
|
|
18976
|
+
- 1d
|
|
18977
|
+
- 2d
|
|
18978
|
+
- 1w
|
|
18979
|
+
- 1mo
|
|
18980
|
+
- 3mo
|
|
18981
|
+
- 6mo
|
|
18982
|
+
- 1y
|
|
18983
|
+
- alert
|
|
18984
|
+
example: 5m
|
|
18985
|
+
type: string
|
|
18986
|
+
x-enum-varnames:
|
|
18987
|
+
- PAST_ONE_MINUTE
|
|
18988
|
+
- PAST_FIVE_MINUTES
|
|
18989
|
+
- PAST_TEN_MINUTES
|
|
18990
|
+
- PAST_FIFTEEN_MINUTES
|
|
18991
|
+
- PAST_THIRTY_MINUTES
|
|
18992
|
+
- PAST_ONE_HOUR
|
|
18993
|
+
- PAST_FOUR_HOURS
|
|
18994
|
+
- PAST_ONE_DAY
|
|
18995
|
+
- PAST_TWO_DAYS
|
|
18996
|
+
- PAST_ONE_WEEK
|
|
18997
|
+
- PAST_ONE_MONTH
|
|
18998
|
+
- PAST_THREE_MONTHS
|
|
18999
|
+
- PAST_SIX_MONTHS
|
|
19000
|
+
- PAST_ONE_YEAR
|
|
19001
|
+
- ALERT
|
|
17211
19002
|
securitySchemes:
|
|
17212
19003
|
AuthZ:
|
|
17213
19004
|
description: This API uses OAuth 2 with the implicit grant flow.
|
|
@@ -17218,6 +19009,9 @@ components:
|
|
|
17218
19009
|
apm_service_catalog_read: View service catalog and service definitions.
|
|
17219
19010
|
apm_service_catalog_write: Add, modify, and delete service catalog definitions
|
|
17220
19011
|
when those definitions are maintained by Datadog.
|
|
19012
|
+
ci_visibility_pipelines_write: Create CI Visibility pipeline spans using
|
|
19013
|
+
the API.
|
|
19014
|
+
ci_visibility_read: View CI Visibility.
|
|
17221
19015
|
create_webhooks: Create webhooks integrations.
|
|
17222
19016
|
dashboards_public_share: Generate public and authenticated links to share
|
|
17223
19017
|
dashboards or embeddable graphs externally.
|
|
@@ -17307,6 +19101,8 @@ paths:
|
|
|
17307
19101
|
- $ref: '#/components/parameters/APIKeyFilterModifiedAtStartParameter'
|
|
17308
19102
|
- $ref: '#/components/parameters/APIKeyFilterModifiedAtEndParameter'
|
|
17309
19103
|
- $ref: '#/components/parameters/APIKeyIncludeParameter'
|
|
19104
|
+
- $ref: '#/components/parameters/APIKeyReadConfigReadEnabledParameter'
|
|
19105
|
+
- $ref: '#/components/parameters/APIKeyCategoryParameter'
|
|
17310
19106
|
responses:
|
|
17311
19107
|
'200':
|
|
17312
19108
|
content:
|
|
@@ -17472,34 +19268,156 @@ paths:
|
|
|
17472
19268
|
content:
|
|
17473
19269
|
application/json:
|
|
17474
19270
|
schema:
|
|
17475
|
-
$ref: '#/components/schemas/SpansMetricsResponse'
|
|
19271
|
+
$ref: '#/components/schemas/SpansMetricsResponse'
|
|
19272
|
+
description: OK
|
|
19273
|
+
'403':
|
|
19274
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
19275
|
+
'429':
|
|
19276
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
19277
|
+
summary: Get all span-based metrics
|
|
19278
|
+
tags:
|
|
19279
|
+
- Spans Metrics
|
|
19280
|
+
post:
|
|
19281
|
+
description: 'Create a metric based on your ingested spans in your organization.
|
|
19282
|
+
|
|
19283
|
+
Returns the span-based metric object from the request body when the request
|
|
19284
|
+
is successful.'
|
|
19285
|
+
operationId: CreateSpansMetric
|
|
19286
|
+
requestBody:
|
|
19287
|
+
content:
|
|
19288
|
+
application/json:
|
|
19289
|
+
schema:
|
|
19290
|
+
$ref: '#/components/schemas/SpansMetricCreateRequest'
|
|
19291
|
+
description: The definition of the new span-based metric.
|
|
19292
|
+
required: true
|
|
19293
|
+
responses:
|
|
19294
|
+
'200':
|
|
19295
|
+
content:
|
|
19296
|
+
application/json:
|
|
19297
|
+
schema:
|
|
19298
|
+
$ref: '#/components/schemas/SpansMetricResponse'
|
|
19299
|
+
description: OK
|
|
19300
|
+
'400':
|
|
19301
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
19302
|
+
'403':
|
|
19303
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
19304
|
+
'409':
|
|
19305
|
+
$ref: '#/components/responses/ConflictResponse'
|
|
19306
|
+
'429':
|
|
19307
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
19308
|
+
summary: Create a span-based metric
|
|
19309
|
+
tags:
|
|
19310
|
+
- Spans Metrics
|
|
19311
|
+
x-codegen-request-body-name: body
|
|
19312
|
+
/api/v2/apm/config/metrics/{metric_id}:
|
|
19313
|
+
delete:
|
|
19314
|
+
description: Delete a specific span-based metric from your organization.
|
|
19315
|
+
operationId: DeleteSpansMetric
|
|
19316
|
+
parameters:
|
|
19317
|
+
- $ref: '#/components/parameters/SpansMetricIDParameter'
|
|
19318
|
+
responses:
|
|
19319
|
+
'204':
|
|
19320
|
+
description: OK
|
|
19321
|
+
'403':
|
|
19322
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
19323
|
+
'404':
|
|
19324
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
19325
|
+
'429':
|
|
19326
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
19327
|
+
summary: Delete a span-based metric
|
|
19328
|
+
tags:
|
|
19329
|
+
- Spans Metrics
|
|
19330
|
+
get:
|
|
19331
|
+
description: Get a specific span-based metric from your organization.
|
|
19332
|
+
operationId: GetSpansMetric
|
|
19333
|
+
parameters:
|
|
19334
|
+
- $ref: '#/components/parameters/SpansMetricIDParameter'
|
|
19335
|
+
responses:
|
|
19336
|
+
'200':
|
|
19337
|
+
content:
|
|
19338
|
+
application/json:
|
|
19339
|
+
schema:
|
|
19340
|
+
$ref: '#/components/schemas/SpansMetricResponse'
|
|
19341
|
+
description: OK
|
|
19342
|
+
'403':
|
|
19343
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
19344
|
+
'404':
|
|
19345
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
19346
|
+
'429':
|
|
19347
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
19348
|
+
summary: Get a span-based metric
|
|
19349
|
+
tags:
|
|
19350
|
+
- Spans Metrics
|
|
19351
|
+
patch:
|
|
19352
|
+
description: 'Update a specific span-based metric from your organization.
|
|
19353
|
+
|
|
19354
|
+
Returns the span-based metric object from the request body when the request
|
|
19355
|
+
is successful.'
|
|
19356
|
+
operationId: UpdateSpansMetric
|
|
19357
|
+
parameters:
|
|
19358
|
+
- $ref: '#/components/parameters/SpansMetricIDParameter'
|
|
19359
|
+
requestBody:
|
|
19360
|
+
content:
|
|
19361
|
+
application/json:
|
|
19362
|
+
schema:
|
|
19363
|
+
$ref: '#/components/schemas/SpansMetricUpdateRequest'
|
|
19364
|
+
description: New definition of the span-based metric.
|
|
19365
|
+
required: true
|
|
19366
|
+
responses:
|
|
19367
|
+
'200':
|
|
19368
|
+
content:
|
|
19369
|
+
application/json:
|
|
19370
|
+
schema:
|
|
19371
|
+
$ref: '#/components/schemas/SpansMetricResponse'
|
|
19372
|
+
description: OK
|
|
19373
|
+
'400':
|
|
19374
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
19375
|
+
'403':
|
|
19376
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
19377
|
+
'404':
|
|
19378
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
19379
|
+
'429':
|
|
19380
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
19381
|
+
summary: Update a span-based metric
|
|
19382
|
+
tags:
|
|
19383
|
+
- Spans Metrics
|
|
19384
|
+
x-codegen-request-body-name: body
|
|
19385
|
+
/api/v2/apm/config/retention-filters:
|
|
19386
|
+
get:
|
|
19387
|
+
description: Get the list of APM retention filters.
|
|
19388
|
+
operationId: ListApmRetentionFilters
|
|
19389
|
+
responses:
|
|
19390
|
+
'200':
|
|
19391
|
+
content:
|
|
19392
|
+
application/json:
|
|
19393
|
+
schema:
|
|
19394
|
+
$ref: '#/components/schemas/RetentionFiltersResponse'
|
|
17476
19395
|
description: OK
|
|
17477
19396
|
'403':
|
|
17478
19397
|
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
17479
19398
|
'429':
|
|
17480
19399
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
17481
|
-
summary:
|
|
19400
|
+
summary: List all APM retention filters
|
|
17482
19401
|
tags:
|
|
17483
|
-
-
|
|
19402
|
+
- APM Retention Filters
|
|
17484
19403
|
post:
|
|
17485
|
-
description: 'Create a
|
|
19404
|
+
description: 'Create a retention filter to index spans in your organization.
|
|
17486
19405
|
|
|
17487
|
-
Returns the
|
|
17488
|
-
|
|
17489
|
-
operationId: CreateSpansMetric
|
|
19406
|
+
Returns the retention filter definition when the request is successful.'
|
|
19407
|
+
operationId: CreateApmRetentionFilter
|
|
17490
19408
|
requestBody:
|
|
17491
19409
|
content:
|
|
17492
19410
|
application/json:
|
|
17493
19411
|
schema:
|
|
17494
|
-
$ref: '#/components/schemas/
|
|
17495
|
-
description: The definition of the new
|
|
19412
|
+
$ref: '#/components/schemas/RetentionFilterCreateRequest'
|
|
19413
|
+
description: The definition of the new retention filter.
|
|
17496
19414
|
required: true
|
|
17497
19415
|
responses:
|
|
17498
19416
|
'200':
|
|
17499
19417
|
content:
|
|
17500
19418
|
application/json:
|
|
17501
19419
|
schema:
|
|
17502
|
-
$ref: '#/components/schemas/
|
|
19420
|
+
$ref: '#/components/schemas/RetentionFilterResponse'
|
|
17503
19421
|
description: OK
|
|
17504
19422
|
'400':
|
|
17505
19423
|
$ref: '#/components/responses/BadRequestResponse'
|
|
@@ -17509,18 +19427,42 @@ paths:
|
|
|
17509
19427
|
$ref: '#/components/responses/ConflictResponse'
|
|
17510
19428
|
'429':
|
|
17511
19429
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
17512
|
-
summary: Create a
|
|
19430
|
+
summary: Create a retention filter
|
|
17513
19431
|
tags:
|
|
17514
|
-
-
|
|
19432
|
+
- APM Retention Filters
|
|
17515
19433
|
x-codegen-request-body-name: body
|
|
17516
|
-
/api/v2/apm/config/
|
|
19434
|
+
/api/v2/apm/config/retention-filters-execution-order:
|
|
19435
|
+
put:
|
|
19436
|
+
description: Re-order the execution order of retention filters.
|
|
19437
|
+
operationId: ReorderApmRetentionFilters
|
|
19438
|
+
requestBody:
|
|
19439
|
+
content:
|
|
19440
|
+
application/json:
|
|
19441
|
+
schema:
|
|
19442
|
+
$ref: '#/components/schemas/ReorderRetentionFiltersRequest'
|
|
19443
|
+
description: The list of retention filters in the new order.
|
|
19444
|
+
required: true
|
|
19445
|
+
responses:
|
|
19446
|
+
'200':
|
|
19447
|
+
description: OK
|
|
19448
|
+
'400':
|
|
19449
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
19450
|
+
'403':
|
|
19451
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
19452
|
+
'429':
|
|
19453
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
19454
|
+
summary: Re-order retention filters
|
|
19455
|
+
tags:
|
|
19456
|
+
- APM Retention Filters
|
|
19457
|
+
x-codegen-request-body-name: body
|
|
19458
|
+
/api/v2/apm/config/retention-filters/{filter_id}:
|
|
17517
19459
|
delete:
|
|
17518
|
-
description: Delete a specific
|
|
17519
|
-
operationId:
|
|
19460
|
+
description: Delete a specific retention filter from your organization.
|
|
19461
|
+
operationId: DeleteApmRetentionFilter
|
|
17520
19462
|
parameters:
|
|
17521
|
-
- $ref: '#/components/parameters/
|
|
19463
|
+
- $ref: '#/components/parameters/RetentionFilterIdParam'
|
|
17522
19464
|
responses:
|
|
17523
|
-
'
|
|
19465
|
+
'200':
|
|
17524
19466
|
description: OK
|
|
17525
19467
|
'403':
|
|
17526
19468
|
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
@@ -17528,20 +19470,20 @@ paths:
|
|
|
17528
19470
|
$ref: '#/components/responses/NotFoundResponse'
|
|
17529
19471
|
'429':
|
|
17530
19472
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
17531
|
-
summary: Delete a
|
|
19473
|
+
summary: Delete a retention filter
|
|
17532
19474
|
tags:
|
|
17533
|
-
-
|
|
19475
|
+
- APM Retention Filters
|
|
17534
19476
|
get:
|
|
17535
|
-
description: Get
|
|
17536
|
-
operationId:
|
|
19477
|
+
description: Get an APM retention filter.
|
|
19478
|
+
operationId: GetApmRetentionFilter
|
|
17537
19479
|
parameters:
|
|
17538
|
-
- $ref: '#/components/parameters/
|
|
19480
|
+
- $ref: '#/components/parameters/RetentionFilterIdParam'
|
|
17539
19481
|
responses:
|
|
17540
19482
|
'200':
|
|
17541
19483
|
content:
|
|
17542
19484
|
application/json:
|
|
17543
19485
|
schema:
|
|
17544
|
-
$ref: '#/components/schemas/
|
|
19486
|
+
$ref: '#/components/schemas/RetentionFilterResponse'
|
|
17545
19487
|
description: OK
|
|
17546
19488
|
'403':
|
|
17547
19489
|
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
@@ -17549,30 +19491,27 @@ paths:
|
|
|
17549
19491
|
$ref: '#/components/responses/NotFoundResponse'
|
|
17550
19492
|
'429':
|
|
17551
19493
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
17552
|
-
summary: Get a
|
|
19494
|
+
summary: Get a given APM retention filter
|
|
17553
19495
|
tags:
|
|
17554
|
-
-
|
|
17555
|
-
|
|
17556
|
-
description:
|
|
17557
|
-
|
|
17558
|
-
Returns the span-based metric object from the request body when the request
|
|
17559
|
-
is successful.'
|
|
17560
|
-
operationId: UpdateSpansMetric
|
|
19496
|
+
- APM Retention Filters
|
|
19497
|
+
put:
|
|
19498
|
+
description: Update a retention filter from your organization.
|
|
19499
|
+
operationId: UpdateApmRetentionFilter
|
|
17561
19500
|
parameters:
|
|
17562
|
-
- $ref: '#/components/parameters/
|
|
19501
|
+
- $ref: '#/components/parameters/RetentionFilterIdParam'
|
|
17563
19502
|
requestBody:
|
|
17564
19503
|
content:
|
|
17565
19504
|
application/json:
|
|
17566
19505
|
schema:
|
|
17567
|
-
$ref: '#/components/schemas/
|
|
17568
|
-
description:
|
|
19506
|
+
$ref: '#/components/schemas/RetentionFilterUpdateRequest'
|
|
19507
|
+
description: The updated definition of the retention filter.
|
|
17569
19508
|
required: true
|
|
17570
19509
|
responses:
|
|
17571
19510
|
'200':
|
|
17572
19511
|
content:
|
|
17573
19512
|
application/json:
|
|
17574
19513
|
schema:
|
|
17575
|
-
$ref: '#/components/schemas/
|
|
19514
|
+
$ref: '#/components/schemas/RetentionFilterResponse'
|
|
17576
19515
|
description: OK
|
|
17577
19516
|
'400':
|
|
17578
19517
|
$ref: '#/components/responses/BadRequestResponse'
|
|
@@ -17582,9 +19521,9 @@ paths:
|
|
|
17582
19521
|
$ref: '#/components/responses/NotFoundResponse'
|
|
17583
19522
|
'429':
|
|
17584
19523
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
17585
|
-
summary: Update a
|
|
19524
|
+
summary: Update a retention filter
|
|
17586
19525
|
tags:
|
|
17587
|
-
-
|
|
19526
|
+
- APM Retention Filters
|
|
17588
19527
|
x-codegen-request-body-name: body
|
|
17589
19528
|
/api/v2/application_keys:
|
|
17590
19529
|
get:
|
|
@@ -17597,6 +19536,7 @@ paths:
|
|
|
17597
19536
|
- $ref: '#/components/parameters/ApplicationKeyFilterParameter'
|
|
17598
19537
|
- $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtStartParameter'
|
|
17599
19538
|
- $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtEndParameter'
|
|
19539
|
+
- $ref: '#/components/parameters/ApplicationKeyIncludeParameter'
|
|
17600
19540
|
responses:
|
|
17601
19541
|
'200':
|
|
17602
19542
|
content:
|
|
@@ -18139,12 +20079,15 @@ paths:
|
|
|
18139
20079
|
schema:
|
|
18140
20080
|
$ref: '#/components/schemas/HTTPCIAppErrors'
|
|
18141
20081
|
description: Service Unavailable
|
|
20082
|
+
security:
|
|
20083
|
+
- apiKeyAuth: []
|
|
18142
20084
|
summary: Send pipeline event
|
|
18143
20085
|
tags:
|
|
18144
20086
|
- CI Visibility Pipelines
|
|
18145
20087
|
x-codegen-request-body-name: body
|
|
18146
|
-
x-unstable: '**Note
|
|
18147
|
-
|
|
20088
|
+
x-unstable: '**Note:** This endpoint is in public beta.
|
|
20089
|
+
|
|
20090
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
18148
20091
|
/api/v2/ci/pipelines/analytics/aggregate:
|
|
18149
20092
|
post:
|
|
18150
20093
|
description: Use this API endpoint to aggregate CI Visibility pipeline events
|
|
@@ -18169,6 +20112,11 @@ paths:
|
|
|
18169
20112
|
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
18170
20113
|
'429':
|
|
18171
20114
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
20115
|
+
security:
|
|
20116
|
+
- apiKeyAuth: []
|
|
20117
|
+
appKeyAuth: []
|
|
20118
|
+
- AuthZ:
|
|
20119
|
+
- ci_visibility_read
|
|
18172
20120
|
summary: Aggregate pipelines events
|
|
18173
20121
|
tags:
|
|
18174
20122
|
- CI Visibility Pipelines
|
|
@@ -18244,6 +20192,11 @@ paths:
|
|
|
18244
20192
|
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
18245
20193
|
'429':
|
|
18246
20194
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
20195
|
+
security:
|
|
20196
|
+
- apiKeyAuth: []
|
|
20197
|
+
appKeyAuth: []
|
|
20198
|
+
- AuthZ:
|
|
20199
|
+
- ci_visibility_read
|
|
18247
20200
|
summary: Get a list of pipelines events
|
|
18248
20201
|
tags:
|
|
18249
20202
|
- CI Visibility Pipelines
|
|
@@ -18281,6 +20234,11 @@ paths:
|
|
|
18281
20234
|
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
18282
20235
|
'429':
|
|
18283
20236
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
20237
|
+
security:
|
|
20238
|
+
- apiKeyAuth: []
|
|
20239
|
+
appKeyAuth: []
|
|
20240
|
+
- AuthZ:
|
|
20241
|
+
- ci_visibility_read
|
|
18284
20242
|
summary: Search pipelines events
|
|
18285
20243
|
tags:
|
|
18286
20244
|
- CI Visibility Pipelines
|
|
@@ -18314,6 +20272,11 @@ paths:
|
|
|
18314
20272
|
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
18315
20273
|
'429':
|
|
18316
20274
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
20275
|
+
security:
|
|
20276
|
+
- apiKeyAuth: []
|
|
20277
|
+
appKeyAuth: []
|
|
20278
|
+
- AuthZ:
|
|
20279
|
+
- ci_visibility_read
|
|
18317
20280
|
summary: Aggregate tests events
|
|
18318
20281
|
tags:
|
|
18319
20282
|
- CI Visibility Tests
|
|
@@ -18336,105 +20299,275 @@ paths:
|
|
|
18336
20299
|
required: false
|
|
18337
20300
|
schema:
|
|
18338
20301
|
type: string
|
|
18339
|
-
- description: Minimum timestamp for requested events.
|
|
18340
|
-
example: '2019-01-02T09:42:36.320Z'
|
|
20302
|
+
- description: Minimum timestamp for requested events.
|
|
20303
|
+
example: '2019-01-02T09:42:36.320Z'
|
|
20304
|
+
in: query
|
|
20305
|
+
name: filter[from]
|
|
20306
|
+
required: false
|
|
20307
|
+
schema:
|
|
20308
|
+
format: date-time
|
|
20309
|
+
type: string
|
|
20310
|
+
- description: Maximum timestamp for requested events.
|
|
20311
|
+
example: '2019-01-03T09:42:36.320Z'
|
|
20312
|
+
in: query
|
|
20313
|
+
name: filter[to]
|
|
20314
|
+
required: false
|
|
20315
|
+
schema:
|
|
20316
|
+
format: date-time
|
|
20317
|
+
type: string
|
|
20318
|
+
- description: Order of events in results.
|
|
20319
|
+
in: query
|
|
20320
|
+
name: sort
|
|
20321
|
+
required: false
|
|
20322
|
+
schema:
|
|
20323
|
+
$ref: '#/components/schemas/CIAppSort'
|
|
20324
|
+
- description: List following results with a cursor provided in the previous
|
|
20325
|
+
query.
|
|
20326
|
+
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
|
20327
|
+
in: query
|
|
20328
|
+
name: page[cursor]
|
|
20329
|
+
required: false
|
|
20330
|
+
schema:
|
|
20331
|
+
type: string
|
|
20332
|
+
- description: Maximum number of events in the response.
|
|
20333
|
+
example: 25
|
|
20334
|
+
in: query
|
|
20335
|
+
name: page[limit]
|
|
20336
|
+
required: false
|
|
20337
|
+
schema:
|
|
20338
|
+
default: 10
|
|
20339
|
+
format: int32
|
|
20340
|
+
maximum: 1000
|
|
20341
|
+
type: integer
|
|
20342
|
+
responses:
|
|
20343
|
+
'200':
|
|
20344
|
+
content:
|
|
20345
|
+
application/json:
|
|
20346
|
+
schema:
|
|
20347
|
+
$ref: '#/components/schemas/CIAppTestEventsResponse'
|
|
20348
|
+
description: OK
|
|
20349
|
+
'400':
|
|
20350
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
20351
|
+
'403':
|
|
20352
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
20353
|
+
'429':
|
|
20354
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
20355
|
+
security:
|
|
20356
|
+
- apiKeyAuth: []
|
|
20357
|
+
appKeyAuth: []
|
|
20358
|
+
- AuthZ:
|
|
20359
|
+
- ci_visibility_read
|
|
20360
|
+
summary: Get a list of tests events
|
|
20361
|
+
tags:
|
|
20362
|
+
- CI Visibility Tests
|
|
20363
|
+
x-pagination:
|
|
20364
|
+
cursorParam: page[cursor]
|
|
20365
|
+
cursorPath: meta.page.after
|
|
20366
|
+
limitParam: page[limit]
|
|
20367
|
+
resultsPath: data
|
|
20368
|
+
/api/v2/ci/tests/events/search:
|
|
20369
|
+
post:
|
|
20370
|
+
description: 'List endpoint returns CI Visibility test events that match a [log
|
|
20371
|
+
search query](https://docs.datadoghq.com/logs/explorer/search_syntax/).
|
|
20372
|
+
|
|
20373
|
+
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).
|
|
20374
|
+
|
|
20375
|
+
|
|
20376
|
+
Use this endpoint to build complex events filtering and search.'
|
|
20377
|
+
operationId: SearchCIAppTestEvents
|
|
20378
|
+
requestBody:
|
|
20379
|
+
content:
|
|
20380
|
+
application/json:
|
|
20381
|
+
schema:
|
|
20382
|
+
$ref: '#/components/schemas/CIAppTestEventsRequest'
|
|
20383
|
+
required: false
|
|
20384
|
+
responses:
|
|
20385
|
+
'200':
|
|
20386
|
+
content:
|
|
20387
|
+
application/json:
|
|
20388
|
+
schema:
|
|
20389
|
+
$ref: '#/components/schemas/CIAppTestEventsResponse'
|
|
20390
|
+
description: OK
|
|
20391
|
+
'400':
|
|
20392
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
20393
|
+
'403':
|
|
20394
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
20395
|
+
'429':
|
|
20396
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
20397
|
+
security:
|
|
20398
|
+
- apiKeyAuth: []
|
|
20399
|
+
appKeyAuth: []
|
|
20400
|
+
- AuthZ:
|
|
20401
|
+
- ci_visibility_read
|
|
20402
|
+
summary: Search tests events
|
|
20403
|
+
tags:
|
|
20404
|
+
- CI Visibility Tests
|
|
20405
|
+
x-codegen-request-body-name: body
|
|
20406
|
+
x-pagination:
|
|
20407
|
+
cursorParam: body.page.cursor
|
|
20408
|
+
cursorPath: meta.page.after
|
|
20409
|
+
limitParam: body.page.limit
|
|
20410
|
+
resultsPath: data
|
|
20411
|
+
/api/v2/container_images:
|
|
20412
|
+
get:
|
|
20413
|
+
description: Get all Container Images for your organization.
|
|
20414
|
+
operationId: ListContainerImages
|
|
20415
|
+
parameters:
|
|
20416
|
+
- description: Comma-separated list of tags to filter Container Images by.
|
|
20417
|
+
example: short_image:redis,status:running
|
|
20418
|
+
in: query
|
|
20419
|
+
name: filter[tags]
|
|
20420
|
+
required: false
|
|
20421
|
+
schema:
|
|
20422
|
+
type: string
|
|
20423
|
+
- description: Comma-separated list of tags to group Container Images by.
|
|
20424
|
+
example: registry,image_tags
|
|
20425
|
+
in: query
|
|
20426
|
+
name: group_by
|
|
20427
|
+
required: false
|
|
20428
|
+
schema:
|
|
20429
|
+
type: string
|
|
20430
|
+
- description: Attribute to sort Container Images by.
|
|
20431
|
+
example: container_count
|
|
20432
|
+
in: query
|
|
20433
|
+
name: sort
|
|
20434
|
+
required: false
|
|
20435
|
+
schema:
|
|
20436
|
+
type: string
|
|
20437
|
+
- description: Maximum number of results returned.
|
|
20438
|
+
in: query
|
|
20439
|
+
name: page[size]
|
|
20440
|
+
required: false
|
|
20441
|
+
schema:
|
|
20442
|
+
default: 1000
|
|
20443
|
+
format: int32
|
|
20444
|
+
maximum: 10000
|
|
20445
|
+
minimum: 1
|
|
20446
|
+
type: integer
|
|
20447
|
+
- description: 'String to query the next page of results.
|
|
20448
|
+
|
|
20449
|
+
This key is provided with each valid response from the API in `meta.pagination.next_cursor`.'
|
|
20450
|
+
in: query
|
|
20451
|
+
name: page[cursor]
|
|
20452
|
+
required: false
|
|
20453
|
+
schema:
|
|
20454
|
+
type: string
|
|
20455
|
+
responses:
|
|
20456
|
+
'200':
|
|
20457
|
+
content:
|
|
20458
|
+
application/json:
|
|
20459
|
+
schema:
|
|
20460
|
+
$ref: '#/components/schemas/ContainerImagesResponse'
|
|
20461
|
+
description: OK
|
|
20462
|
+
'400':
|
|
20463
|
+
content:
|
|
20464
|
+
application/json:
|
|
20465
|
+
schema:
|
|
20466
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
20467
|
+
description: Bad Request
|
|
20468
|
+
'403':
|
|
20469
|
+
content:
|
|
20470
|
+
application/json:
|
|
20471
|
+
schema:
|
|
20472
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
20473
|
+
description: Authentication Error
|
|
20474
|
+
'429':
|
|
20475
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
20476
|
+
security:
|
|
20477
|
+
- apiKeyAuth: []
|
|
20478
|
+
appKeyAuth: []
|
|
20479
|
+
- AuthZ: []
|
|
20480
|
+
summary: Get all Container Images
|
|
20481
|
+
tags:
|
|
20482
|
+
- Container Images
|
|
20483
|
+
x-pagination:
|
|
20484
|
+
cursorParam: page[cursor]
|
|
20485
|
+
cursorPath: meta.pagination.next_cursor
|
|
20486
|
+
limitParam: page[size]
|
|
20487
|
+
resultsPath: data
|
|
20488
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
|
20489
|
+
|
|
20490
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
20491
|
+
/api/v2/containers:
|
|
20492
|
+
get:
|
|
20493
|
+
description: Get all containers for your organization.
|
|
20494
|
+
operationId: ListContainers
|
|
20495
|
+
parameters:
|
|
20496
|
+
- description: Comma-separated list of tags to filter containers by.
|
|
20497
|
+
example: env:prod,short_image:cassandra
|
|
20498
|
+
in: query
|
|
20499
|
+
name: filter[tags]
|
|
20500
|
+
required: false
|
|
20501
|
+
schema:
|
|
20502
|
+
type: string
|
|
20503
|
+
- description: Comma-separated list of tags to group containers by.
|
|
20504
|
+
example: datacenter,cluster
|
|
18341
20505
|
in: query
|
|
18342
|
-
name:
|
|
20506
|
+
name: group_by
|
|
18343
20507
|
required: false
|
|
18344
20508
|
schema:
|
|
18345
|
-
format: date-time
|
|
18346
20509
|
type: string
|
|
18347
|
-
- description:
|
|
18348
|
-
example:
|
|
20510
|
+
- description: Attribute to sort containers by.
|
|
20511
|
+
example: started_at
|
|
18349
20512
|
in: query
|
|
18350
|
-
name:
|
|
20513
|
+
name: sort
|
|
18351
20514
|
required: false
|
|
18352
20515
|
schema:
|
|
18353
|
-
format: date-time
|
|
18354
20516
|
type: string
|
|
18355
|
-
- description:
|
|
20517
|
+
- description: Maximum number of results returned.
|
|
18356
20518
|
in: query
|
|
18357
|
-
name:
|
|
20519
|
+
name: page[size]
|
|
18358
20520
|
required: false
|
|
18359
20521
|
schema:
|
|
18360
|
-
|
|
18361
|
-
|
|
18362
|
-
|
|
18363
|
-
|
|
20522
|
+
default: 1000
|
|
20523
|
+
format: int32
|
|
20524
|
+
maximum: 10000
|
|
20525
|
+
minimum: 1
|
|
20526
|
+
type: integer
|
|
20527
|
+
- description: 'String to query the next page of results.
|
|
20528
|
+
|
|
20529
|
+
This key is provided with each valid response from the API in `meta.pagination.next_cursor`.'
|
|
18364
20530
|
in: query
|
|
18365
20531
|
name: page[cursor]
|
|
18366
20532
|
required: false
|
|
18367
20533
|
schema:
|
|
18368
20534
|
type: string
|
|
18369
|
-
- description: Maximum number of events in the response.
|
|
18370
|
-
example: 25
|
|
18371
|
-
in: query
|
|
18372
|
-
name: page[limit]
|
|
18373
|
-
required: false
|
|
18374
|
-
schema:
|
|
18375
|
-
default: 10
|
|
18376
|
-
format: int32
|
|
18377
|
-
maximum: 1000
|
|
18378
|
-
type: integer
|
|
18379
20535
|
responses:
|
|
18380
20536
|
'200':
|
|
18381
20537
|
content:
|
|
18382
20538
|
application/json:
|
|
18383
20539
|
schema:
|
|
18384
|
-
$ref: '#/components/schemas/
|
|
20540
|
+
$ref: '#/components/schemas/ContainersResponse'
|
|
18385
20541
|
description: OK
|
|
18386
20542
|
'400':
|
|
18387
|
-
$ref: '#/components/responses/BadRequestResponse'
|
|
18388
|
-
'403':
|
|
18389
|
-
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
18390
|
-
'429':
|
|
18391
|
-
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
18392
|
-
summary: Get a list of tests events
|
|
18393
|
-
tags:
|
|
18394
|
-
- CI Visibility Tests
|
|
18395
|
-
x-pagination:
|
|
18396
|
-
cursorParam: page[cursor]
|
|
18397
|
-
cursorPath: meta.page.after
|
|
18398
|
-
limitParam: page[limit]
|
|
18399
|
-
resultsPath: data
|
|
18400
|
-
/api/v2/ci/tests/events/search:
|
|
18401
|
-
post:
|
|
18402
|
-
description: 'List endpoint returns CI Visibility test events that match a [log
|
|
18403
|
-
search query](https://docs.datadoghq.com/logs/explorer/search_syntax/).
|
|
18404
|
-
|
|
18405
|
-
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).
|
|
18406
|
-
|
|
18407
|
-
|
|
18408
|
-
Use this endpoint to build complex events filtering and search.'
|
|
18409
|
-
operationId: SearchCIAppTestEvents
|
|
18410
|
-
requestBody:
|
|
18411
|
-
content:
|
|
18412
|
-
application/json:
|
|
18413
|
-
schema:
|
|
18414
|
-
$ref: '#/components/schemas/CIAppTestEventsRequest'
|
|
18415
|
-
required: false
|
|
18416
|
-
responses:
|
|
18417
|
-
'200':
|
|
18418
20543
|
content:
|
|
18419
20544
|
application/json:
|
|
18420
20545
|
schema:
|
|
18421
|
-
$ref: '#/components/schemas/
|
|
18422
|
-
description:
|
|
18423
|
-
'400':
|
|
18424
|
-
$ref: '#/components/responses/BadRequestResponse'
|
|
20546
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
20547
|
+
description: Bad Request
|
|
18425
20548
|
'403':
|
|
18426
|
-
|
|
20549
|
+
content:
|
|
20550
|
+
application/json:
|
|
20551
|
+
schema:
|
|
20552
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
20553
|
+
description: Authentication Error
|
|
18427
20554
|
'429':
|
|
18428
20555
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
18429
|
-
|
|
20556
|
+
security:
|
|
20557
|
+
- apiKeyAuth: []
|
|
20558
|
+
appKeyAuth: []
|
|
20559
|
+
- AuthZ: []
|
|
20560
|
+
summary: Get All Containers
|
|
18430
20561
|
tags:
|
|
18431
|
-
-
|
|
18432
|
-
x-codegen-request-body-name: body
|
|
20562
|
+
- Containers
|
|
18433
20563
|
x-pagination:
|
|
18434
|
-
cursorParam:
|
|
18435
|
-
cursorPath: meta.
|
|
18436
|
-
limitParam:
|
|
20564
|
+
cursorParam: page[cursor]
|
|
20565
|
+
cursorPath: meta.pagination.next_cursor
|
|
20566
|
+
limitParam: page[size]
|
|
18437
20567
|
resultsPath: data
|
|
20568
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
|
20569
|
+
|
|
20570
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
18438
20571
|
/api/v2/current_user/application_keys:
|
|
18439
20572
|
get:
|
|
18440
20573
|
description: List all application keys available for current user
|
|
@@ -18446,6 +20579,7 @@ paths:
|
|
|
18446
20579
|
- $ref: '#/components/parameters/ApplicationKeyFilterParameter'
|
|
18447
20580
|
- $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtStartParameter'
|
|
18448
20581
|
- $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtEndParameter'
|
|
20582
|
+
- $ref: '#/components/parameters/ApplicationKeyIncludeParameter'
|
|
18449
20583
|
responses:
|
|
18450
20584
|
'200':
|
|
18451
20585
|
content:
|
|
@@ -18982,7 +21116,7 @@ paths:
|
|
|
18982
21116
|
- apiKeyAuth: []
|
|
18983
21117
|
appKeyAuth: []
|
|
18984
21118
|
- AuthZ:
|
|
18985
|
-
-
|
|
21119
|
+
- monitors_downtime
|
|
18986
21120
|
summary: Get a downtime
|
|
18987
21121
|
tags:
|
|
18988
21122
|
- Downtimes
|
|
@@ -21902,7 +24036,11 @@ paths:
|
|
|
21902
24036
|
If multiple calls include the same metric, the last configuration applied
|
|
21903
24037
|
(not by submit order) is used, do not
|
|
21904
24038
|
|
|
21905
|
-
expect deterministic ordering of concurrent calls.
|
|
24039
|
+
expect deterministic ordering of concurrent calls. The `exclude_tags_mode`
|
|
24040
|
+
value will set all metrics that match the prefix to
|
|
24041
|
+
|
|
24042
|
+
the same exclusion state, metric tag configurations do not support mixed inclusion
|
|
24043
|
+
and exclusion for tags on the same metric.
|
|
21906
24044
|
|
|
21907
24045
|
Can only be used with application keys of users with the `Manage Tags for
|
|
21908
24046
|
Metrics` permission.'
|
|
@@ -22228,7 +24366,11 @@ paths:
|
|
|
22228
24366
|
description: 'Update the tag configuration of a metric or percentile aggregations
|
|
22229
24367
|
of a distribution metric or custom aggregations
|
|
22230
24368
|
|
|
22231
|
-
of a count, rate, or gauge metric.
|
|
24369
|
+
of a count, rate, or gauge metric. By setting `exclude_tags_mode` to true
|
|
24370
|
+
the behavior is changed
|
|
24371
|
+
|
|
24372
|
+
from an allow-list to a deny-list, and tags in the defined list will not be
|
|
24373
|
+
queryable.
|
|
22232
24374
|
|
|
22233
24375
|
Can only be used with application keys from users with the `Manage Tags for
|
|
22234
24376
|
Metrics` permission.'
|
|
@@ -22283,7 +24425,11 @@ paths:
|
|
|
22283
24425
|
Optionally, include percentile aggregations on any distribution metric or
|
|
22284
24426
|
configure custom aggregations
|
|
22285
24427
|
|
|
22286
|
-
on any count, rate, or gauge metric.
|
|
24428
|
+
on any count, rate, or gauge metric. By setting `exclude_tags_mode` to true
|
|
24429
|
+
the behavior is changed
|
|
24430
|
+
|
|
24431
|
+
from an allow-list to a deny-list, and tags in the defined list will not be
|
|
24432
|
+
queryable.
|
|
22287
24433
|
|
|
22288
24434
|
Can only be used with application keys of users with the `Manage Tags for
|
|
22289
24435
|
Metrics` permission.'
|
|
@@ -22782,6 +24928,54 @@ paths:
|
|
|
22782
24928
|
resultsPath: data
|
|
22783
24929
|
x-unstable: '**Note**: This endpoint is in public beta.
|
|
22784
24930
|
|
|
24931
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
24932
|
+
patch:
|
|
24933
|
+
description: Mute or unmute findings.
|
|
24934
|
+
operationId: MuteFindings
|
|
24935
|
+
requestBody:
|
|
24936
|
+
content:
|
|
24937
|
+
application/json:
|
|
24938
|
+
schema:
|
|
24939
|
+
$ref: '#/components/schemas/BulkMuteFindingsRequest'
|
|
24940
|
+
description: "### Attributes\n\nAll findings are updated with the same attributes.
|
|
24941
|
+
The request body must include at least two attributes: `muted` and `reason`.\nThe
|
|
24942
|
+
allowed reasons depend on whether the finding is being muted or unmuted:\n
|
|
24943
|
+
\ - To mute a finding: `PENDING_FIX`, `FALSE_POSITIVE`, `ACCEPTED_RISK`,
|
|
24944
|
+
`OTHER`.\n - To unmute a finding : `NO_PENDING_FIX`, `HUMAN_ERROR`, `NO_LONGER_ACCEPTED_RISK`,
|
|
24945
|
+
`OTHER`.\n\n### Meta\n\nThe request body must include a list of the finding
|
|
24946
|
+
IDs to be updated.\n"
|
|
24947
|
+
required: true
|
|
24948
|
+
responses:
|
|
24949
|
+
'200':
|
|
24950
|
+
content:
|
|
24951
|
+
application/json:
|
|
24952
|
+
schema:
|
|
24953
|
+
$ref: '#/components/schemas/BulkMuteFindingsResponse'
|
|
24954
|
+
description: OK
|
|
24955
|
+
'400':
|
|
24956
|
+
$ref: '#/components/responses/FindingsBadRequestResponse'
|
|
24957
|
+
'403':
|
|
24958
|
+
$ref: '#/components/responses/FindingsForbiddenResponse'
|
|
24959
|
+
'404':
|
|
24960
|
+
$ref: '#/components/responses/FindingsNotFoundResponse'
|
|
24961
|
+
'422':
|
|
24962
|
+
content:
|
|
24963
|
+
application/json:
|
|
24964
|
+
schema:
|
|
24965
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
|
24966
|
+
description: 'Invalid Request: The server understands the request syntax
|
|
24967
|
+
but cannot process it due to invalid data.'
|
|
24968
|
+
'429':
|
|
24969
|
+
$ref: '#/components/responses/FindingsTooManyRequestsResponse'
|
|
24970
|
+
security:
|
|
24971
|
+
- apiKeyAuth: []
|
|
24972
|
+
appKeyAuth: []
|
|
24973
|
+
summary: Mute or unmute a batch of findings
|
|
24974
|
+
tags:
|
|
24975
|
+
- Security Monitoring
|
|
24976
|
+
x-codegen-request-body-name: body
|
|
24977
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
|
24978
|
+
|
|
22785
24979
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
22786
24980
|
/api/v2/posture_management/findings/{finding_id}:
|
|
22787
24981
|
get:
|
|
@@ -22829,15 +25023,147 @@ paths:
|
|
|
22829
25023
|
x-unstable: '**Note**: This endpoint is in public beta.
|
|
22830
25024
|
|
|
22831
25025
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
25026
|
+
/api/v2/powerpacks:
|
|
25027
|
+
get:
|
|
25028
|
+
description: Get a list of all powerpacks.
|
|
25029
|
+
operationId: ListPowerpacks
|
|
25030
|
+
parameters:
|
|
25031
|
+
- description: Maximum number of powerpacks in the response.
|
|
25032
|
+
example: 25
|
|
25033
|
+
in: query
|
|
25034
|
+
name: page[limit]
|
|
25035
|
+
required: false
|
|
25036
|
+
schema:
|
|
25037
|
+
default: 25
|
|
25038
|
+
format: int64
|
|
25039
|
+
maximum: 1000
|
|
25040
|
+
type: integer
|
|
25041
|
+
- $ref: '#/components/parameters/PageOffset'
|
|
25042
|
+
responses:
|
|
25043
|
+
'200':
|
|
25044
|
+
content:
|
|
25045
|
+
application/json:
|
|
25046
|
+
schema:
|
|
25047
|
+
$ref: '#/components/schemas/ListPowerpacksResponse'
|
|
25048
|
+
description: OK
|
|
25049
|
+
'429':
|
|
25050
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
25051
|
+
security:
|
|
25052
|
+
- apiKeyAuth: []
|
|
25053
|
+
appKeyAuth: []
|
|
25054
|
+
- AuthZ:
|
|
25055
|
+
- dashboards_read
|
|
25056
|
+
summary: Get all powerpacks
|
|
25057
|
+
tags:
|
|
25058
|
+
- Powerpack
|
|
25059
|
+
x-pagination:
|
|
25060
|
+
limitParam: page[limit]
|
|
25061
|
+
pageOffsetParam: page[offset]
|
|
25062
|
+
resultsPath: data
|
|
25063
|
+
post:
|
|
25064
|
+
description: Create a powerpack.
|
|
25065
|
+
operationId: CreatePowerpack
|
|
25066
|
+
requestBody:
|
|
25067
|
+
content:
|
|
25068
|
+
application/json:
|
|
25069
|
+
schema:
|
|
25070
|
+
$ref: '#/components/schemas/Powerpack'
|
|
25071
|
+
description: Create a powerpack request body.
|
|
25072
|
+
required: true
|
|
25073
|
+
responses:
|
|
25074
|
+
'200':
|
|
25075
|
+
content:
|
|
25076
|
+
application/json:
|
|
25077
|
+
schema:
|
|
25078
|
+
$ref: '#/components/schemas/PowerpackResponse'
|
|
25079
|
+
description: OK
|
|
25080
|
+
'400':
|
|
25081
|
+
content:
|
|
25082
|
+
application/json:
|
|
25083
|
+
schema:
|
|
25084
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
25085
|
+
description: Bad Request
|
|
25086
|
+
'429':
|
|
25087
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
25088
|
+
security:
|
|
25089
|
+
- apiKeyAuth: []
|
|
25090
|
+
appKeyAuth: []
|
|
25091
|
+
- AuthZ:
|
|
25092
|
+
- dashboards_write
|
|
25093
|
+
summary: Create a new powerpack
|
|
25094
|
+
tags:
|
|
25095
|
+
- Powerpack
|
|
25096
|
+
x-codegen-request-body-name: body
|
|
25097
|
+
/api/v2/powerpacks/{powerpack_id}:
|
|
25098
|
+
delete:
|
|
25099
|
+
description: Delete a powerpack.
|
|
25100
|
+
operationId: DeletePowerpack
|
|
25101
|
+
parameters:
|
|
25102
|
+
- description: Powerpack id
|
|
25103
|
+
in: path
|
|
25104
|
+
name: powerpack_id
|
|
25105
|
+
required: true
|
|
25106
|
+
schema:
|
|
25107
|
+
type: string
|
|
25108
|
+
responses:
|
|
25109
|
+
'204':
|
|
25110
|
+
description: OK
|
|
25111
|
+
'404':
|
|
25112
|
+
content:
|
|
25113
|
+
application/json:
|
|
25114
|
+
schema:
|
|
25115
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
25116
|
+
description: Powerpack Not Found
|
|
25117
|
+
'429':
|
|
25118
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
25119
|
+
security:
|
|
25120
|
+
- apiKeyAuth: []
|
|
25121
|
+
appKeyAuth: []
|
|
25122
|
+
- AuthZ:
|
|
25123
|
+
- dashboards_write
|
|
25124
|
+
summary: Delete a powerpack
|
|
25125
|
+
tags:
|
|
25126
|
+
- Powerpack
|
|
25127
|
+
get:
|
|
25128
|
+
description: Get a powerpack.
|
|
25129
|
+
operationId: GetPowerpack
|
|
25130
|
+
parameters:
|
|
25131
|
+
- description: ID of the powerpack.
|
|
25132
|
+
in: path
|
|
25133
|
+
name: powerpack_id
|
|
25134
|
+
required: true
|
|
25135
|
+
schema:
|
|
25136
|
+
type: string
|
|
25137
|
+
responses:
|
|
25138
|
+
'200':
|
|
25139
|
+
content:
|
|
25140
|
+
application/json:
|
|
25141
|
+
schema:
|
|
25142
|
+
$ref: '#/components/schemas/PowerpackResponse'
|
|
25143
|
+
description: OK
|
|
25144
|
+
'404':
|
|
25145
|
+
content:
|
|
25146
|
+
application/json:
|
|
25147
|
+
schema:
|
|
25148
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
25149
|
+
description: Powerpack Not Found.
|
|
25150
|
+
'429':
|
|
25151
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
25152
|
+
security:
|
|
25153
|
+
- apiKeyAuth: []
|
|
25154
|
+
appKeyAuth: []
|
|
25155
|
+
- AuthZ:
|
|
25156
|
+
- dashboards_read
|
|
25157
|
+
summary: Get a Powerpack
|
|
25158
|
+
tags:
|
|
25159
|
+
- Powerpack
|
|
22832
25160
|
patch:
|
|
22833
|
-
description:
|
|
22834
|
-
|
|
22835
|
-
The API returns the updated finding object when the request is successful.'
|
|
22836
|
-
operationId: UpdateFinding
|
|
25161
|
+
description: Update a powerpack.
|
|
25162
|
+
operationId: UpdatePowerpack
|
|
22837
25163
|
parameters:
|
|
22838
|
-
- description:
|
|
25164
|
+
- description: ID of the powerpack.
|
|
22839
25165
|
in: path
|
|
22840
|
-
name:
|
|
25166
|
+
name: powerpack_id
|
|
22841
25167
|
required: true
|
|
22842
25168
|
schema:
|
|
22843
25169
|
type: string
|
|
@@ -22845,57 +25171,39 @@ paths:
|
|
|
22845
25171
|
content:
|
|
22846
25172
|
application/json:
|
|
22847
25173
|
schema:
|
|
22848
|
-
$ref: '#/components/schemas/
|
|
22849
|
-
description:
|
|
22850
|
-
at least two attributes: `muted` and `reason`. The allowed reasons depend
|
|
22851
|
-
on whether the finding is being muted or unmuted:
|
|
22852
|
-
|
|
22853
|
-
- To mute a finding: `PENDING_FIX`, `FALSE_POSITIVE`, `ACCEPTED_RISK`, `OTHER`.
|
|
22854
|
-
|
|
22855
|
-
- To unmute a finding : `NO_PENDING_FIX`, `HUMAN_ERROR`, `NO_LONGER_ACCEPTED_RISK`,
|
|
22856
|
-
`OTHER`.
|
|
22857
|
-
|
|
22858
|
-
'
|
|
25174
|
+
$ref: '#/components/schemas/Powerpack'
|
|
25175
|
+
description: Update a powerpack request body.
|
|
22859
25176
|
required: true
|
|
22860
25177
|
responses:
|
|
22861
25178
|
'200':
|
|
22862
25179
|
content:
|
|
22863
25180
|
application/json:
|
|
22864
25181
|
schema:
|
|
22865
|
-
$ref: '#/components/schemas/
|
|
25182
|
+
$ref: '#/components/schemas/PowerpackResponse'
|
|
22866
25183
|
description: OK
|
|
22867
25184
|
'400':
|
|
22868
|
-
$ref: '#/components/responses/FindingsBadRequestResponse'
|
|
22869
|
-
'403':
|
|
22870
|
-
$ref: '#/components/responses/FindingsForbiddenResponse'
|
|
22871
|
-
'404':
|
|
22872
|
-
$ref: '#/components/responses/FindingsNotFoundResponse'
|
|
22873
|
-
'409':
|
|
22874
25185
|
content:
|
|
22875
25186
|
application/json:
|
|
22876
25187
|
schema:
|
|
22877
|
-
$ref: '#/components/schemas/
|
|
22878
|
-
description:
|
|
22879
|
-
|
|
22880
|
-
'422':
|
|
25188
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
25189
|
+
description: Bad Request
|
|
25190
|
+
'404':
|
|
22881
25191
|
content:
|
|
22882
25192
|
application/json:
|
|
22883
25193
|
schema:
|
|
22884
|
-
$ref: '#/components/schemas/
|
|
22885
|
-
description:
|
|
22886
|
-
but cannot process it due to invalid data.'
|
|
25194
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
25195
|
+
description: Powerpack Not Found
|
|
22887
25196
|
'429':
|
|
22888
|
-
$ref: '#/components/responses/
|
|
25197
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
22889
25198
|
security:
|
|
22890
25199
|
- apiKeyAuth: []
|
|
22891
25200
|
appKeyAuth: []
|
|
22892
|
-
|
|
25201
|
+
- AuthZ:
|
|
25202
|
+
- dashboards_write
|
|
25203
|
+
summary: Update a powerpack
|
|
22893
25204
|
tags:
|
|
22894
|
-
-
|
|
25205
|
+
- Powerpack
|
|
22895
25206
|
x-codegen-request-body-name: body
|
|
22896
|
-
x-unstable: '**Note**: This endpoint is in public beta.
|
|
22897
|
-
|
|
22898
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
22899
25207
|
/api/v2/processes:
|
|
22900
25208
|
get:
|
|
22901
25209
|
description: Get all processes for your organization.
|
|
@@ -23214,6 +25522,12 @@ paths:
|
|
|
23214
25522
|
required: false
|
|
23215
25523
|
schema:
|
|
23216
25524
|
type: string
|
|
25525
|
+
- description: Filter all roles by the given list of role IDs.
|
|
25526
|
+
in: query
|
|
25527
|
+
name: filter[id]
|
|
25528
|
+
required: false
|
|
25529
|
+
schema:
|
|
25530
|
+
type: string
|
|
23217
25531
|
responses:
|
|
23218
25532
|
'200':
|
|
23219
25533
|
content:
|
|
@@ -23841,217 +26155,502 @@ paths:
|
|
|
23841
26155
|
content:
|
|
23842
26156
|
application/json:
|
|
23843
26157
|
schema:
|
|
23844
|
-
$ref: '#/components/schemas/RUMApplicationResponse'
|
|
26158
|
+
$ref: '#/components/schemas/RUMApplicationResponse'
|
|
26159
|
+
description: OK
|
|
26160
|
+
'404':
|
|
26161
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
26162
|
+
'429':
|
|
26163
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
26164
|
+
summary: Get a RUM application
|
|
26165
|
+
tags:
|
|
26166
|
+
- RUM
|
|
26167
|
+
patch:
|
|
26168
|
+
description: Update the RUM application with given ID in your organization.
|
|
26169
|
+
operationId: UpdateRUMApplication
|
|
26170
|
+
parameters:
|
|
26171
|
+
- description: RUM application ID.
|
|
26172
|
+
in: path
|
|
26173
|
+
name: id
|
|
26174
|
+
required: true
|
|
26175
|
+
schema:
|
|
26176
|
+
type: string
|
|
26177
|
+
requestBody:
|
|
26178
|
+
content:
|
|
26179
|
+
application/json:
|
|
26180
|
+
schema:
|
|
26181
|
+
$ref: '#/components/schemas/RUMApplicationUpdateRequest'
|
|
26182
|
+
required: true
|
|
26183
|
+
responses:
|
|
26184
|
+
'200':
|
|
26185
|
+
content:
|
|
26186
|
+
application/json:
|
|
26187
|
+
schema:
|
|
26188
|
+
$ref: '#/components/schemas/RUMApplicationResponse'
|
|
26189
|
+
description: OK
|
|
26190
|
+
'400':
|
|
26191
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
26192
|
+
'404':
|
|
26193
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
26194
|
+
'422':
|
|
26195
|
+
content:
|
|
26196
|
+
application/json:
|
|
26197
|
+
schema:
|
|
26198
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
26199
|
+
description: Unprocessable Entity.
|
|
26200
|
+
'429':
|
|
26201
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
26202
|
+
summary: Update a RUM application
|
|
26203
|
+
tags:
|
|
26204
|
+
- RUM
|
|
26205
|
+
x-codegen-request-body-name: body
|
|
26206
|
+
/api/v2/rum/events:
|
|
26207
|
+
get:
|
|
26208
|
+
description: 'List endpoint returns events that match a RUM search query.
|
|
26209
|
+
|
|
26210
|
+
[Results are paginated][1].
|
|
26211
|
+
|
|
26212
|
+
|
|
26213
|
+
Use this endpoint to see your latest RUM events.
|
|
26214
|
+
|
|
26215
|
+
|
|
26216
|
+
[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination'
|
|
26217
|
+
operationId: ListRUMEvents
|
|
26218
|
+
parameters:
|
|
26219
|
+
- description: Search query following RUM syntax.
|
|
26220
|
+
example: '@type:session @application_id:xxxx'
|
|
26221
|
+
in: query
|
|
26222
|
+
name: filter[query]
|
|
26223
|
+
required: false
|
|
26224
|
+
schema:
|
|
26225
|
+
type: string
|
|
26226
|
+
- description: Minimum timestamp for requested events.
|
|
26227
|
+
example: '2019-01-02T09:42:36.320Z'
|
|
26228
|
+
in: query
|
|
26229
|
+
name: filter[from]
|
|
26230
|
+
required: false
|
|
26231
|
+
schema:
|
|
26232
|
+
format: date-time
|
|
26233
|
+
type: string
|
|
26234
|
+
- description: Maximum timestamp for requested events.
|
|
26235
|
+
example: '2019-01-03T09:42:36.320Z'
|
|
26236
|
+
in: query
|
|
26237
|
+
name: filter[to]
|
|
26238
|
+
required: false
|
|
26239
|
+
schema:
|
|
26240
|
+
format: date-time
|
|
26241
|
+
type: string
|
|
26242
|
+
- description: Order of events in results.
|
|
26243
|
+
in: query
|
|
26244
|
+
name: sort
|
|
26245
|
+
required: false
|
|
26246
|
+
schema:
|
|
26247
|
+
$ref: '#/components/schemas/RUMSort'
|
|
26248
|
+
- description: List following results with a cursor provided in the previous
|
|
26249
|
+
query.
|
|
26250
|
+
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
|
26251
|
+
in: query
|
|
26252
|
+
name: page[cursor]
|
|
26253
|
+
required: false
|
|
26254
|
+
schema:
|
|
26255
|
+
type: string
|
|
26256
|
+
- description: Maximum number of events in the response.
|
|
26257
|
+
example: 25
|
|
26258
|
+
in: query
|
|
26259
|
+
name: page[limit]
|
|
26260
|
+
required: false
|
|
26261
|
+
schema:
|
|
26262
|
+
default: 10
|
|
26263
|
+
format: int32
|
|
26264
|
+
maximum: 1000
|
|
26265
|
+
type: integer
|
|
26266
|
+
responses:
|
|
26267
|
+
'200':
|
|
26268
|
+
content:
|
|
26269
|
+
application/json:
|
|
26270
|
+
schema:
|
|
26271
|
+
$ref: '#/components/schemas/RUMEventsResponse'
|
|
26272
|
+
description: OK
|
|
26273
|
+
'400':
|
|
26274
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
26275
|
+
'403':
|
|
26276
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
26277
|
+
'429':
|
|
26278
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
26279
|
+
security:
|
|
26280
|
+
- apiKeyAuth: []
|
|
26281
|
+
appKeyAuth: []
|
|
26282
|
+
- AuthZ: []
|
|
26283
|
+
summary: Get a list of RUM events
|
|
26284
|
+
tags:
|
|
26285
|
+
- RUM
|
|
26286
|
+
x-pagination:
|
|
26287
|
+
cursorParam: page[cursor]
|
|
26288
|
+
cursorPath: meta.page.after
|
|
26289
|
+
limitParam: page[limit]
|
|
26290
|
+
resultsPath: data
|
|
26291
|
+
/api/v2/rum/events/search:
|
|
26292
|
+
post:
|
|
26293
|
+
description: 'List endpoint returns RUM events that match a RUM search query.
|
|
26294
|
+
|
|
26295
|
+
[Results are paginated][1].
|
|
26296
|
+
|
|
26297
|
+
|
|
26298
|
+
Use this endpoint to build complex RUM events filtering and search.
|
|
26299
|
+
|
|
26300
|
+
|
|
26301
|
+
[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination'
|
|
26302
|
+
operationId: SearchRUMEvents
|
|
26303
|
+
requestBody:
|
|
26304
|
+
content:
|
|
26305
|
+
application/json:
|
|
26306
|
+
schema:
|
|
26307
|
+
$ref: '#/components/schemas/RUMSearchEventsRequest'
|
|
26308
|
+
required: true
|
|
26309
|
+
responses:
|
|
26310
|
+
'200':
|
|
26311
|
+
content:
|
|
26312
|
+
application/json:
|
|
26313
|
+
schema:
|
|
26314
|
+
$ref: '#/components/schemas/RUMEventsResponse'
|
|
26315
|
+
description: OK
|
|
26316
|
+
'400':
|
|
26317
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
26318
|
+
'403':
|
|
26319
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
26320
|
+
'429':
|
|
26321
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
26322
|
+
security:
|
|
26323
|
+
- apiKeyAuth: []
|
|
26324
|
+
appKeyAuth: []
|
|
26325
|
+
- AuthZ: []
|
|
26326
|
+
summary: Search RUM events
|
|
26327
|
+
tags:
|
|
26328
|
+
- RUM
|
|
26329
|
+
x-codegen-request-body-name: body
|
|
26330
|
+
x-pagination:
|
|
26331
|
+
cursorParam: body.page.cursor
|
|
26332
|
+
cursorPath: meta.page.after
|
|
26333
|
+
limitParam: body.page.limit
|
|
26334
|
+
resultsPath: data
|
|
26335
|
+
/api/v2/saml_configurations/idp_metadata:
|
|
26336
|
+
post:
|
|
26337
|
+
description: 'Endpoint for uploading IdP metadata for SAML setup.
|
|
26338
|
+
|
|
26339
|
+
|
|
26340
|
+
Use this endpoint to upload or replace IdP metadata for SAML login configuration.'
|
|
26341
|
+
operationId: UploadIdPMetadata
|
|
26342
|
+
requestBody:
|
|
26343
|
+
content:
|
|
26344
|
+
multipart/form-data:
|
|
26345
|
+
schema:
|
|
26346
|
+
$ref: '#/components/schemas/IdPMetadataFormData'
|
|
26347
|
+
required: true
|
|
26348
|
+
responses:
|
|
26349
|
+
'200':
|
|
26350
|
+
description: OK
|
|
26351
|
+
'400':
|
|
26352
|
+
content:
|
|
26353
|
+
application/json:
|
|
26354
|
+
schema:
|
|
26355
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
26356
|
+
description: Bad Request
|
|
26357
|
+
'403':
|
|
26358
|
+
content:
|
|
26359
|
+
application/json:
|
|
26360
|
+
schema:
|
|
26361
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
26362
|
+
description: Forbidden
|
|
26363
|
+
'429':
|
|
26364
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
26365
|
+
summary: Upload IdP metadata
|
|
26366
|
+
tags:
|
|
26367
|
+
- Organizations
|
|
26368
|
+
x-codegen-request-body-name: body
|
|
26369
|
+
/api/v2/scorecard/outcomes:
|
|
26370
|
+
get:
|
|
26371
|
+
description: Fetches all rule outcomes.
|
|
26372
|
+
operationId: ListScorecardOutcomes
|
|
26373
|
+
parameters:
|
|
26374
|
+
- $ref: '#/components/parameters/PageSize'
|
|
26375
|
+
- $ref: '#/components/parameters/PageOffset'
|
|
26376
|
+
- description: Include related rule details in the response.
|
|
26377
|
+
in: query
|
|
26378
|
+
name: include
|
|
26379
|
+
required: false
|
|
26380
|
+
schema:
|
|
26381
|
+
example: rule
|
|
26382
|
+
type: string
|
|
26383
|
+
- description: Return only specified values in the outcome attributes.
|
|
26384
|
+
in: query
|
|
26385
|
+
name: fields[outcome]
|
|
26386
|
+
required: false
|
|
26387
|
+
schema:
|
|
26388
|
+
example: state, service_name
|
|
26389
|
+
type: string
|
|
26390
|
+
- description: Return only specified values in the included rule details.
|
|
26391
|
+
in: query
|
|
26392
|
+
name: fields[rule]
|
|
26393
|
+
required: false
|
|
26394
|
+
schema:
|
|
26395
|
+
example: name
|
|
26396
|
+
type: string
|
|
26397
|
+
- description: Filter the outcomes on a specific service name.
|
|
26398
|
+
in: query
|
|
26399
|
+
name: filter[outcome][service_name]
|
|
26400
|
+
required: false
|
|
26401
|
+
schema:
|
|
26402
|
+
example: web-store
|
|
26403
|
+
type: string
|
|
26404
|
+
- description: Filter the outcomes by a specific state.
|
|
26405
|
+
in: query
|
|
26406
|
+
name: filter[outcome][state]
|
|
26407
|
+
required: false
|
|
26408
|
+
schema:
|
|
26409
|
+
example: fail
|
|
26410
|
+
type: string
|
|
26411
|
+
- description: Filter outcomes on whether a rule is enabled/disabled.
|
|
26412
|
+
in: query
|
|
26413
|
+
name: filter[rule][enabled]
|
|
26414
|
+
required: false
|
|
26415
|
+
schema:
|
|
26416
|
+
example: true
|
|
26417
|
+
type: boolean
|
|
26418
|
+
- description: Filter outcomes based on rule ID.
|
|
26419
|
+
in: query
|
|
26420
|
+
name: filter[rule][id]
|
|
26421
|
+
required: false
|
|
26422
|
+
schema:
|
|
26423
|
+
example: f4485c79-0762-449c-96cf-c31e54a659f6
|
|
26424
|
+
type: string
|
|
26425
|
+
- description: Filter outcomes based on rule name.
|
|
26426
|
+
in: query
|
|
26427
|
+
name: filter[rule][name]
|
|
26428
|
+
required: false
|
|
26429
|
+
schema:
|
|
26430
|
+
example: SLOs Defined
|
|
26431
|
+
type: string
|
|
26432
|
+
responses:
|
|
26433
|
+
'200':
|
|
26434
|
+
content:
|
|
26435
|
+
application/json:
|
|
26436
|
+
schema:
|
|
26437
|
+
$ref: '#/components/schemas/OutcomesResponse'
|
|
23845
26438
|
description: OK
|
|
23846
|
-
'
|
|
23847
|
-
$ref: '#/components/responses/
|
|
26439
|
+
'400':
|
|
26440
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
26441
|
+
'403':
|
|
26442
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
23848
26443
|
'429':
|
|
23849
26444
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
23850
|
-
|
|
26445
|
+
security:
|
|
26446
|
+
- apiKeyAuth: []
|
|
26447
|
+
appKeyAuth: []
|
|
26448
|
+
- AuthZ:
|
|
26449
|
+
- apm_service_catalog_read
|
|
26450
|
+
summary: List all rule outcomes
|
|
23851
26451
|
tags:
|
|
23852
|
-
-
|
|
23853
|
-
|
|
23854
|
-
|
|
23855
|
-
|
|
23856
|
-
|
|
23857
|
-
-
|
|
23858
|
-
|
|
23859
|
-
|
|
23860
|
-
|
|
23861
|
-
|
|
23862
|
-
|
|
26452
|
+
- Service Scorecards
|
|
26453
|
+
x-pagination:
|
|
26454
|
+
limitParam: page[size]
|
|
26455
|
+
pageOffsetParam: page[offset]
|
|
26456
|
+
resultsPath: data
|
|
26457
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
|
26458
|
+
|
|
26459
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
26460
|
+
/api/v2/scorecard/outcomes/batch:
|
|
26461
|
+
post:
|
|
26462
|
+
description: Sets multiple service-rule outcomes in a single batched request.
|
|
26463
|
+
operationId: CreateScorecardOutcomesBatch
|
|
23863
26464
|
requestBody:
|
|
23864
26465
|
content:
|
|
23865
26466
|
application/json:
|
|
23866
26467
|
schema:
|
|
23867
|
-
$ref: '#/components/schemas/
|
|
26468
|
+
$ref: '#/components/schemas/OutcomesBatchRequest'
|
|
26469
|
+
description: Set of scorecard outcomes.
|
|
23868
26470
|
required: true
|
|
23869
26471
|
responses:
|
|
23870
26472
|
'200':
|
|
23871
26473
|
content:
|
|
23872
26474
|
application/json:
|
|
23873
26475
|
schema:
|
|
23874
|
-
$ref: '#/components/schemas/
|
|
26476
|
+
$ref: '#/components/schemas/OutcomesBatchResponse'
|
|
23875
26477
|
description: OK
|
|
23876
26478
|
'400':
|
|
23877
26479
|
$ref: '#/components/responses/BadRequestResponse'
|
|
23878
|
-
'
|
|
23879
|
-
$ref: '#/components/responses/
|
|
23880
|
-
'422':
|
|
23881
|
-
content:
|
|
23882
|
-
application/json:
|
|
23883
|
-
schema:
|
|
23884
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
|
23885
|
-
description: Unprocessable Entity.
|
|
26480
|
+
'403':
|
|
26481
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
23886
26482
|
'429':
|
|
23887
26483
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
23888
|
-
|
|
26484
|
+
security:
|
|
26485
|
+
- apiKeyAuth: []
|
|
26486
|
+
appKeyAuth: []
|
|
26487
|
+
- AuthZ:
|
|
26488
|
+
- apm_service_catalog_write
|
|
26489
|
+
summary: Create outcomes batch
|
|
23889
26490
|
tags:
|
|
23890
|
-
-
|
|
26491
|
+
- Service Scorecards
|
|
23891
26492
|
x-codegen-request-body-name: body
|
|
23892
|
-
|
|
23893
|
-
|
|
23894
|
-
description: 'List endpoint returns events that match a RUM search query.
|
|
23895
|
-
|
|
23896
|
-
[Results are paginated][1].
|
|
23897
|
-
|
|
26493
|
+
x-unstable: '**Note**: This endpoint is in private beta. To request access,
|
|
26494
|
+
fill out this [sign-up form](https://forms.gle/CcEyp1uJmZpxRv8U8),
|
|
23898
26495
|
|
|
23899
|
-
|
|
23900
|
-
|
|
23901
|
-
|
|
23902
|
-
|
|
23903
|
-
operationId:
|
|
26496
|
+
and we will be in touch. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
26497
|
+
/api/v2/scorecard/rules:
|
|
26498
|
+
get:
|
|
26499
|
+
description: Fetch all rules.
|
|
26500
|
+
operationId: ListScorecardRules
|
|
23904
26501
|
parameters:
|
|
23905
|
-
-
|
|
23906
|
-
|
|
26502
|
+
- $ref: '#/components/parameters/PageSize'
|
|
26503
|
+
- $ref: '#/components/parameters/PageOffset'
|
|
26504
|
+
- description: Include related scorecard details in the response.
|
|
23907
26505
|
in: query
|
|
23908
|
-
name:
|
|
26506
|
+
name: include
|
|
23909
26507
|
required: false
|
|
23910
26508
|
schema:
|
|
26509
|
+
example: scorecard
|
|
23911
26510
|
type: string
|
|
23912
|
-
- description:
|
|
23913
|
-
example: '2019-01-02T09:42:36.320Z'
|
|
26511
|
+
- description: Filter the rules on a rule ID.
|
|
23914
26512
|
in: query
|
|
23915
|
-
name: filter[
|
|
26513
|
+
name: filter[rule][id]
|
|
23916
26514
|
required: false
|
|
23917
26515
|
schema:
|
|
23918
|
-
|
|
26516
|
+
example: 37d2f990-c885-4972-949b-8b798213a166
|
|
23919
26517
|
type: string
|
|
23920
|
-
- description:
|
|
23921
|
-
example: '2019-01-03T09:42:36.320Z'
|
|
26518
|
+
- description: Filter for enabled rules only.
|
|
23922
26519
|
in: query
|
|
23923
|
-
name: filter[
|
|
26520
|
+
name: filter[rule][enabled]
|
|
23924
26521
|
required: false
|
|
23925
26522
|
schema:
|
|
23926
|
-
|
|
26523
|
+
example: true
|
|
26524
|
+
type: boolean
|
|
26525
|
+
- description: Filter for custom rules only.
|
|
26526
|
+
in: query
|
|
26527
|
+
name: filter[rule][custom]
|
|
26528
|
+
required: false
|
|
26529
|
+
schema:
|
|
26530
|
+
example: true
|
|
26531
|
+
type: boolean
|
|
26532
|
+
- description: Filter rules on the rule name.
|
|
26533
|
+
in: query
|
|
26534
|
+
name: filter[rule][name]
|
|
26535
|
+
required: false
|
|
26536
|
+
schema:
|
|
26537
|
+
example: Code Repos Defined
|
|
23927
26538
|
type: string
|
|
23928
|
-
- description:
|
|
26539
|
+
- description: Filter rules on the rule description.
|
|
23929
26540
|
in: query
|
|
23930
|
-
name:
|
|
26541
|
+
name: filter[rule][description]
|
|
23931
26542
|
required: false
|
|
23932
26543
|
schema:
|
|
23933
|
-
|
|
23934
|
-
|
|
23935
|
-
|
|
23936
|
-
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
|
26544
|
+
example: Identifying
|
|
26545
|
+
type: string
|
|
26546
|
+
- description: Return only specific fields in the response for rule attributes.
|
|
23937
26547
|
in: query
|
|
23938
|
-
name:
|
|
26548
|
+
name: fields[rule]
|
|
23939
26549
|
required: false
|
|
23940
26550
|
schema:
|
|
26551
|
+
example: name, description
|
|
23941
26552
|
type: string
|
|
23942
|
-
- description:
|
|
23943
|
-
|
|
26553
|
+
- description: Return only specific fields in the included response for scorecard
|
|
26554
|
+
attributes.
|
|
23944
26555
|
in: query
|
|
23945
|
-
name:
|
|
26556
|
+
name: fields[scorecard]
|
|
23946
26557
|
required: false
|
|
23947
26558
|
schema:
|
|
23948
|
-
|
|
23949
|
-
|
|
23950
|
-
maximum: 1000
|
|
23951
|
-
type: integer
|
|
26559
|
+
example: name
|
|
26560
|
+
type: string
|
|
23952
26561
|
responses:
|
|
23953
26562
|
'200':
|
|
23954
26563
|
content:
|
|
23955
26564
|
application/json:
|
|
23956
26565
|
schema:
|
|
23957
|
-
$ref: '#/components/schemas/
|
|
26566
|
+
$ref: '#/components/schemas/ListRulesResponse'
|
|
23958
26567
|
description: OK
|
|
23959
26568
|
'400':
|
|
23960
26569
|
$ref: '#/components/responses/BadRequestResponse'
|
|
23961
26570
|
'403':
|
|
23962
|
-
$ref: '#/components/responses/
|
|
26571
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
23963
26572
|
'429':
|
|
23964
26573
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
23965
26574
|
security:
|
|
23966
26575
|
- apiKeyAuth: []
|
|
23967
26576
|
appKeyAuth: []
|
|
23968
|
-
- AuthZ:
|
|
23969
|
-
|
|
26577
|
+
- AuthZ:
|
|
26578
|
+
- apm_service_catalog_read
|
|
26579
|
+
summary: List all rules
|
|
23970
26580
|
tags:
|
|
23971
|
-
-
|
|
26581
|
+
- Service Scorecards
|
|
23972
26582
|
x-pagination:
|
|
23973
|
-
|
|
23974
|
-
|
|
23975
|
-
limitParam: page[limit]
|
|
26583
|
+
limitParam: page[size]
|
|
26584
|
+
pageOffsetParam: page[offset]
|
|
23976
26585
|
resultsPath: data
|
|
23977
|
-
|
|
23978
|
-
post:
|
|
23979
|
-
description: 'List endpoint returns RUM events that match a RUM search query.
|
|
23980
|
-
|
|
23981
|
-
[Results are paginated][1].
|
|
23982
|
-
|
|
23983
|
-
|
|
23984
|
-
Use this endpoint to build complex RUM events filtering and search.
|
|
23985
|
-
|
|
26586
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
|
23986
26587
|
|
|
23987
|
-
[
|
|
23988
|
-
|
|
26588
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
26589
|
+
post:
|
|
26590
|
+
description: Creates a new rule.
|
|
26591
|
+
operationId: CreateScorecardRule
|
|
23989
26592
|
requestBody:
|
|
23990
26593
|
content:
|
|
23991
26594
|
application/json:
|
|
23992
26595
|
schema:
|
|
23993
|
-
$ref: '#/components/schemas/
|
|
26596
|
+
$ref: '#/components/schemas/CreateRuleRequest'
|
|
26597
|
+
description: Rule attributes.
|
|
23994
26598
|
required: true
|
|
23995
26599
|
responses:
|
|
23996
|
-
'
|
|
26600
|
+
'201':
|
|
23997
26601
|
content:
|
|
23998
26602
|
application/json:
|
|
23999
26603
|
schema:
|
|
24000
|
-
$ref: '#/components/schemas/
|
|
24001
|
-
description:
|
|
26604
|
+
$ref: '#/components/schemas/CreateRuleResponse'
|
|
26605
|
+
description: Created
|
|
24002
26606
|
'400':
|
|
24003
26607
|
$ref: '#/components/responses/BadRequestResponse'
|
|
24004
26608
|
'403':
|
|
24005
|
-
$ref: '#/components/responses/
|
|
26609
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
24006
26610
|
'429':
|
|
24007
26611
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
24008
26612
|
security:
|
|
24009
26613
|
- apiKeyAuth: []
|
|
24010
26614
|
appKeyAuth: []
|
|
24011
|
-
- AuthZ:
|
|
24012
|
-
|
|
26615
|
+
- AuthZ:
|
|
26616
|
+
- apm_service_catalog_write
|
|
26617
|
+
summary: Create a new rule
|
|
24013
26618
|
tags:
|
|
24014
|
-
-
|
|
26619
|
+
- Service Scorecards
|
|
24015
26620
|
x-codegen-request-body-name: body
|
|
24016
|
-
x-
|
|
24017
|
-
|
|
24018
|
-
cursorPath: meta.page.after
|
|
24019
|
-
limitParam: body.page.limit
|
|
24020
|
-
resultsPath: data
|
|
24021
|
-
/api/v2/saml_configurations/idp_metadata:
|
|
24022
|
-
post:
|
|
24023
|
-
description: 'Endpoint for uploading IdP metadata for SAML setup.
|
|
24024
|
-
|
|
26621
|
+
x-unstable: '**Note**: This endpoint is in private beta. To request access,
|
|
26622
|
+
fill out this [sign-up form](https://forms.gle/CcEyp1uJmZpxRv8U8),
|
|
24025
26623
|
|
|
24026
|
-
|
|
24027
|
-
|
|
24028
|
-
|
|
24029
|
-
|
|
24030
|
-
|
|
24031
|
-
|
|
24032
|
-
|
|
24033
|
-
required: true
|
|
26624
|
+
and we will be in touch. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
26625
|
+
/api/v2/scorecard/rules/{rule_id}:
|
|
26626
|
+
delete:
|
|
26627
|
+
description: Deletes a single rule.
|
|
26628
|
+
operationId: DeleteScorecardRule
|
|
26629
|
+
parameters:
|
|
26630
|
+
- $ref: '#/components/parameters/RuleId'
|
|
24034
26631
|
responses:
|
|
24035
|
-
'
|
|
26632
|
+
'204':
|
|
24036
26633
|
description: OK
|
|
24037
26634
|
'400':
|
|
24038
|
-
|
|
24039
|
-
application/json:
|
|
24040
|
-
schema:
|
|
24041
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
|
24042
|
-
description: Bad Request
|
|
26635
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
24043
26636
|
'403':
|
|
24044
|
-
|
|
24045
|
-
|
|
24046
|
-
|
|
24047
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
|
24048
|
-
description: Forbidden
|
|
26637
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
26638
|
+
'404':
|
|
26639
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
24049
26640
|
'429':
|
|
24050
26641
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
24051
|
-
|
|
26642
|
+
security:
|
|
26643
|
+
- apiKeyAuth: []
|
|
26644
|
+
appKeyAuth: []
|
|
26645
|
+
- AuthZ:
|
|
26646
|
+
- apm_service_catalog_write
|
|
26647
|
+
summary: Delete a rule
|
|
24052
26648
|
tags:
|
|
24053
|
-
-
|
|
24054
|
-
x-
|
|
26649
|
+
- Service Scorecards
|
|
26650
|
+
x-unstable: '**Note**: This endpoint is in private beta. To request access,
|
|
26651
|
+
fill out this [sign-up form](https://forms.gle/CcEyp1uJmZpxRv8U8),
|
|
26652
|
+
|
|
26653
|
+
and we will be in touch. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
24055
26654
|
/api/v2/security/cloud_workload/policy/download:
|
|
24056
26655
|
get:
|
|
24057
26656
|
description: 'The download endpoint generates a Cloud Workload Security policy
|
|
@@ -25934,12 +28533,14 @@ paths:
|
|
|
25934
28533
|
- description: Specifies the order of the returned teams
|
|
25935
28534
|
in: query
|
|
25936
28535
|
name: sort
|
|
28536
|
+
required: false
|
|
25937
28537
|
schema:
|
|
25938
28538
|
$ref: '#/components/schemas/ListTeamsSort'
|
|
25939
28539
|
- description: 'Included related resources optionally requested. Allowed enum
|
|
25940
28540
|
values: `team_links, user_team_permissions`'
|
|
25941
28541
|
in: query
|
|
25942
28542
|
name: include
|
|
28543
|
+
required: false
|
|
25943
28544
|
schema:
|
|
25944
28545
|
items:
|
|
25945
28546
|
$ref: '#/components/schemas/ListTeamsInclude'
|
|
@@ -25948,13 +28549,24 @@ paths:
|
|
|
25948
28549
|
member
|
|
25949
28550
|
in: query
|
|
25950
28551
|
name: filter[keyword]
|
|
28552
|
+
required: false
|
|
25951
28553
|
schema:
|
|
25952
28554
|
type: string
|
|
25953
28555
|
- description: When true, only returns teams the current user belongs to
|
|
25954
28556
|
in: query
|
|
25955
28557
|
name: filter[me]
|
|
28558
|
+
required: false
|
|
25956
28559
|
schema:
|
|
25957
28560
|
type: boolean
|
|
28561
|
+
- description: List of fields that need to be fetched.
|
|
28562
|
+
explode: false
|
|
28563
|
+
in: query
|
|
28564
|
+
name: fields[team]
|
|
28565
|
+
required: false
|
|
28566
|
+
schema:
|
|
28567
|
+
items:
|
|
28568
|
+
$ref: '#/components/schemas/TeamsField'
|
|
28569
|
+
type: array
|
|
25958
28570
|
responses:
|
|
25959
28571
|
'200':
|
|
25960
28572
|
content:
|
|
@@ -25962,6 +28574,8 @@ paths:
|
|
|
25962
28574
|
schema:
|
|
25963
28575
|
$ref: '#/components/schemas/TeamsResponse'
|
|
25964
28576
|
description: OK
|
|
28577
|
+
'403':
|
|
28578
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
25965
28579
|
'429':
|
|
25966
28580
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
25967
28581
|
security:
|
|
@@ -25994,6 +28608,8 @@ paths:
|
|
|
25994
28608
|
schema:
|
|
25995
28609
|
$ref: '#/components/schemas/TeamResponse'
|
|
25996
28610
|
description: CREATED
|
|
28611
|
+
'403':
|
|
28612
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
25997
28613
|
'409':
|
|
25998
28614
|
content:
|
|
25999
28615
|
application/json:
|
|
@@ -26026,6 +28642,8 @@ paths:
|
|
|
26026
28642
|
responses:
|
|
26027
28643
|
'204':
|
|
26028
28644
|
description: No Content
|
|
28645
|
+
'403':
|
|
28646
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
26029
28647
|
'404':
|
|
26030
28648
|
content:
|
|
26031
28649
|
application/json:
|
|
@@ -26060,6 +28678,8 @@ paths:
|
|
|
26060
28678
|
schema:
|
|
26061
28679
|
$ref: '#/components/schemas/TeamResponse'
|
|
26062
28680
|
description: OK
|
|
28681
|
+
'403':
|
|
28682
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
26063
28683
|
'404':
|
|
26064
28684
|
content:
|
|
26065
28685
|
application/json:
|
|
@@ -26109,6 +28729,8 @@ paths:
|
|
|
26109
28729
|
schema:
|
|
26110
28730
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
26111
28731
|
description: API error response.
|
|
28732
|
+
'403':
|
|
28733
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
26112
28734
|
'404':
|
|
26113
28735
|
content:
|
|
26114
28736
|
application/json:
|
|
@@ -26150,6 +28772,8 @@ paths:
|
|
|
26150
28772
|
schema:
|
|
26151
28773
|
$ref: '#/components/schemas/TeamLinksResponse'
|
|
26152
28774
|
description: OK
|
|
28775
|
+
'403':
|
|
28776
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
26153
28777
|
'404':
|
|
26154
28778
|
content:
|
|
26155
28779
|
application/json:
|
|
@@ -26189,6 +28813,8 @@ paths:
|
|
|
26189
28813
|
schema:
|
|
26190
28814
|
$ref: '#/components/schemas/TeamLinkResponse'
|
|
26191
28815
|
description: OK
|
|
28816
|
+
'403':
|
|
28817
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
26192
28818
|
'404':
|
|
26193
28819
|
content:
|
|
26194
28820
|
application/json:
|
|
@@ -26232,6 +28858,8 @@ paths:
|
|
|
26232
28858
|
responses:
|
|
26233
28859
|
'204':
|
|
26234
28860
|
description: No Content
|
|
28861
|
+
'403':
|
|
28862
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
26235
28863
|
'404':
|
|
26236
28864
|
content:
|
|
26237
28865
|
application/json:
|
|
@@ -26271,6 +28899,8 @@ paths:
|
|
|
26271
28899
|
schema:
|
|
26272
28900
|
$ref: '#/components/schemas/TeamLinkResponse'
|
|
26273
28901
|
description: OK
|
|
28902
|
+
'403':
|
|
28903
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
26274
28904
|
'404':
|
|
26275
28905
|
content:
|
|
26276
28906
|
application/json:
|
|
@@ -26316,6 +28946,8 @@ paths:
|
|
|
26316
28946
|
schema:
|
|
26317
28947
|
$ref: '#/components/schemas/TeamLinkResponse'
|
|
26318
28948
|
description: OK
|
|
28949
|
+
'403':
|
|
28950
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
26319
28951
|
'404':
|
|
26320
28952
|
content:
|
|
26321
28953
|
application/json:
|
|
@@ -26349,11 +28981,13 @@ paths:
|
|
|
26349
28981
|
- description: Specifies the order of returned team memberships
|
|
26350
28982
|
in: query
|
|
26351
28983
|
name: sort
|
|
28984
|
+
required: false
|
|
26352
28985
|
schema:
|
|
26353
28986
|
$ref: '#/components/schemas/GetTeamMembershipsSort'
|
|
26354
28987
|
- description: Search query, can be user email or name
|
|
26355
28988
|
in: query
|
|
26356
28989
|
name: filter[keyword]
|
|
28990
|
+
required: false
|
|
26357
28991
|
schema:
|
|
26358
28992
|
type: string
|
|
26359
28993
|
responses:
|
|
@@ -26363,6 +28997,8 @@ paths:
|
|
|
26363
28997
|
schema:
|
|
26364
28998
|
$ref: '#/components/schemas/UserTeamsResponse'
|
|
26365
28999
|
description: Represents a user's association to a team
|
|
29000
|
+
'403':
|
|
29001
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
26366
29002
|
'404':
|
|
26367
29003
|
content:
|
|
26368
29004
|
application/json:
|
|
@@ -26402,6 +29038,8 @@ paths:
|
|
|
26402
29038
|
schema:
|
|
26403
29039
|
$ref: '#/components/schemas/UserTeamResponse'
|
|
26404
29040
|
description: Represents a user's association to a team
|
|
29041
|
+
'403':
|
|
29042
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
26405
29043
|
'404':
|
|
26406
29044
|
content:
|
|
26407
29045
|
application/json:
|
|
@@ -26445,6 +29083,8 @@ paths:
|
|
|
26445
29083
|
responses:
|
|
26446
29084
|
'204':
|
|
26447
29085
|
description: No Content
|
|
29086
|
+
'403':
|
|
29087
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
26448
29088
|
'404':
|
|
26449
29089
|
content:
|
|
26450
29090
|
application/json:
|
|
@@ -26490,6 +29130,8 @@ paths:
|
|
|
26490
29130
|
schema:
|
|
26491
29131
|
$ref: '#/components/schemas/UserTeamResponse'
|
|
26492
29132
|
description: Represents a user's association to a team
|
|
29133
|
+
'403':
|
|
29134
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
26493
29135
|
'404':
|
|
26494
29136
|
content:
|
|
26495
29137
|
application/json:
|
|
@@ -26525,6 +29167,8 @@ paths:
|
|
|
26525
29167
|
schema:
|
|
26526
29168
|
$ref: '#/components/schemas/TeamPermissionSettingsResponse'
|
|
26527
29169
|
description: OK
|
|
29170
|
+
'403':
|
|
29171
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
26528
29172
|
'404':
|
|
26529
29173
|
content:
|
|
26530
29174
|
application/json:
|
|
@@ -26571,6 +29215,8 @@ paths:
|
|
|
26571
29215
|
schema:
|
|
26572
29216
|
$ref: '#/components/schemas/TeamPermissionSettingResponse'
|
|
26573
29217
|
description: OK
|
|
29218
|
+
'403':
|
|
29219
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
26574
29220
|
'404':
|
|
26575
29221
|
content:
|
|
26576
29222
|
application/json:
|
|
@@ -27072,12 +29718,14 @@ paths:
|
|
|
27072
29718
|
|
|
27073
29719
|
`application_security`, `audit_trail`, `serverless`, `ci_app`, `cloud_cost_management`,
|
|
27074
29720
|
|
|
27075
|
-
`
|
|
29721
|
+
`csm_container_enterprise`, `csm_host_enterprise`, `cspm`, `custom_events`,
|
|
29722
|
+
`cws`, `dbm`, `fargate`,
|
|
27076
29723
|
|
|
27077
29724
|
`infra_hosts`, `incident_management`, `indexed_logs`, `indexed_spans`, `ingested_spans`,
|
|
27078
29725
|
`iot`,
|
|
27079
29726
|
|
|
27080
|
-
`lambda_traced_invocations`, `logs`, `network_flows`, `network_hosts`, `
|
|
29727
|
+
`lambda_traced_invocations`, `logs`, `network_flows`, `network_hosts`, `netflow_monitoring`,
|
|
29728
|
+
`observability_pipelines`,
|
|
27081
29729
|
|
|
27082
29730
|
`online_archive`, `profiling`, `rum`, `rum_browser_sessions`, `rum_mobile_sessions`,
|
|
27083
29731
|
`sds`, `snmp`,
|
|
@@ -27534,7 +30182,7 @@ paths:
|
|
|
27534
30182
|
application/json:
|
|
27535
30183
|
schema:
|
|
27536
30184
|
$ref: '#/components/schemas/UserResponse'
|
|
27537
|
-
description: OK
|
|
30185
|
+
description: OK
|
|
27538
30186
|
'403':
|
|
27539
30187
|
content:
|
|
27540
30188
|
application/json:
|
|
@@ -27758,6 +30406,13 @@ servers:
|
|
|
27758
30406
|
default: api
|
|
27759
30407
|
description: The subdomain where the API is deployed.
|
|
27760
30408
|
tags:
|
|
30409
|
+
- description: Manage configuration of [APM retention filters](https://app.datadoghq.com/apm/traces/retention-filters)
|
|
30410
|
+
for your organization. You need an API and application key with Admin rights to
|
|
30411
|
+
interact with this endpoint.
|
|
30412
|
+
externalDocs:
|
|
30413
|
+
description: Find out more at
|
|
30414
|
+
url: https://docs.datadoghq.com/tracing/trace_pipeline/trace_retention/
|
|
30415
|
+
name: APM Retention Filters
|
|
27761
30416
|
- description: Search your Audit Logs events over HTTP.
|
|
27762
30417
|
name: Audit
|
|
27763
30418
|
- description: '[AuthN Mappings API](https://docs.datadoghq.com/account_management/authn_mapping/?tab=example)
|
|
@@ -27780,6 +30435,11 @@ tags:
|
|
|
27780
30435
|
- description: Configure your Datadog Confluent Cloud integration directly through
|
|
27781
30436
|
the Datadog API.
|
|
27782
30437
|
name: Confluent Cloud
|
|
30438
|
+
- description: The Container Images API allows you to query Container Image data for
|
|
30439
|
+
your organization.
|
|
30440
|
+
name: Container Images
|
|
30441
|
+
- description: The Containers API allows you to query container data for your organization.
|
|
30442
|
+
name: Containers
|
|
27783
30443
|
- description: 'Interact with your dashboard lists through the API to
|
|
27784
30444
|
|
|
27785
30445
|
organize, find, and share all of your dashboards with your team and
|
|
@@ -27901,6 +30561,22 @@ tags:
|
|
|
27901
30561
|
description: Find out more at
|
|
27902
30562
|
url: https://docs.datadoghq.com/account_management/multi_organization
|
|
27903
30563
|
name: Organizations
|
|
30564
|
+
- description: 'The powerpack endpoints allow you to:
|
|
30565
|
+
|
|
30566
|
+
|
|
30567
|
+
- Get a powerpack
|
|
30568
|
+
|
|
30569
|
+
- Create a powerpack
|
|
30570
|
+
|
|
30571
|
+
- Delete a powerpack
|
|
30572
|
+
|
|
30573
|
+
- Get a list of all powerpacks
|
|
30574
|
+
|
|
30575
|
+
|
|
30576
|
+
The Patch and Delete API methods can only be performed on a powerpack by
|
|
30577
|
+
|
|
30578
|
+
a user who has the powerpack create permission for that specific powerpack.'
|
|
30579
|
+
name: Powerpack
|
|
27904
30580
|
- description: The processes API allows you to query processes data for your organization.
|
|
27905
30581
|
name: Processes
|
|
27906
30582
|
- description: Search or aggregate your RUM events over HTTP.
|
|
@@ -27908,8 +30584,8 @@ tags:
|
|
|
27908
30584
|
- description: 'A restriction policy defines the access control rules for a resource,
|
|
27909
30585
|
mapping a set of relations
|
|
27910
30586
|
|
|
27911
|
-
(such as editor and viewer) to a set of allowed principals (such as roles, teams
|
|
27912
|
-
|
|
30587
|
+
(such as editor and viewer) to a set of allowed principals (such as roles, teams,
|
|
30588
|
+
or users).
|
|
27913
30589
|
|
|
27914
30590
|
The restriction policy determines who is authorized to perform what actions on
|
|
27915
30591
|
the resource.'
|
|
@@ -27942,6 +30618,12 @@ tags:
|
|
|
27942
30618
|
externalDocs:
|
|
27943
30619
|
url: https://docs.datadoghq.com/tracing/service_catalog/
|
|
27944
30620
|
name: Service Definition
|
|
30621
|
+
- description: 'API to create, update scorecard rules and outcomes.
|
|
30622
|
+
|
|
30623
|
+
|
|
30624
|
+
This feature is currently in BETA. If you have any feedback, contact [Datadog
|
|
30625
|
+
support](https://docs.datadoghq.com/help/).'
|
|
30626
|
+
name: Service Scorecards
|
|
27945
30627
|
- description: Search and aggregate your spans from your Datadog platform over HTTP.
|
|
27946
30628
|
name: Spans
|
|
27947
30629
|
- description: Manage configuration of [span-based metrics](https://app.datadoghq.com/apm/traces/generate-metrics)
|