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 Accounts 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: Accounts
paths:
/api/v2/csm/onboarding/coverage_analysis/cloud_accounts:
get:
description: 'Get the CSM Coverage Analysis of your Cloud Accounts.
This is calculated based on the number of your Cloud Accounts that are
scanned for security issues.'
operationId: GetCSMCloudAccountsCoverageAnalysis
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CsmCloudAccountsCoverageAnalysisResponse'
description: OK
'403':
$ref: '#/components/responses/NotAuthorizedResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog Get the Csm Cloud Accounts Coverage Analysis
tags:
- Accounts
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/integration/gcp/accounts:
x-merge-override:
get: false
post: false
get:
description: List all GCP STS-enabled service accounts configured in your Datadog account.
operationId: ListGCPSTSAccounts
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GCPSTSServiceAccountsResponse'
description: OK
'403':
$ref: '#/components/responses/NotAuthorizedResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog List All Gcp Sts-enabled Service Accounts
tags:
- Accounts
x-menu-order: 1
x-permission:
operator: OR
permissions:
- gcp_configuration_read
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/integrations/cloudflare/accounts:
x-merge-override:
get: true
get:
description: List Cloudflare accounts.
operationId: ListCloudflareAccounts
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CloudflareAccountsResponse'
description: OK
'400':
$ref: '#/components/responses/BadRequestResponse'
'403':
$ref: '#/components/responses/ForbiddenResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog List Cloudflare Accounts
tags:
- Accounts
x-menu-order: 1
x-permission:
operator: OR
permissions:
- integrations_read
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/integrations/confluent-cloud/accounts:
get:
description: List Confluent accounts.
operationId: ListConfluentAccount
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ConfluentAccountsResponse'
description: OK
'400':
$ref: '#/components/responses/BadRequestResponse'
'403':
$ref: '#/components/responses/ForbiddenResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog List Confluent Accounts
tags:
- Accounts
x-menu-order: 10
x-permission:
operator: OR
permissions:
- integrations_read
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/integrations/fastly/accounts:
x-merge-override:
get: true
get:
description: List Fastly accounts.
operationId: ListFastlyAccounts
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FastlyAccountsResponse'
description: OK
'400':
$ref: '#/components/responses/BadRequestResponse'
'403':
$ref: '#/components/responses/ForbiddenResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog List Fastly Accounts
tags:
- Accounts
x-menu-order: 1
x-permission:
operator: OR
permissions:
- integrations_read
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/integrations/okta/accounts:
x-merge-override:
get: true
get:
description: List Okta accounts.
operationId: ListOktaAccounts
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OktaAccountsResponse'
description: OK
'400':
$ref: '#/components/responses/BadRequestResponse'
'403':
$ref: '#/components/responses/ForbiddenResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog List Okta Accounts
tags:
- Accounts
x-menu-order: 1
x-permission:
operator: OR
permissions:
- integrations_read
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
FastlyService:
description: The schema representation of a Fastly service.
properties:
id:
description: The ID of the Fastly service
example: 6abc7de6893AbcDe9fghIj
type: string
tags:
description: A list of tags for the Fastly service.
example:
- myTag
- myTag2:myValue
items:
type: string
type: array
required:
- id
type: object
GCPMetricNamespaceConfig:
description: Configuration for a GCP metric namespace.
properties:
disabled:
default: false
description: When disabled, Datadog does not collect metrics that are related to this GCP metric namespace.
example: true
type: boolean
id:
description: The id of the GCP metric namespace.
example: aiplatform
type: string
type: object
CsmCloudAccountsCoverageAnalysisResponse:
description: CSM Cloud Accounts Coverage Analysis response.
properties:
data:
$ref: '#/components/schemas/CsmCloudAccountsCoverageAnalysisData'
type: object
GCPSTSServiceAccountsResponse:
description: Object containing all your STS enabled accounts.
properties:
data:
description: Array of GCP STS enabled service accounts.
items:
$ref: '#/components/schemas/GCPSTSServiceAccount'
type: array
type: object
GCPServiceAccountType:
default: gcp_service_account
description: The type of account.
enum:
- gcp_service_account
example: gcp_service_account
type: string
x-enum-varnames:
- GCP_SERVICE_ACCOUNT
CsmCloudAccountsCoverageAnalysisData:
description: CSM Cloud Accounts Coverage Analysis data.
properties:
attributes:
$ref: '#/components/schemas/CsmCloudAccountsCoverageAnalysisAttributes'
id:
description: The ID of your organization.
example: 66b3c6b5-5c9a-457e-b1c3-f247ca23afa3
type: string
type:
default: get_cloud_accounts_coverage_analysis_response_public_v0
description: The type of the resource. The value should always be `get_cloud_accounts_coverage_analysis_response_public_v0`.
example: get_cloud_accounts_coverage_analysis_response_public_v0
type: string
type: object
CloudflareAccountType:
default: cloudflare-accounts
description: The JSON:API type for this API. Should always be `cloudflare-accounts`.
enum:
- cloudflare-accounts
example: cloudflare-accounts
type: string
x-enum-varnames:
- CLOUDFLARE_ACCOUNTS
ConfluentAccountResponseData:
description: An API key and API secret pair that represents a Confluent account.
properties:
attributes:
$ref: '#/components/schemas/ConfluentAccountResponseAttributes'
id:
description: A randomly generated ID associated with a Confluent account.
example: account_id_abc123
type: string
type:
$ref: '#/components/schemas/ConfluentAccountType'
required:
- attributes
- id
- type
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
ConfluentResourceResponseAttributes:
description: Model representation of a Confluent Cloud resource.
properties:
enable_custom_metrics:
default: false
description: Enable the `custom.consumer_lag_offset` metric, which contains extra metric tags.
example: false
type: boolean
id:
description: The ID associated with the Confluent resource.
example: resource_id_abc123
type: string
resource_type:
description: The resource type of the Resource. Can be `kafka`, `connector`, `ksql`, or `schema_registry`.
example: kafka
type: string
tags:
description: A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon.
example:
- myTag
- myTag2:myValue
items:
type: string
type: array
required:
- resource_type
type: object
x-merge-override:
required: false
CloudflareAccountResponseAttributes:
description: Attributes object of a Cloudflare account.
properties:
email:
description: The email associated with the Cloudflare account.
example: test-email@example.com
type: string
name:
description: The name of the Cloudflare account.
example: test-name
type: string
resources:
description: An allowlist of resources, such as `web`, `dns`, `lb` (load balancer), `worker`, that restricts pulling metrics from those resources.
example:
- web
- dns
- lb
- worker
items:
type: string
type: array
zones:
description: An allowlist of zones to restrict pulling metrics for.
example:
- zone_id_1
- zone_id_2
items:
type: string
type: array
required:
- name
type: object
GCPServiceAccountMeta:
description: Additional information related to your service account.
properties:
accessible_projects:
description: The current list of projects accessible from your service account.
items:
description: List of GCP projects.
type: string
type: array
type: object
ConfluentAccountsResponse:
description: Confluent account returned by the API.
properties:
data:
description: The Confluent account.
items:
$ref: '#/components/schemas/ConfluentAccountResponseData'
type: array
type: object
ConfluentAccountResponseAttributes:
description: The attributes of a Confluent account.
properties:
api_key:
description: The API key associated with your Confluent account.
example: TESTAPIKEY123
type: string
resources:
description: A list of Confluent resources associated with the Confluent account.
items:
$ref: '#/components/schemas/ConfluentResourceResponseAttributes'
type: array
tags:
description: A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon.
example:
- myTag
- myTag2:myValue
items:
type: string
type: array
required:
- api_key
type: object
GCPSTSServiceAccount:
description: Info on your service account.
properties:
attributes:
$ref: '#/components/schemas/GCPSTSServiceAccountAttributes'
id:
description: Your service account's unique ID.
example: d291291f-12c2-22g4-j290-123456678897
type: string
meta:
$ref: '#/components/schemas/GCPServiceAccountMeta'
type:
$ref: '#/components/schemas/GCPServiceAccountType'
type: object
x-merge-override:
required: false
CloudflareAccountsResponse:
description: The expected response schema when getting Cloudflare accounts.
properties:
data:
description: The JSON:API data schema.
items:
$ref: '#/components/schemas/CloudflareAccountResponseData'
type: array
type: object
CsmCoverageAnalysis:
description: CSM Coverage Analysis.
properties:
configured_resources_count:
description: The number of fully configured resources.
example: 8
format: int64
type: integer
coverage:
description: The coverage percentage.
example: 0.8
format: double
type: number
partially_configured_resources_count:
description: The number of partially configured resources.
example: 0
format: int64
type: integer
total_resources_count:
description: The total number of resources.
example: 10
format: int64
type: integer
type: object
OktaAccountsResponse:
description: The expected response schema when getting Okta accounts.
properties:
data:
description: List of Okta accounts.
items:
$ref: '#/components/schemas/OktaAccountResponseData'
type: array
type: object
CloudflareAccountResponseData:
description: Data object of a Cloudflare account.
properties:
attributes:
$ref: '#/components/schemas/CloudflareAccountResponseAttributes'
id:
description: The ID of the Cloudflare account, a hash of the account name.
example: c1a8e059bfd1e911cf10b626340c9a54
type: string
type:
$ref: '#/components/schemas/CloudflareAccountType'
required:
- attributes
- id
- type
type: object
x-merge-override:
required: false
FastlyAccountsResponse:
description: The expected response schema when getting Fastly accounts.
properties:
data:
description: The JSON:API data schema.
items:
$ref: '#/components/schemas/FastlyAccountResponseData'
type: array
type: object
FastlyAccounResponseAttributes:
description: Attributes object of a Fastly account.
properties:
name:
description: The name of the Fastly account.
example: test-name
type: string
services:
description: A list of services belonging to the parent account.
items:
$ref: '#/components/schemas/FastlyService'
type: array
required:
- name
type: object
OktaAccountType:
default: okta-accounts
description: Account type for an Okta account.
enum:
- okta-accounts
example: okta-accounts
type: string
x-enum-varnames:
- OKTA_ACCOUNTS
OktaAccountAttributes:
description: Attributes object for an Okta account.
properties:
api_key:
description: The API key of the Okta account.
type: string
writeOnly: true
example: example_value
auth_method:
description: The authorization method for an Okta account.
example: oauth
type: string
client_id:
description: The Client ID of an Okta app integration.
type: string
example: abc-123-def
client_secret:
description: The client secret of an Okta app integration.
type: string
writeOnly: true
example: example_value
domain:
description: The domain of the Okta account.
example: https://example.okta.com/
type: string
name:
description: The name of the Okta account.
example: Okta-Prod
type: string
required:
- auth_method
- domain
- name
type: object
FastlyAccountResponseData:
description: Data object of a Fastly account.
properties:
attributes:
$ref: '#/components/schemas/FastlyAccounResponseAttributes'
id:
description: The ID of the Fastly account, a hash of the account name.
example: abc123
type: string
type:
$ref: '#/components/schemas/FastlyAccountType'
required:
- attributes
- id
- type
type: object
x-merge-override:
required: false
GCPSTSServiceAccountAttributes:
description: Attributes associated with your service account.
properties:
account_tags:
description: Tags to be associated with GCP metrics and service checks from your account.
items:
description: Account Level Tag
type: string
type: array
automute:
description: Silence monitors for expected GCE instance shutdowns.
type: boolean
example: true
client_email:
description: Your service account email address.
example: datadog-service-account@test-project.iam.gserviceaccount.com
type: string
cloud_run_revision_filters:
description: 'List of filters to limit the Cloud Run revisions that are pulled into Datadog by using tags.
Only Cloud Run revision resources that apply to specified filters are imported into Datadog.'
example:
- $KEY:$VALUE
items:
description: Cloud Run Filters
type: string
type: array
host_filters:
description: Your Host Filters.
items:
description: Host Filters
type: string
type: array
is_cspm_enabled:
description: 'When enabled, Datadog will activate the Cloud Security Monitoring product for this service account. Note: This requires resource_collection_enabled to be set to true.'
type: boolean
example: true
is_per_project_quota_enabled:
default: false
description: When enabled, Datadog applies the `X-Goog-User-Project` header, attributing Google Cloud billing and quota usage to the project being monitored rather than the default service account project.
example: true
type: boolean
is_resource_change_collection_enabled:
default: false
description: When enabled, Datadog scans for all resource change data in your Google Cloud environment.
example: true
type: boolean
is_security_command_center_enabled:
default: false
description: 'When enabled, Datadog will attempt to collect Security Command Center Findings. Note: This requires additional permissions on the service account.'
example: true
type: boolean
metric_namespace_configs:
description: Configurations for GCP metric namespaces.
example:
- disabled: true
id: aiplatform
items:
$ref: '#/components/schemas/GCPMetricNamespaceConfig'
type: array
resource_collection_enabled:
description: When enabled, Datadog scans for all resources in your GCP environment.
type: boolean
example: true
type: object
x-merge-override:
required: false
OktaAccountResponseData:
description: Data object of an Okta account
properties:
attributes:
$ref: '#/components/schemas/OktaAccountAttributes'
id:
description: The ID of the Okta account, a UUID hash of the account name.
example: f749daaf-682e-4208-a38d-c9b43162c609
type: string
type:
$ref: '#/components/schemas/OktaAccountType'
required:
- attributes
- id
- type
type: object
x-merge-override:
required: false
ConfluentAccountType:
default: confluent-cloud-accounts
description: The JSON:API type for this API. Should always be `confluent-cloud-accounts`.
enum:
- confluent-cloud-accounts
example: confluent-cloud-accounts
type: string
x-enum-varnames:
- CONFLUENT_CLOUD_ACCOUNTS
CsmCloudAccountsCoverageAnalysisAttributes:
description: CSM Cloud Accounts Coverage Analysis attributes.
properties:
aws_coverage:
$ref: '#/components/schemas/CsmCoverageAnalysis'
azure_coverage:
$ref: '#/components/schemas/CsmCoverageAnalysis'
gcp_coverage:
$ref: '#/components/schemas/CsmCoverageAnalysis'
org_id:
description: The ID of your organization.
example: 123456
format: int64
type: integer
total_coverage:
$ref: '#/components/schemas/CsmCoverageAnalysis'
type: object
FastlyAccountType:
default: fastly-accounts
description: The JSON:API type for this API. Should always be `fastly-accounts`.
enum:
- fastly-accounts
example: fastly-accounts
type: string
x-enum-varnames:
- FASTLY_ACCOUNTS
responses:
NotAuthorizedResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Not Authorized
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