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 Audit 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:
- description: Search your Audit Logs events over HTTP.
name: Audit
paths:
/api/v2/audit/events:
get:
description: 'List endpoint returns events that match a Audit Logs search query.
[Results are paginated][1].
Use this endpoint to see your latest Audit Logs events.
[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination'
operationId: ListAuditLogs
parameters:
- description: Search query following Audit Logs syntax.
example: '@type:session @application_id:xxxx'
in: query
name: filter[query]
required: false
schema:
type: string
- description: Minimum timestamp for requested events.
example: '2019-01-02T09:42:36.320Z'
in: query
name: filter[from]
required: false
schema:
format: date-time
type: string
- description: Maximum timestamp for requested events.
example: '2019-01-03T09:42:36.320Z'
in: query
name: filter[to]
required: false
schema:
format: date-time
type: string
- description: Order of events in results.
in: query
name: sort
required: false
schema:
$ref: '#/components/schemas/AuditLogsSort'
example: example_value
- description: List following results with a cursor provided in the previous query.
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
in: query
name: page[cursor]
required: false
schema:
type: string
- description: Maximum number of events in the response.
example: 25
in: query
name: page[limit]
required: false
schema:
default: 10
format: int32
maximum: 1000
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AuditLogsEventsResponse'
description: OK
'400':
$ref: '#/components/responses/BadRequestResponse'
'403':
$ref: '#/components/responses/NotAuthorizedResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog Get a List of Audit Logs Events
tags:
- Audit
x-menu-order: 2
x-pagination:
cursorParam: page[cursor]
cursorPath: meta.page.after
limitParam: page[limit]
resultsPath: data
x-permission:
operator: OR
permissions:
- audit_logs_read
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/audit/events/search:
post:
description: 'List endpoint returns Audit Logs events that match an Audit search query.
[Results are paginated][1].
Use this endpoint to build complex Audit Logs events filtering and search.
[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination'
operationId: SearchAuditLogs
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AuditLogsSearchEventsRequest'
required: false
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AuditLogsEventsResponse'
description: OK
'400':
$ref: '#/components/responses/BadRequestResponse'
'403':
$ref: '#/components/responses/NotAuthorizedResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog Search Audit Logs Events
tags:
- Audit
x-codegen-request-body-name: body
x-menu-order: 1
x-pagination:
cursorParam: body.page.cursor
cursorPath: meta.page.after
limitParam: body.page.limit
resultsPath: data
x-permission:
operator: OR
permissions:
- audit_logs_read
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
AuditLogsResponseLinks:
description: Links attributes.
properties:
next:
description: 'Link for the next set of results. Note that the request can also be made using the
POST endpoint.'
example: https://app.datadoghq.com/api/v2/audit/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
type: string
type: object
AuditLogsQueryOptions:
description: 'Global query options that are used during the query.
Note: Specify either timezone or time offset, not both. Otherwise, the query fails.'
properties:
time_offset:
description: Time offset (in seconds) to apply to the query.
format: int64
type: integer
example: 42
timezone:
default: UTC
description: The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York).
example: GMT
type: string
type: object
AuditLogsResponseStatus:
description: The status of the response.
enum:
- done
- timeout
example: done
type: string
x-enum-varnames:
- DONE
- TIMEOUT
AuditLogsQueryFilter:
description: Search and filter query settings.
properties:
from:
default: now-15m
description: Minimum time for the requested events. Supports date, math, and regular timestamps (in milliseconds).
example: now-15m
type: string
query:
default: '*'
description: Search query following the Audit Logs search syntax.
example: '@type:session AND @session.type:user'
type: string
to:
default: now
description: Maximum time for the requested events. Supports date, math, and regular timestamps (in milliseconds).
example: now
type: string
type: object
AuditLogsResponsePage:
description: Paging attributes.
properties:
after:
description: The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of `page[cursor]`.
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
type: string
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
AuditLogsEventType:
default: audit
description: Type of the event.
enum:
- audit
example: audit
type: string
x-enum-varnames:
- Audit
AuditLogsQueryPageOptions:
description: Paging attributes for listing events.
properties:
cursor:
description: List following results with a cursor provided in the previous query.
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
type: string
limit:
default: 10
description: Maximum number of events in the response.
example: 25
format: int32
maximum: 1000
type: integer
type: object
AuditLogsEvent:
description: Object description of an Audit Logs event after it is processed and stored by Datadog.
properties:
attributes:
$ref: '#/components/schemas/AuditLogsEventAttributes'
id:
description: Unique ID of the event.
example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA
type: string
type:
$ref: '#/components/schemas/AuditLogsEventType'
type: object
AuditLogsSearchEventsRequest:
description: The request for a Audit Logs events list.
properties:
filter:
$ref: '#/components/schemas/AuditLogsQueryFilter'
options:
$ref: '#/components/schemas/AuditLogsQueryOptions'
page:
$ref: '#/components/schemas/AuditLogsQueryPageOptions'
sort:
$ref: '#/components/schemas/AuditLogsSort'
type: object
AuditLogsEventsResponse:
description: Response object with all events matching the request and pagination information.
properties:
data:
description: Array of events matching the request.
items:
$ref: '#/components/schemas/AuditLogsEvent'
type: array
links:
$ref: '#/components/schemas/AuditLogsResponseLinks'
meta:
$ref: '#/components/schemas/AuditLogsResponseMetadata'
type: object
AuditLogsWarning:
description: Warning message indicating something that went wrong with the query.
properties:
code:
description: Unique code for this type of warning.
example: unknown_index
type: string
detail:
description: Detailed explanation of this specific warning.
example: 'indexes: foo, bar'
type: string
title:
description: Short human-readable summary of the warning.
example: One or several indexes are missing or invalid, results hold data from the other indexes
type: string
type: object
AuditLogsEventAttributes:
description: JSON object containing all event attributes and their associated values.
properties:
attributes:
additionalProperties: {}
description: JSON object of attributes from Audit Logs events.
example:
customAttribute: 123
duration: 2345
type: object
message:
description: Message of the event.
type: string
example: CPU usage is high on {{host.name}}
service:
description: 'Name of the application or service generating Audit Logs events.
This name is used to correlate Audit Logs to APM, so make sure you specify the same
value when you use both products.'
example: web-app
type: string
tags:
description: Array of tags associated with your event.
example:
- team:A
items:
description: Tag associated with your event.
type: string
type: array
timestamp:
description: Timestamp of your event.
example: '2019-01-02T09:42:36.320Z'
format: date-time
type: string
type: object
AuditLogsSort:
description: Sort parameters when querying events.
enum:
- timestamp
- -timestamp
type: string
x-enum-varnames:
- TIMESTAMP_ASCENDING
- TIMESTAMP_DESCENDING
AuditLogsResponseMetadata:
description: The metadata associated with a request.
properties:
elapsed:
description: Time elapsed in milliseconds.
example: 132
format: int64
type: integer
page:
$ref: '#/components/schemas/AuditLogsResponsePage'
request_id:
description: The identifier of the request.
example: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR
type: string
status:
$ref: '#/components/schemas/AuditLogsResponseStatus'
warnings:
description: 'A list of warnings (non-fatal errors) encountered. Partial results may return if
warnings are present in the response.'
items:
$ref: '#/components/schemas/AuditLogsWarning'
type: array
type: object
responses:
BadRequestResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
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
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