openapi: 3.0.0
info:
contact:
email: support@datadoghq.com
name: Datadog Support
url: https://www.datadoghq.com/support/
description: The Datadog API is an HTTP REST API. The API uses resource-oriented URLs to call the API, uses status codes to indicate the success or failure of requests, returns JSON from all requests, and uses standard HTTP response codes. Use the Datadog API to access the Datadog platform programmatically.
title: Datadog Account Configure API
version: '1.0'
servers:
- url: https://{subdomain}.{site}
variables:
site:
default: datadoghq.com
description: The regional site for Datadog customers.
enum:
- datadoghq.com
- us3.datadoghq.com
- us5.datadoghq.com
- ap1.datadoghq.com
- datadoghq.eu
- ddog-gov.com
subdomain:
default: api
description: The subdomain where the API is deployed.
- url: '{protocol}://{name}'
variables:
name:
default: api.datadoghq.com
description: Full site DNS name.
protocol:
default: https
description: The protocol for accessing the API.
- url: https://{subdomain}.{site}
variables:
site:
default: datadoghq.com
description: Any Datadog deployment.
subdomain:
default: api
description: The subdomain where the API is deployed.
security:
- apiKeyAuth: []
appKeyAuth: []
tags:
- name: Configure
paths:
/api/v2/metrics/config/bulk-tags:
x-merge-override:
delete: false
post:
description: 'Create and define a list of queryable tag keys for a set of existing count, gauge, rate, and distribution metrics.
Metrics are selected by passing a metric name prefix. Use the Delete method of this API path to remove tag configurations.
Results can be sent to a set of account email addresses, just like the same operation in the Datadog web app.
If multiple calls include the same metric, the last configuration applied (not by submit order) is used, do not
expect deterministic ordering of concurrent calls. The `exclude_tags_mode` value will set all metrics that match the prefix to
the same exclusion state, metric tag configurations do not support mixed inclusion and exclusion for tags on the same metric.
Can only be used with application keys of users with the `Manage Tags for Metrics` permission.'
operationId: CreateBulkTagsMetricsConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MetricBulkTagConfigCreateRequest'
required: true
responses:
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/MetricBulkTagConfigResponse'
description: Accepted
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Not Found
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Too Many Requests
summary: Datadog Configure Tags for Multiple Metrics
tags:
- Configure
x-codegen-request-body-name: body
x-menu-order: 9
x-permission:
operator: OR
permissions:
- metric_tags_write
x-undo:
operationId: DeleteBulkTagsMetricsConfiguration
parameters:
- name: body
template: "{\n \"data\": {\n \"id\":\"{{ data.id }}\",\n \"type\":\"metric_bulk_configure_tags\",\n \"attributes\": {\n \"emails\": [\"{{ data.attributes.emails[0] }}\"]\n }\n }\n}"
type: unsafe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
MetricBulkTagConfigCreateRequest:
description: Wrapper object for a single bulk tag configuration request.
properties:
data:
$ref: '#/components/schemas/MetricBulkTagConfigCreate'
required:
- data
type: object
MetricBulkTagConfigCreate:
description: Request object to bulk configure tags for metrics matching the given prefix.
properties:
attributes:
$ref: '#/components/schemas/MetricBulkTagConfigCreateAttributes'
id:
$ref: '#/components/schemas/MetricBulkTagConfigNamePrefix'
type:
$ref: '#/components/schemas/MetricBulkConfigureTagsType'
required:
- id
- type
type: object
APIErrorResponse:
description: API error response.
properties:
errors:
description: A list of errors.
example:
- Bad Request
items:
description: A list of items.
example: Bad Request
type: string
type: array
required:
- errors
type: object
MetricBulkTagConfigStatus:
description: 'The status of a request to bulk configure metric tags.
It contains the fields from the original request for reference.'
properties:
attributes:
$ref: '#/components/schemas/MetricBulkTagConfigStatusAttributes'
id:
$ref: '#/components/schemas/MetricBulkTagConfigNamePrefix'
type:
$ref: '#/components/schemas/MetricBulkConfigureTagsType'
required:
- id
- type
type: object
MetricBulkTagConfigResponse:
description: Wrapper for a single bulk tag configuration status response.
properties:
data:
$ref: '#/components/schemas/MetricBulkTagConfigStatus'
type: object
MetricBulkConfigureTagsType:
default: metric_bulk_configure_tags
description: The metric bulk configure tags resource.
enum:
- metric_bulk_configure_tags
example: metric_bulk_configure_tags
type: string
x-enum-varnames:
- BULK_MANAGE_TAGS
MetricBulkTagConfigEmailList:
description: A list of account emails to notify when the configuration is applied.
example:
- sue@example.com
- bob@example.com
items:
description: An email address.
type: string
type: array
MetricBulkTagConfigNamePrefix:
description: A text prefix to match against metric names.
example: kafka.lag
type: string
MetricBulkTagConfigTagNameList:
description: A list of tag names to apply to the configuration.
example:
- host
- pod_name
- is_shadow
items:
description: A metric tag name.
maxLength: 200
pattern: ^[A-Za-z][A-Za-z0-9\.\-\_:\/]*$
type: string
type: array
MetricBulkTagConfigStatusAttributes:
description: Optional attributes for the status of a bulk tag configuration request.
properties:
emails:
$ref: '#/components/schemas/MetricBulkTagConfigEmailList'
exclude_tags_mode:
description: 'When set to true, the configuration will exclude the configured tags and include any other submitted tags.
When set to false, the configuration will include the configured tags and exclude any other submitted tags.'
type: boolean
example: true
status:
description: The status of the request.
example: Accepted
type: string
tags:
$ref: '#/components/schemas/MetricBulkTagConfigTagNameList'
type: object
MetricBulkTagConfigCreateAttributes:
description: Optional parameters for bulk creating metric tag configurations.
properties:
emails:
$ref: '#/components/schemas/MetricBulkTagConfigEmailList'
exclude_tags_mode:
description: 'When set to true, the configuration will exclude the configured tags and include any other submitted tags.
When set to false, the configuration will include the configured tags and exclude any other submitted tags.
Defaults to false.'
type: boolean
example: true
include_actively_queried_tags_window:
description: 'When provided, all tags that have been actively queried are
configured (and, therefore, remain queryable) for each metric that
matches the given prefix. Minimum value is 1 second, and maximum
value is 7,776,000 seconds (90 days).'
format: double
maximum: 7776000
minimum: 1
type: number
example: 95.5
override_existing_configurations:
description: 'When set to true, the configuration overrides any existing
configurations for the given metric with the new set of tags in this
configuration request. If false, old configurations are kept and
are merged with the set of tags in this configuration request.
Defaults to true.'
type: boolean
example: true
tags:
$ref: '#/components/schemas/MetricBulkTagConfigTagNameList'
type: object
securitySchemes:
AuthZ:
description: This API uses OAuth 2 with the implicit grant flow.
flows:
authorizationCode:
authorizationUrl: /oauth2/v1/authorize
scopes:
apm_api_catalog_read: View API catalog and API definitions.
apm_api_catalog_write: Add, modify, and delete API catalog definitions.
apm_read: Read and query APM and Trace Analytics.
apm_service_catalog_read: View service catalog and service definitions.
apm_service_catalog_write: Add, modify, and delete service catalog definitions when those definitions are maintained by Datadog.
appsec_vm_read: View infrastructure, application code, and library vulnerabilities. This does not restrict API or inventory SQL access to the vulnerability data source.
cases_read: View Cases.
cases_write: Create and update cases.
ci_visibility_pipelines_write: Create CI Visibility pipeline spans using the API.
ci_visibility_read: View CI Visibility.
cloud_cost_management_read: View Cloud Cost pages and the cloud cost data source in dashboards and notebooks. For more details, see the Cloud Cost Management docs.
cloud_cost_management_write: Configure cloud cost accounts and global customizations. For more details, see the Cloud Cost Management docs.
code_analysis_read: View Code Analysis.
continuous_profiler_pgo_read: Read and query Continuous Profiler data for Profile-Guided Optimization (PGO).
create_webhooks: Create webhooks integrations.
dashboards_embed_share: Create, modify, and delete shared dashboards with share type 'embed'.
dashboards_invite_share: Create, modify, and delete shared dashboards with share type 'invite'.
dashboards_public_share: Generate public and authenticated links to share dashboards or embeddable graphs externally.
dashboards_read: View dashboards.
dashboards_write: Create and change dashboards.
data_scanner_read: View Data Scanner configurations.
data_scanner_write: Edit Data Scanner configurations.
embeddable_graphs_share: Generate public links to share embeddable graphs externally.
events_read: Read Events data.
hosts_read: List hosts and their attributes.
incident_notification_settings_write: Configure Incidents Notification settings.
incident_read: View incidents in Datadog.
incident_settings_write: Configure Incident Settings.
incident_write: Create, view, and manage incidents in Datadog.
metrics_read: View custom metrics.
monitor_config_policy_write: Edit and delete monitor configuration.
monitors_downtime: Set downtimes to suppress alerts from any monitor in an organization. Mute and unmute monitors. The ability to write monitors is not required to set downtimes.
monitors_read: View monitors.
monitors_write: Edit, delete, and resolve individual monitors.
org_management: Edit org configurations, including authentication and certain security preferences such as configuring SAML, renaming an org, configuring allowed login methods, creating child orgs, subscribing & unsubscribing from apps in the marketplace, and enabling & disabling Remote Configuration for the entire organization.
security_comments_read: Read comments of vulnerabilities.
security_monitoring_filters_read: Read Security Filters.
security_monitoring_filters_write: Create, edit, and delete Security Filters.
security_monitoring_findings_read: View a list of findings that include both misconfigurations and identity risks.
security_monitoring_notification_profiles_read: View Rule Security Notification rules.
security_monitoring_notification_profiles_write: Create, edit, and delete Security Notification rules.
security_monitoring_rules_read: Read Detection Rules.
security_monitoring_rules_write: Create and edit Detection Rules.
security_monitoring_signals_read: View Security Signals.
security_monitoring_suppressions_read: Read Rule Suppressions.
security_monitoring_suppressions_write: Write Rule Suppressions.
security_pipelines_read: View Security Pipelines.
security_pipelines_write: Create, edit, and delete CSM Security Pipelines.
slos_corrections: Apply, edit, and delete SLO status corrections. A user with this permission can make status corrections, even if they do not have permission to edit those SLOs.
slos_read: View SLOs and status corrections.
slos_write: Create, edit, and delete SLOs.
synthetics_global_variable_read: View, search, and use Synthetics global variables.
synthetics_global_variable_write: Create, edit, and delete global variables for Synthetics.
synthetics_private_location_read: View, search, and use Synthetics private locations.
synthetics_private_location_write: Create and delete private locations in addition to having access to the associated installation guidelines.
synthetics_read: List and view configured Synthetic tests and test results.
synthetics_write: Create, edit, and delete Synthetic tests.
teams_manage: Manage Teams. Create, delete, rename, and edit metadata of all Teams. To control Team membership across all Teams, use the User Access Manage permission.
teams_read: Read Teams data. A User with this permission can view Team names, metadata, and which Users are on each Team.
test_optimization_read: View Test Optimization.
timeseries_query: Query Timeseries data.
usage_read: View your organization's usage and usage attribution.
user_access_invite: Invite other users to your organization.
user_access_manage: Disable users, manage user roles, manage SAML-to-role mappings, and configure logs restriction queries.
user_access_read: View users and their roles and settings.
workflows_read: View workflows.
workflows_run: Run workflows.
workflows_write: Create, edit, and delete workflows.
tokenUrl: /oauth2/v1/token
type: oauth2
apiKeyAuth:
description: Your Datadog API Key.
in: header
name: DD-API-KEY
type: apiKey
x-env-name: DD_API_KEY
appKeyAuth:
description: Your Datadog APP Key.
in: header
name: DD-APPLICATION-KEY
type: apiKey
x-env-name: DD_APP_KEY
bearerAuth:
scheme: bearer
type: http
x-env-name: DD_BEARER_TOKEN
x-group-parameters: true
x-merge-override:
paths: false