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 Metric Tags 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: Metric Tags
description: Manage metric tag configurations
paths:
/api/v2/metrics/{metric_name}/tags:
get:
operationId: getMetricTagConfiguration
summary: Datadog List Tags by Metric Name
description: Returns the tag configuration for a specified metric including all configured tag keys, aggregation types, and exclude percentiles setting. Only available for custom metrics with tag configurations.
tags:
- Metric Tags
parameters:
- $ref: '#/components/parameters/metricNameParam'
responses:
'200':
description: Successful response with metric tag configuration
content:
application/json:
schema:
$ref: '#/components/schemas/MetricTagConfigurationResponse'
'401':
description: Unauthorized - missing or invalid API key
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
'403':
description: Forbidden - insufficient permissions for this operation
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
'404':
description: Not found - metric does not exist or has no tag configuration
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
operationId: createMetricTagConfiguration
summary: Datadog Create a Tag Configuration
description: Creates a tag configuration for a specified custom metric. Allows specifying which tag keys to include, the metric type, whether to exclude percentile aggregations, and aggregation settings. Tag configurations reduce the number of custom metrics by limiting which tag combinations are stored.
tags:
- Metric Tags
parameters:
- $ref: '#/components/parameters/metricNameParam'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MetricTagConfigurationCreateRequest'
responses:
'201':
description: Created - tag configuration created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/MetricTagConfigurationResponse'
'400':
description: Bad request - invalid tag configuration parameters
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
'401':
description: Unauthorized - missing or invalid API key
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
'403':
description: Forbidden - insufficient permissions for this operation
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
'409':
description: Conflict - tag configuration already exists for this metric
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
patch:
operationId: updateMetricTagConfiguration
summary: Datadog Update a Tag Configuration
description: Updates the tag configuration for a specified custom metric. Supports partial updates using JSON merge patch semantics. Allows changing the set of tag keys, aggregation types, and exclude percentiles settings.
tags:
- Metric Tags
parameters:
- $ref: '#/components/parameters/metricNameParam'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MetricTagConfigurationUpdateRequest'
responses:
'200':
description: Successful response with updated tag configuration
content:
application/json:
schema:
$ref: '#/components/schemas/MetricTagConfigurationResponse'
'400':
description: Bad request - invalid tag configuration parameters
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
'401':
description: Unauthorized - missing or invalid API key
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
'403':
description: Forbidden - insufficient permissions for this operation
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
'404':
description: Not found - metric tag configuration does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
operationId: deleteMetricTagConfiguration
summary: Datadog Delete a Tag Configuration
description: Deletes the tag configuration for a specified custom metric. After deletion, all tag combinations for the metric will be stored again, which may increase custom metric usage. This action cannot be undone.
tags:
- Metric Tags
parameters:
- $ref: '#/components/parameters/metricNameParam'
responses:
'204':
description: No content - tag configuration deleted successfully
'401':
description: Unauthorized - missing or invalid API key
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
'403':
description: Forbidden - insufficient permissions for this operation
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
'404':
description: Not found - metric tag configuration does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
MetricTagConfigurationResponse:
type: object
description: Response wrapper for a metric tag configuration
properties:
data:
$ref: '#/components/schemas/MetricTagConfiguration'
APIErrorResponse:
type: object
description: Standard API error response returned for failed requests
required:
- errors
properties:
errors:
type: array
description: List of error messages describing the failure
items:
type: string
MetricTagConfigurationUpdateRequest:
type: object
description: Request body for updating an existing metric tag configuration
required:
- data
properties:
data:
type: object
description: The tag configuration data to update
required:
- type
- id
- attributes
properties:
type:
type: string
description: The resource type identifier
enum:
- manage_tags
id:
type: string
description: The metric name of the tag configuration to update
attributes:
type: object
description: The tag configuration attributes to update
properties:
tags:
type: array
description: Updated list of tag keys to include when storing metric data
items:
type: string
include_percentiles:
type: boolean
description: Whether to include percentile aggregations (only for distribution metrics)
MetricTagConfiguration:
type: object
description: The tag configuration for a custom metric
properties:
id:
type: string
description: The metric name that this tag configuration applies to
example: abc-123-def
type:
type: string
description: The resource type identifier
enum:
- manage_tags
example: manage_tags
attributes:
type: object
description: The tag configuration attributes
properties:
tags:
type: array
description: List of tag keys to include when storing this metric
items:
type: string
metric_type:
type: string
description: The type of metric this configuration applies to
enum:
- gauge
- count
- rate
- distribution
include_percentiles:
type: boolean
description: Whether to include percentile aggregations for distribution metrics
aggregations:
type: array
description: List of aggregation types to compute for this metric
items:
type: object
properties:
space:
type: string
description: The spatial aggregation type
enum:
- avg
- max
- min
- sum
time:
type: string
description: The temporal aggregation type
enum:
- avg
- count
- max
- min
- sum
created_at:
type: string
format: date-time
description: ISO 8601 timestamp when this tag configuration was created
modified_at:
type: string
format: date-time
description: ISO 8601 timestamp when this tag configuration was last modified
MetricTagConfigurationCreateRequest:
type: object
description: Request body for creating a new metric tag configuration
required:
- data
properties:
data:
type: object
description: The tag configuration data to create
required:
- type
- id
- attributes
properties:
type:
type: string
description: The resource type identifier
enum:
- manage_tags
id:
type: string
description: The metric name to create the tag configuration for
attributes:
type: object
description: The tag configuration attributes to set
required:
- metric_type
- tags
properties:
metric_type:
type: string
description: The type of the metric
enum:
- gauge
- count
- rate
- distribution
tags:
type: array
description: List of tag keys to include when storing metric data
items:
type: string
include_percentiles:
type: boolean
description: Whether to include percentile aggregations (only for distribution metrics)
parameters:
metricNameParam:
name: metric_name
in: path
required: true
description: The name of the metric to manage tag configuration for (e.g., system.cpu.user)
schema:
type: string
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