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 Names 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: Names
paths:
/api/v2/integration/ms-teams/configuration/channel/{tenant_name}/{team_name}/{channel_name}:
x-merge-override:
get: true
get:
description: Get the tenant, team, and channel ID of a channel in the Datadog Microsoft Teams integration.
operationId: GetChannelByName
parameters:
- $ref: '#/components/parameters/MicrosoftTeamsTenantNamePathParameter'
- $ref: '#/components/parameters/MicrosoftTeamsTeamNamePathParameter'
- $ref: '#/components/parameters/MicrosoftTeamsChannelNamePathParameter'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MicrosoftTeamsGetChannelByNameResponse'
description: OK
'400':
$ref: '#/components/responses/BadRequestResponse'
'403':
$ref: '#/components/responses/ForbiddenResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog Get Channel Information by Name
tags:
- Names
x-menu-order: 1
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/metrics/{metric_name}/all-tags:
get:
description: View indexed tag key-value pairs for a given metric name over the previous hour.
operationId: ListTagsByMetricName
parameters:
- $ref: '#/components/parameters/MetricName'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MetricAllTagsResponse'
description: Success
'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
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- metrics_read
summary: Datadog List Tags by Metric Name
tags:
- Names
x-menu-order: 6
x-permission:
operator: OR
permissions:
- metrics_read
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/metrics/{metric_name}/tags:
get:
description: Returns the tag configuration for the given metric name.
operationId: ListTagConfigurationByName
parameters:
- $ref: '#/components/parameters/MetricName'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MetricTagConfigurationResponse'
description: Success
'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
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- metrics_read
summary: Datadog List Tag Configuration by Name
tags:
- Names
x-menu-order: 2
x-permission:
operator: OR
permissions:
- metrics_read
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/metrics/{metric_name}/volumes:
get:
description: 'View distinct metrics volumes for the given metric name.
Custom metrics generated in-app from other products will return `null` for ingested volumes.'
operationId: ListVolumesByMetricName
parameters:
- $ref: '#/components/parameters/MetricName'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MetricVolumesResponse'
description: Success
'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 List Distinct Metric Volumes by Metric Name
tags:
- Names
x-menu-order: 8
x-permission:
operator: OPEN
permissions: []
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
MetricName:
description: The metric name for this resource.
example: test.metric.latency
type: string
MetricDistinctVolume:
description: Object for a single metric's distinct volume.
properties:
attributes:
$ref: '#/components/schemas/MetricDistinctVolumeAttributes'
id:
$ref: '#/components/schemas/MetricName'
type:
$ref: '#/components/schemas/MetricDistinctVolumeType'
type: object
MetricCustomAggregations:
description: Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.
example:
- space: sum
time: sum
- space: sum
time: count
items:
$ref: '#/components/schemas/MetricCustomAggregation'
type: array
MicrosoftTeamsGetChannelByNameResponse:
description: Response with channel, team, and tenant ID information.
properties:
data:
$ref: '#/components/schemas/MicrosoftTeamsChannelInfoResponseData'
type: object
MetricTagConfiguration:
description: Object for a single metric tag configuration.
example:
attributes:
aggregations:
- space: avg
time: avg
created_at: '2020-03-25T09:48:37.463835Z'
metric_type: gauge
modified_at: '2020-04-25T09:48:37.463835Z'
tags:
- app
- datacenter
id: http.request.latency
type: manage_tags
properties:
attributes:
$ref: '#/components/schemas/MetricTagConfigurationAttributes'
id:
$ref: '#/components/schemas/MetricName'
type:
$ref: '#/components/schemas/MetricTagConfigurationType'
type: object
MicrosoftTeamsChannelInfoResponseAttributes:
description: Channel attributes.
properties:
is_primary:
description: Indicates if this is the primary channel.
example: true
maxLength: 255
type: boolean
team_id:
description: Team id.
example: 00000000-0000-0000-0000-000000000000
maxLength: 255
type: string
tenant_id:
description: Tenant id.
example: 00000000-0000-0000-0000-000000000001
maxLength: 255
type: string
type: object
x-merge-override:
required: false
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
MetricCustomAggregation:
description: A time and space aggregation combination for use in query.
example:
space: sum
time: sum
properties:
space:
$ref: '#/components/schemas/MetricCustomSpaceAggregation'
time:
$ref: '#/components/schemas/MetricCustomTimeAggregation'
required:
- time
- space
type: object
MetricVolumes:
description: Possible response objects for a metric's volume.
oneOf:
- $ref: '#/components/schemas/MetricDistinctVolume'
- $ref: '#/components/schemas/MetricIngestedIndexedVolume'
MetricTagConfigurationAttributes:
description: Object containing the definition of a metric tag configuration attributes.
properties:
aggregations:
$ref: '#/components/schemas/MetricCustomAggregations'
created_at:
description: Timestamp when the tag configuration was created.
example: '2020-03-25T09:48:37.463835Z'
format: date-time
type: string
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. Requires `tags` property.'
type: boolean
example: true
include_percentiles:
description: 'Toggle to include or exclude percentile aggregations for distribution metrics.
Only present when the `metric_type` is `distribution`.'
example: true
type: boolean
metric_type:
$ref: '#/components/schemas/MetricTagConfigurationMetricTypes'
modified_at:
description: Timestamp when the tag configuration was last modified.
example: '2020-03-25T09:48:37.463835Z'
format: date-time
type: string
tags:
description: List of tag keys on which to group.
example:
- app
- datacenter
items:
description: Tag keys to group by.
type: string
type: array
type: object
MetricAllTagsResponse:
description: Response object that includes a single metric's indexed tags.
properties:
data:
$ref: '#/components/schemas/MetricAllTags'
readOnly: true
type: object
MetricTagConfigurationType:
default: manage_tags
description: The metric tag configuration resource type.
enum:
- manage_tags
example: manage_tags
type: string
x-enum-varnames:
- MANAGE_TAGS
MetricTagConfigurationResponse:
description: Response object which includes a single metric's tag configuration.
properties:
data:
$ref: '#/components/schemas/MetricTagConfiguration'
readOnly: true
type: object
MetricAllTagsAttributes:
description: Object containing the definition of a metric's tags.
properties:
tags:
description: List of indexed tag value pairs.
example:
- sport:golf
- sport:football
- animal:dog
items:
description: Tag key-value pairs.
type: string
type: array
type: object
MetricIngestedIndexedVolume:
description: Object for a single metric's ingested and indexed volume.
properties:
attributes:
$ref: '#/components/schemas/MetricIngestedIndexedVolumeAttributes'
id:
$ref: '#/components/schemas/MetricName'
type:
$ref: '#/components/schemas/MetricIngestedIndexedVolumeType'
type: object
MicrosoftTeamsChannelInfoType:
default: ms-teams-channel-info
description: Channel info resource type.
enum:
- ms-teams-channel-info
example: ms-teams-channel-info
type: string
x-enum-varnames:
- MS_TEAMS_CHANNEL_INFO
MicrosoftTeamsChannelInfoResponseData:
description: Channel data from a response.
properties:
attributes:
$ref: '#/components/schemas/MicrosoftTeamsChannelInfoResponseAttributes'
id:
description: The ID of the channel.
example: 19:b41k24b14bn1nwffkernfkwrnfneubgkr@thread.tacv2
maxLength: 255
minLength: 1
type: string
type:
$ref: '#/components/schemas/MicrosoftTeamsChannelInfoType'
type: object
x-merge-override:
required: false
MetricDistinctVolumeAttributes:
description: Object containing the definition of a metric's distinct volume.
properties:
distinct_volume:
description: Distinct volume for the given metric.
example: 10
format: int64
type: integer
type: object
MetricCustomSpaceAggregation:
description: A space aggregation for use in query.
enum:
- avg
- max
- min
- sum
example: sum
type: string
x-enum-varnames:
- AVG
- MAX
- MIN
- SUM
MetricDistinctVolumeType:
default: distinct_metric_volumes
description: The metric distinct volume type.
enum:
- distinct_metric_volumes
example: distinct_metric_volumes
type: string
x-enum-varnames:
- DISTINCT_METRIC_VOLUMES
MetricType:
default: metrics
description: The metric resource type.
enum:
- metrics
example: metrics
type: string
x-enum-varnames:
- METRICS
MetricVolumesResponse:
description: Response object which includes a single metric's volume.
properties:
data:
$ref: '#/components/schemas/MetricVolumes'
readOnly: true
type: object
MetricIngestedIndexedVolumeAttributes:
description: Object containing the definition of a metric's ingested and indexed volume.
properties:
indexed_volume:
description: Indexed volume for the given metric.
example: 10
format: int64
type: integer
ingested_volume:
description: Ingested volume for the given metric.
example: 20
format: int64
type: integer
type: object
MetricIngestedIndexedVolumeType:
default: metric_volumes
description: The metric ingested and indexed volume type.
enum:
- metric_volumes
example: metric_volumes
type: string
x-enum-varnames:
- METRIC_VOLUMES
MetricCustomTimeAggregation:
description: A time aggregation for use in query.
enum:
- avg
- count
- max
- min
- sum
example: sum
type: string
x-enum-varnames:
- AVG
- COUNT
- MAX
- MIN
- SUM
MetricAllTags:
description: Object for a single metric's indexed tags.
properties:
attributes:
$ref: '#/components/schemas/MetricAllTagsAttributes'
id:
$ref: '#/components/schemas/MetricName'
type:
$ref: '#/components/schemas/MetricType'
type: object
MetricTagConfigurationMetricTypes:
default: gauge
description: The metric's type.
enum:
- gauge
- count
- rate
- distribution
example: count
type: string
x-enum-varnames:
- GAUGE
- COUNT
- RATE
- DISTRIBUTION
parameters:
MetricName:
description: The name of the metric.
example: dist.http.endpoint.request
in: path
name: metric_name
required: true
schema:
type: string
MicrosoftTeamsTenantNamePathParameter:
description: Your tenant name.
in: path
name: tenant_name
required: true
schema:
type: string
MicrosoftTeamsChannelNamePathParameter:
description: Your channel name.
in: path
name: channel_name
required: true
schema:
type: string
MicrosoftTeamsTeamNamePathParameter:
description: Your team name.
in: path
name: team_name
required: true
schema:
type: string
responses:
TooManyRequestsResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
NotFoundResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Not Found
BadRequestResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
ForbiddenResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
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