datadog_api_client 2.16.0 → 2.18.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.apigentools-info +4 -4
- data/.generator/schemas/v1/openapi.yaml +799 -16
- data/.generator/schemas/v2/openapi.yaml +2732 -409
- data/.generator/src/generator/cli.py +5 -0
- data/.generator/src/generator/formatter.py +4 -0
- data/.generator/src/generator/openapi.py +2 -0
- data/.generator/src/generator/templates/api_client.j2 +3 -0
- data/.generator/src/generator/templates/datadog_api_client.j2 +19 -0
- data/.generator/src/generator/templates/inflector.j2 +1 -1
- data/.generator/src/generator/templates/model_base.j2 +4 -0
- data/.pre-commit-config.yaml +1 -1
- data/CHANGELOG.md +54 -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 +2 -2
- 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/aws-integration/UpdateAWSAccount.rb +6 -6
- data/examples/v1/azure-integration/CreateAzureIntegration.rb +2 -0
- data/examples/v1/azure-integration/DeleteAzureIntegration.rb +2 -0
- data/examples/v1/azure-integration/UpdateAzureHostFilters.rb +2 -0
- data/examples/v1/azure-integration/UpdateAzureIntegration.rb +2 -0
- data/examples/v1/dashboards/CreateDashboard_1213075383.rb +7 -0
- data/examples/v1/dashboards/CreateDashboard_1284514532.rb +3 -0
- data/examples/v1/monitors/CreateMonitor_1539578087.rb +0 -1
- data/examples/v1/synthetics/PatchTest.rb +22 -0
- data/examples/v2/ci-visibility-pipelines/CreateCIAppPipelineEvent.rb +3 -0
- data/examples/v2/ci-visibility-pipelines/CreateCIAppPipelineEvent_129899466.rb +3 -0
- 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 +0 -3
- data/examples/v2/container-images/ListContainerImages_3088586393.rb +0 -3
- data/examples/v2/container-images/ListContainerImages_3974828736.rb +0 -3
- data/examples/v2/containers/ListContainers.rb +5 -0
- data/examples/v2/containers/ListContainers_2175733917.rb +8 -0
- data/examples/v2/containers/ListContainers_931009654.rb +8 -0
- data/examples/v2/dora-metrics/CreateDORADeployment.rb +23 -0
- data/examples/v2/dora-metrics/CreateDORAIncident.rb +25 -0
- data/examples/v2/downtimes/ListMonitorDowntimes.rb +1 -1
- data/examples/v2/events/ListEvents.rb +0 -3
- data/examples/v2/events/ListEvents_1527584014.rb +0 -3
- data/examples/v2/events/ListEvents_2663715109.rb +0 -3
- data/examples/v2/events/SearchEvents.rb +0 -3
- data/examples/v2/events/SearchEvents_3856995058.rb +0 -3
- 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/okta-integration/CreateOktaAccount.rb +19 -0
- data/examples/v2/okta-integration/DeleteOktaAccount.rb +5 -0
- data/examples/v2/okta-integration/GetOktaAccount.rb +8 -0
- data/examples/v2/okta-integration/ListOktaAccounts.rb +5 -0
- data/examples/v2/okta-integration/UpdateOktaAccount.rb +20 -0
- data/examples/v2/powerpack/CreatePowerpack.rb +1 -0
- data/examples/v2/powerpack/UpdatePowerpack.rb +1 -0
- data/examples/v2/security-monitoring/MuteFindings.rb +29 -0
- data/examples/v2/service-definition/CreateOrUpdateServiceDefinitions.rb +1 -1
- 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/GetActiveBillingDimensions.rb +8 -0
- data/examples/v2/usage-metering/GetMonthlyCostAttribution.rb +8 -0
- data/examples/v2/usage-metering/GetProjectedCost.rb +8 -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 +3 -0
- data/lib/datadog_api_client/configuration.rb +11 -4
- data/lib/datadog_api_client/inflector.rb +137 -9
- data/lib/datadog_api_client/v1/api/aws_integration_api.rb +194 -0
- data/lib/datadog_api_client/v1/api/hosts_api.rb +1 -1
- data/lib/datadog_api_client/v1/api/monitors_api.rb +5 -1
- data/lib/datadog_api_client/v1/api/synthetics_api.rb +73 -1
- data/lib/datadog_api_client/v1/api/usage_metering_api.rb +3 -3
- data/lib/datadog_api_client/v1/model_base.rb +4 -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 +24 -2
- data/lib/datadog_api_client/v1/models/hourly_usage_attribution_usage_type.rb +21 -0
- data/lib/datadog_api_client/v1/models/monitor_options.rb +1 -1
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_supported_metrics.rb +42 -0
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_values.rb +421 -1
- data/lib/datadog_api_client/v1/models/synthetics_patch_test_body.rb +82 -0
- data/lib/datadog_api_client/v1/models/synthetics_patch_test_operation.rb +100 -0
- data/lib/datadog_api_client/v1/models/synthetics_patch_test_operation_name.rb +31 -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_summary_date.rb +11 -1
- data/lib/datadog_api_client/v1/models/usage_summary_date_org.rb +31 -1
- data/lib/datadog_api_client/v1/models/usage_summary_response.rb +31 -1
- data/lib/datadog_api_client/v1/models/widget_live_span.rb +2 -0
- data/lib/datadog_api_client/v2/api/ci_visibility_pipelines_api.rb +6 -0
- data/lib/datadog_api_client/v2/api/container_images_api.rb +0 -6
- data/lib/datadog_api_client/v2/api/containers_api.rb +123 -0
- data/lib/datadog_api_client/v2/api/dora_metrics_api.rb +181 -0
- data/lib/datadog_api_client/v2/api/events_api.rb +0 -12
- 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/okta_integration_api.rb +355 -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_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 +241 -0
- data/lib/datadog_api_client/v2/model_base.rb +4 -0
- data/lib/datadog_api_client/v2/models/active_billing_dimensions_attributes.rb +92 -0
- data/lib/datadog_api_client/v2/models/active_billing_dimensions_body.rb +100 -0
- data/lib/datadog_api_client/v2/models/active_billing_dimensions_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/active_billing_dimensions_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/api_keys_response.rb +14 -4
- data/lib/datadog_api_client/v2/models/api_keys_response_meta.rb +90 -0
- data/lib/datadog_api_client/v2/models/api_keys_response_meta_page.rb +80 -0
- data/lib/datadog_api_client/v2/models/application_key_response_meta.rb +90 -0
- data/lib/datadog_api_client/v2/models/application_key_response_meta_page.rb +80 -0
- data/lib/datadog_api_client/v2/models/bulk_mute_findings_request.rb +98 -0
- 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/bulk_mute_findings_response.rb +98 -0
- data/lib/datadog_api_client/v2/models/bulk_mute_findings_response_data.rb +90 -0
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_attributes.rb +13 -1
- 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_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/cost_attribution_aggregates_body.rb +100 -0
- data/lib/datadog_api_client/v2/models/cost_attribution_type.rb +26 -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/dora_deployment_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/dora_deployment_request_attributes.rb +170 -0
- data/lib/datadog_api_client/v2/models/dora_deployment_request_data.rb +98 -0
- data/lib/datadog_api_client/v2/models/dora_deployment_response.rb +98 -0
- data/lib/datadog_api_client/v2/models/dora_deployment_response_data.rb +108 -0
- data/lib/datadog_api_client/v2/models/dora_deployment_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/dora_git_info.rb +125 -0
- data/lib/datadog_api_client/v2/models/{mute_finding_response.rb → dora_incident_request.rb} +6 -6
- data/lib/datadog_api_client/v2/models/dora_incident_request_attributes.rb +179 -0
- data/lib/datadog_api_client/v2/models/dora_incident_request_data.rb +98 -0
- data/lib/datadog_api_client/v2/models/dora_incident_response.rb +98 -0
- data/lib/datadog_api_client/v2/models/dora_incident_response_data.rb +108 -0
- data/lib/datadog_api_client/v2/models/dora_incident_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/full_api_key_attributes.rb +24 -4
- data/lib/datadog_api_client/v2/models/incident_attachment_link_attributes.rb +14 -4
- data/lib/datadog_api_client/v2/models/incident_create_relationships.rb +9 -19
- data/lib/datadog_api_client/v2/models/incident_impacts_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/incident_integration_metadata_attributes.rb +21 -1
- data/lib/datadog_api_client/v2/models/incident_integration_metadata_response_data.rb +11 -1
- data/lib/datadog_api_client/v2/models/incident_integration_relationships.rb +90 -0
- data/lib/datadog_api_client/v2/models/incident_non_datadog_creator.rb +90 -0
- data/lib/datadog_api_client/v2/models/incident_responders_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/incident_response_attributes.rb +69 -4
- data/lib/datadog_api_client/v2/models/incident_response_relationships.rb +42 -4
- data/lib/datadog_api_client/v2/models/incident_severity.rb +31 -0
- data/lib/datadog_api_client/v2/models/incident_todo_attributes.rb +24 -4
- data/lib/datadog_api_client/v2/models/incident_todo_relationships.rb +90 -0
- data/lib/datadog_api_client/v2/models/incident_todo_response_data.rb +11 -1
- data/lib/datadog_api_client/v2/models/incident_update_relationships.rb +8 -0
- data/lib/datadog_api_client/v2/models/incident_user_defined_field_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/list_application_keys_response.rb +14 -4
- 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/monthly_cost_attribution_attributes.rb +151 -0
- data/lib/datadog_api_client/v2/models/monthly_cost_attribution_body.rb +100 -0
- data/lib/datadog_api_client/v2/models/monthly_cost_attribution_meta.rb +92 -0
- data/lib/datadog_api_client/v2/models/monthly_cost_attribution_pagination.rb +88 -0
- data/lib/datadog_api_client/v2/models/monthly_cost_attribution_response.rb +92 -0
- data/lib/datadog_api_client/v2/models/okta_account.rb +129 -0
- data/lib/datadog_api_client/v2/models/okta_account_attributes.rb +170 -0
- data/lib/datadog_api_client/v2/models/{mute_finding_request.rb → okta_account_request.rb} +6 -6
- data/lib/datadog_api_client/v2/models/okta_account_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/{mute_finding_request_data.rb → okta_account_response_data.rb} +9 -9
- data/lib/datadog_api_client/v2/models/okta_account_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/okta_account_update_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/okta_account_update_request_attributes.rb +149 -0
- data/lib/datadog_api_client/v2/models/okta_account_update_request_data.rb +90 -0
- data/lib/datadog_api_client/v2/models/okta_accounts_response.rb +82 -0
- 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/partial_api_key_attributes.rb +24 -4
- data/lib/datadog_api_client/v2/models/powerpack_group_widget.rb +14 -4
- data/lib/datadog_api_client/v2/models/powerpack_relationships.rb +2 -2
- data/lib/datadog_api_client/v2/models/powerpacks_response_meta_pagination.rb +8 -0
- data/lib/datadog_api_client/v2/models/projected_cost.rb +100 -0
- data/lib/datadog_api_client/v2/models/projected_cost_attributes.rb +132 -0
- data/lib/datadog_api_client/v2/models/projected_cost_response.rb +82 -0
- data/lib/datadog_api_client/v2/models/projected_cost_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/relationship_to_incident_impact_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/relationship_to_incident_impacts.rb +100 -0
- data/lib/datadog_api_client/v2/models/relationship_to_incident_responder_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/relationship_to_incident_responders.rb +100 -0
- data/lib/datadog_api_client/v2/models/relationship_to_incident_user_defined_field_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/relationship_to_incident_user_defined_fields.rb +100 -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/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/scorecard_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_type_create.rb +1 -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/sensitive_data_scanner_standard_pattern_attributes.rb +13 -1
- data/lib/datadog_api_client/v2/models/service_definition_v2_dot2.rb +8 -8
- data/lib/datadog_api_client/v2/models/sort_direction.rb +27 -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/lib/datadog_api_client.rb +16 -1
- metadata +186 -25
- 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/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
|
|
@@ -383,6 +397,13 @@ components:
|
|
383
397
|
required: true
|
384
398
|
schema:
|
385
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
|
386
407
|
SchemaVersion:
|
387
408
|
description: The schema version desired in the response.
|
388
409
|
in: query
|
@@ -668,6 +689,26 @@ components:
|
|
668
689
|
items:
|
669
690
|
$ref: '#/components/schemas/APIKeyResponseIncludedItem'
|
670
691
|
type: array
|
692
|
+
meta:
|
693
|
+
$ref: '#/components/schemas/APIKeysResponseMeta'
|
694
|
+
type: object
|
695
|
+
APIKeysResponseMeta:
|
696
|
+
description: Additional information related to api keys response.
|
697
|
+
properties:
|
698
|
+
max_allowed:
|
699
|
+
description: Max allowed number of API keys.
|
700
|
+
format: int64
|
701
|
+
type: integer
|
702
|
+
page:
|
703
|
+
$ref: '#/components/schemas/APIKeysResponseMetaPage'
|
704
|
+
type: object
|
705
|
+
APIKeysResponseMetaPage:
|
706
|
+
description: Additional information related to the API keys response.
|
707
|
+
properties:
|
708
|
+
total_filtered_count:
|
709
|
+
description: Total filtered application key count.
|
710
|
+
format: int64
|
711
|
+
type: integer
|
671
712
|
type: object
|
672
713
|
APIKeysSort:
|
673
714
|
default: name
|
@@ -700,6 +741,47 @@ components:
|
|
700
741
|
type: string
|
701
742
|
x-enum-varnames:
|
702
743
|
- API_KEYS
|
744
|
+
ActiveBillingDimensionsAttributes:
|
745
|
+
description: List of active billing dimensions.
|
746
|
+
properties:
|
747
|
+
month:
|
748
|
+
description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`.'
|
749
|
+
format: date-time
|
750
|
+
type: string
|
751
|
+
values:
|
752
|
+
description: 'List of active billing dimensions. Example: `[infra_host,
|
753
|
+
apm_host, serverless_infra]`.'
|
754
|
+
items:
|
755
|
+
description: A given billing dimension in a list.
|
756
|
+
example: infra_host
|
757
|
+
type: string
|
758
|
+
type: array
|
759
|
+
type: object
|
760
|
+
ActiveBillingDimensionsBody:
|
761
|
+
description: Active billing dimensions data.
|
762
|
+
properties:
|
763
|
+
attributes:
|
764
|
+
$ref: '#/components/schemas/ActiveBillingDimensionsAttributes'
|
765
|
+
id:
|
766
|
+
description: Unique ID of the response.
|
767
|
+
type: string
|
768
|
+
type:
|
769
|
+
$ref: '#/components/schemas/ActiveBillingDimensionsType'
|
770
|
+
type: object
|
771
|
+
ActiveBillingDimensionsResponse:
|
772
|
+
description: Active billing dimensions response.
|
773
|
+
properties:
|
774
|
+
data:
|
775
|
+
$ref: '#/components/schemas/ActiveBillingDimensionsBody'
|
776
|
+
type: object
|
777
|
+
ActiveBillingDimensionsType:
|
778
|
+
default: billing_dimensions
|
779
|
+
description: Type of active billing dimensions data.
|
780
|
+
enum:
|
781
|
+
- billing_dimensions
|
782
|
+
type: string
|
783
|
+
x-enum-varnames:
|
784
|
+
- BILLING_DIMENSIONS
|
703
785
|
ApmRetentionFilterType:
|
704
786
|
default: apm_retention_filter
|
705
787
|
description: The type of the resource.
|
@@ -771,6 +853,24 @@ components:
|
|
771
853
|
oneOf:
|
772
854
|
- $ref: '#/components/schemas/User'
|
773
855
|
- $ref: '#/components/schemas/Role'
|
856
|
+
ApplicationKeyResponseMeta:
|
857
|
+
description: Additional information related to the application key response.
|
858
|
+
properties:
|
859
|
+
max_allowed_per_user:
|
860
|
+
description: Max allowed number of application keys per user.
|
861
|
+
format: int64
|
862
|
+
type: integer
|
863
|
+
page:
|
864
|
+
$ref: '#/components/schemas/ApplicationKeyResponseMetaPage'
|
865
|
+
type: object
|
866
|
+
ApplicationKeyResponseMetaPage:
|
867
|
+
description: Additional information related to the application key response.
|
868
|
+
properties:
|
869
|
+
total_filtered_count:
|
870
|
+
description: Total filtered application key count.
|
871
|
+
format: int64
|
872
|
+
type: integer
|
873
|
+
type: object
|
774
874
|
ApplicationKeyUpdateAttributes:
|
775
875
|
description: Attributes used to update an application Key.
|
776
876
|
properties:
|
@@ -1269,6 +1369,104 @@ components:
|
|
1269
1369
|
type: string
|
1270
1370
|
x-enum-varnames:
|
1271
1371
|
- AUTHN_MAPPINGS
|
1372
|
+
BulkMuteFindingsRequest:
|
1373
|
+
description: The new bulk mute finding request.
|
1374
|
+
properties:
|
1375
|
+
data:
|
1376
|
+
$ref: '#/components/schemas/BulkMuteFindingsRequestData'
|
1377
|
+
required:
|
1378
|
+
- data
|
1379
|
+
type: object
|
1380
|
+
BulkMuteFindingsRequestAttributes:
|
1381
|
+
additionalProperties: false
|
1382
|
+
description: The mute properties to be updated.
|
1383
|
+
properties:
|
1384
|
+
mute:
|
1385
|
+
$ref: '#/components/schemas/BulkMuteFindingsRequestProperties'
|
1386
|
+
required:
|
1387
|
+
- mute
|
1388
|
+
type: object
|
1389
|
+
BulkMuteFindingsRequestData:
|
1390
|
+
description: Data object containing the new bulk mute properties of the finding.
|
1391
|
+
properties:
|
1392
|
+
attributes:
|
1393
|
+
$ref: '#/components/schemas/BulkMuteFindingsRequestAttributes'
|
1394
|
+
id:
|
1395
|
+
description: UUID to identify the request
|
1396
|
+
example: dbe5f567-192b-4404-b908-29b70e1c9f76
|
1397
|
+
type: string
|
1398
|
+
meta:
|
1399
|
+
$ref: '#/components/schemas/BulkMuteFindingsRequestMeta'
|
1400
|
+
type:
|
1401
|
+
$ref: '#/components/schemas/FindingType'
|
1402
|
+
required:
|
1403
|
+
- id
|
1404
|
+
- type
|
1405
|
+
- attributes
|
1406
|
+
- meta
|
1407
|
+
type: object
|
1408
|
+
BulkMuteFindingsRequestMeta:
|
1409
|
+
description: Meta object containing the findings to be updated.
|
1410
|
+
properties:
|
1411
|
+
findings:
|
1412
|
+
description: Array of findings.
|
1413
|
+
items:
|
1414
|
+
$ref: '#/components/schemas/BulkMuteFindingsRequestMetaFindings'
|
1415
|
+
type: array
|
1416
|
+
type: object
|
1417
|
+
BulkMuteFindingsRequestMetaFindings:
|
1418
|
+
description: Finding object containing the finding information.
|
1419
|
+
properties:
|
1420
|
+
finding_id:
|
1421
|
+
$ref: '#/components/schemas/FindingID'
|
1422
|
+
type: object
|
1423
|
+
BulkMuteFindingsRequestProperties:
|
1424
|
+
additionalProperties: false
|
1425
|
+
description: Object containing the new mute properties of the findings.
|
1426
|
+
properties:
|
1427
|
+
description:
|
1428
|
+
description: Additional information about the reason why those findings
|
1429
|
+
are muted or unmuted. This field has a maximum limit of 280 characters.
|
1430
|
+
type: string
|
1431
|
+
expiration_date:
|
1432
|
+
description: 'The expiration date of the mute or unmute action (Unix ms).
|
1433
|
+
It must be set to a value greater than the current timestamp.
|
1434
|
+
|
1435
|
+
If this field is not provided, the finding will be muted or unmuted indefinitely,
|
1436
|
+
which is equivalent to setting the expiration date to 9999999999999.
|
1437
|
+
|
1438
|
+
'
|
1439
|
+
example: 1778721573794
|
1440
|
+
format: int64
|
1441
|
+
type: integer
|
1442
|
+
muted:
|
1443
|
+
description: Whether those findings should be muted or unmuted.
|
1444
|
+
example: true
|
1445
|
+
type: boolean
|
1446
|
+
reason:
|
1447
|
+
$ref: '#/components/schemas/FindingMuteReason'
|
1448
|
+
required:
|
1449
|
+
- muted
|
1450
|
+
- reason
|
1451
|
+
type: object
|
1452
|
+
BulkMuteFindingsResponse:
|
1453
|
+
description: The expected response schema.
|
1454
|
+
properties:
|
1455
|
+
data:
|
1456
|
+
$ref: '#/components/schemas/BulkMuteFindingsResponseData'
|
1457
|
+
required:
|
1458
|
+
- data
|
1459
|
+
type: object
|
1460
|
+
BulkMuteFindingsResponseData:
|
1461
|
+
description: Data object containing the ID of the request that was updated.
|
1462
|
+
properties:
|
1463
|
+
id:
|
1464
|
+
description: UUID used to identify the request
|
1465
|
+
example: 93bfeb70-af47-424d-908a-948d3f08e37f
|
1466
|
+
type: string
|
1467
|
+
type:
|
1468
|
+
$ref: '#/components/schemas/FindingType'
|
1469
|
+
type: object
|
1272
1470
|
CIAppAggregateBucketValue:
|
1273
1471
|
description: A bucket value, can either be a timeseries or a single value.
|
1274
1472
|
oneOf:
|
@@ -2844,6 +3042,11 @@ components:
|
|
2844
3042
|
description: The SECL expression of the Agent rule.
|
2845
3043
|
example: exec.file.name == \"sh\"
|
2846
3044
|
type: string
|
3045
|
+
filters:
|
3046
|
+
description: The platforms the Agent rule is supported on.
|
3047
|
+
items:
|
3048
|
+
type: string
|
3049
|
+
type: array
|
2847
3050
|
name:
|
2848
3051
|
description: The name of the Agent rule.
|
2849
3052
|
example: my_agent_rule
|
@@ -3441,6 +3644,117 @@ components:
|
|
3441
3644
|
$ref: '#/components/schemas/ConfluentResourceResponseData'
|
3442
3645
|
type: array
|
3443
3646
|
type: object
|
3647
|
+
Container:
|
3648
|
+
description: Container object.
|
3649
|
+
properties:
|
3650
|
+
attributes:
|
3651
|
+
$ref: '#/components/schemas/ContainerAttributes'
|
3652
|
+
id:
|
3653
|
+
description: Container ID.
|
3654
|
+
type: string
|
3655
|
+
type:
|
3656
|
+
$ref: '#/components/schemas/ContainerType'
|
3657
|
+
type: object
|
3658
|
+
ContainerAttributes:
|
3659
|
+
description: Attributes for a container.
|
3660
|
+
properties:
|
3661
|
+
container_id:
|
3662
|
+
description: The ID of the container.
|
3663
|
+
type: string
|
3664
|
+
created_at:
|
3665
|
+
description: Time the container was created.
|
3666
|
+
type: string
|
3667
|
+
host:
|
3668
|
+
description: Hostname of the host running the container.
|
3669
|
+
type: string
|
3670
|
+
image_digest:
|
3671
|
+
description: Digest of the compressed image manifest.
|
3672
|
+
nullable: true
|
3673
|
+
type: string
|
3674
|
+
image_name:
|
3675
|
+
description: Name of the associated container image.
|
3676
|
+
type: string
|
3677
|
+
image_tags:
|
3678
|
+
description: List of image tags associated with the container image.
|
3679
|
+
items:
|
3680
|
+
type: string
|
3681
|
+
nullable: true
|
3682
|
+
type: array
|
3683
|
+
name:
|
3684
|
+
description: Name of the container.
|
3685
|
+
type: string
|
3686
|
+
started_at:
|
3687
|
+
description: Time the container was started.
|
3688
|
+
type: string
|
3689
|
+
state:
|
3690
|
+
description: State of the container. This depends on the container runtime.
|
3691
|
+
type: string
|
3692
|
+
tags:
|
3693
|
+
description: List of tags associated with the container.
|
3694
|
+
items:
|
3695
|
+
type: string
|
3696
|
+
type: array
|
3697
|
+
type: object
|
3698
|
+
ContainerGroup:
|
3699
|
+
description: Container group object.
|
3700
|
+
properties:
|
3701
|
+
attributes:
|
3702
|
+
$ref: '#/components/schemas/ContainerGroupAttributes'
|
3703
|
+
id:
|
3704
|
+
description: Container Group ID.
|
3705
|
+
type: string
|
3706
|
+
relationships:
|
3707
|
+
$ref: '#/components/schemas/ContainerGroupRelationships'
|
3708
|
+
type:
|
3709
|
+
$ref: '#/components/schemas/ContainerGroupType'
|
3710
|
+
type: object
|
3711
|
+
ContainerGroupAttributes:
|
3712
|
+
description: Attributes for a container group.
|
3713
|
+
properties:
|
3714
|
+
count:
|
3715
|
+
description: Number of containers in the group.
|
3716
|
+
format: int64
|
3717
|
+
type: integer
|
3718
|
+
tags:
|
3719
|
+
description: Tags from the group name parsed in key/value format.
|
3720
|
+
type: object
|
3721
|
+
type: object
|
3722
|
+
ContainerGroupRelationships:
|
3723
|
+
description: Relationships to containers inside a container group.
|
3724
|
+
properties:
|
3725
|
+
containers:
|
3726
|
+
$ref: '#/components/schemas/ContainerGroupRelationshipsLink'
|
3727
|
+
type: object
|
3728
|
+
ContainerGroupRelationshipsData:
|
3729
|
+
description: Links data.
|
3730
|
+
items:
|
3731
|
+
description: A link data.
|
3732
|
+
type: string
|
3733
|
+
type: array
|
3734
|
+
ContainerGroupRelationshipsLink:
|
3735
|
+
description: Relationships to Containers inside a Container Group.
|
3736
|
+
properties:
|
3737
|
+
data:
|
3738
|
+
$ref: '#/components/schemas/ContainerGroupRelationshipsData'
|
3739
|
+
links:
|
3740
|
+
$ref: '#/components/schemas/ContainerGroupRelationshipsLinks'
|
3741
|
+
type: object
|
3742
|
+
ContainerGroupRelationshipsLinks:
|
3743
|
+
description: Links attributes.
|
3744
|
+
properties:
|
3745
|
+
related:
|
3746
|
+
description: Link to related containers.
|
3747
|
+
type: string
|
3748
|
+
type: object
|
3749
|
+
ContainerGroupType:
|
3750
|
+
default: container_group
|
3751
|
+
description: Type of container group.
|
3752
|
+
enum:
|
3753
|
+
- container_group
|
3754
|
+
example: container_group
|
3755
|
+
type: string
|
3756
|
+
x-enum-varnames:
|
3757
|
+
- CONTAINER_GROUP
|
3444
3758
|
ContainerImage:
|
3445
3759
|
description: Container Image object.
|
3446
3760
|
properties:
|
@@ -3751,54 +4065,201 @@ components:
|
|
3751
4065
|
description: Link to current page.
|
3752
4066
|
type: string
|
3753
4067
|
type: object
|
3754
|
-
|
3755
|
-
description:
|
3756
|
-
|
3757
|
-
-
|
3758
|
-
-
|
3759
|
-
|
3760
|
-
|
3761
|
-
x-enum-varnames:
|
3762
|
-
- IDENTITY
|
3763
|
-
- GZIP
|
3764
|
-
- DEFLATE
|
3765
|
-
CostByOrg:
|
3766
|
-
description: Cost data.
|
4068
|
+
ContainerItem:
|
4069
|
+
description: Possible Container models.
|
4070
|
+
oneOf:
|
4071
|
+
- $ref: '#/components/schemas/Container'
|
4072
|
+
- $ref: '#/components/schemas/ContainerGroup'
|
4073
|
+
ContainerMeta:
|
4074
|
+
description: Response metadata object.
|
3767
4075
|
properties:
|
3768
|
-
|
3769
|
-
$ref: '#/components/schemas/
|
3770
|
-
id:
|
3771
|
-
description: Unique ID of the response.
|
3772
|
-
type: string
|
3773
|
-
type:
|
3774
|
-
$ref: '#/components/schemas/CostByOrgType'
|
4076
|
+
pagination:
|
4077
|
+
$ref: '#/components/schemas/ContainerMetaPage'
|
3775
4078
|
type: object
|
3776
|
-
|
3777
|
-
description:
|
4079
|
+
ContainerMetaPage:
|
4080
|
+
description: Paging attributes.
|
3778
4081
|
properties:
|
3779
|
-
|
3780
|
-
description:
|
3781
|
-
items:
|
3782
|
-
$ref: '#/components/schemas/ChargebackBreakdown'
|
3783
|
-
type: array
|
3784
|
-
date:
|
3785
|
-
description: The month requested.
|
3786
|
-
format: date-time
|
3787
|
-
type: string
|
3788
|
-
org_name:
|
3789
|
-
description: The organization name.
|
4082
|
+
cursor:
|
4083
|
+
description: The cursor used to get the current results, if any.
|
3790
4084
|
type: string
|
3791
|
-
|
3792
|
-
description:
|
4085
|
+
limit:
|
4086
|
+
description: Number of results returned
|
4087
|
+
format: int32
|
4088
|
+
maximum: 10000
|
4089
|
+
minimum: 0
|
4090
|
+
type: integer
|
4091
|
+
next_cursor:
|
4092
|
+
description: The cursor used to get the next results, if any.
|
3793
4093
|
type: string
|
3794
|
-
|
3795
|
-
description: The
|
3796
|
-
|
4094
|
+
prev_cursor:
|
4095
|
+
description: The cursor used to get the previous results, if any.
|
4096
|
+
nullable: true
|
3797
4097
|
type: string
|
3798
|
-
|
3799
|
-
description:
|
3800
|
-
format:
|
3801
|
-
type:
|
4098
|
+
total:
|
4099
|
+
description: Total number of records that match the query.
|
4100
|
+
format: int64
|
4101
|
+
type: integer
|
4102
|
+
type:
|
4103
|
+
$ref: '#/components/schemas/ContainerMetaPageType'
|
4104
|
+
type: object
|
4105
|
+
ContainerMetaPageType:
|
4106
|
+
default: cursor_limit
|
4107
|
+
description: Type of Container pagination.
|
4108
|
+
enum:
|
4109
|
+
- cursor_limit
|
4110
|
+
example: cursor_limit
|
4111
|
+
type: string
|
4112
|
+
x-enum-varnames:
|
4113
|
+
- CURSOR_LIMIT
|
4114
|
+
ContainerType:
|
4115
|
+
default: container
|
4116
|
+
description: Type of container.
|
4117
|
+
enum:
|
4118
|
+
- container
|
4119
|
+
example: container
|
4120
|
+
type: string
|
4121
|
+
x-enum-varnames:
|
4122
|
+
- CONTAINER
|
4123
|
+
ContainersResponse:
|
4124
|
+
description: List of containers.
|
4125
|
+
properties:
|
4126
|
+
data:
|
4127
|
+
description: Array of Container objects.
|
4128
|
+
items:
|
4129
|
+
$ref: '#/components/schemas/ContainerItem'
|
4130
|
+
type: array
|
4131
|
+
links:
|
4132
|
+
$ref: '#/components/schemas/ContainersResponseLinks'
|
4133
|
+
meta:
|
4134
|
+
$ref: '#/components/schemas/ContainerMeta'
|
4135
|
+
type: object
|
4136
|
+
ContainersResponseLinks:
|
4137
|
+
description: Pagination links.
|
4138
|
+
properties:
|
4139
|
+
first:
|
4140
|
+
description: Link to the first page.
|
4141
|
+
type: string
|
4142
|
+
last:
|
4143
|
+
description: Link to the last page.
|
4144
|
+
nullable: true
|
4145
|
+
type: string
|
4146
|
+
next:
|
4147
|
+
description: Link to the next page.
|
4148
|
+
nullable: true
|
4149
|
+
type: string
|
4150
|
+
prev:
|
4151
|
+
description: Link to previous page.
|
4152
|
+
nullable: true
|
4153
|
+
type: string
|
4154
|
+
self:
|
4155
|
+
description: Link to current page.
|
4156
|
+
type: string
|
4157
|
+
type: object
|
4158
|
+
ContentEncoding:
|
4159
|
+
description: HTTP header used to compress the media-type.
|
4160
|
+
enum:
|
4161
|
+
- identity
|
4162
|
+
- gzip
|
4163
|
+
- deflate
|
4164
|
+
type: string
|
4165
|
+
x-enum-varnames:
|
4166
|
+
- IDENTITY
|
4167
|
+
- GZIP
|
4168
|
+
- DEFLATE
|
4169
|
+
CostAttributionAggregates:
|
4170
|
+
description: An array of available aggregates.
|
4171
|
+
items:
|
4172
|
+
$ref: '#/components/schemas/CostAttributionAggregatesBody'
|
4173
|
+
type: array
|
4174
|
+
CostAttributionAggregatesBody:
|
4175
|
+
description: The object containing the aggregates.
|
4176
|
+
properties:
|
4177
|
+
agg_type:
|
4178
|
+
description: The aggregate type.
|
4179
|
+
example: sum
|
4180
|
+
type: string
|
4181
|
+
field:
|
4182
|
+
description: The field.
|
4183
|
+
example: infra_host_committed_cost
|
4184
|
+
type: string
|
4185
|
+
value:
|
4186
|
+
description: The value for a given field.
|
4187
|
+
format: double
|
4188
|
+
type: number
|
4189
|
+
type: object
|
4190
|
+
CostAttributionTagNames:
|
4191
|
+
additionalProperties:
|
4192
|
+
description: 'A list of values that are associated with each tag key.
|
4193
|
+
|
4194
|
+
- An empty list means the resource use wasn''t tagged with the respective
|
4195
|
+
tag.
|
4196
|
+
|
4197
|
+
- Multiple values means the respective tag was applied multiple times on
|
4198
|
+
the resource.
|
4199
|
+
|
4200
|
+
- An `<empty>` value means the resource was tagged with the respective tag
|
4201
|
+
but did not have a value.'
|
4202
|
+
items:
|
4203
|
+
description: A given tag in a list.
|
4204
|
+
example: datadog-integrations-lab
|
4205
|
+
type: string
|
4206
|
+
type: array
|
4207
|
+
description: 'Tag keys and values.
|
4208
|
+
|
4209
|
+
A `null` value here means that the requested tag breakdown cannot be applied
|
4210
|
+
because it does not match the [tags
|
4211
|
+
|
4212
|
+
configured for usage attribution](https://docs.datadoghq.com/account_management/billing/usage_attribution/#getting-started).
|
4213
|
+
|
4214
|
+
In this scenario the API returns the total cost, not broken down by tags.'
|
4215
|
+
nullable: true
|
4216
|
+
type: object
|
4217
|
+
CostAttributionType:
|
4218
|
+
default: cost_by_tag
|
4219
|
+
description: Type of cost attribution data.
|
4220
|
+
enum:
|
4221
|
+
- cost_by_tag
|
4222
|
+
example: cost_by_tag
|
4223
|
+
type: string
|
4224
|
+
x-enum-varnames:
|
4225
|
+
- COST_BY_TAG
|
4226
|
+
CostByOrg:
|
4227
|
+
description: Cost data.
|
4228
|
+
properties:
|
4229
|
+
attributes:
|
4230
|
+
$ref: '#/components/schemas/CostByOrgAttributes'
|
4231
|
+
id:
|
4232
|
+
description: Unique ID of the response.
|
4233
|
+
type: string
|
4234
|
+
type:
|
4235
|
+
$ref: '#/components/schemas/CostByOrgType'
|
4236
|
+
type: object
|
4237
|
+
CostByOrgAttributes:
|
4238
|
+
description: Cost attributes data.
|
4239
|
+
properties:
|
4240
|
+
charges:
|
4241
|
+
description: List of charges data reported for the requested month.
|
4242
|
+
items:
|
4243
|
+
$ref: '#/components/schemas/ChargebackBreakdown'
|
4244
|
+
type: array
|
4245
|
+
date:
|
4246
|
+
description: The month requested.
|
4247
|
+
format: date-time
|
4248
|
+
type: string
|
4249
|
+
org_name:
|
4250
|
+
description: The organization name.
|
4251
|
+
type: string
|
4252
|
+
public_id:
|
4253
|
+
description: The organization public ID.
|
4254
|
+
type: string
|
4255
|
+
region:
|
4256
|
+
description: The region of the Datadog instance that the organization belongs
|
4257
|
+
to.
|
4258
|
+
type: string
|
4259
|
+
total_cost:
|
4260
|
+
description: The total cost of products for the month.
|
4261
|
+
format: double
|
4262
|
+
type: number
|
3802
4263
|
type: object
|
3803
4264
|
CostByOrgResponse:
|
3804
4265
|
description: Chargeback Summary response.
|
@@ -3818,6 +4279,38 @@ components:
|
|
3818
4279
|
type: string
|
3819
4280
|
x-enum-varnames:
|
3820
4281
|
- COST_BY_ORG
|
4282
|
+
CreateRuleRequest:
|
4283
|
+
description: Scorecard create rule request.
|
4284
|
+
properties:
|
4285
|
+
data:
|
4286
|
+
$ref: '#/components/schemas/CreateRuleRequestData'
|
4287
|
+
type: object
|
4288
|
+
CreateRuleRequestData:
|
4289
|
+
description: Scorecard create rule request data.
|
4290
|
+
properties:
|
4291
|
+
attributes:
|
4292
|
+
$ref: '#/components/schemas/RuleAttributes'
|
4293
|
+
type:
|
4294
|
+
$ref: '#/components/schemas/RuleType'
|
4295
|
+
type: object
|
4296
|
+
CreateRuleResponse:
|
4297
|
+
description: Created rule in response.
|
4298
|
+
properties:
|
4299
|
+
data:
|
4300
|
+
$ref: '#/components/schemas/CreateRuleResponseData'
|
4301
|
+
type: object
|
4302
|
+
CreateRuleResponseData:
|
4303
|
+
description: Create rule response data.
|
4304
|
+
properties:
|
4305
|
+
attributes:
|
4306
|
+
$ref: '#/components/schemas/RuleAttributes'
|
4307
|
+
id:
|
4308
|
+
$ref: '#/components/schemas/RuleId'
|
4309
|
+
relationships:
|
4310
|
+
$ref: '#/components/schemas/RelationshipToRule'
|
4311
|
+
type:
|
4312
|
+
$ref: '#/components/schemas/RuleType'
|
4313
|
+
type: object
|
3821
4314
|
Creator:
|
3822
4315
|
description: Creator of the object.
|
3823
4316
|
properties:
|
@@ -3832,6 +4325,178 @@ components:
|
|
3832
4325
|
nullable: true
|
3833
4326
|
type: string
|
3834
4327
|
type: object
|
4328
|
+
DORADeploymentRequest:
|
4329
|
+
description: Request to create a DORA deployment event.
|
4330
|
+
properties:
|
4331
|
+
data:
|
4332
|
+
$ref: '#/components/schemas/DORADeploymentRequestData'
|
4333
|
+
required:
|
4334
|
+
- data
|
4335
|
+
type: object
|
4336
|
+
DORADeploymentRequestAttributes:
|
4337
|
+
description: Attributes to create a DORA deployment event.
|
4338
|
+
properties:
|
4339
|
+
finished_at:
|
4340
|
+
description: Unix timestamp in nanoseconds when the deployment finished.
|
4341
|
+
It should not be older than 3 hours.
|
4342
|
+
example: 1693491984000000000
|
4343
|
+
format: int64
|
4344
|
+
type: integer
|
4345
|
+
git:
|
4346
|
+
$ref: '#/components/schemas/DORAGitInfo'
|
4347
|
+
id:
|
4348
|
+
description: Deployment ID.
|
4349
|
+
type: string
|
4350
|
+
service:
|
4351
|
+
description: Service name from a service available in the Service Catalog.
|
4352
|
+
example: shopist
|
4353
|
+
type: string
|
4354
|
+
started_at:
|
4355
|
+
description: Unix timestamp in nanoseconds when the deployment started.
|
4356
|
+
example: 1693491974000000000
|
4357
|
+
format: int64
|
4358
|
+
type: integer
|
4359
|
+
version:
|
4360
|
+
description: Version to correlate with [APM Deployment Tracking](https://docs.datadoghq.com/tracing/services/deployment_tracking/).
|
4361
|
+
example: v1.12.07
|
4362
|
+
type: string
|
4363
|
+
required:
|
4364
|
+
- service
|
4365
|
+
- started_at
|
4366
|
+
- finished_at
|
4367
|
+
type: object
|
4368
|
+
DORADeploymentRequestData:
|
4369
|
+
description: The JSON:API data.
|
4370
|
+
properties:
|
4371
|
+
attributes:
|
4372
|
+
$ref: '#/components/schemas/DORADeploymentRequestAttributes'
|
4373
|
+
required:
|
4374
|
+
- attributes
|
4375
|
+
type: object
|
4376
|
+
DORADeploymentResponse:
|
4377
|
+
description: Response after receiving a DORA deployment event.
|
4378
|
+
properties:
|
4379
|
+
data:
|
4380
|
+
$ref: '#/components/schemas/DORADeploymentResponseData'
|
4381
|
+
required:
|
4382
|
+
- data
|
4383
|
+
type: object
|
4384
|
+
DORADeploymentResponseData:
|
4385
|
+
description: The JSON:API data.
|
4386
|
+
properties:
|
4387
|
+
id:
|
4388
|
+
description: The ID of the received DORA deployment event.
|
4389
|
+
example: 4242fcdd31586083
|
4390
|
+
type: string
|
4391
|
+
type:
|
4392
|
+
$ref: '#/components/schemas/DORADeploymentType'
|
4393
|
+
required:
|
4394
|
+
- id
|
4395
|
+
type: object
|
4396
|
+
DORADeploymentType:
|
4397
|
+
default: dora_deployment
|
4398
|
+
description: JSON:API type for DORA deployment events.
|
4399
|
+
enum:
|
4400
|
+
- dora_deployment
|
4401
|
+
example: dora_deployment
|
4402
|
+
type: string
|
4403
|
+
x-enum-varnames:
|
4404
|
+
- DORA_DEPLOYMENT
|
4405
|
+
DORAGitInfo:
|
4406
|
+
description: Git info for DORA Metrics events.
|
4407
|
+
properties:
|
4408
|
+
commit_sha:
|
4409
|
+
$ref: '#/components/schemas/GitCommitSHA'
|
4410
|
+
repository_url:
|
4411
|
+
$ref: '#/components/schemas/GitRepositoryURL'
|
4412
|
+
required:
|
4413
|
+
- repository_url
|
4414
|
+
- commit_sha
|
4415
|
+
type: object
|
4416
|
+
DORAIncidentRequest:
|
4417
|
+
description: Request to create a DORA incident event.
|
4418
|
+
properties:
|
4419
|
+
data:
|
4420
|
+
$ref: '#/components/schemas/DORAIncidentRequestData'
|
4421
|
+
required:
|
4422
|
+
- data
|
4423
|
+
type: object
|
4424
|
+
DORAIncidentRequestAttributes:
|
4425
|
+
description: Attributes to create a DORA incident event.
|
4426
|
+
properties:
|
4427
|
+
finished_at:
|
4428
|
+
description: Unix timestamp in nanoseconds when the incident finished. It
|
4429
|
+
should not be older than 3 hours.
|
4430
|
+
example: 1693491984000000000
|
4431
|
+
format: int64
|
4432
|
+
type: integer
|
4433
|
+
git:
|
4434
|
+
$ref: '#/components/schemas/DORAGitInfo'
|
4435
|
+
id:
|
4436
|
+
description: Incident ID
|
4437
|
+
type: string
|
4438
|
+
name:
|
4439
|
+
description: Incident name.
|
4440
|
+
example: Webserver is down failing all requests
|
4441
|
+
type: string
|
4442
|
+
service:
|
4443
|
+
description: Service name from a service available in the Service Catalog.
|
4444
|
+
example: shopist
|
4445
|
+
type: string
|
4446
|
+
severity:
|
4447
|
+
description: Incident severity.
|
4448
|
+
example: High
|
4449
|
+
type: string
|
4450
|
+
started_at:
|
4451
|
+
description: Unix timestamp in nanoseconds when the incident started.
|
4452
|
+
example: 1693491974000000000
|
4453
|
+
format: int64
|
4454
|
+
type: integer
|
4455
|
+
version:
|
4456
|
+
description: Version to correlate with [APM Deployment Tracking](https://docs.datadoghq.com/tracing/services/deployment_tracking/).
|
4457
|
+
example: v1.12.07
|
4458
|
+
type: string
|
4459
|
+
required:
|
4460
|
+
- service
|
4461
|
+
- started_at
|
4462
|
+
type: object
|
4463
|
+
DORAIncidentRequestData:
|
4464
|
+
description: The JSON:API data.
|
4465
|
+
properties:
|
4466
|
+
attributes:
|
4467
|
+
$ref: '#/components/schemas/DORAIncidentRequestAttributes'
|
4468
|
+
required:
|
4469
|
+
- attributes
|
4470
|
+
type: object
|
4471
|
+
DORAIncidentResponse:
|
4472
|
+
description: Response after receiving a DORA incident event.
|
4473
|
+
properties:
|
4474
|
+
data:
|
4475
|
+
$ref: '#/components/schemas/DORAIncidentResponseData'
|
4476
|
+
required:
|
4477
|
+
- data
|
4478
|
+
type: object
|
4479
|
+
DORAIncidentResponseData:
|
4480
|
+
description: Response after receiving a DORA incident event.
|
4481
|
+
properties:
|
4482
|
+
id:
|
4483
|
+
description: The ID of the received DORA incident event.
|
4484
|
+
example: 4242fcdd31586083
|
4485
|
+
type: string
|
4486
|
+
type:
|
4487
|
+
$ref: '#/components/schemas/DORAIncidentType'
|
4488
|
+
required:
|
4489
|
+
- id
|
4490
|
+
type: object
|
4491
|
+
DORAIncidentType:
|
4492
|
+
default: dora_incident
|
4493
|
+
description: JSON:API type for DORA incident events.
|
4494
|
+
enum:
|
4495
|
+
- dora_incident
|
4496
|
+
example: dora_incident
|
4497
|
+
type: string
|
4498
|
+
x-enum-varnames:
|
4499
|
+
- DORA_INCIDENT
|
3835
4500
|
DashboardListAddItemsRequest:
|
3836
4501
|
description: Request containing a list of dashboards to add.
|
3837
4502
|
properties:
|
@@ -5431,7 +6096,7 @@ components:
|
|
5431
6096
|
type: integer
|
5432
6097
|
FindingID:
|
5433
6098
|
description: The unique ID for this finding.
|
5434
|
-
example:
|
6099
|
+
example: ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==
|
5435
6100
|
type: string
|
5436
6101
|
FindingMute:
|
5437
6102
|
additionalProperties: false
|
@@ -5575,6 +6240,9 @@ components:
|
|
5575
6240
|
FullAPIKeyAttributes:
|
5576
6241
|
description: Attributes of a full API key.
|
5577
6242
|
properties:
|
6243
|
+
category:
|
6244
|
+
description: The category of the API key.
|
6245
|
+
type: string
|
5578
6246
|
created_at:
|
5579
6247
|
description: Creation date of the API key.
|
5580
6248
|
example: '2020-11-23T10:00:00.000Z'
|
@@ -5600,6 +6268,9 @@ components:
|
|
5600
6268
|
description: Name of the API key.
|
5601
6269
|
example: API Key for submitting metrics
|
5602
6270
|
type: string
|
6271
|
+
remote_config_read_enabled:
|
6272
|
+
description: The remote config read enabled status.
|
6273
|
+
type: boolean
|
5603
6274
|
type: object
|
5604
6275
|
FullApplicationKey:
|
5605
6276
|
description: Datadog application key.
|
@@ -5821,6 +6492,15 @@ components:
|
|
5821
6492
|
- _HANDLE
|
5822
6493
|
- EMAIL
|
5823
6494
|
- _EMAIL
|
6495
|
+
GitCommitSHA:
|
6496
|
+
description: Git Commit SHA.
|
6497
|
+
example: 66adc9350f2cc9b250b69abddab733dd55e1a588
|
6498
|
+
pattern: ^[a-fA-F0-9]{40,}$
|
6499
|
+
type: string
|
6500
|
+
GitRepositoryURL:
|
6501
|
+
description: Git Repository URL
|
6502
|
+
example: https://github.com/organization/example-repository
|
6503
|
+
type: string
|
5824
6504
|
GroupScalarColumn:
|
5825
6505
|
description: A column containing the tag keys and values in a group.
|
5826
6506
|
properties:
|
@@ -6214,6 +6894,11 @@ components:
|
|
6214
6894
|
$ref: '#/components/schemas/IncidentAttachmentLinkAttributesAttachmentObject'
|
6215
6895
|
attachment_type:
|
6216
6896
|
$ref: '#/components/schemas/IncidentAttachmentLinkAttachmentType'
|
6897
|
+
modified:
|
6898
|
+
description: Timestamp when the incident attachment link was last modified.
|
6899
|
+
format: date-time
|
6900
|
+
readOnly: true
|
6901
|
+
type: string
|
6217
6902
|
required:
|
6218
6903
|
- attachment_type
|
6219
6904
|
- attachment
|
@@ -6519,9 +7204,22 @@ components:
|
|
6519
7204
|
- TEXTARRAY
|
6520
7205
|
- METRICTAG
|
6521
7206
|
- AUTOCOMPLETE
|
7207
|
+
IncidentImpactsType:
|
7208
|
+
description: The incident impacts type.
|
7209
|
+
enum:
|
7210
|
+
- incident_impacts
|
7211
|
+
example: incident_impacts
|
7212
|
+
type: string
|
7213
|
+
x-enum-varnames:
|
7214
|
+
- INCIDENT_IMPACTS
|
6522
7215
|
IncidentIntegrationMetadataAttributes:
|
6523
7216
|
description: Incident integration metadata's attributes for a create request.
|
6524
7217
|
properties:
|
7218
|
+
created:
|
7219
|
+
description: Timestamp when the incident todo was created.
|
7220
|
+
format: date-time
|
7221
|
+
readOnly: true
|
7222
|
+
type: string
|
6525
7223
|
incident_id:
|
6526
7224
|
description: UUID of the incident this integration metadata is connected
|
6527
7225
|
to.
|
@@ -6538,6 +7236,11 @@ components:
|
|
6538
7236
|
type: integer
|
6539
7237
|
metadata:
|
6540
7238
|
$ref: '#/components/schemas/IncidentIntegrationMetadataMetadata'
|
7239
|
+
modified:
|
7240
|
+
description: Timestamp when the incident todo was last modified.
|
7241
|
+
format: date-time
|
7242
|
+
readOnly: true
|
7243
|
+
type: string
|
6541
7244
|
status:
|
6542
7245
|
description: 'A number indicating the status of this integration metadata.
|
6543
7246
|
0 indicates unknown;
|
@@ -6637,6 +7340,8 @@ components:
|
|
6637
7340
|
description: The incident integration metadata's ID.
|
6638
7341
|
example: 00000000-0000-0000-1234-000000000000
|
6639
7342
|
type: string
|
7343
|
+
relationships:
|
7344
|
+
$ref: '#/components/schemas/IncidentIntegrationRelationships'
|
6640
7345
|
type:
|
6641
7346
|
$ref: '#/components/schemas/IncidentIntegrationMetadataType'
|
6642
7347
|
required:
|
@@ -6657,6 +7362,25 @@ components:
|
|
6657
7362
|
type: string
|
6658
7363
|
x-enum-varnames:
|
6659
7364
|
- INCIDENT_INTEGRATIONS
|
7365
|
+
IncidentIntegrationRelationships:
|
7366
|
+
description: The incident's integration relationships from a response.
|
7367
|
+
properties:
|
7368
|
+
created_by_user:
|
7369
|
+
$ref: '#/components/schemas/RelationshipToUser'
|
7370
|
+
last_modified_by_user:
|
7371
|
+
$ref: '#/components/schemas/RelationshipToUser'
|
7372
|
+
type: object
|
7373
|
+
IncidentNonDatadogCreator:
|
7374
|
+
description: Incident's non Datadog creator.
|
7375
|
+
nullable: true
|
7376
|
+
properties:
|
7377
|
+
image_48_px:
|
7378
|
+
description: Non Datadog creator `48px` image.
|
7379
|
+
type: string
|
7380
|
+
name:
|
7381
|
+
description: Non Datadog creator name.
|
7382
|
+
type: string
|
7383
|
+
type: object
|
6660
7384
|
IncidentNotificationHandle:
|
6661
7385
|
description: A notification handle that will be notified at incident creation.
|
6662
7386
|
properties:
|
@@ -6687,6 +7411,14 @@ components:
|
|
6687
7411
|
x-enum-varnames:
|
6688
7412
|
- USERS
|
6689
7413
|
- ATTACHMENTS
|
7414
|
+
IncidentRespondersType:
|
7415
|
+
description: The incident responders type.
|
7416
|
+
enum:
|
7417
|
+
- incident_responders
|
7418
|
+
example: incident_responders
|
7419
|
+
type: string
|
7420
|
+
x-enum-varnames:
|
7421
|
+
- INCIDENT_RESPONDERS
|
6690
7422
|
IncidentResponse:
|
6691
7423
|
description: Response with an incident.
|
6692
7424
|
properties:
|
@@ -6704,12 +7436,23 @@ components:
|
|
6704
7436
|
IncidentResponseAttributes:
|
6705
7437
|
description: The incident's attributes from a response.
|
6706
7438
|
properties:
|
6707
|
-
|
6708
|
-
description: Timestamp when the incident was
|
7439
|
+
archived:
|
7440
|
+
description: Timestamp of when the incident was archived.
|
6709
7441
|
format: date-time
|
7442
|
+
nullable: true
|
6710
7443
|
readOnly: true
|
6711
7444
|
type: string
|
6712
|
-
|
7445
|
+
case_id:
|
7446
|
+
description: The incident case id.
|
7447
|
+
format: int64
|
7448
|
+
nullable: true
|
7449
|
+
type: integer
|
7450
|
+
created:
|
7451
|
+
description: Timestamp when the incident was created.
|
7452
|
+
format: date-time
|
7453
|
+
readOnly: true
|
7454
|
+
type: string
|
7455
|
+
customer_impact_duration:
|
6713
7456
|
description: 'Length of the incident''s customer impact in seconds.
|
6714
7457
|
|
6715
7458
|
Equals the difference between `customer_impact_start` and `customer_impact_end`.'
|
@@ -6754,6 +7497,8 @@ components:
|
|
6754
7497
|
format: date-time
|
6755
7498
|
readOnly: true
|
6756
7499
|
type: string
|
7500
|
+
non_datadog_creator:
|
7501
|
+
$ref: '#/components/schemas/IncidentNonDatadogCreator'
|
6757
7502
|
notification_handles:
|
6758
7503
|
description: Notification handles that will be notified of the incident
|
6759
7504
|
during update.
|
@@ -6772,6 +7517,12 @@ components:
|
|
6772
7517
|
format: date-time
|
6773
7518
|
nullable: true
|
6774
7519
|
type: string
|
7520
|
+
severity:
|
7521
|
+
$ref: '#/components/schemas/IncidentSeverity'
|
7522
|
+
state:
|
7523
|
+
description: The state incident.
|
7524
|
+
nullable: true
|
7525
|
+
type: string
|
6775
7526
|
time_to_detect:
|
6776
7527
|
description: 'The amount of time in seconds to detect the incident.
|
6777
7528
|
|
@@ -6802,6 +7553,10 @@ components:
|
|
6802
7553
|
description: The title of the incident, which summarizes what happened.
|
6803
7554
|
example: A test incident title
|
6804
7555
|
type: string
|
7556
|
+
visibility:
|
7557
|
+
description: The incident visibility status.
|
7558
|
+
nullable: true
|
7559
|
+
type: string
|
6805
7560
|
required:
|
6806
7561
|
- title
|
6807
7562
|
type: object
|
@@ -6863,10 +7618,16 @@ components:
|
|
6863
7618
|
$ref: '#/components/schemas/NullableRelationshipToUser'
|
6864
7619
|
created_by_user:
|
6865
7620
|
$ref: '#/components/schemas/RelationshipToUser'
|
7621
|
+
impacts:
|
7622
|
+
$ref: '#/components/schemas/RelationshipToIncidentImpacts'
|
6866
7623
|
integrations:
|
6867
7624
|
$ref: '#/components/schemas/RelationshipToIncidentIntegrationMetadatas'
|
6868
7625
|
last_modified_by_user:
|
6869
7626
|
$ref: '#/components/schemas/RelationshipToUser'
|
7627
|
+
responders:
|
7628
|
+
$ref: '#/components/schemas/RelationshipToIncidentResponders'
|
7629
|
+
user_defined_fields:
|
7630
|
+
$ref: '#/components/schemas/RelationshipToIncidentUserDefinedFields'
|
6870
7631
|
type: object
|
6871
7632
|
IncidentSearchResponse:
|
6872
7633
|
description: Response with incidents and facets.
|
@@ -7249,6 +8010,24 @@ components:
|
|
7249
8010
|
required:
|
7250
8011
|
- data
|
7251
8012
|
type: object
|
8013
|
+
IncidentSeverity:
|
8014
|
+
description: The incident severity.
|
8015
|
+
enum:
|
8016
|
+
- UNKNOWN
|
8017
|
+
- SEV-1
|
8018
|
+
- SEV-2
|
8019
|
+
- SEV-3
|
8020
|
+
- SEV-4
|
8021
|
+
- SEV-5
|
8022
|
+
example: UNKNOWN
|
8023
|
+
type: string
|
8024
|
+
x-enum-varnames:
|
8025
|
+
- UNKNOWN
|
8026
|
+
- SEV_1
|
8027
|
+
- SEV_2
|
8028
|
+
- SEV_3
|
8029
|
+
- SEV_4
|
8030
|
+
- SEV_5
|
7252
8031
|
IncidentTeamCreateAttributes:
|
7253
8032
|
description: The incident team's attributes for a create request.
|
7254
8033
|
properties:
|
@@ -7508,6 +8287,11 @@ components:
|
|
7508
8287
|
description: The follow-up task's content.
|
7509
8288
|
example: Restore lost data.
|
7510
8289
|
type: string
|
8290
|
+
created:
|
8291
|
+
description: Timestamp when the incident todo was created.
|
8292
|
+
format: date-time
|
8293
|
+
readOnly: true
|
8294
|
+
type: string
|
7511
8295
|
due_date:
|
7512
8296
|
description: Timestamp when the todo should be completed by.
|
7513
8297
|
example: '2023-07-10T05:00:00.000000+00:00'
|
@@ -7517,6 +8301,11 @@ components:
|
|
7517
8301
|
description: UUID of the incident this todo is connected to.
|
7518
8302
|
example: 00000000-aaaa-0000-0000-000000000000
|
7519
8303
|
type: string
|
8304
|
+
modified:
|
8305
|
+
description: Timestamp when the incident todo was last modified.
|
8306
|
+
format: date-time
|
8307
|
+
readOnly: true
|
8308
|
+
type: string
|
7520
8309
|
required:
|
7521
8310
|
- content
|
7522
8311
|
- assignees
|
@@ -7578,6 +8367,14 @@ components:
|
|
7578
8367
|
required:
|
7579
8368
|
- data
|
7580
8369
|
type: object
|
8370
|
+
IncidentTodoRelationships:
|
8371
|
+
description: The incident's relationships from a response.
|
8372
|
+
properties:
|
8373
|
+
created_by_user:
|
8374
|
+
$ref: '#/components/schemas/RelationshipToUser'
|
8375
|
+
last_modified_by_user:
|
8376
|
+
$ref: '#/components/schemas/RelationshipToUser'
|
8377
|
+
type: object
|
7581
8378
|
IncidentTodoResponse:
|
7582
8379
|
description: Response with an incident todo.
|
7583
8380
|
properties:
|
@@ -7601,6 +8398,8 @@ components:
|
|
7601
8398
|
description: The incident todo's ID.
|
7602
8399
|
example: 00000000-0000-0000-1234-000000000000
|
7603
8400
|
type: string
|
8401
|
+
relationships:
|
8402
|
+
$ref: '#/components/schemas/IncidentTodoRelationships'
|
7604
8403
|
type:
|
7605
8404
|
$ref: '#/components/schemas/IncidentTodoType'
|
7606
8405
|
required:
|
@@ -7711,6 +8510,14 @@ components:
|
|
7711
8510
|
required:
|
7712
8511
|
- data
|
7713
8512
|
type: object
|
8513
|
+
IncidentUserDefinedFieldType:
|
8514
|
+
description: The incident user defined fields type.
|
8515
|
+
enum:
|
8516
|
+
- user_defined_field
|
8517
|
+
example: user_defined_field
|
8518
|
+
type: string
|
8519
|
+
x-enum-varnames:
|
8520
|
+
- USER_DEFINED_FIELD
|
7714
8521
|
IncidentsResponse:
|
7715
8522
|
description: Response with a list of incidents.
|
7716
8523
|
properties:
|
@@ -7909,6 +8716,8 @@ components:
|
|
7909
8716
|
items:
|
7910
8717
|
$ref: '#/components/schemas/ApplicationKeyResponseIncludedItem'
|
7911
8718
|
type: array
|
8719
|
+
meta:
|
8720
|
+
$ref: '#/components/schemas/ApplicationKeyResponseMeta'
|
7912
8721
|
type: object
|
7913
8722
|
ListDowntimesResponse:
|
7914
8723
|
description: Response for retrieving all downtimes.
|
@@ -7987,6 +8796,39 @@ components:
|
|
7987
8796
|
meta:
|
7988
8797
|
$ref: '#/components/schemas/PowerpacksResponseMeta'
|
7989
8798
|
type: object
|
8799
|
+
ListRulesResponse:
|
8800
|
+
description: Scorecard rules response.
|
8801
|
+
properties:
|
8802
|
+
data:
|
8803
|
+
$ref: '#/components/schemas/ListRulesResponseData'
|
8804
|
+
links:
|
8805
|
+
$ref: '#/components/schemas/ListRulesResponseLinks'
|
8806
|
+
type: object
|
8807
|
+
ListRulesResponseData:
|
8808
|
+
description: Array of rule details.
|
8809
|
+
items:
|
8810
|
+
$ref: '#/components/schemas/ListRulesResponseDataItem'
|
8811
|
+
type: array
|
8812
|
+
ListRulesResponseDataItem:
|
8813
|
+
description: Rule details.
|
8814
|
+
properties:
|
8815
|
+
attributes:
|
8816
|
+
$ref: '#/components/schemas/RuleAttributes'
|
8817
|
+
id:
|
8818
|
+
$ref: '#/components/schemas/RuleId'
|
8819
|
+
relationships:
|
8820
|
+
$ref: '#/components/schemas/RelationshipToRule'
|
8821
|
+
type:
|
8822
|
+
$ref: '#/components/schemas/RuleType'
|
8823
|
+
type: object
|
8824
|
+
ListRulesResponseLinks:
|
8825
|
+
description: Links attributes.
|
8826
|
+
properties:
|
8827
|
+
next:
|
8828
|
+
description: Link for the next set of rules.
|
8829
|
+
example: /api/v2/scorecard/rules?page%5Blimit%5D=2&page%5Boffset%5D=2&page%5Bsize%5D=2
|
8830
|
+
type: string
|
8831
|
+
type: object
|
7990
8832
|
ListTeamsInclude:
|
7991
8833
|
description: Included related resources optionally requested.
|
7992
8834
|
enum:
|
@@ -9217,6 +10059,15 @@ components:
|
|
9217
10059
|
properties:
|
9218
10060
|
emails:
|
9219
10061
|
$ref: '#/components/schemas/MetricBulkTagConfigEmailList'
|
10062
|
+
exclude_tags_mode:
|
10063
|
+
description: 'When set to true, the configuration will exclude the configured
|
10064
|
+
tags and include any other submitted tags.
|
10065
|
+
|
10066
|
+
When set to false, the configuration will include the configured tags
|
10067
|
+
and exclude any other submitted tags.
|
10068
|
+
|
10069
|
+
Defaults to false.'
|
10070
|
+
type: boolean
|
9220
10071
|
tags:
|
9221
10072
|
$ref: '#/components/schemas/MetricBulkTagConfigTagNameList'
|
9222
10073
|
type: object
|
@@ -9297,6 +10148,13 @@ components:
|
|
9297
10148
|
properties:
|
9298
10149
|
emails:
|
9299
10150
|
$ref: '#/components/schemas/MetricBulkTagConfigEmailList'
|
10151
|
+
exclude_tags_mode:
|
10152
|
+
description: 'When set to true, the configuration will exclude the configured
|
10153
|
+
tags and include any other submitted tags.
|
10154
|
+
|
10155
|
+
When set to false, the configuration will include the configured tags
|
10156
|
+
and exclude any other submitted tags.'
|
10157
|
+
type: boolean
|
9300
10158
|
status:
|
9301
10159
|
description: The status of the request.
|
9302
10160
|
example: Accepted
|
@@ -9761,6 +10619,15 @@ components:
|
|
9761
10619
|
example: '2020-03-25T09:48:37.463835Z'
|
9762
10620
|
format: date-time
|
9763
10621
|
type: string
|
10622
|
+
exclude_tags_mode:
|
10623
|
+
description: 'When set to true, the configuration will exclude the configured
|
10624
|
+
tags and include any other submitted tags.
|
10625
|
+
|
10626
|
+
When set to false, the configuration will include the configured tags
|
10627
|
+
and exclude any other submitted tags.
|
10628
|
+
|
10629
|
+
Defaults to false. Requires `tags` property.'
|
10630
|
+
type: boolean
|
9764
10631
|
include_percentiles:
|
9765
10632
|
description: 'Toggle to include or exclude percentile aggregations for distribution
|
9766
10633
|
metrics.
|
@@ -9791,6 +10658,15 @@ components:
|
|
9791
10658
|
properties:
|
9792
10659
|
aggregations:
|
9793
10660
|
$ref: '#/components/schemas/MetricCustomAggregations'
|
10661
|
+
exclude_tags_mode:
|
10662
|
+
description: 'When set to true, the configuration will exclude the configured
|
10663
|
+
tags and include any other submitted tags.
|
10664
|
+
|
10665
|
+
When set to false, the configuration will include the configured tags
|
10666
|
+
and exclude any other submitted tags.
|
10667
|
+
|
10668
|
+
Defaults to false. Requires `tags` property.'
|
10669
|
+
type: boolean
|
9794
10670
|
include_percentiles:
|
9795
10671
|
description: 'Toggle to include/exclude percentiles for a distribution metric.
|
9796
10672
|
|
@@ -9882,6 +10758,15 @@ components:
|
|
9882
10758
|
properties:
|
9883
10759
|
aggregations:
|
9884
10760
|
$ref: '#/components/schemas/MetricCustomAggregations'
|
10761
|
+
exclude_tags_mode:
|
10762
|
+
description: 'When set to true, the configuration will exclude the configured
|
10763
|
+
tags and include any other submitted tags.
|
10764
|
+
|
10765
|
+
When set to false, the configuration will include the configured tags
|
10766
|
+
and exclude any other submitted tags.
|
10767
|
+
|
10768
|
+
Defaults to false. Requires `tags` property.'
|
10769
|
+
type: boolean
|
9885
10770
|
include_percentiles:
|
9886
10771
|
description: 'Toggle to include/exclude percentiles for a distribution metric.
|
9887
10772
|
|
@@ -10325,160 +11210,232 @@ components:
|
|
10325
11210
|
description: The monitor type.
|
10326
11211
|
type: string
|
10327
11212
|
type: object
|
10328
|
-
|
10329
|
-
description:
|
11213
|
+
MonthlyCostAttributionAttributes:
|
11214
|
+
description: Cost Attribution by Tag for a given organization.
|
11215
|
+
properties:
|
11216
|
+
month:
|
11217
|
+
description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`.'
|
11218
|
+
format: date-time
|
11219
|
+
type: string
|
11220
|
+
org_name:
|
11221
|
+
description: The name of the organization.
|
11222
|
+
type: string
|
11223
|
+
public_id:
|
11224
|
+
description: The organization public ID.
|
11225
|
+
type: string
|
11226
|
+
tag_config_source:
|
11227
|
+
description: The source of the cost attribution tag configuration and the
|
11228
|
+
selected tags in the format `<source_org_name>:::<selected tag 1>///<selected
|
11229
|
+
tag 2>///<selected tag 3>`.
|
11230
|
+
type: string
|
11231
|
+
tags:
|
11232
|
+
$ref: '#/components/schemas/CostAttributionTagNames'
|
11233
|
+
updated_at:
|
11234
|
+
description: Shows the most recent hour in the current months for all organizations
|
11235
|
+
for which all costs were calculated.
|
11236
|
+
type: string
|
11237
|
+
values:
|
11238
|
+
description: 'Fields in Cost Attribution by tag(s). Example: `infra_host_on_demand_cost`,
|
11239
|
+
`infra_host_committed_cost`, `infra_host_total_cost`, `infra_host_percentage_in_org`,
|
11240
|
+
`infra_host_percentage_in_account`.'
|
11241
|
+
type: object
|
11242
|
+
type: object
|
11243
|
+
MonthlyCostAttributionBody:
|
11244
|
+
description: Cost data.
|
11245
|
+
properties:
|
11246
|
+
attributes:
|
11247
|
+
$ref: '#/components/schemas/MonthlyCostAttributionAttributes'
|
11248
|
+
id:
|
11249
|
+
description: Unique ID of the response.
|
11250
|
+
type: string
|
11251
|
+
type:
|
11252
|
+
$ref: '#/components/schemas/CostAttributionType'
|
11253
|
+
type: object
|
11254
|
+
MonthlyCostAttributionMeta:
|
11255
|
+
description: The object containing document metadata.
|
11256
|
+
properties:
|
11257
|
+
aggregates:
|
11258
|
+
$ref: '#/components/schemas/CostAttributionAggregates'
|
11259
|
+
pagination:
|
11260
|
+
$ref: '#/components/schemas/MonthlyCostAttributionPagination'
|
11261
|
+
type: object
|
11262
|
+
MonthlyCostAttributionPagination:
|
11263
|
+
description: The metadata for the current pagination.
|
11264
|
+
properties:
|
11265
|
+
next_record_id:
|
11266
|
+
description: The cursor to use to get the next results, if any. To make
|
11267
|
+
the next request, use the same parameters with the addition of the `next_record_id`.
|
11268
|
+
nullable: true
|
11269
|
+
type: string
|
11270
|
+
type: object
|
11271
|
+
MonthlyCostAttributionResponse:
|
11272
|
+
description: Response containing the monthly cost attribution by tag(s).
|
11273
|
+
properties:
|
11274
|
+
data:
|
11275
|
+
description: Response containing cost attribution.
|
11276
|
+
items:
|
11277
|
+
$ref: '#/components/schemas/MonthlyCostAttributionBody'
|
11278
|
+
type: array
|
11279
|
+
meta:
|
11280
|
+
$ref: '#/components/schemas/MonthlyCostAttributionMeta'
|
11281
|
+
type: object
|
11282
|
+
NullableRelationshipToUser:
|
11283
|
+
description: Relationship to user.
|
11284
|
+
nullable: true
|
10330
11285
|
properties:
|
10331
11286
|
data:
|
10332
|
-
$ref: '#/components/schemas/
|
11287
|
+
$ref: '#/components/schemas/NullableRelationshipToUserData'
|
10333
11288
|
required:
|
10334
11289
|
- data
|
10335
11290
|
type: object
|
10336
|
-
|
10337
|
-
|
10338
|
-
|
11291
|
+
NullableRelationshipToUserData:
|
11292
|
+
description: Relationship to user object.
|
11293
|
+
nullable: true
|
10339
11294
|
properties:
|
10340
|
-
|
10341
|
-
|
11295
|
+
id:
|
11296
|
+
description: A unique identifier that represents the user.
|
11297
|
+
example: 00000000-0000-0000-0000-000000000000
|
11298
|
+
type: string
|
11299
|
+
type:
|
11300
|
+
$ref: '#/components/schemas/UsersType'
|
10342
11301
|
required:
|
10343
|
-
-
|
11302
|
+
- id
|
11303
|
+
- type
|
10344
11304
|
type: object
|
10345
|
-
|
10346
|
-
description:
|
11305
|
+
OktaAccount:
|
11306
|
+
description: Schema for an Okta account.
|
10347
11307
|
properties:
|
10348
11308
|
attributes:
|
10349
|
-
$ref: '#/components/schemas/
|
11309
|
+
$ref: '#/components/schemas/OktaAccountAttributes'
|
10350
11310
|
id:
|
10351
|
-
|
11311
|
+
description: The ID of the Okta account, a UUID hash of the account name.
|
11312
|
+
example: f749daaf-682e-4208-a38d-c9b43162c609
|
11313
|
+
type: string
|
10352
11314
|
type:
|
10353
|
-
$ref: '#/components/schemas/
|
11315
|
+
$ref: '#/components/schemas/OktaAccountType'
|
10354
11316
|
required:
|
10355
|
-
- id
|
10356
|
-
- type
|
10357
11317
|
- attributes
|
11318
|
+
- type
|
10358
11319
|
type: object
|
10359
|
-
|
10360
|
-
|
10361
|
-
description: Object containing the new mute properties of the finding.
|
11320
|
+
OktaAccountAttributes:
|
11321
|
+
description: Attributes object for an Okta account.
|
10362
11322
|
properties:
|
10363
|
-
|
10364
|
-
description:
|
10365
|
-
|
10366
|
-
|
11323
|
+
api_key:
|
11324
|
+
description: The API key of the Okta account.
|
11325
|
+
type: string
|
11326
|
+
writeOnly: true
|
11327
|
+
auth_method:
|
11328
|
+
description: The authorization method for an Okta account.
|
11329
|
+
example: oauth
|
11330
|
+
type: string
|
11331
|
+
client_id:
|
11332
|
+
description: The Client ID of an Okta app integration.
|
11333
|
+
type: string
|
11334
|
+
client_secret:
|
11335
|
+
description: The client secret of an Okta app integration.
|
11336
|
+
type: string
|
11337
|
+
writeOnly: true
|
11338
|
+
domain:
|
11339
|
+
description: The domain of the Okta account.
|
11340
|
+
example: https://example.okta.com/
|
11341
|
+
type: string
|
11342
|
+
name:
|
11343
|
+
description: The name of the Okta account.
|
11344
|
+
example: Okta-Prod
|
10367
11345
|
type: string
|
10368
|
-
expiration_date:
|
10369
|
-
description: 'The expiration date of the mute or unmute action (Unix ms).
|
10370
|
-
It must be set to a value greater than the current timestamp.
|
10371
|
-
|
10372
|
-
If this field is not provided, the finding will be muted or unmuted indefinitely,
|
10373
|
-
which is equivalent to setting the expiration date to 9999999999999.
|
10374
|
-
|
10375
|
-
'
|
10376
|
-
example: 1778721573794
|
10377
|
-
format: int64
|
10378
|
-
type: integer
|
10379
|
-
muted:
|
10380
|
-
description: Whether this finding is muted or unmuted.
|
10381
|
-
example: true
|
10382
|
-
type: boolean
|
10383
|
-
reason:
|
10384
|
-
$ref: '#/components/schemas/FindingMuteReason'
|
10385
11346
|
required:
|
10386
|
-
-
|
10387
|
-
-
|
11347
|
+
- auth_method
|
11348
|
+
- domain
|
11349
|
+
- name
|
10388
11350
|
type: object
|
10389
|
-
|
10390
|
-
description:
|
11351
|
+
OktaAccountRequest:
|
11352
|
+
description: Request object for an Okta account.
|
10391
11353
|
properties:
|
10392
11354
|
data:
|
10393
|
-
$ref: '#/components/schemas/
|
11355
|
+
$ref: '#/components/schemas/OktaAccount'
|
10394
11356
|
required:
|
10395
11357
|
- data
|
10396
11358
|
type: object
|
10397
|
-
|
10398
|
-
description:
|
11359
|
+
OktaAccountResponse:
|
11360
|
+
description: Response object for an Okta account.
|
10399
11361
|
properties:
|
10400
|
-
|
10401
|
-
$ref: '#/components/schemas/
|
10402
|
-
evaluation_changed_at:
|
10403
|
-
$ref: '#/components/schemas/FindingEvaluationChangedAt'
|
10404
|
-
mute:
|
10405
|
-
$ref: '#/components/schemas/MuteFindingResponseProperties'
|
10406
|
-
resource:
|
10407
|
-
$ref: '#/components/schemas/FindingResource'
|
10408
|
-
resource_discovery_date:
|
10409
|
-
$ref: '#/components/schemas/FindingResourceDiscoveryDate'
|
10410
|
-
resource_type:
|
10411
|
-
$ref: '#/components/schemas/FindingResourceType'
|
10412
|
-
rule:
|
10413
|
-
$ref: '#/components/schemas/FindingRule'
|
10414
|
-
status:
|
10415
|
-
$ref: '#/components/schemas/FindingStatus'
|
10416
|
-
tags:
|
10417
|
-
$ref: '#/components/schemas/FindingTags'
|
11362
|
+
data:
|
11363
|
+
$ref: '#/components/schemas/OktaAccount'
|
10418
11364
|
type: object
|
10419
|
-
|
10420
|
-
description: Data object
|
11365
|
+
OktaAccountResponseData:
|
11366
|
+
description: Data object of an Okta account
|
10421
11367
|
properties:
|
10422
11368
|
attributes:
|
10423
|
-
$ref: '#/components/schemas/
|
11369
|
+
$ref: '#/components/schemas/OktaAccountAttributes'
|
10424
11370
|
id:
|
10425
|
-
|
10426
|
-
|
10427
|
-
$ref: '#/components/schemas/FindingType'
|
10428
|
-
type: object
|
10429
|
-
MuteFindingResponseProperties:
|
10430
|
-
additionalProperties: false
|
10431
|
-
description: Information about the mute status of this finding.
|
10432
|
-
properties:
|
10433
|
-
description:
|
10434
|
-
description: 'Additional information about the reason why this finding is
|
10435
|
-
muted or unmuted.
|
10436
|
-
|
10437
|
-
This attribute will not be included in the response if the description
|
10438
|
-
is not provided in the request body.
|
10439
|
-
|
10440
|
-
'
|
10441
|
-
example: To be resolved later
|
11371
|
+
description: The ID of the Okta account, a UUID hash of the account name.
|
11372
|
+
example: f749daaf-682e-4208-a38d-c9b43162c609
|
10442
11373
|
type: string
|
10443
|
-
|
10444
|
-
|
10445
|
-
|
10446
|
-
|
10447
|
-
|
10448
|
-
|
10449
|
-
|
10450
|
-
'
|
10451
|
-
example: 1778721573794
|
10452
|
-
format: int64
|
10453
|
-
type: integer
|
10454
|
-
muted:
|
10455
|
-
description: Whether this finding is muted or unmuted.
|
10456
|
-
example: true
|
10457
|
-
type: boolean
|
10458
|
-
reason:
|
10459
|
-
$ref: '#/components/schemas/FindingMuteReason'
|
11374
|
+
type:
|
11375
|
+
$ref: '#/components/schemas/OktaAccountType'
|
11376
|
+
required:
|
11377
|
+
- attributes
|
11378
|
+
- id
|
11379
|
+
- type
|
10460
11380
|
type: object
|
10461
|
-
|
10462
|
-
|
11381
|
+
OktaAccountType:
|
11382
|
+
default: okta-accounts
|
11383
|
+
description: Account type for an Okta account.
|
11384
|
+
enum:
|
11385
|
+
- okta-accounts
|
11386
|
+
example: okta-accounts
|
11387
|
+
type: string
|
11388
|
+
x-enum-varnames:
|
11389
|
+
- OKTA_ACCOUNTS
|
11390
|
+
OktaAccountUpdateRequest:
|
11391
|
+
description: Payload schema when updating an Okta account.
|
10463
11392
|
properties:
|
10464
11393
|
data:
|
10465
|
-
$ref: '#/components/schemas/
|
11394
|
+
$ref: '#/components/schemas/OktaAccountUpdateRequestData'
|
10466
11395
|
required:
|
10467
11396
|
- data
|
10468
11397
|
type: object
|
10469
|
-
|
10470
|
-
description:
|
10471
|
-
nullable: true
|
11398
|
+
OktaAccountUpdateRequestAttributes:
|
11399
|
+
description: Attributes object for updating an Okta account.
|
10472
11400
|
properties:
|
10473
|
-
|
10474
|
-
description:
|
10475
|
-
|
11401
|
+
api_key:
|
11402
|
+
description: The API key of the Okta account.
|
11403
|
+
type: string
|
11404
|
+
writeOnly: true
|
11405
|
+
auth_method:
|
11406
|
+
description: The authorization method for an Okta account.
|
11407
|
+
example: oauth
|
11408
|
+
type: string
|
11409
|
+
client_id:
|
11410
|
+
description: The Client ID of an Okta app integration.
|
11411
|
+
type: string
|
11412
|
+
client_secret:
|
11413
|
+
description: The client secret of an Okta app integration.
|
11414
|
+
type: string
|
11415
|
+
writeOnly: true
|
11416
|
+
domain:
|
11417
|
+
description: The domain associated with an Okta account.
|
11418
|
+
example: https://dev-test.okta.com/
|
10476
11419
|
type: string
|
10477
|
-
type:
|
10478
|
-
$ref: '#/components/schemas/UsersType'
|
10479
11420
|
required:
|
10480
|
-
-
|
10481
|
-
-
|
11421
|
+
- auth_method
|
11422
|
+
- domain
|
11423
|
+
type: object
|
11424
|
+
OktaAccountUpdateRequestData:
|
11425
|
+
description: Data object for updating an Okta account.
|
11426
|
+
properties:
|
11427
|
+
attributes:
|
11428
|
+
$ref: '#/components/schemas/OktaAccountUpdateRequestAttributes'
|
11429
|
+
type:
|
11430
|
+
$ref: '#/components/schemas/OktaAccountType'
|
11431
|
+
OktaAccountsResponse:
|
11432
|
+
description: The expected response schema when getting Okta accounts.
|
11433
|
+
properties:
|
11434
|
+
data:
|
11435
|
+
description: List of Okta accounts.
|
11436
|
+
items:
|
11437
|
+
$ref: '#/components/schemas/OktaAccountResponseData'
|
11438
|
+
type: array
|
10482
11439
|
type: object
|
10483
11440
|
OnDemandConcurrencyCap:
|
10484
11441
|
description: On-demand concurrency cap.
|
@@ -10729,9 +11686,188 @@ components:
|
|
10729
11686
|
type: string
|
10730
11687
|
x-enum-varnames:
|
10731
11688
|
- ORGS
|
10732
|
-
|
10733
|
-
|
10734
|
-
|
11689
|
+
OutcomeType:
|
11690
|
+
default: outcome
|
11691
|
+
description: The JSON:API type for an outcome.
|
11692
|
+
enum:
|
11693
|
+
- outcome
|
11694
|
+
example: outcome
|
11695
|
+
type: string
|
11696
|
+
x-enum-varnames:
|
11697
|
+
- OUTCOME
|
11698
|
+
OutcomesBatchAttributes:
|
11699
|
+
description: The JSON:API attributes for a batched set of scorecard outcomes.
|
11700
|
+
properties:
|
11701
|
+
results:
|
11702
|
+
description: Set of scorecard outcomes to update.
|
11703
|
+
items:
|
11704
|
+
$ref: '#/components/schemas/OutcomesBatchRequestItem'
|
11705
|
+
type: array
|
11706
|
+
type: object
|
11707
|
+
OutcomesBatchRequest:
|
11708
|
+
description: Scorecard outcomes batch request.
|
11709
|
+
properties:
|
11710
|
+
data:
|
11711
|
+
$ref: '#/components/schemas/OutcomesBatchRequestData'
|
11712
|
+
type: object
|
11713
|
+
OutcomesBatchRequestData:
|
11714
|
+
description: Scorecard outcomes batch request data.
|
11715
|
+
properties:
|
11716
|
+
attributes:
|
11717
|
+
$ref: '#/components/schemas/OutcomesBatchAttributes'
|
11718
|
+
type:
|
11719
|
+
$ref: '#/components/schemas/OutcomesBatchType'
|
11720
|
+
type: object
|
11721
|
+
OutcomesBatchRequestItem:
|
11722
|
+
description: Scorecard outcome for a specific rule, for a given service within
|
11723
|
+
a batched update.
|
11724
|
+
properties:
|
11725
|
+
remarks:
|
11726
|
+
description: Any remarks regarding the scorecard rule's evaluation, and
|
11727
|
+
supports HTML hyperlinks.
|
11728
|
+
example: 'See: <a href="https://app.datadoghq.com/services">Services</a>'
|
11729
|
+
type: string
|
11730
|
+
rule_id:
|
11731
|
+
$ref: '#/components/schemas/RuleId'
|
11732
|
+
service_name:
|
11733
|
+
description: The unique name for a service in the catalog.
|
11734
|
+
example: my-service
|
11735
|
+
type: string
|
11736
|
+
state:
|
11737
|
+
$ref: '#/components/schemas/State'
|
11738
|
+
required:
|
11739
|
+
- rule_id
|
11740
|
+
- service_name
|
11741
|
+
- state
|
11742
|
+
type: object
|
11743
|
+
OutcomesBatchResponse:
|
11744
|
+
description: Scorecard outcomes batch response.
|
11745
|
+
properties:
|
11746
|
+
data:
|
11747
|
+
$ref: '#/components/schemas/OutcomesBatchResponseData'
|
11748
|
+
meta:
|
11749
|
+
$ref: '#/components/schemas/OutcomesBatchResponseMeta'
|
11750
|
+
required:
|
11751
|
+
- data
|
11752
|
+
- meta
|
11753
|
+
type: object
|
11754
|
+
OutcomesBatchResponseAttributes:
|
11755
|
+
description: The JSON:API attributes for an outcome.
|
11756
|
+
properties:
|
11757
|
+
created_at:
|
11758
|
+
description: Creation time of the rule outcome.
|
11759
|
+
format: date-time
|
11760
|
+
type: string
|
11761
|
+
modified_at:
|
11762
|
+
description: Time of last rule outcome modification.
|
11763
|
+
format: date-time
|
11764
|
+
type: string
|
11765
|
+
remarks:
|
11766
|
+
description: Any remarks regarding the scorecard rule's evaluation, and
|
11767
|
+
supports HTML hyperlinks.
|
11768
|
+
example: 'See: <a href="https://app.datadoghq.com/services">Services</a>'
|
11769
|
+
type: string
|
11770
|
+
service_name:
|
11771
|
+
description: The unique name for a service in the catalog.
|
11772
|
+
example: my-service
|
11773
|
+
type: string
|
11774
|
+
state:
|
11775
|
+
$ref: '#/components/schemas/State'
|
11776
|
+
type: object
|
11777
|
+
OutcomesBatchResponseData:
|
11778
|
+
description: List of rule outcomes which were affected during the bulk operation.
|
11779
|
+
items:
|
11780
|
+
$ref: '#/components/schemas/OutcomesResponseDataItem'
|
11781
|
+
type: array
|
11782
|
+
OutcomesBatchResponseMeta:
|
11783
|
+
description: Metadata pertaining to the bulk operation.
|
11784
|
+
properties:
|
11785
|
+
total_received:
|
11786
|
+
description: Total number of scorecard results received during the bulk
|
11787
|
+
operation.
|
11788
|
+
format: int64
|
11789
|
+
type: integer
|
11790
|
+
total_updated:
|
11791
|
+
description: Total number of scorecard results modified during the bulk
|
11792
|
+
operation.
|
11793
|
+
format: int64
|
11794
|
+
type: integer
|
11795
|
+
type: object
|
11796
|
+
OutcomesBatchType:
|
11797
|
+
default: batched-outcome
|
11798
|
+
description: The JSON:API type for scorecard outcomes.
|
11799
|
+
enum:
|
11800
|
+
- batched-outcome
|
11801
|
+
example: batched-outcome
|
11802
|
+
type: string
|
11803
|
+
x-enum-varnames:
|
11804
|
+
- BATCHED_OUTCOME
|
11805
|
+
OutcomesResponse:
|
11806
|
+
description: Scorecard outcomes - the result of a rule for a service.
|
11807
|
+
properties:
|
11808
|
+
data:
|
11809
|
+
$ref: '#/components/schemas/OutcomesResponseData'
|
11810
|
+
included:
|
11811
|
+
$ref: '#/components/schemas/OutcomesResponseIncluded'
|
11812
|
+
links:
|
11813
|
+
$ref: '#/components/schemas/OutcomesResponseLinks'
|
11814
|
+
type: object
|
11815
|
+
OutcomesResponseData:
|
11816
|
+
description: List of rule outcomes.
|
11817
|
+
items:
|
11818
|
+
$ref: '#/components/schemas/OutcomesResponseDataItem'
|
11819
|
+
type: array
|
11820
|
+
OutcomesResponseDataItem:
|
11821
|
+
description: A single rule outcome.
|
11822
|
+
properties:
|
11823
|
+
attributes:
|
11824
|
+
$ref: '#/components/schemas/OutcomesBatchResponseAttributes'
|
11825
|
+
id:
|
11826
|
+
description: The unique ID for a rule outcome.
|
11827
|
+
type: string
|
11828
|
+
relationships:
|
11829
|
+
$ref: '#/components/schemas/RuleOutcomeRelationships'
|
11830
|
+
type:
|
11831
|
+
$ref: '#/components/schemas/OutcomeType'
|
11832
|
+
type: object
|
11833
|
+
OutcomesResponseIncluded:
|
11834
|
+
description: Array of rule details.
|
11835
|
+
items:
|
11836
|
+
$ref: '#/components/schemas/OutcomesResponseIncludedItem'
|
11837
|
+
type: array
|
11838
|
+
OutcomesResponseIncludedItem:
|
11839
|
+
description: Attributes of the included rule.
|
11840
|
+
properties:
|
11841
|
+
attributes:
|
11842
|
+
$ref: '#/components/schemas/OutcomesResponseIncludedRuleAttributes'
|
11843
|
+
id:
|
11844
|
+
$ref: '#/components/schemas/RuleId'
|
11845
|
+
type:
|
11846
|
+
$ref: '#/components/schemas/RuleType'
|
11847
|
+
type: object
|
11848
|
+
OutcomesResponseIncludedRuleAttributes:
|
11849
|
+
description: Details of a rule.
|
11850
|
+
properties:
|
11851
|
+
name:
|
11852
|
+
description: Name of the rule.
|
11853
|
+
example: Team Defined
|
11854
|
+
type: string
|
11855
|
+
scorecard_name:
|
11856
|
+
description: The scorecard name to which this rule must belong.
|
11857
|
+
example: Observability Best Practices
|
11858
|
+
type: string
|
11859
|
+
type: object
|
11860
|
+
OutcomesResponseLinks:
|
11861
|
+
description: Links attributes.
|
11862
|
+
properties:
|
11863
|
+
next:
|
11864
|
+
description: Link for the next set of results.
|
11865
|
+
example: /api/v2/scorecard/outcomes?include=rule&page%5Blimit%5D=100&page%5Boffset%5D=100
|
11866
|
+
type: string
|
11867
|
+
type: object
|
11868
|
+
Pagination:
|
11869
|
+
description: Pagination object.
|
11870
|
+
properties:
|
10735
11871
|
total_count:
|
10736
11872
|
description: Total count.
|
10737
11873
|
format: int64
|
@@ -10757,6 +11893,9 @@ components:
|
|
10757
11893
|
PartialAPIKeyAttributes:
|
10758
11894
|
description: Attributes of a partial API key.
|
10759
11895
|
properties:
|
11896
|
+
category:
|
11897
|
+
description: The category of the API key.
|
11898
|
+
type: string
|
10760
11899
|
created_at:
|
10761
11900
|
description: Creation date of the API key.
|
10762
11901
|
example: '2020-11-23T10:00:00.000Z'
|
@@ -10778,6 +11917,9 @@ components:
|
|
10778
11917
|
description: Name of the API key.
|
10779
11918
|
example: API Key for submitting metrics
|
10780
11919
|
type: string
|
11920
|
+
remote_config_read_enabled:
|
11921
|
+
description: The remote config read enabled status.
|
11922
|
+
type: boolean
|
10781
11923
|
type: object
|
10782
11924
|
PartialApplicationKey:
|
10783
11925
|
description: Partial Datadog application key.
|
@@ -10955,6 +12097,8 @@ components:
|
|
10955
12097
|
$ref: '#/components/schemas/PowerpackGroupWidgetDefinition'
|
10956
12098
|
layout:
|
10957
12099
|
$ref: '#/components/schemas/PowerpackGroupWidgetLayout'
|
12100
|
+
live_span:
|
12101
|
+
$ref: '#/components/schemas/WidgetLiveSpan'
|
10958
12102
|
required:
|
10959
12103
|
- definition
|
10960
12104
|
type: object
|
@@ -11087,7 +12231,7 @@ components:
|
|
11087
12231
|
description: Powerpack relationship object.
|
11088
12232
|
properties:
|
11089
12233
|
author:
|
11090
|
-
$ref: '#/components/schemas/
|
12234
|
+
$ref: '#/components/schemas/RelationshipToUser'
|
11091
12235
|
type: object
|
11092
12236
|
PowerpackResponse:
|
11093
12237
|
description: Response object which includes a single powerpack configuration.
|
@@ -11159,6 +12303,7 @@ components:
|
|
11159
12303
|
last_offset:
|
11160
12304
|
description: The last offset.
|
11161
12305
|
format: int64
|
12306
|
+
nullable: true
|
11162
12307
|
type: integer
|
11163
12308
|
limit:
|
11164
12309
|
description: Pagination limit.
|
@@ -11271,6 +12416,62 @@ components:
|
|
11271
12416
|
type: string
|
11272
12417
|
x-enum-varnames:
|
11273
12418
|
- PROCESS
|
12419
|
+
ProjectedCost:
|
12420
|
+
description: Projected Cost data.
|
12421
|
+
properties:
|
12422
|
+
attributes:
|
12423
|
+
$ref: '#/components/schemas/ProjectedCostAttributes'
|
12424
|
+
id:
|
12425
|
+
description: Unique ID of the response.
|
12426
|
+
type: string
|
12427
|
+
type:
|
12428
|
+
$ref: '#/components/schemas/ProjectedCostType'
|
12429
|
+
type: object
|
12430
|
+
ProjectedCostAttributes:
|
12431
|
+
description: Projected Cost attributes data.
|
12432
|
+
properties:
|
12433
|
+
charges:
|
12434
|
+
description: List of charges data reported for the requested month.
|
12435
|
+
items:
|
12436
|
+
$ref: '#/components/schemas/ChargebackBreakdown'
|
12437
|
+
type: array
|
12438
|
+
date:
|
12439
|
+
description: The month requested.
|
12440
|
+
format: date-time
|
12441
|
+
type: string
|
12442
|
+
org_name:
|
12443
|
+
description: The organization name.
|
12444
|
+
type: string
|
12445
|
+
projected_total_cost:
|
12446
|
+
description: The total projected cost of products for the month.
|
12447
|
+
format: double
|
12448
|
+
type: number
|
12449
|
+
public_id:
|
12450
|
+
description: The organization public ID.
|
12451
|
+
type: string
|
12452
|
+
region:
|
12453
|
+
description: The region of the Datadog instance that the organization belongs
|
12454
|
+
to.
|
12455
|
+
type: string
|
12456
|
+
type: object
|
12457
|
+
ProjectedCostResponse:
|
12458
|
+
description: Projected Cost response.
|
12459
|
+
properties:
|
12460
|
+
data:
|
12461
|
+
description: Response containing Projected Cost.
|
12462
|
+
items:
|
12463
|
+
$ref: '#/components/schemas/ProjectedCost'
|
12464
|
+
type: array
|
12465
|
+
type: object
|
12466
|
+
ProjectedCostType:
|
12467
|
+
default: projected_cost
|
12468
|
+
description: Type of cost data.
|
12469
|
+
enum:
|
12470
|
+
- projected_cost
|
12471
|
+
example: projected_cost
|
12472
|
+
type: string
|
12473
|
+
x-enum-varnames:
|
12474
|
+
- PROJECt_COST
|
11274
12475
|
QueryFormula:
|
11275
12476
|
description: A formula for calculation based on one or more queries.
|
11276
12477
|
properties:
|
@@ -12083,6 +13284,30 @@ components:
|
|
12083
13284
|
- id
|
12084
13285
|
- type
|
12085
13286
|
type: object
|
13287
|
+
RelationshipToIncidentImpactData:
|
13288
|
+
description: Relationship to impact object.
|
13289
|
+
properties:
|
13290
|
+
id:
|
13291
|
+
description: A unique identifier that represents the impact.
|
13292
|
+
example: 00000000-0000-0000-2345-000000000000
|
13293
|
+
type: string
|
13294
|
+
type:
|
13295
|
+
$ref: '#/components/schemas/IncidentImpactsType'
|
13296
|
+
required:
|
13297
|
+
- id
|
13298
|
+
- type
|
13299
|
+
type: object
|
13300
|
+
RelationshipToIncidentImpacts:
|
13301
|
+
description: Relationship to impacts.
|
13302
|
+
properties:
|
13303
|
+
data:
|
13304
|
+
description: An array of incident impacts.
|
13305
|
+
items:
|
13306
|
+
$ref: '#/components/schemas/RelationshipToIncidentImpactData'
|
13307
|
+
type: array
|
13308
|
+
required:
|
13309
|
+
- data
|
13310
|
+
type: object
|
12086
13311
|
RelationshipToIncidentIntegrationMetadataData:
|
12087
13312
|
description: A relationship reference for an integration metadata object.
|
12088
13313
|
example:
|
@@ -12149,6 +13374,54 @@ components:
|
|
12149
13374
|
- id
|
12150
13375
|
- type
|
12151
13376
|
type: object
|
13377
|
+
RelationshipToIncidentResponderData:
|
13378
|
+
description: Relationship to impact object.
|
13379
|
+
properties:
|
13380
|
+
id:
|
13381
|
+
description: A unique identifier that represents the responder.
|
13382
|
+
example: 00000000-0000-0000-2345-000000000000
|
13383
|
+
type: string
|
13384
|
+
type:
|
13385
|
+
$ref: '#/components/schemas/IncidentRespondersType'
|
13386
|
+
required:
|
13387
|
+
- id
|
13388
|
+
- type
|
13389
|
+
type: object
|
13390
|
+
RelationshipToIncidentResponders:
|
13391
|
+
description: Relationship to incident responders.
|
13392
|
+
properties:
|
13393
|
+
data:
|
13394
|
+
description: An array of incident responders.
|
13395
|
+
items:
|
13396
|
+
$ref: '#/components/schemas/RelationshipToIncidentResponderData'
|
13397
|
+
type: array
|
13398
|
+
required:
|
13399
|
+
- data
|
13400
|
+
type: object
|
13401
|
+
RelationshipToIncidentUserDefinedFieldData:
|
13402
|
+
description: Relationship to impact object.
|
13403
|
+
properties:
|
13404
|
+
id:
|
13405
|
+
description: A unique identifier that represents the responder.
|
13406
|
+
example: 00000000-0000-0000-2345-000000000000
|
13407
|
+
type: string
|
13408
|
+
type:
|
13409
|
+
$ref: '#/components/schemas/IncidentUserDefinedFieldType'
|
13410
|
+
required:
|
13411
|
+
- id
|
13412
|
+
- type
|
13413
|
+
type: object
|
13414
|
+
RelationshipToIncidentUserDefinedFields:
|
13415
|
+
description: Relationship to incident user defined fields.
|
13416
|
+
properties:
|
13417
|
+
data:
|
13418
|
+
description: An array of user defined fields.
|
13419
|
+
items:
|
13420
|
+
$ref: '#/components/schemas/RelationshipToIncidentUserDefinedFieldData'
|
13421
|
+
type: array
|
13422
|
+
required:
|
13423
|
+
- data
|
13424
|
+
type: object
|
12152
13425
|
RelationshipToOrganization:
|
12153
13426
|
description: Relationship to an organization.
|
12154
13427
|
properties:
|
@@ -12182,6 +13455,21 @@ components:
|
|
12182
13455
|
required:
|
12183
13456
|
- data
|
12184
13457
|
type: object
|
13458
|
+
RelationshipToOutcome:
|
13459
|
+
description: The JSON:API relationship to a scorecard outcome.
|
13460
|
+
properties:
|
13461
|
+
data:
|
13462
|
+
$ref: '#/components/schemas/RelationshipToOutcomeData'
|
13463
|
+
type: object
|
13464
|
+
RelationshipToOutcomeData:
|
13465
|
+
description: The JSON:API relationship to an outcome, which returns the related
|
13466
|
+
rule id.
|
13467
|
+
properties:
|
13468
|
+
id:
|
13469
|
+
$ref: '#/components/schemas/RuleId'
|
13470
|
+
type:
|
13471
|
+
$ref: '#/components/schemas/RuleType'
|
13472
|
+
type: object
|
12185
13473
|
RelationshipToPermission:
|
12186
13474
|
description: Relationship to a permissions object.
|
12187
13475
|
properties:
|
@@ -12231,6 +13519,28 @@ components:
|
|
12231
13519
|
$ref: '#/components/schemas/RelationshipToRoleData'
|
12232
13520
|
type: array
|
12233
13521
|
type: object
|
13522
|
+
RelationshipToRule:
|
13523
|
+
description: Scorecard create rule response relationship.
|
13524
|
+
properties:
|
13525
|
+
scorecard:
|
13526
|
+
$ref: '#/components/schemas/RelationshipToRuleData'
|
13527
|
+
type: object
|
13528
|
+
RelationshipToRuleData:
|
13529
|
+
description: Relationship data for a rule.
|
13530
|
+
properties:
|
13531
|
+
data:
|
13532
|
+
$ref: '#/components/schemas/RelationshipToRuleDataObject'
|
13533
|
+
type: object
|
13534
|
+
RelationshipToRuleDataObject:
|
13535
|
+
description: Rule relationship data.
|
13536
|
+
properties:
|
13537
|
+
id:
|
13538
|
+
description: The unique ID for a scorecard.
|
13539
|
+
example: 00000000-0000-beef-0000-000000000000
|
13540
|
+
type: string
|
13541
|
+
type:
|
13542
|
+
$ref: '#/components/schemas/ScorecardType'
|
13543
|
+
type: object
|
12234
13544
|
RelationshipToSAMLAssertionAttribute:
|
12235
13545
|
description: AuthN Mapping relationship to SAML Assertion Attribute.
|
12236
13546
|
properties:
|
@@ -12957,6 +14267,62 @@ components:
|
|
12957
14267
|
type: string
|
12958
14268
|
x-enum-varnames:
|
12959
14269
|
- ROLES
|
14270
|
+
RuleAttributes:
|
14271
|
+
description: Details of a rule.
|
14272
|
+
properties:
|
14273
|
+
category:
|
14274
|
+
deprecated: true
|
14275
|
+
description: The scorecard name to which this rule must belong.
|
14276
|
+
type: string
|
14277
|
+
created_at:
|
14278
|
+
description: Creation time of the rule outcome.
|
14279
|
+
format: date-time
|
14280
|
+
type: string
|
14281
|
+
custom:
|
14282
|
+
description: Defines if the rule is a custom rule.
|
14283
|
+
type: boolean
|
14284
|
+
description:
|
14285
|
+
description: Explanation of the rule.
|
14286
|
+
type: string
|
14287
|
+
enabled:
|
14288
|
+
description: If enabled, the rule is calculated as part of the score.
|
14289
|
+
example: true
|
14290
|
+
type: boolean
|
14291
|
+
modified_at:
|
14292
|
+
description: Time of the last rule outcome modification.
|
14293
|
+
format: date-time
|
14294
|
+
type: string
|
14295
|
+
name:
|
14296
|
+
description: Name of the rule.
|
14297
|
+
example: Team Defined
|
14298
|
+
type: string
|
14299
|
+
owner:
|
14300
|
+
description: Owner of the rule.
|
14301
|
+
type: string
|
14302
|
+
scorecard_name:
|
14303
|
+
description: The scorecard name to which this rule must belong.
|
14304
|
+
example: Deployments automated via Deployment Trains
|
14305
|
+
type: string
|
14306
|
+
type: object
|
14307
|
+
RuleId:
|
14308
|
+
description: The unique ID for a scorecard rule.
|
14309
|
+
example: 00000000-0000-beef-0000-000000000000
|
14310
|
+
type: string
|
14311
|
+
RuleOutcomeRelationships:
|
14312
|
+
description: The JSON:API relationship to a scorecard rule.
|
14313
|
+
properties:
|
14314
|
+
rule:
|
14315
|
+
$ref: '#/components/schemas/RelationshipToOutcome'
|
14316
|
+
type: object
|
14317
|
+
RuleType:
|
14318
|
+
default: rule
|
14319
|
+
description: The JSON:API type for scorecard rules.
|
14320
|
+
enum:
|
14321
|
+
- rule
|
14322
|
+
example: rule
|
14323
|
+
type: string
|
14324
|
+
x-enum-varnames:
|
14325
|
+
- RULE
|
12960
14326
|
SAMLAssertionAttribute:
|
12961
14327
|
description: SAML assertion attribute.
|
12962
14328
|
properties:
|
@@ -13142,6 +14508,15 @@ components:
|
|
13142
14508
|
type:
|
13143
14509
|
$ref: '#/components/schemas/ScalarFormulaResponseType'
|
13144
14510
|
type: object
|
14511
|
+
ScorecardType:
|
14512
|
+
default: scorecard
|
14513
|
+
description: The JSON:API type for scorecard.
|
14514
|
+
enum:
|
14515
|
+
- scorecard
|
14516
|
+
example: scorecard
|
14517
|
+
type: string
|
14518
|
+
x-enum-varnames:
|
14519
|
+
- SCORECARD
|
13145
14520
|
SecurityFilter:
|
13146
14521
|
description: The security filter's properties.
|
13147
14522
|
properties:
|
@@ -13721,10 +15096,12 @@ components:
|
|
13721
15096
|
SecurityMonitoringRuleTypeCreate:
|
13722
15097
|
description: The rule type.
|
13723
15098
|
enum:
|
15099
|
+
- application_security
|
13724
15100
|
- log_detection
|
13725
15101
|
- workload_security
|
13726
15102
|
type: string
|
13727
15103
|
x-enum-varnames:
|
15104
|
+
- APPLICATION_SECURITY
|
13728
15105
|
- LOG_DETECTION
|
13729
15106
|
- WORKLOAD_SECURITY
|
13730
15107
|
SecurityMonitoringRuleTypeRead:
|
@@ -13855,7 +15232,7 @@ components:
|
|
13855
15232
|
|
13856
15233
|
associated values.'
|
13857
15234
|
properties:
|
13858
|
-
|
15235
|
+
custom:
|
13859
15236
|
additionalProperties: {}
|
13860
15237
|
description: A JSON object of attributes in the security signal.
|
13861
15238
|
example:
|
@@ -14441,6 +15818,13 @@ components:
|
|
14441
15818
|
description: Field.
|
14442
15819
|
type: string
|
14443
15820
|
type: array
|
15821
|
+
hasOptionalGroupByFields:
|
15822
|
+
description: When false, events without a group-by value are ignored by
|
15823
|
+
the rule. When true, events with missing group-by fields are processed
|
15824
|
+
with `N/A`, replacing the missing values.
|
15825
|
+
example: false
|
15826
|
+
readOnly: true
|
15827
|
+
type: boolean
|
14444
15828
|
metric:
|
14445
15829
|
deprecated: true
|
14446
15830
|
description: '(Deprecated) The target field to aggregate over when using
|
@@ -15080,6 +16464,11 @@ components:
|
|
15080
16464
|
description:
|
15081
16465
|
description: Description of the standard pattern.
|
15082
16466
|
type: string
|
16467
|
+
included_keywords:
|
16468
|
+
description: List of included keywords.
|
16469
|
+
items:
|
16470
|
+
type: string
|
16471
|
+
type: array
|
15083
16472
|
name:
|
15084
16473
|
description: Name of the standard pattern.
|
15085
16474
|
type: string
|
@@ -15809,7 +17198,7 @@ components:
|
|
15809
17198
|
type: object
|
15810
17199
|
integrations:
|
15811
17200
|
$ref: '#/components/schemas/ServiceDefinitionV2Dot2Integrations'
|
15812
|
-
|
17201
|
+
languages:
|
15813
17202
|
description: 'The service''s programming language. Datadog recognizes the
|
15814
17203
|
following languages: `dotnet`, `go`, `java`, `js`, `php`, `python`, `ruby`,
|
15815
17204
|
and `c++`.'
|
@@ -16203,6 +17592,16 @@ components:
|
|
16203
17592
|
- channel_name
|
16204
17593
|
- redirect_url
|
16205
17594
|
type: object
|
17595
|
+
SortDirection:
|
17596
|
+
default: desc
|
17597
|
+
description: The direction to sort by.
|
17598
|
+
enum:
|
17599
|
+
- desc
|
17600
|
+
- asc
|
17601
|
+
type: string
|
17602
|
+
x-enum-varnames:
|
17603
|
+
- DESC
|
17604
|
+
- ASC
|
16206
17605
|
Span:
|
16207
17606
|
description: Object description of a spans after being processed and stored
|
16208
17607
|
by Datadog.
|
@@ -17068,12 +18467,24 @@ components:
|
|
17068
18467
|
from the other indexes
|
17069
18468
|
type: string
|
17070
18469
|
type: object
|
17071
|
-
|
17072
|
-
description:
|
17073
|
-
|
17074
|
-
-
|
17075
|
-
|
17076
|
-
|
18470
|
+
State:
|
18471
|
+
description: The state of the rule evaluation.
|
18472
|
+
enum:
|
18473
|
+
- pass
|
18474
|
+
- fail
|
18475
|
+
- skip
|
18476
|
+
example: pass
|
18477
|
+
type: string
|
18478
|
+
x-enum-varnames:
|
18479
|
+
- PASS
|
18480
|
+
- FAIL
|
18481
|
+
- SKIP
|
18482
|
+
TagsEventAttribute:
|
18483
|
+
description: Array of tags associated with your event.
|
18484
|
+
example:
|
18485
|
+
- team:A
|
18486
|
+
items:
|
18487
|
+
description: Tag associated with your event.
|
17077
18488
|
type: string
|
17078
18489
|
type: array
|
17079
18490
|
Team:
|
@@ -17543,6 +18954,41 @@ components:
|
|
17543
18954
|
required:
|
17544
18955
|
- data
|
17545
18956
|
type: object
|
18957
|
+
TeamsField:
|
18958
|
+
description: Supported teams field.
|
18959
|
+
enum:
|
18960
|
+
- id
|
18961
|
+
- name
|
18962
|
+
- handle
|
18963
|
+
- summary
|
18964
|
+
- description
|
18965
|
+
- avatar
|
18966
|
+
- banner
|
18967
|
+
- visible_modules
|
18968
|
+
- hidden_modules
|
18969
|
+
- created_at
|
18970
|
+
- modified_at
|
18971
|
+
- user_count
|
18972
|
+
- link_count
|
18973
|
+
- team_links
|
18974
|
+
- user_team_permissions
|
18975
|
+
type: string
|
18976
|
+
x-enum-varnames:
|
18977
|
+
- ID
|
18978
|
+
- NAME
|
18979
|
+
- HANDLE
|
18980
|
+
- SUMMARY
|
18981
|
+
- DESCRIPTION
|
18982
|
+
- AVATAR
|
18983
|
+
- BANNER
|
18984
|
+
- VISIBLE_MODULES
|
18985
|
+
- HIDDEN_MODULES
|
18986
|
+
- CREATED_AT
|
18987
|
+
- MODIFIED_AT
|
18988
|
+
- USER_COUNT
|
18989
|
+
- LINK_COUNT
|
18990
|
+
- TEAM_LINKS
|
18991
|
+
- USER_TEAM_PERMISSIONS
|
17546
18992
|
TeamsResponse:
|
17547
18993
|
description: Response with multiple teams
|
17548
18994
|
properties:
|
@@ -18177,8 +19623,8 @@ components:
|
|
18177
19623
|
description: User team permission attributes
|
18178
19624
|
properties:
|
18179
19625
|
permissions:
|
18180
|
-
description: Object of team permission actions and boolean values
|
18181
|
-
|
19626
|
+
description: Object of team permission actions and boolean values that a
|
19627
|
+
logged in user can perform on this team.
|
18182
19628
|
readOnly: true
|
18183
19629
|
type: object
|
18184
19630
|
type: object
|
@@ -18331,6 +19777,42 @@ components:
|
|
18331
19777
|
type: string
|
18332
19778
|
x-enum-varnames:
|
18333
19779
|
- USERS
|
19780
|
+
WidgetLiveSpan:
|
19781
|
+
description: The available timeframes depend on the widget you are using.
|
19782
|
+
enum:
|
19783
|
+
- 1m
|
19784
|
+
- 5m
|
19785
|
+
- 10m
|
19786
|
+
- 15m
|
19787
|
+
- 30m
|
19788
|
+
- 1h
|
19789
|
+
- 4h
|
19790
|
+
- 1d
|
19791
|
+
- 2d
|
19792
|
+
- 1w
|
19793
|
+
- 1mo
|
19794
|
+
- 3mo
|
19795
|
+
- 6mo
|
19796
|
+
- 1y
|
19797
|
+
- alert
|
19798
|
+
example: 5m
|
19799
|
+
type: string
|
19800
|
+
x-enum-varnames:
|
19801
|
+
- PAST_ONE_MINUTE
|
19802
|
+
- PAST_FIVE_MINUTES
|
19803
|
+
- PAST_TEN_MINUTES
|
19804
|
+
- PAST_FIFTEEN_MINUTES
|
19805
|
+
- PAST_THIRTY_MINUTES
|
19806
|
+
- PAST_ONE_HOUR
|
19807
|
+
- PAST_FOUR_HOURS
|
19808
|
+
- PAST_ONE_DAY
|
19809
|
+
- PAST_TWO_DAYS
|
19810
|
+
- PAST_ONE_WEEK
|
19811
|
+
- PAST_ONE_MONTH
|
19812
|
+
- PAST_THREE_MONTHS
|
19813
|
+
- PAST_SIX_MONTHS
|
19814
|
+
- PAST_ONE_YEAR
|
19815
|
+
- ALERT
|
18334
19816
|
securitySchemes:
|
18335
19817
|
AuthZ:
|
18336
19818
|
description: This API uses OAuth 2 with the implicit grant flow.
|
@@ -18360,7 +19842,7 @@ components:
|
|
18360
19842
|
an organization. Mute and unmute hosts. The ability to write monitors
|
18361
19843
|
is not required to set downtimes.
|
18362
19844
|
monitors_read: View monitors.
|
18363
|
-
monitors_write: Edit
|
19845
|
+
monitors_write: Edit and delete individual monitors.
|
18364
19846
|
security_monitoring_filters_read: Read Security Filters.
|
18365
19847
|
security_monitoring_filters_write: Create, edit, and delete Security Filters.
|
18366
19848
|
security_monitoring_findings_read: View CSPM Findings.
|
@@ -18433,6 +19915,8 @@ paths:
|
|
18433
19915
|
- $ref: '#/components/parameters/APIKeyFilterModifiedAtStartParameter'
|
18434
19916
|
- $ref: '#/components/parameters/APIKeyFilterModifiedAtEndParameter'
|
18435
19917
|
- $ref: '#/components/parameters/APIKeyIncludeParameter'
|
19918
|
+
- $ref: '#/components/parameters/APIKeyReadConfigReadEnabledParameter'
|
19919
|
+
- $ref: '#/components/parameters/APIKeyCategoryParameter'
|
18436
19920
|
responses:
|
18437
19921
|
'200':
|
18438
19922
|
content:
|
@@ -18866,6 +20350,7 @@ paths:
|
|
18866
20350
|
- $ref: '#/components/parameters/ApplicationKeyFilterParameter'
|
18867
20351
|
- $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtStartParameter'
|
18868
20352
|
- $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtEndParameter'
|
20353
|
+
- $ref: '#/components/parameters/ApplicationKeyIncludeParameter'
|
18869
20354
|
responses:
|
18870
20355
|
'200':
|
18871
20356
|
content:
|
@@ -19414,6 +20899,9 @@ paths:
|
|
19414
20899
|
tags:
|
19415
20900
|
- CI Visibility Pipelines
|
19416
20901
|
x-codegen-request-body-name: body
|
20902
|
+
x-unstable: '**Note:** This endpoint is in public beta.
|
20903
|
+
|
20904
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
19417
20905
|
/api/v2/ci/pipelines/analytics/aggregate:
|
19418
20906
|
post:
|
19419
20907
|
description: Use this API endpoint to aggregate CI Visibility pipeline events
|
@@ -19811,6 +21299,241 @@ paths:
|
|
19811
21299
|
cursorPath: meta.pagination.next_cursor
|
19812
21300
|
limitParam: page[size]
|
19813
21301
|
resultsPath: data
|
21302
|
+
/api/v2/containers:
|
21303
|
+
get:
|
21304
|
+
description: Get all containers for your organization.
|
21305
|
+
operationId: ListContainers
|
21306
|
+
parameters:
|
21307
|
+
- description: Comma-separated list of tags to filter containers by.
|
21308
|
+
example: env:prod,short_image:cassandra
|
21309
|
+
in: query
|
21310
|
+
name: filter[tags]
|
21311
|
+
required: false
|
21312
|
+
schema:
|
21313
|
+
type: string
|
21314
|
+
- description: Comma-separated list of tags to group containers by.
|
21315
|
+
example: datacenter,cluster
|
21316
|
+
in: query
|
21317
|
+
name: group_by
|
21318
|
+
required: false
|
21319
|
+
schema:
|
21320
|
+
type: string
|
21321
|
+
- description: Attribute to sort containers by.
|
21322
|
+
example: started_at
|
21323
|
+
in: query
|
21324
|
+
name: sort
|
21325
|
+
required: false
|
21326
|
+
schema:
|
21327
|
+
type: string
|
21328
|
+
- description: Maximum number of results returned.
|
21329
|
+
in: query
|
21330
|
+
name: page[size]
|
21331
|
+
required: false
|
21332
|
+
schema:
|
21333
|
+
default: 1000
|
21334
|
+
format: int32
|
21335
|
+
maximum: 10000
|
21336
|
+
minimum: 1
|
21337
|
+
type: integer
|
21338
|
+
- description: 'String to query the next page of results.
|
21339
|
+
|
21340
|
+
This key is provided with each valid response from the API in `meta.pagination.next_cursor`.'
|
21341
|
+
in: query
|
21342
|
+
name: page[cursor]
|
21343
|
+
required: false
|
21344
|
+
schema:
|
21345
|
+
type: string
|
21346
|
+
responses:
|
21347
|
+
'200':
|
21348
|
+
content:
|
21349
|
+
application/json:
|
21350
|
+
schema:
|
21351
|
+
$ref: '#/components/schemas/ContainersResponse'
|
21352
|
+
description: OK
|
21353
|
+
'400':
|
21354
|
+
content:
|
21355
|
+
application/json:
|
21356
|
+
schema:
|
21357
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
21358
|
+
description: Bad Request
|
21359
|
+
'403':
|
21360
|
+
content:
|
21361
|
+
application/json:
|
21362
|
+
schema:
|
21363
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
21364
|
+
description: Authentication Error
|
21365
|
+
'429':
|
21366
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
21367
|
+
security:
|
21368
|
+
- apiKeyAuth: []
|
21369
|
+
appKeyAuth: []
|
21370
|
+
- AuthZ: []
|
21371
|
+
summary: Get All Containers
|
21372
|
+
tags:
|
21373
|
+
- Containers
|
21374
|
+
x-pagination:
|
21375
|
+
cursorParam: page[cursor]
|
21376
|
+
cursorPath: meta.pagination.next_cursor
|
21377
|
+
limitParam: page[size]
|
21378
|
+
resultsPath: data
|
21379
|
+
/api/v2/cost_by_tag/active_billing_dimensions:
|
21380
|
+
get:
|
21381
|
+
description: Get active billing dimensions for cost attribution. Cost data for
|
21382
|
+
a given month becomes available no later than the 17th of the following month.
|
21383
|
+
operationId: GetActiveBillingDimensions
|
21384
|
+
responses:
|
21385
|
+
'200':
|
21386
|
+
content:
|
21387
|
+
application/json;datetime-format=rfc3339:
|
21388
|
+
schema:
|
21389
|
+
$ref: '#/components/schemas/ActiveBillingDimensionsResponse'
|
21390
|
+
description: OK
|
21391
|
+
'400':
|
21392
|
+
content:
|
21393
|
+
application/json;datetime-format=rfc3339:
|
21394
|
+
schema:
|
21395
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
21396
|
+
description: Bad Request
|
21397
|
+
'403':
|
21398
|
+
content:
|
21399
|
+
application/json;datetime-format=rfc3339:
|
21400
|
+
schema:
|
21401
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
21402
|
+
description: Forbidden - User is not authorized
|
21403
|
+
'429':
|
21404
|
+
content:
|
21405
|
+
application/json;datetime-format=rfc3339:
|
21406
|
+
schema:
|
21407
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
21408
|
+
description: Too many requests
|
21409
|
+
security:
|
21410
|
+
- apiKeyAuth: []
|
21411
|
+
appKeyAuth: []
|
21412
|
+
- AuthZ: []
|
21413
|
+
summary: Get active billing dimensions for cost attribution
|
21414
|
+
tags:
|
21415
|
+
- Usage Metering
|
21416
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
21417
|
+
|
21418
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
21419
|
+
/api/v2/cost_by_tag/monthly_cost_attribution:
|
21420
|
+
get:
|
21421
|
+
description: "Get monthly cost attribution by tag across multi-org and single
|
21422
|
+
root-org accounts.\nCost Attribution data for a given month becomes available
|
21423
|
+
no later than the 17th of the following month.\nThis API endpoint is paginated.
|
21424
|
+
To make sure you receive all records, check if the value of `next_record_id`
|
21425
|
+
is\nset in the response. If it is, make another request and pass `next_record_id`
|
21426
|
+
as a parameter.\nPseudo code example:\n```\nresponse := GetMonthlyCostAttribution(start_month,
|
21427
|
+
end_month)\ncursor := response.metadata.pagination.next_record_id\nWHILE cursor
|
21428
|
+
!= null BEGIN\n sleep(5 seconds) # Avoid running into rate limit\n response
|
21429
|
+
:= GetMonthlyCostAttribution(start_month, end_month, next_record_id=cursor)\n
|
21430
|
+
\ cursor := response.metadata.pagination.next_record_id\nEND\n```"
|
21431
|
+
operationId: GetMonthlyCostAttribution
|
21432
|
+
parameters:
|
21433
|
+
- description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
|
21434
|
+
for cost beginning in this month.'
|
21435
|
+
in: query
|
21436
|
+
name: start_month
|
21437
|
+
required: true
|
21438
|
+
schema:
|
21439
|
+
format: date-time
|
21440
|
+
type: string
|
21441
|
+
- description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
|
21442
|
+
for cost ending this month.'
|
21443
|
+
in: query
|
21444
|
+
name: end_month
|
21445
|
+
required: true
|
21446
|
+
schema:
|
21447
|
+
format: date-time
|
21448
|
+
type: string
|
21449
|
+
- description: 'Comma-separated list specifying cost types (e.g., `<billing_dimension>_on_demand_cost`,
|
21450
|
+
`<billing_dimension>_committed_cost`, `<billing_dimension>_total_cost`)
|
21451
|
+
and the
|
21452
|
+
|
21453
|
+
proportions (`<billing_dimension>_percentage_in_org`, `<billing_dimension>_percentage_in_account`).
|
21454
|
+
Use `*` to retrieve all fields.
|
21455
|
+
|
21456
|
+
Example: `infra_host_on_demand_cost,infra_host_percentage_in_account`
|
21457
|
+
|
21458
|
+
To obtain the complete list of active billing dimensions that can be used
|
21459
|
+
to replace
|
21460
|
+
|
21461
|
+
`<billing_dimension>` in the field names, make a request to the [Get active
|
21462
|
+
billing dimensions API](https://docs.datadoghq.com/api/latest/usage-metering/#get-active-billing-dimensions-for-cost-attribution).'
|
21463
|
+
in: query
|
21464
|
+
name: fields
|
21465
|
+
required: true
|
21466
|
+
schema:
|
21467
|
+
type: string
|
21468
|
+
- description: 'The direction to sort by: `[desc, asc]`.'
|
21469
|
+
in: query
|
21470
|
+
name: sort_direction
|
21471
|
+
required: false
|
21472
|
+
schema:
|
21473
|
+
$ref: '#/components/schemas/SortDirection'
|
21474
|
+
- description: 'The billing dimension to sort by. Always sorted by total cost.
|
21475
|
+
Example: `infra_host`.'
|
21476
|
+
in: query
|
21477
|
+
name: sort_name
|
21478
|
+
required: false
|
21479
|
+
schema:
|
21480
|
+
type: string
|
21481
|
+
- description: 'Comma separated list of tag keys used to group cost. If no value
|
21482
|
+
is provided the cost will not be broken down by tags.
|
21483
|
+
|
21484
|
+
To see which tags are available, look for the value of `tag_config_source`
|
21485
|
+
in the API response.'
|
21486
|
+
in: query
|
21487
|
+
name: tag_breakdown_keys
|
21488
|
+
required: false
|
21489
|
+
schema:
|
21490
|
+
type: string
|
21491
|
+
- description: List following results with a next_record_id provided in the
|
21492
|
+
previous query.
|
21493
|
+
in: query
|
21494
|
+
name: next_record_id
|
21495
|
+
required: false
|
21496
|
+
schema:
|
21497
|
+
type: string
|
21498
|
+
- description: Include child org cost in the response. Defaults to `true`.
|
21499
|
+
in: query
|
21500
|
+
name: include_descendants
|
21501
|
+
required: false
|
21502
|
+
schema:
|
21503
|
+
default: true
|
21504
|
+
type: boolean
|
21505
|
+
responses:
|
21506
|
+
'200':
|
21507
|
+
content:
|
21508
|
+
application/json;datetime-format=rfc3339:
|
21509
|
+
schema:
|
21510
|
+
$ref: '#/components/schemas/MonthlyCostAttributionResponse'
|
21511
|
+
description: OK
|
21512
|
+
'400':
|
21513
|
+
content:
|
21514
|
+
application/json;datetime-format=rfc3339:
|
21515
|
+
schema:
|
21516
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
21517
|
+
description: Bad Request
|
21518
|
+
'403':
|
21519
|
+
content:
|
21520
|
+
application/json;datetime-format=rfc3339:
|
21521
|
+
schema:
|
21522
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
21523
|
+
description: Forbidden - User is not authorized
|
21524
|
+
'429':
|
21525
|
+
content:
|
21526
|
+
application/json;datetime-format=rfc3339:
|
21527
|
+
schema:
|
21528
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
21529
|
+
description: Too many requests
|
21530
|
+
security:
|
21531
|
+
- apiKeyAuth: []
|
21532
|
+
appKeyAuth: []
|
21533
|
+
- AuthZ: []
|
21534
|
+
summary: Get Monthly Cost Attribution
|
21535
|
+
tags:
|
21536
|
+
- Usage Metering
|
19814
21537
|
x-unstable: '**Note**: This endpoint is in public beta.
|
19815
21538
|
|
19816
21539
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
@@ -19825,6 +21548,7 @@ paths:
|
|
19825
21548
|
- $ref: '#/components/parameters/ApplicationKeyFilterParameter'
|
19826
21549
|
- $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtStartParameter'
|
19827
21550
|
- $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtEndParameter'
|
21551
|
+
- $ref: '#/components/parameters/ApplicationKeyIncludeParameter'
|
19828
21552
|
responses:
|
19829
21553
|
'200':
|
19830
21554
|
content:
|
@@ -20174,37 +21898,141 @@ paths:
|
|
20174
21898
|
tags:
|
20175
21899
|
- Dashboard Lists
|
20176
21900
|
x-codegen-request-body-name: body
|
20177
|
-
/api/v2/
|
20178
|
-
|
20179
|
-
description:
|
20180
|
-
|
20181
|
-
parameters:
|
20182
|
-
- description: Only return downtimes that are active when the request is made.
|
20183
|
-
in: query
|
20184
|
-
name: current_only
|
20185
|
-
required: false
|
20186
|
-
schema:
|
20187
|
-
type: boolean
|
20188
|
-
- description: 'Comma-separated list of resource paths for related resources
|
20189
|
-
to include in the response. Supported resource
|
21901
|
+
/api/v2/dora/deployment:
|
21902
|
+
post:
|
21903
|
+
description: 'Use this API endpoint to provide data about deployments for DORA
|
21904
|
+
metrics.
|
20190
21905
|
|
20191
|
-
|
20192
|
-
|
20193
|
-
|
20194
|
-
|
20195
|
-
|
20196
|
-
|
20197
|
-
|
20198
|
-
|
20199
|
-
|
20200
|
-
|
20201
|
-
|
20202
|
-
|
20203
|
-
|
20204
|
-
|
20205
|
-
|
20206
|
-
|
20207
|
-
|
21906
|
+
|
21907
|
+
This is necessary for:
|
21908
|
+
|
21909
|
+
- Deployment Frequency
|
21910
|
+
|
21911
|
+
- Change Lead Time
|
21912
|
+
|
21913
|
+
- Change Failure Rate'
|
21914
|
+
operationId: CreateDORADeployment
|
21915
|
+
requestBody:
|
21916
|
+
content:
|
21917
|
+
application/json:
|
21918
|
+
schema:
|
21919
|
+
$ref: '#/components/schemas/DORADeploymentRequest'
|
21920
|
+
required: true
|
21921
|
+
responses:
|
21922
|
+
'200':
|
21923
|
+
content:
|
21924
|
+
application/json:
|
21925
|
+
schema:
|
21926
|
+
$ref: '#/components/schemas/DORADeploymentResponse'
|
21927
|
+
description: OK
|
21928
|
+
'202':
|
21929
|
+
content:
|
21930
|
+
application/json:
|
21931
|
+
schema:
|
21932
|
+
$ref: '#/components/schemas/DORADeploymentResponse'
|
21933
|
+
description: OK - but delayed due to incident
|
21934
|
+
'400':
|
21935
|
+
content:
|
21936
|
+
application/json:
|
21937
|
+
schema:
|
21938
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
21939
|
+
description: Bad Request
|
21940
|
+
'403':
|
21941
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
21942
|
+
'429':
|
21943
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
21944
|
+
security:
|
21945
|
+
- apiKeyAuth: []
|
21946
|
+
summary: Send a deployment event for DORA Metrics
|
21947
|
+
tags:
|
21948
|
+
- DORA Metrics
|
21949
|
+
x-codegen-request-body-name: body
|
21950
|
+
x-unstable: '**Note**: This endpoint is in private beta for CI Pipeline Visibility
|
21951
|
+
customers.
|
21952
|
+
|
21953
|
+
If you want to request access, complete the [form](https://forms.gle/Eqq6uXfGjYxmqpjDA).'
|
21954
|
+
/api/v2/dora/incident:
|
21955
|
+
post:
|
21956
|
+
description: 'Use this API endpoint to provide data about incidents for DORA
|
21957
|
+
metrics.
|
21958
|
+
|
21959
|
+
|
21960
|
+
This is necessary for:
|
21961
|
+
|
21962
|
+
- Change Failure Rate
|
21963
|
+
|
21964
|
+
- Time to Restore'
|
21965
|
+
operationId: CreateDORAIncident
|
21966
|
+
requestBody:
|
21967
|
+
content:
|
21968
|
+
application/json:
|
21969
|
+
schema:
|
21970
|
+
$ref: '#/components/schemas/DORAIncidentRequest'
|
21971
|
+
required: true
|
21972
|
+
responses:
|
21973
|
+
'200':
|
21974
|
+
content:
|
21975
|
+
application/json:
|
21976
|
+
schema:
|
21977
|
+
$ref: '#/components/schemas/DORAIncidentResponse'
|
21978
|
+
description: OK
|
21979
|
+
'202':
|
21980
|
+
content:
|
21981
|
+
application/json:
|
21982
|
+
schema:
|
21983
|
+
$ref: '#/components/schemas/DORAIncidentResponse'
|
21984
|
+
description: OK - but delayed due to incident
|
21985
|
+
'400':
|
21986
|
+
content:
|
21987
|
+
application/json:
|
21988
|
+
schema:
|
21989
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
21990
|
+
description: Bad Request
|
21991
|
+
'403':
|
21992
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
21993
|
+
'429':
|
21994
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
21995
|
+
security:
|
21996
|
+
- apiKeyAuth: []
|
21997
|
+
summary: Send an incident event for DORA Metrics
|
21998
|
+
tags:
|
21999
|
+
- DORA Metrics
|
22000
|
+
x-codegen-request-body-name: body
|
22001
|
+
x-unstable: '**Note**: This endpoint is in private beta for CI Pipeline Visibility
|
22002
|
+
customers.
|
22003
|
+
|
22004
|
+
If you want to request access, complete the [form](https://forms.gle/Eqq6uXfGjYxmqpjDA).'
|
22005
|
+
/api/v2/downtime:
|
22006
|
+
get:
|
22007
|
+
description: Get all scheduled downtimes.
|
22008
|
+
operationId: ListDowntimes
|
22009
|
+
parameters:
|
22010
|
+
- description: Only return downtimes that are active when the request is made.
|
22011
|
+
in: query
|
22012
|
+
name: current_only
|
22013
|
+
required: false
|
22014
|
+
schema:
|
22015
|
+
type: boolean
|
22016
|
+
- description: 'Comma-separated list of resource paths for related resources
|
22017
|
+
to include in the response. Supported resource
|
22018
|
+
|
22019
|
+
paths are `created_by` and `monitor`.'
|
22020
|
+
in: query
|
22021
|
+
name: include
|
22022
|
+
required: false
|
22023
|
+
schema:
|
22024
|
+
example: created_by,monitor
|
22025
|
+
type: string
|
22026
|
+
- $ref: '#/components/parameters/PageOffset'
|
22027
|
+
- description: Maximum number of downtimes in the response.
|
22028
|
+
example: 100
|
22029
|
+
in: query
|
22030
|
+
name: page[limit]
|
22031
|
+
required: false
|
22032
|
+
schema:
|
22033
|
+
default: 30
|
22034
|
+
format: int64
|
22035
|
+
type: integer
|
20208
22036
|
responses:
|
20209
22037
|
'200':
|
20210
22038
|
content:
|
@@ -20361,7 +22189,7 @@ paths:
|
|
20361
22189
|
- apiKeyAuth: []
|
20362
22190
|
appKeyAuth: []
|
20363
22191
|
- AuthZ:
|
20364
|
-
-
|
22192
|
+
- monitors_downtime
|
20365
22193
|
summary: Get a downtime
|
20366
22194
|
tags:
|
20367
22195
|
- Downtimes
|
@@ -20497,9 +22325,6 @@ paths:
|
|
20497
22325
|
cursorPath: meta.page.after
|
20498
22326
|
limitParam: page[limit]
|
20499
22327
|
resultsPath: data
|
20500
|
-
x-unstable: '**Note**: This endpoint is in beta.
|
20501
|
-
|
20502
|
-
For access, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
20503
22328
|
/api/v2/events/search:
|
20504
22329
|
post:
|
20505
22330
|
description: 'List endpoint returns events that match an events search query.
|
@@ -20542,9 +22367,6 @@ paths:
|
|
20542
22367
|
cursorPath: meta.page.after
|
20543
22368
|
limitParam: body.page.limit
|
20544
22369
|
resultsPath: data
|
20545
|
-
x-unstable: '**Note**: This endpoint is in beta.
|
20546
|
-
|
20547
|
-
For access, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
20548
22370
|
/api/v2/incidents:
|
20549
22371
|
get:
|
20550
22372
|
description: Get all incidents for the user's organization.
|
@@ -22142,6 +23964,144 @@ paths:
|
|
22142
23964
|
tags:
|
22143
23965
|
- Fastly Integration
|
22144
23966
|
x-codegen-request-body-name: body
|
23967
|
+
/api/v2/integrations/okta/accounts:
|
23968
|
+
get:
|
23969
|
+
description: List Okta accounts.
|
23970
|
+
operationId: ListOktaAccounts
|
23971
|
+
responses:
|
23972
|
+
'200':
|
23973
|
+
content:
|
23974
|
+
application/json:
|
23975
|
+
schema:
|
23976
|
+
$ref: '#/components/schemas/OktaAccountsResponse'
|
23977
|
+
description: OK
|
23978
|
+
'400':
|
23979
|
+
$ref: '#/components/responses/BadRequestResponse'
|
23980
|
+
'403':
|
23981
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
23982
|
+
'404':
|
23983
|
+
$ref: '#/components/responses/NotFoundResponse'
|
23984
|
+
'429':
|
23985
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
23986
|
+
summary: List Okta accounts
|
23987
|
+
tags:
|
23988
|
+
- Okta Integration
|
23989
|
+
post:
|
23990
|
+
description: Create an Okta account.
|
23991
|
+
operationId: CreateOktaAccount
|
23992
|
+
requestBody:
|
23993
|
+
content:
|
23994
|
+
application/json:
|
23995
|
+
schema:
|
23996
|
+
$ref: '#/components/schemas/OktaAccountRequest'
|
23997
|
+
required: true
|
23998
|
+
responses:
|
23999
|
+
'201':
|
24000
|
+
content:
|
24001
|
+
application/json:
|
24002
|
+
schema:
|
24003
|
+
$ref: '#/components/schemas/OktaAccountResponse'
|
24004
|
+
description: OK
|
24005
|
+
'400':
|
24006
|
+
$ref: '#/components/responses/BadRequestResponse'
|
24007
|
+
'403':
|
24008
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
24009
|
+
'404':
|
24010
|
+
$ref: '#/components/responses/NotFoundResponse'
|
24011
|
+
'429':
|
24012
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
24013
|
+
summary: Add Okta account
|
24014
|
+
tags:
|
24015
|
+
- Okta Integration
|
24016
|
+
x-codegen-request-body-name: body
|
24017
|
+
/api/v2/integrations/okta/accounts/{account_id}:
|
24018
|
+
delete:
|
24019
|
+
description: Delete an Okta account.
|
24020
|
+
operationId: DeleteOktaAccount
|
24021
|
+
parameters:
|
24022
|
+
- description: None
|
24023
|
+
in: path
|
24024
|
+
name: account_id
|
24025
|
+
required: true
|
24026
|
+
schema:
|
24027
|
+
type: string
|
24028
|
+
responses:
|
24029
|
+
'204':
|
24030
|
+
description: OK
|
24031
|
+
'400':
|
24032
|
+
$ref: '#/components/responses/BadRequestResponse'
|
24033
|
+
'403':
|
24034
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
24035
|
+
'404':
|
24036
|
+
$ref: '#/components/responses/NotFoundResponse'
|
24037
|
+
'429':
|
24038
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
24039
|
+
summary: Delete Okta account
|
24040
|
+
tags:
|
24041
|
+
- Okta Integration
|
24042
|
+
get:
|
24043
|
+
description: Get an Okta account.
|
24044
|
+
operationId: GetOktaAccount
|
24045
|
+
parameters:
|
24046
|
+
- description: None
|
24047
|
+
in: path
|
24048
|
+
name: account_id
|
24049
|
+
required: true
|
24050
|
+
schema:
|
24051
|
+
type: string
|
24052
|
+
responses:
|
24053
|
+
'200':
|
24054
|
+
content:
|
24055
|
+
application/json:
|
24056
|
+
schema:
|
24057
|
+
$ref: '#/components/schemas/OktaAccountResponse'
|
24058
|
+
description: OK
|
24059
|
+
'400':
|
24060
|
+
$ref: '#/components/responses/BadRequestResponse'
|
24061
|
+
'403':
|
24062
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
24063
|
+
'404':
|
24064
|
+
$ref: '#/components/responses/NotFoundResponse'
|
24065
|
+
'429':
|
24066
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
24067
|
+
summary: Get Okta account
|
24068
|
+
tags:
|
24069
|
+
- Okta Integration
|
24070
|
+
patch:
|
24071
|
+
description: Update an Okta account.
|
24072
|
+
operationId: UpdateOktaAccount
|
24073
|
+
parameters:
|
24074
|
+
- description: None
|
24075
|
+
in: path
|
24076
|
+
name: account_id
|
24077
|
+
required: true
|
24078
|
+
schema:
|
24079
|
+
type: string
|
24080
|
+
requestBody:
|
24081
|
+
content:
|
24082
|
+
application/json:
|
24083
|
+
schema:
|
24084
|
+
$ref: '#/components/schemas/OktaAccountUpdateRequest'
|
24085
|
+
required: true
|
24086
|
+
responses:
|
24087
|
+
'200':
|
24088
|
+
content:
|
24089
|
+
application/json:
|
24090
|
+
schema:
|
24091
|
+
$ref: '#/components/schemas/OktaAccountResponse'
|
24092
|
+
description: OK
|
24093
|
+
'400':
|
24094
|
+
$ref: '#/components/responses/BadRequestResponse'
|
24095
|
+
'403':
|
24096
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
24097
|
+
'404':
|
24098
|
+
$ref: '#/components/responses/NotFoundResponse'
|
24099
|
+
'429':
|
24100
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
24101
|
+
summary: Update Okta account
|
24102
|
+
tags:
|
24103
|
+
- Okta Integration
|
24104
|
+
x-codegen-request-body-name: body
|
22145
24105
|
/api/v2/ip_allowlist:
|
22146
24106
|
get:
|
22147
24107
|
description: Returns the IP allowlist and its enabled or disabled state.
|
@@ -23281,7 +25241,11 @@ paths:
|
|
23281
25241
|
If multiple calls include the same metric, the last configuration applied
|
23282
25242
|
(not by submit order) is used, do not
|
23283
25243
|
|
23284
|
-
expect deterministic ordering of concurrent calls.
|
25244
|
+
expect deterministic ordering of concurrent calls. The `exclude_tags_mode`
|
25245
|
+
value will set all metrics that match the prefix to
|
25246
|
+
|
25247
|
+
the same exclusion state, metric tag configurations do not support mixed inclusion
|
25248
|
+
and exclusion for tags on the same metric.
|
23285
25249
|
|
23286
25250
|
Can only be used with application keys of users with the `Manage Tags for
|
23287
25251
|
Metrics` permission.'
|
@@ -23607,7 +25571,11 @@ paths:
|
|
23607
25571
|
description: 'Update the tag configuration of a metric or percentile aggregations
|
23608
25572
|
of a distribution metric or custom aggregations
|
23609
25573
|
|
23610
|
-
of a count, rate, or gauge metric.
|
25574
|
+
of a count, rate, or gauge metric. By setting `exclude_tags_mode` to true
|
25575
|
+
the behavior is changed
|
25576
|
+
|
25577
|
+
from an allow-list to a deny-list, and tags in the defined list will not be
|
25578
|
+
queryable.
|
23611
25579
|
|
23612
25580
|
Can only be used with application keys from users with the `Manage Tags for
|
23613
25581
|
Metrics` permission.'
|
@@ -23662,7 +25630,11 @@ paths:
|
|
23662
25630
|
Optionally, include percentile aggregations on any distribution metric or
|
23663
25631
|
configure custom aggregations
|
23664
25632
|
|
23665
|
-
on any count, rate, or gauge metric.
|
25633
|
+
on any count, rate, or gauge metric. By setting `exclude_tags_mode` to true
|
25634
|
+
the behavior is changed
|
25635
|
+
|
25636
|
+
from an allow-list to a deny-list, and tags in the defined list will not be
|
25637
|
+
queryable.
|
23666
25638
|
|
23667
25639
|
Can only be used with application keys of users with the `Manage Tags for
|
23668
25640
|
Metrics` permission.'
|
@@ -24161,6 +26133,54 @@ paths:
|
|
24161
26133
|
resultsPath: data
|
24162
26134
|
x-unstable: '**Note**: This endpoint is in public beta.
|
24163
26135
|
|
26136
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
26137
|
+
patch:
|
26138
|
+
description: Mute or unmute findings.
|
26139
|
+
operationId: MuteFindings
|
26140
|
+
requestBody:
|
26141
|
+
content:
|
26142
|
+
application/json:
|
26143
|
+
schema:
|
26144
|
+
$ref: '#/components/schemas/BulkMuteFindingsRequest'
|
26145
|
+
description: "### Attributes\n\nAll findings are updated with the same attributes.
|
26146
|
+
The request body must include at least two attributes: `muted` and `reason`.\nThe
|
26147
|
+
allowed reasons depend on whether the finding is being muted or unmuted:\n
|
26148
|
+
\ - To mute a finding: `PENDING_FIX`, `FALSE_POSITIVE`, `ACCEPTED_RISK`,
|
26149
|
+
`OTHER`.\n - To unmute a finding : `NO_PENDING_FIX`, `HUMAN_ERROR`, `NO_LONGER_ACCEPTED_RISK`,
|
26150
|
+
`OTHER`.\n\n### Meta\n\nThe request body must include a list of the finding
|
26151
|
+
IDs to be updated.\n"
|
26152
|
+
required: true
|
26153
|
+
responses:
|
26154
|
+
'200':
|
26155
|
+
content:
|
26156
|
+
application/json:
|
26157
|
+
schema:
|
26158
|
+
$ref: '#/components/schemas/BulkMuteFindingsResponse'
|
26159
|
+
description: OK
|
26160
|
+
'400':
|
26161
|
+
$ref: '#/components/responses/FindingsBadRequestResponse'
|
26162
|
+
'403':
|
26163
|
+
$ref: '#/components/responses/FindingsForbiddenResponse'
|
26164
|
+
'404':
|
26165
|
+
$ref: '#/components/responses/FindingsNotFoundResponse'
|
26166
|
+
'422':
|
26167
|
+
content:
|
26168
|
+
application/json:
|
26169
|
+
schema:
|
26170
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
26171
|
+
description: 'Invalid Request: The server understands the request syntax
|
26172
|
+
but cannot process it due to invalid data.'
|
26173
|
+
'429':
|
26174
|
+
$ref: '#/components/responses/FindingsTooManyRequestsResponse'
|
26175
|
+
security:
|
26176
|
+
- apiKeyAuth: []
|
26177
|
+
appKeyAuth: []
|
26178
|
+
summary: Mute or unmute a batch of findings
|
26179
|
+
tags:
|
26180
|
+
- Security Monitoring
|
26181
|
+
x-codegen-request-body-name: body
|
26182
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
26183
|
+
|
24164
26184
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
24165
26185
|
/api/v2/posture_management/findings/{finding_id}:
|
24166
26186
|
get:
|
@@ -24208,77 +26228,10 @@ paths:
|
|
24208
26228
|
x-unstable: '**Note**: This endpoint is in public beta.
|
24209
26229
|
|
24210
26230
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
24211
|
-
|
24212
|
-
|
24213
|
-
|
24214
|
-
|
24215
|
-
operationId: UpdateFinding
|
24216
|
-
parameters:
|
24217
|
-
- description: The ID of the finding.
|
24218
|
-
in: path
|
24219
|
-
name: finding_id
|
24220
|
-
required: true
|
24221
|
-
schema:
|
24222
|
-
type: string
|
24223
|
-
requestBody:
|
24224
|
-
content:
|
24225
|
-
application/json:
|
24226
|
-
schema:
|
24227
|
-
$ref: '#/components/schemas/MuteFindingRequest'
|
24228
|
-
description: 'To mute or unmute a finding, the request body should include
|
24229
|
-
at least two attributes: `muted` and `reason`. The allowed reasons depend
|
24230
|
-
on whether the finding is being muted or unmuted:
|
24231
|
-
|
24232
|
-
- To mute a finding: `PENDING_FIX`, `FALSE_POSITIVE`, `ACCEPTED_RISK`, `OTHER`.
|
24233
|
-
|
24234
|
-
- To unmute a finding : `NO_PENDING_FIX`, `HUMAN_ERROR`, `NO_LONGER_ACCEPTED_RISK`,
|
24235
|
-
`OTHER`.
|
24236
|
-
|
24237
|
-
'
|
24238
|
-
required: true
|
24239
|
-
responses:
|
24240
|
-
'200':
|
24241
|
-
content:
|
24242
|
-
application/json:
|
24243
|
-
schema:
|
24244
|
-
$ref: '#/components/schemas/MuteFindingResponse'
|
24245
|
-
description: OK
|
24246
|
-
'400':
|
24247
|
-
$ref: '#/components/responses/FindingsBadRequestResponse'
|
24248
|
-
'403':
|
24249
|
-
$ref: '#/components/responses/FindingsForbiddenResponse'
|
24250
|
-
'404':
|
24251
|
-
$ref: '#/components/responses/FindingsNotFoundResponse'
|
24252
|
-
'409':
|
24253
|
-
content:
|
24254
|
-
application/json:
|
24255
|
-
schema:
|
24256
|
-
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
24257
|
-
description: 'Resource Conflict: The finding has already been muted or unmuted
|
24258
|
-
within the last 60 seconds.'
|
24259
|
-
'422':
|
24260
|
-
content:
|
24261
|
-
application/json:
|
24262
|
-
schema:
|
24263
|
-
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
24264
|
-
description: 'Invalid Request: The server understands the request syntax
|
24265
|
-
but cannot process it due to invalid data.'
|
24266
|
-
'429':
|
24267
|
-
$ref: '#/components/responses/FindingsTooManyRequestsResponse'
|
24268
|
-
security:
|
24269
|
-
- apiKeyAuth: []
|
24270
|
-
appKeyAuth: []
|
24271
|
-
summary: Mute or unmute a finding
|
24272
|
-
tags:
|
24273
|
-
- Security Monitoring
|
24274
|
-
x-codegen-request-body-name: body
|
24275
|
-
x-unstable: '**Note**: This endpoint is in public beta.
|
24276
|
-
|
24277
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
24278
|
-
/api/v2/powerpacks:
|
24279
|
-
get:
|
24280
|
-
description: Get a list of all powerpacks.
|
24281
|
-
operationId: ListPowerpacks
|
26231
|
+
/api/v2/powerpacks:
|
26232
|
+
get:
|
26233
|
+
description: Get a list of all powerpacks.
|
26234
|
+
operationId: ListPowerpacks
|
24282
26235
|
parameters:
|
24283
26236
|
- description: Maximum number of powerpacks in the response.
|
24284
26237
|
example: 25
|
@@ -24774,6 +26727,12 @@ paths:
|
|
24774
26727
|
required: false
|
24775
26728
|
schema:
|
24776
26729
|
type: string
|
26730
|
+
- description: Filter all roles by the given list of role IDs.
|
26731
|
+
in: query
|
26732
|
+
name: filter[id]
|
26733
|
+
required: false
|
26734
|
+
schema:
|
26735
|
+
type: string
|
24777
26736
|
responses:
|
24778
26737
|
'200':
|
24779
26738
|
content:
|
@@ -25401,217 +27360,502 @@ paths:
|
|
25401
27360
|
content:
|
25402
27361
|
application/json:
|
25403
27362
|
schema:
|
25404
|
-
$ref: '#/components/schemas/RUMApplicationResponse'
|
27363
|
+
$ref: '#/components/schemas/RUMApplicationResponse'
|
27364
|
+
description: OK
|
27365
|
+
'404':
|
27366
|
+
$ref: '#/components/responses/NotFoundResponse'
|
27367
|
+
'429':
|
27368
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
27369
|
+
summary: Get a RUM application
|
27370
|
+
tags:
|
27371
|
+
- RUM
|
27372
|
+
patch:
|
27373
|
+
description: Update the RUM application with given ID in your organization.
|
27374
|
+
operationId: UpdateRUMApplication
|
27375
|
+
parameters:
|
27376
|
+
- description: RUM application ID.
|
27377
|
+
in: path
|
27378
|
+
name: id
|
27379
|
+
required: true
|
27380
|
+
schema:
|
27381
|
+
type: string
|
27382
|
+
requestBody:
|
27383
|
+
content:
|
27384
|
+
application/json:
|
27385
|
+
schema:
|
27386
|
+
$ref: '#/components/schemas/RUMApplicationUpdateRequest'
|
27387
|
+
required: true
|
27388
|
+
responses:
|
27389
|
+
'200':
|
27390
|
+
content:
|
27391
|
+
application/json:
|
27392
|
+
schema:
|
27393
|
+
$ref: '#/components/schemas/RUMApplicationResponse'
|
27394
|
+
description: OK
|
27395
|
+
'400':
|
27396
|
+
$ref: '#/components/responses/BadRequestResponse'
|
27397
|
+
'404':
|
27398
|
+
$ref: '#/components/responses/NotFoundResponse'
|
27399
|
+
'422':
|
27400
|
+
content:
|
27401
|
+
application/json:
|
27402
|
+
schema:
|
27403
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
27404
|
+
description: Unprocessable Entity.
|
27405
|
+
'429':
|
27406
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
27407
|
+
summary: Update a RUM application
|
27408
|
+
tags:
|
27409
|
+
- RUM
|
27410
|
+
x-codegen-request-body-name: body
|
27411
|
+
/api/v2/rum/events:
|
27412
|
+
get:
|
27413
|
+
description: 'List endpoint returns events that match a RUM search query.
|
27414
|
+
|
27415
|
+
[Results are paginated][1].
|
27416
|
+
|
27417
|
+
|
27418
|
+
Use this endpoint to see your latest RUM events.
|
27419
|
+
|
27420
|
+
|
27421
|
+
[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination'
|
27422
|
+
operationId: ListRUMEvents
|
27423
|
+
parameters:
|
27424
|
+
- description: Search query following RUM syntax.
|
27425
|
+
example: '@type:session @application_id:xxxx'
|
27426
|
+
in: query
|
27427
|
+
name: filter[query]
|
27428
|
+
required: false
|
27429
|
+
schema:
|
27430
|
+
type: string
|
27431
|
+
- description: Minimum timestamp for requested events.
|
27432
|
+
example: '2019-01-02T09:42:36.320Z'
|
27433
|
+
in: query
|
27434
|
+
name: filter[from]
|
27435
|
+
required: false
|
27436
|
+
schema:
|
27437
|
+
format: date-time
|
27438
|
+
type: string
|
27439
|
+
- description: Maximum timestamp for requested events.
|
27440
|
+
example: '2019-01-03T09:42:36.320Z'
|
27441
|
+
in: query
|
27442
|
+
name: filter[to]
|
27443
|
+
required: false
|
27444
|
+
schema:
|
27445
|
+
format: date-time
|
27446
|
+
type: string
|
27447
|
+
- description: Order of events in results.
|
27448
|
+
in: query
|
27449
|
+
name: sort
|
27450
|
+
required: false
|
27451
|
+
schema:
|
27452
|
+
$ref: '#/components/schemas/RUMSort'
|
27453
|
+
- description: List following results with a cursor provided in the previous
|
27454
|
+
query.
|
27455
|
+
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
27456
|
+
in: query
|
27457
|
+
name: page[cursor]
|
27458
|
+
required: false
|
27459
|
+
schema:
|
27460
|
+
type: string
|
27461
|
+
- description: Maximum number of events in the response.
|
27462
|
+
example: 25
|
27463
|
+
in: query
|
27464
|
+
name: page[limit]
|
27465
|
+
required: false
|
27466
|
+
schema:
|
27467
|
+
default: 10
|
27468
|
+
format: int32
|
27469
|
+
maximum: 1000
|
27470
|
+
type: integer
|
27471
|
+
responses:
|
27472
|
+
'200':
|
27473
|
+
content:
|
27474
|
+
application/json:
|
27475
|
+
schema:
|
27476
|
+
$ref: '#/components/schemas/RUMEventsResponse'
|
27477
|
+
description: OK
|
27478
|
+
'400':
|
27479
|
+
$ref: '#/components/responses/BadRequestResponse'
|
27480
|
+
'403':
|
27481
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
27482
|
+
'429':
|
27483
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
27484
|
+
security:
|
27485
|
+
- apiKeyAuth: []
|
27486
|
+
appKeyAuth: []
|
27487
|
+
- AuthZ: []
|
27488
|
+
summary: Get a list of RUM events
|
27489
|
+
tags:
|
27490
|
+
- RUM
|
27491
|
+
x-pagination:
|
27492
|
+
cursorParam: page[cursor]
|
27493
|
+
cursorPath: meta.page.after
|
27494
|
+
limitParam: page[limit]
|
27495
|
+
resultsPath: data
|
27496
|
+
/api/v2/rum/events/search:
|
27497
|
+
post:
|
27498
|
+
description: 'List endpoint returns RUM events that match a RUM search query.
|
27499
|
+
|
27500
|
+
[Results are paginated][1].
|
27501
|
+
|
27502
|
+
|
27503
|
+
Use this endpoint to build complex RUM events filtering and search.
|
27504
|
+
|
27505
|
+
|
27506
|
+
[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination'
|
27507
|
+
operationId: SearchRUMEvents
|
27508
|
+
requestBody:
|
27509
|
+
content:
|
27510
|
+
application/json:
|
27511
|
+
schema:
|
27512
|
+
$ref: '#/components/schemas/RUMSearchEventsRequest'
|
27513
|
+
required: true
|
27514
|
+
responses:
|
27515
|
+
'200':
|
27516
|
+
content:
|
27517
|
+
application/json:
|
27518
|
+
schema:
|
27519
|
+
$ref: '#/components/schemas/RUMEventsResponse'
|
27520
|
+
description: OK
|
27521
|
+
'400':
|
27522
|
+
$ref: '#/components/responses/BadRequestResponse'
|
27523
|
+
'403':
|
27524
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
27525
|
+
'429':
|
27526
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
27527
|
+
security:
|
27528
|
+
- apiKeyAuth: []
|
27529
|
+
appKeyAuth: []
|
27530
|
+
- AuthZ: []
|
27531
|
+
summary: Search RUM events
|
27532
|
+
tags:
|
27533
|
+
- RUM
|
27534
|
+
x-codegen-request-body-name: body
|
27535
|
+
x-pagination:
|
27536
|
+
cursorParam: body.page.cursor
|
27537
|
+
cursorPath: meta.page.after
|
27538
|
+
limitParam: body.page.limit
|
27539
|
+
resultsPath: data
|
27540
|
+
/api/v2/saml_configurations/idp_metadata:
|
27541
|
+
post:
|
27542
|
+
description: 'Endpoint for uploading IdP metadata for SAML setup.
|
27543
|
+
|
27544
|
+
|
27545
|
+
Use this endpoint to upload or replace IdP metadata for SAML login configuration.'
|
27546
|
+
operationId: UploadIdPMetadata
|
27547
|
+
requestBody:
|
27548
|
+
content:
|
27549
|
+
multipart/form-data:
|
27550
|
+
schema:
|
27551
|
+
$ref: '#/components/schemas/IdPMetadataFormData'
|
27552
|
+
required: true
|
27553
|
+
responses:
|
27554
|
+
'200':
|
27555
|
+
description: OK
|
27556
|
+
'400':
|
27557
|
+
content:
|
27558
|
+
application/json:
|
27559
|
+
schema:
|
27560
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
27561
|
+
description: Bad Request
|
27562
|
+
'403':
|
27563
|
+
content:
|
27564
|
+
application/json:
|
27565
|
+
schema:
|
27566
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
27567
|
+
description: Forbidden
|
27568
|
+
'429':
|
27569
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
27570
|
+
summary: Upload IdP metadata
|
27571
|
+
tags:
|
27572
|
+
- Organizations
|
27573
|
+
x-codegen-request-body-name: body
|
27574
|
+
/api/v2/scorecard/outcomes:
|
27575
|
+
get:
|
27576
|
+
description: Fetches all rule outcomes.
|
27577
|
+
operationId: ListScorecardOutcomes
|
27578
|
+
parameters:
|
27579
|
+
- $ref: '#/components/parameters/PageSize'
|
27580
|
+
- $ref: '#/components/parameters/PageOffset'
|
27581
|
+
- description: Include related rule details in the response.
|
27582
|
+
in: query
|
27583
|
+
name: include
|
27584
|
+
required: false
|
27585
|
+
schema:
|
27586
|
+
example: rule
|
27587
|
+
type: string
|
27588
|
+
- description: Return only specified values in the outcome attributes.
|
27589
|
+
in: query
|
27590
|
+
name: fields[outcome]
|
27591
|
+
required: false
|
27592
|
+
schema:
|
27593
|
+
example: state, service_name
|
27594
|
+
type: string
|
27595
|
+
- description: Return only specified values in the included rule details.
|
27596
|
+
in: query
|
27597
|
+
name: fields[rule]
|
27598
|
+
required: false
|
27599
|
+
schema:
|
27600
|
+
example: name
|
27601
|
+
type: string
|
27602
|
+
- description: Filter the outcomes on a specific service name.
|
27603
|
+
in: query
|
27604
|
+
name: filter[outcome][service_name]
|
27605
|
+
required: false
|
27606
|
+
schema:
|
27607
|
+
example: web-store
|
27608
|
+
type: string
|
27609
|
+
- description: Filter the outcomes by a specific state.
|
27610
|
+
in: query
|
27611
|
+
name: filter[outcome][state]
|
27612
|
+
required: false
|
27613
|
+
schema:
|
27614
|
+
example: fail
|
27615
|
+
type: string
|
27616
|
+
- description: Filter outcomes on whether a rule is enabled/disabled.
|
27617
|
+
in: query
|
27618
|
+
name: filter[rule][enabled]
|
27619
|
+
required: false
|
27620
|
+
schema:
|
27621
|
+
example: true
|
27622
|
+
type: boolean
|
27623
|
+
- description: Filter outcomes based on rule ID.
|
27624
|
+
in: query
|
27625
|
+
name: filter[rule][id]
|
27626
|
+
required: false
|
27627
|
+
schema:
|
27628
|
+
example: f4485c79-0762-449c-96cf-c31e54a659f6
|
27629
|
+
type: string
|
27630
|
+
- description: Filter outcomes based on rule name.
|
27631
|
+
in: query
|
27632
|
+
name: filter[rule][name]
|
27633
|
+
required: false
|
27634
|
+
schema:
|
27635
|
+
example: SLOs Defined
|
27636
|
+
type: string
|
27637
|
+
responses:
|
27638
|
+
'200':
|
27639
|
+
content:
|
27640
|
+
application/json:
|
27641
|
+
schema:
|
27642
|
+
$ref: '#/components/schemas/OutcomesResponse'
|
25405
27643
|
description: OK
|
25406
|
-
'
|
25407
|
-
$ref: '#/components/responses/
|
27644
|
+
'400':
|
27645
|
+
$ref: '#/components/responses/BadRequestResponse'
|
27646
|
+
'403':
|
27647
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
25408
27648
|
'429':
|
25409
27649
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
25410
|
-
|
27650
|
+
security:
|
27651
|
+
- apiKeyAuth: []
|
27652
|
+
appKeyAuth: []
|
27653
|
+
- AuthZ:
|
27654
|
+
- apm_service_catalog_read
|
27655
|
+
summary: List all rule outcomes
|
25411
27656
|
tags:
|
25412
|
-
-
|
25413
|
-
|
25414
|
-
|
25415
|
-
|
25416
|
-
|
25417
|
-
-
|
25418
|
-
|
25419
|
-
|
25420
|
-
|
25421
|
-
|
25422
|
-
|
27657
|
+
- Service Scorecards
|
27658
|
+
x-pagination:
|
27659
|
+
limitParam: page[size]
|
27660
|
+
pageOffsetParam: page[offset]
|
27661
|
+
resultsPath: data
|
27662
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
27663
|
+
|
27664
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
27665
|
+
/api/v2/scorecard/outcomes/batch:
|
27666
|
+
post:
|
27667
|
+
description: Sets multiple service-rule outcomes in a single batched request.
|
27668
|
+
operationId: CreateScorecardOutcomesBatch
|
25423
27669
|
requestBody:
|
25424
27670
|
content:
|
25425
27671
|
application/json:
|
25426
27672
|
schema:
|
25427
|
-
$ref: '#/components/schemas/
|
27673
|
+
$ref: '#/components/schemas/OutcomesBatchRequest'
|
27674
|
+
description: Set of scorecard outcomes.
|
25428
27675
|
required: true
|
25429
27676
|
responses:
|
25430
27677
|
'200':
|
25431
27678
|
content:
|
25432
27679
|
application/json:
|
25433
27680
|
schema:
|
25434
|
-
$ref: '#/components/schemas/
|
27681
|
+
$ref: '#/components/schemas/OutcomesBatchResponse'
|
25435
27682
|
description: OK
|
25436
27683
|
'400':
|
25437
27684
|
$ref: '#/components/responses/BadRequestResponse'
|
25438
|
-
'
|
25439
|
-
$ref: '#/components/responses/
|
25440
|
-
'422':
|
25441
|
-
content:
|
25442
|
-
application/json:
|
25443
|
-
schema:
|
25444
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
25445
|
-
description: Unprocessable Entity.
|
27685
|
+
'403':
|
27686
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
25446
27687
|
'429':
|
25447
27688
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
25448
|
-
|
27689
|
+
security:
|
27690
|
+
- apiKeyAuth: []
|
27691
|
+
appKeyAuth: []
|
27692
|
+
- AuthZ:
|
27693
|
+
- apm_service_catalog_write
|
27694
|
+
summary: Create outcomes batch
|
25449
27695
|
tags:
|
25450
|
-
-
|
27696
|
+
- Service Scorecards
|
25451
27697
|
x-codegen-request-body-name: body
|
25452
|
-
|
25453
|
-
|
25454
|
-
description: 'List endpoint returns events that match a RUM search query.
|
25455
|
-
|
25456
|
-
[Results are paginated][1].
|
25457
|
-
|
25458
|
-
|
25459
|
-
Use this endpoint to see your latest RUM events.
|
27698
|
+
x-unstable: '**Note**: This endpoint is in private beta. To request access,
|
27699
|
+
fill out this [sign-up form](https://forms.gle/CcEyp1uJmZpxRv8U8),
|
25460
27700
|
|
25461
|
-
|
25462
|
-
|
25463
|
-
|
27701
|
+
and we will be in touch. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
27702
|
+
/api/v2/scorecard/rules:
|
27703
|
+
get:
|
27704
|
+
description: Fetch all rules.
|
27705
|
+
operationId: ListScorecardRules
|
25464
27706
|
parameters:
|
25465
|
-
-
|
25466
|
-
|
27707
|
+
- $ref: '#/components/parameters/PageSize'
|
27708
|
+
- $ref: '#/components/parameters/PageOffset'
|
27709
|
+
- description: Include related scorecard details in the response.
|
25467
27710
|
in: query
|
25468
|
-
name:
|
27711
|
+
name: include
|
25469
27712
|
required: false
|
25470
27713
|
schema:
|
27714
|
+
example: scorecard
|
25471
27715
|
type: string
|
25472
|
-
- description:
|
25473
|
-
example: '2019-01-02T09:42:36.320Z'
|
27716
|
+
- description: Filter the rules on a rule ID.
|
25474
27717
|
in: query
|
25475
|
-
name: filter[
|
27718
|
+
name: filter[rule][id]
|
25476
27719
|
required: false
|
25477
27720
|
schema:
|
25478
|
-
|
27721
|
+
example: 37d2f990-c885-4972-949b-8b798213a166
|
25479
27722
|
type: string
|
25480
|
-
- description:
|
25481
|
-
example: '2019-01-03T09:42:36.320Z'
|
27723
|
+
- description: Filter for enabled rules only.
|
25482
27724
|
in: query
|
25483
|
-
name: filter[
|
27725
|
+
name: filter[rule][enabled]
|
25484
27726
|
required: false
|
25485
27727
|
schema:
|
25486
|
-
|
27728
|
+
example: true
|
27729
|
+
type: boolean
|
27730
|
+
- description: Filter for custom rules only.
|
27731
|
+
in: query
|
27732
|
+
name: filter[rule][custom]
|
27733
|
+
required: false
|
27734
|
+
schema:
|
27735
|
+
example: true
|
27736
|
+
type: boolean
|
27737
|
+
- description: Filter rules on the rule name.
|
27738
|
+
in: query
|
27739
|
+
name: filter[rule][name]
|
27740
|
+
required: false
|
27741
|
+
schema:
|
27742
|
+
example: Code Repos Defined
|
25487
27743
|
type: string
|
25488
|
-
- description:
|
27744
|
+
- description: Filter rules on the rule description.
|
25489
27745
|
in: query
|
25490
|
-
name:
|
27746
|
+
name: filter[rule][description]
|
25491
27747
|
required: false
|
25492
27748
|
schema:
|
25493
|
-
|
25494
|
-
|
25495
|
-
|
25496
|
-
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
27749
|
+
example: Identifying
|
27750
|
+
type: string
|
27751
|
+
- description: Return only specific fields in the response for rule attributes.
|
25497
27752
|
in: query
|
25498
|
-
name:
|
27753
|
+
name: fields[rule]
|
25499
27754
|
required: false
|
25500
27755
|
schema:
|
27756
|
+
example: name, description
|
25501
27757
|
type: string
|
25502
|
-
- description:
|
25503
|
-
|
27758
|
+
- description: Return only specific fields in the included response for scorecard
|
27759
|
+
attributes.
|
25504
27760
|
in: query
|
25505
|
-
name:
|
27761
|
+
name: fields[scorecard]
|
25506
27762
|
required: false
|
25507
27763
|
schema:
|
25508
|
-
|
25509
|
-
|
25510
|
-
maximum: 1000
|
25511
|
-
type: integer
|
27764
|
+
example: name
|
27765
|
+
type: string
|
25512
27766
|
responses:
|
25513
27767
|
'200':
|
25514
27768
|
content:
|
25515
27769
|
application/json:
|
25516
27770
|
schema:
|
25517
|
-
$ref: '#/components/schemas/
|
27771
|
+
$ref: '#/components/schemas/ListRulesResponse'
|
25518
27772
|
description: OK
|
25519
27773
|
'400':
|
25520
27774
|
$ref: '#/components/responses/BadRequestResponse'
|
25521
27775
|
'403':
|
25522
|
-
$ref: '#/components/responses/
|
27776
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
25523
27777
|
'429':
|
25524
27778
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
25525
27779
|
security:
|
25526
27780
|
- apiKeyAuth: []
|
25527
27781
|
appKeyAuth: []
|
25528
|
-
- AuthZ:
|
25529
|
-
|
27782
|
+
- AuthZ:
|
27783
|
+
- apm_service_catalog_read
|
27784
|
+
summary: List all rules
|
25530
27785
|
tags:
|
25531
|
-
-
|
27786
|
+
- Service Scorecards
|
25532
27787
|
x-pagination:
|
25533
|
-
|
25534
|
-
|
25535
|
-
limitParam: page[limit]
|
27788
|
+
limitParam: page[size]
|
27789
|
+
pageOffsetParam: page[offset]
|
25536
27790
|
resultsPath: data
|
25537
|
-
|
25538
|
-
post:
|
25539
|
-
description: 'List endpoint returns RUM events that match a RUM search query.
|
25540
|
-
|
25541
|
-
[Results are paginated][1].
|
25542
|
-
|
25543
|
-
|
25544
|
-
Use this endpoint to build complex RUM events filtering and search.
|
25545
|
-
|
27791
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
25546
27792
|
|
25547
|
-
[
|
25548
|
-
|
27793
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
27794
|
+
post:
|
27795
|
+
description: Creates a new rule.
|
27796
|
+
operationId: CreateScorecardRule
|
25549
27797
|
requestBody:
|
25550
27798
|
content:
|
25551
27799
|
application/json:
|
25552
27800
|
schema:
|
25553
|
-
$ref: '#/components/schemas/
|
27801
|
+
$ref: '#/components/schemas/CreateRuleRequest'
|
27802
|
+
description: Rule attributes.
|
25554
27803
|
required: true
|
25555
27804
|
responses:
|
25556
|
-
'
|
27805
|
+
'201':
|
25557
27806
|
content:
|
25558
27807
|
application/json:
|
25559
27808
|
schema:
|
25560
|
-
$ref: '#/components/schemas/
|
25561
|
-
description:
|
27809
|
+
$ref: '#/components/schemas/CreateRuleResponse'
|
27810
|
+
description: Created
|
25562
27811
|
'400':
|
25563
27812
|
$ref: '#/components/responses/BadRequestResponse'
|
25564
27813
|
'403':
|
25565
|
-
$ref: '#/components/responses/
|
27814
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
25566
27815
|
'429':
|
25567
27816
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
25568
27817
|
security:
|
25569
27818
|
- apiKeyAuth: []
|
25570
27819
|
appKeyAuth: []
|
25571
|
-
- AuthZ:
|
25572
|
-
|
27820
|
+
- AuthZ:
|
27821
|
+
- apm_service_catalog_write
|
27822
|
+
summary: Create a new rule
|
25573
27823
|
tags:
|
25574
|
-
-
|
27824
|
+
- Service Scorecards
|
25575
27825
|
x-codegen-request-body-name: body
|
25576
|
-
x-
|
25577
|
-
|
25578
|
-
cursorPath: meta.page.after
|
25579
|
-
limitParam: body.page.limit
|
25580
|
-
resultsPath: data
|
25581
|
-
/api/v2/saml_configurations/idp_metadata:
|
25582
|
-
post:
|
25583
|
-
description: 'Endpoint for uploading IdP metadata for SAML setup.
|
25584
|
-
|
27826
|
+
x-unstable: '**Note**: This endpoint is in private beta. To request access,
|
27827
|
+
fill out this [sign-up form](https://forms.gle/CcEyp1uJmZpxRv8U8),
|
25585
27828
|
|
25586
|
-
|
25587
|
-
|
25588
|
-
|
25589
|
-
|
25590
|
-
|
25591
|
-
|
25592
|
-
|
25593
|
-
required: true
|
27829
|
+
and we will be in touch. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
27830
|
+
/api/v2/scorecard/rules/{rule_id}:
|
27831
|
+
delete:
|
27832
|
+
description: Deletes a single rule.
|
27833
|
+
operationId: DeleteScorecardRule
|
27834
|
+
parameters:
|
27835
|
+
- $ref: '#/components/parameters/RuleId'
|
25594
27836
|
responses:
|
25595
|
-
'
|
27837
|
+
'204':
|
25596
27838
|
description: OK
|
25597
27839
|
'400':
|
25598
|
-
|
25599
|
-
application/json:
|
25600
|
-
schema:
|
25601
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
25602
|
-
description: Bad Request
|
27840
|
+
$ref: '#/components/responses/BadRequestResponse'
|
25603
27841
|
'403':
|
25604
|
-
|
25605
|
-
|
25606
|
-
|
25607
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
25608
|
-
description: Forbidden
|
27842
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
27843
|
+
'404':
|
27844
|
+
$ref: '#/components/responses/NotFoundResponse'
|
25609
27845
|
'429':
|
25610
27846
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
25611
|
-
|
27847
|
+
security:
|
27848
|
+
- apiKeyAuth: []
|
27849
|
+
appKeyAuth: []
|
27850
|
+
- AuthZ:
|
27851
|
+
- apm_service_catalog_write
|
27852
|
+
summary: Delete a rule
|
25612
27853
|
tags:
|
25613
|
-
-
|
25614
|
-
x-
|
27854
|
+
- Service Scorecards
|
27855
|
+
x-unstable: '**Note**: This endpoint is in private beta. To request access,
|
27856
|
+
fill out this [sign-up form](https://forms.gle/CcEyp1uJmZpxRv8U8),
|
27857
|
+
|
27858
|
+
and we will be in touch. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
25615
27859
|
/api/v2/security/cloud_workload/policy/download:
|
25616
27860
|
get:
|
25617
27861
|
description: 'The download endpoint generates a Cloud Workload Security policy
|
@@ -27494,12 +29738,14 @@ paths:
|
|
27494
29738
|
- description: Specifies the order of the returned teams
|
27495
29739
|
in: query
|
27496
29740
|
name: sort
|
29741
|
+
required: false
|
27497
29742
|
schema:
|
27498
29743
|
$ref: '#/components/schemas/ListTeamsSort'
|
27499
29744
|
- description: 'Included related resources optionally requested. Allowed enum
|
27500
29745
|
values: `team_links, user_team_permissions`'
|
27501
29746
|
in: query
|
27502
29747
|
name: include
|
29748
|
+
required: false
|
27503
29749
|
schema:
|
27504
29750
|
items:
|
27505
29751
|
$ref: '#/components/schemas/ListTeamsInclude'
|
@@ -27508,13 +29754,24 @@ paths:
|
|
27508
29754
|
member
|
27509
29755
|
in: query
|
27510
29756
|
name: filter[keyword]
|
29757
|
+
required: false
|
27511
29758
|
schema:
|
27512
29759
|
type: string
|
27513
29760
|
- description: When true, only returns teams the current user belongs to
|
27514
29761
|
in: query
|
27515
29762
|
name: filter[me]
|
29763
|
+
required: false
|
27516
29764
|
schema:
|
27517
29765
|
type: boolean
|
29766
|
+
- description: List of fields that need to be fetched.
|
29767
|
+
explode: false
|
29768
|
+
in: query
|
29769
|
+
name: fields[team]
|
29770
|
+
required: false
|
29771
|
+
schema:
|
29772
|
+
items:
|
29773
|
+
$ref: '#/components/schemas/TeamsField'
|
29774
|
+
type: array
|
27518
29775
|
responses:
|
27519
29776
|
'200':
|
27520
29777
|
content:
|
@@ -27929,11 +30186,13 @@ paths:
|
|
27929
30186
|
- description: Specifies the order of returned team memberships
|
27930
30187
|
in: query
|
27931
30188
|
name: sort
|
30189
|
+
required: false
|
27932
30190
|
schema:
|
27933
30191
|
$ref: '#/components/schemas/GetTeamMembershipsSort'
|
27934
30192
|
- description: Search query, can be user email or name
|
27935
30193
|
in: query
|
27936
30194
|
name: filter[keyword]
|
30195
|
+
required: false
|
27937
30196
|
schema:
|
27938
30197
|
type: string
|
27939
30198
|
responses:
|
@@ -28881,6 +31140,57 @@ paths:
|
|
28881
31140
|
summary: Get hourly usage for observability pipelines
|
28882
31141
|
tags:
|
28883
31142
|
- Usage Metering
|
31143
|
+
/api/v2/usage/projected_cost:
|
31144
|
+
get:
|
31145
|
+
description: 'Get projected cost across multi-org and single root-org accounts.
|
31146
|
+
|
31147
|
+
Projected cost data is only available for the current month and becomes available
|
31148
|
+
around the 12th of the month.
|
31149
|
+
|
31150
|
+
This endpoint requires the usage_read authorization scope.'
|
31151
|
+
operationId: GetProjectedCost
|
31152
|
+
parameters:
|
31153
|
+
- description: String to specify whether cost is broken down at a parent-org
|
31154
|
+
level or at the sub-org level. Available views are `summary` and `sub-org`.
|
31155
|
+
Defaults to `summary`.
|
31156
|
+
in: query
|
31157
|
+
name: view
|
31158
|
+
required: false
|
31159
|
+
schema:
|
31160
|
+
type: string
|
31161
|
+
responses:
|
31162
|
+
'200':
|
31163
|
+
content:
|
31164
|
+
application/json;datetime-format=rfc3339:
|
31165
|
+
schema:
|
31166
|
+
$ref: '#/components/schemas/ProjectedCostResponse'
|
31167
|
+
description: OK
|
31168
|
+
'400':
|
31169
|
+
content:
|
31170
|
+
application/json;datetime-format=rfc3339:
|
31171
|
+
schema:
|
31172
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
31173
|
+
description: Bad Request
|
31174
|
+
'403':
|
31175
|
+
content:
|
31176
|
+
application/json;datetime-format=rfc3339:
|
31177
|
+
schema:
|
31178
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
31179
|
+
description: Forbidden - User is not authorized
|
31180
|
+
'429':
|
31181
|
+
content:
|
31182
|
+
application/json;datetime-format=rfc3339:
|
31183
|
+
schema:
|
31184
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
31185
|
+
description: Too many requests
|
31186
|
+
security:
|
31187
|
+
- apiKeyAuth: []
|
31188
|
+
appKeyAuth: []
|
31189
|
+
- AuthZ:
|
31190
|
+
- usage_read
|
31191
|
+
summary: Get projected cost across your account
|
31192
|
+
tags:
|
31193
|
+
- Usage Metering
|
28884
31194
|
/api/v2/user_invitations:
|
28885
31195
|
post:
|
28886
31196
|
description: Sends emails to one or more users inviting them to join the organization.
|
@@ -29128,7 +31438,7 @@ paths:
|
|
29128
31438
|
application/json:
|
29129
31439
|
schema:
|
29130
31440
|
$ref: '#/components/schemas/UserResponse'
|
29131
|
-
description: OK
|
31441
|
+
description: OK
|
29132
31442
|
'403':
|
29133
31443
|
content:
|
29134
31444
|
application/json:
|
@@ -29384,6 +31694,10 @@ tags:
|
|
29384
31694
|
- description: The Container Images API allows you to query Container Image data for
|
29385
31695
|
your organization.
|
29386
31696
|
name: Container Images
|
31697
|
+
- description: The Containers API allows you to query container data for your organization.
|
31698
|
+
name: Containers
|
31699
|
+
- description: Send events for DORA Metrics to measure and improve software delivery.
|
31700
|
+
name: DORA Metrics
|
29387
31701
|
- description: 'Interact with your dashboard lists through the API to
|
29388
31702
|
|
29389
31703
|
organize, find, and share all of your dashboards with your team and
|
@@ -29493,6 +31807,9 @@ tags:
|
|
29493
31807
|
description: Find out more at
|
29494
31808
|
url: https://docs.datadoghq.com/monitors/create/types/
|
29495
31809
|
name: Monitors
|
31810
|
+
- description: Configure your Datadog Okta integration directly through the Datadog
|
31811
|
+
API.
|
31812
|
+
name: Okta Integration
|
29496
31813
|
- description: 'Configure your [Datadog Opsgenie integration](https://docs.datadoghq.com/integrations/opsgenie/)
|
29497
31814
|
|
29498
31815
|
directly through the Datadog API.'
|
@@ -29562,6 +31879,12 @@ tags:
|
|
29562
31879
|
externalDocs:
|
29563
31880
|
url: https://docs.datadoghq.com/tracing/service_catalog/
|
29564
31881
|
name: Service Definition
|
31882
|
+
- description: 'API to create, update scorecard rules and outcomes.
|
31883
|
+
|
31884
|
+
|
31885
|
+
This feature is currently in BETA. If you have any feedback, contact [Datadog
|
31886
|
+
support](https://docs.datadoghq.com/help/).'
|
31887
|
+
name: Service Scorecards
|
29565
31888
|
- description: Search and aggregate your spans from your Datadog platform over HTTP.
|
29566
31889
|
name: Spans
|
29567
31890
|
- description: Manage configuration of [span-based metrics](https://app.datadoghq.com/apm/traces/generate-metrics)
|