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 Given 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: Given
paths:
/api/v2/apm/config/retention-filters/{filter_id}:
get:
description: Get an APM retention filter.
operationId: GetApmRetentionFilter
parameters:
- $ref: '#/components/parameters/RetentionFilterIdParam'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RetentionFilterResponse'
description: OK
'403':
$ref: '#/components/responses/NotAuthorizedResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog Get a Given Apm Retention Filter
tags:
- Given
x-menu-order: 3
x-permission:
operator: OR
permissions:
- apm_retention_filter_read
- apm_pipelines_read
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/logs/config/restriction_queries/role/{role_id}:
get:
description: Get restriction query for a given role.
operationId: GetRoleRestrictionQuery
parameters:
- $ref: '#/components/parameters/RestrictionQueryRoleID'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RestrictionQueryListResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog Get Restriction Query for a Given Role
tags:
- Given
x-menu-order: 10
x-permission:
operator: OR
permissions:
- logs_read_config
x-undo:
type: safe
x-unstable: '**Note**: This endpoint is in public beta.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/logs/config/restriction_queries/user/{user_id}:
get:
description: Get all restriction queries for a given user.
operationId: ListUserRestrictionQueries
parameters:
- $ref: '#/components/parameters/RestrictionQueryUserID'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RestrictionQueryListResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog Get All Restriction Queries for a Given User
tags:
- Given
x-menu-order: 9
x-permission:
operator: OR
permissions:
- logs_read_config
x-undo:
type: safe
x-unstable: '**Note**: This endpoint is in public beta.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
RetentionFilterAllAttributes:
description: The attributes of the retention filter.
properties:
created_at:
description: The creation timestamp of the retention filter.
format: int64
type: integer
example: 42
created_by:
description: The creator of the retention filter.
type: string
example: example_value
editable:
description: Shows whether the filter can be edited.
example: true
type: boolean
enabled:
description: The status of the retention filter (Enabled/Disabled).
example: true
type: boolean
execution_order:
description: The execution order of the retention filter.
format: int64
type: integer
example: 42
filter:
$ref: '#/components/schemas/SpansFilter'
filter_type:
$ref: '#/components/schemas/RetentionFilterAllType'
modified_at:
description: The modification timestamp of the retention filter.
format: int64
type: integer
example: 42
modified_by:
description: The modifier of the retention filter.
type: string
example: example_value
name:
description: The name of the retention filter.
example: my retention filter
type: string
rate:
description: 'Sample rate to apply to spans going through this retention filter.
A value of 1.0 keeps all spans matching the query.'
example: 1
format: double
type: number
trace_rate:
description: 'Sample rate to apply to traces containing spans going through this retention filter.
A value of 1.0 keeps all traces with spans matching the query.'
example: 1
format: double
type: number
type: object
RetentionFilterAllType:
default: spans-sampling-processor
description: The type of retention filter.
enum:
- spans-sampling-processor
- spans-errors-sampling-processor
- spans-appsec-sampling-processor
example: spans-sampling-processor
type: string
x-enum-varnames:
- SPANS_SAMPLING_PROCESSOR
- SPANS_ERRORS_SAMPLING_PROCESSOR
- SPANS_APPSEC_SAMPLING_PROCESSOR
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
RestrictionQueryWithoutRelationships:
description: Restriction query object returned by the API.
properties:
attributes:
$ref: '#/components/schemas/RestrictionQueryAttributes'
id:
description: ID of the restriction query.
example: 79a0e60a-644a-11ea-ad29-43329f7f58b5
type: string
type:
default: logs_restriction_queries
description: Restriction queries type.
example: logs_restriction_queries
readOnly: true
type: string
type: object
RetentionFilterAll:
description: The definition of the retention filter.
properties:
attributes:
$ref: '#/components/schemas/RetentionFilterAllAttributes'
id:
description: The ID of the retention filter.
example: 7RBOb7dLSYWI01yc3pIH8w
type: string
type:
$ref: '#/components/schemas/ApmRetentionFilterType'
required:
- id
- type
- attributes
type: object
RetentionFilterResponse:
description: The retention filters definition.
properties:
data:
$ref: '#/components/schemas/RetentionFilterAll'
type: object
ApmRetentionFilterType:
default: apm_retention_filter
description: The type of the resource.
enum:
- apm_retention_filter
example: apm_retention_filter
type: string
x-enum-varnames:
- apm_retention_filter
RestrictionQueryAttributes:
description: Attributes of the restriction query.
properties:
created_at:
description: Creation time of the restriction query.
example: '2020-03-17T21:06:44.000Z'
format: date-time
readOnly: true
type: string
modified_at:
description: Time of last restriction query modification.
example: '2020-03-17T21:15:15.000Z'
format: date-time
readOnly: true
type: string
restriction_query:
description: The query that defines the restriction. Only the content matching the query can be returned.
example: env:sandbox
type: string
type: object
SpansFilter:
description: The spans filter used to index spans.
properties:
query:
description: The search query - following the [span search syntax](https://docs.datadoghq.com/tracing/trace_explorer/query_syntax/).
example: '@http.status_code:200 service:my-service'
type: string
type: object
RestrictionQueryListResponse:
description: Response containing information about multiple restriction queries.
properties:
data:
description: Array of returned restriction queries.
items:
$ref: '#/components/schemas/RestrictionQueryWithoutRelationships'
type: array
type: object
responses:
TooManyRequestsResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
NotAuthorizedResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Not Authorized
NotFoundResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Not Found
parameters:
RetentionFilterIdParam:
description: The ID of the retention filter.
in: path
name: filter_id
required: true
schema:
type: string
RestrictionQueryRoleID:
description: The ID of the role.
in: path
name: role_id
required: true
schema:
type: string
RestrictionQueryUserID:
description: The ID of the user.
in: path
name: user_id
required: true
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