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 All 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: All
paths:
/api/v2/api_keys:
x-merge-override:
post: true
get:
description: List all API keys available for your account.
operationId: ListAPIKeys
parameters:
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageNumber'
- $ref: '#/components/parameters/APIKeysSortParameter'
- $ref: '#/components/parameters/APIKeyFilterParameter'
- $ref: '#/components/parameters/APIKeyFilterCreatedAtStartParameter'
- $ref: '#/components/parameters/APIKeyFilterCreatedAtEndParameter'
- $ref: '#/components/parameters/APIKeyFilterModifiedAtStartParameter'
- $ref: '#/components/parameters/APIKeyFilterModifiedAtEndParameter'
- $ref: '#/components/parameters/APIKeyIncludeParameter'
- $ref: '#/components/parameters/APIKeyReadConfigReadEnabledParameter'
- $ref: '#/components/parameters/APIKeyCategoryParameter'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/APIKeysResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog Get All Api Keys
tags:
- All
x-menu-order: 5
x-permission:
operator: OR
permissions:
- api_keys_read
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/apm/config/metrics:
get:
description: Get the list of configured span-based metrics with their definitions.
operationId: ListSpansMetrics
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SpansMetricsResponse'
description: OK
'403':
$ref: '#/components/responses/NotAuthorizedResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog Get All Span-based Metrics
tags:
- All
x-menu-order: 1
x-permission:
operator: OR
permissions:
- apm_read
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/apm/config/retention-filters:
get:
description: Get the list of APM retention filters.
operationId: ListApmRetentionFilters
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RetentionFiltersResponse'
description: OK
'403':
$ref: '#/components/responses/NotAuthorizedResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog List All Apm Retention Filters
tags:
- All
x-menu-order: 1
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/application_keys:
get:
description: List all application keys available for your org
operationId: ListApplicationKeys
parameters:
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageNumber'
- $ref: '#/components/parameters/ApplicationKeysSortParameter'
- $ref: '#/components/parameters/ApplicationKeyFilterParameter'
- $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtStartParameter'
- $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtEndParameter'
- $ref: '#/components/parameters/ApplicationKeyIncludeParameter'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListApplicationKeysResponse'
description: OK
'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':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog Get All Application Keys
tags:
- All
x-menu-order: 9
x-permission:
operator: OR
permissions:
- org_app_keys_read
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/authn_mappings:
x-merge-override:
get: false
post: false
get:
description: List all AuthN Mappings in the org.
operationId: ListAuthNMappings
parameters:
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageNumber'
- description: Sort AuthN Mappings depending on the given field.
in: query
name: sort
required: false
schema:
$ref: '#/components/schemas/AuthNMappingsSort'
example: example_value
- description: Filter all mappings by the given string.
in: query
name: filter
required: false
schema:
type: string
example: example_value
- description: Filter by mapping resource type. Defaults to "role" if not specified.
in: query
name: resource_type
schema:
$ref: '#/components/schemas/AuthNMappingResourceType'
example: metric alert
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AuthNMappingsResponse'
description: OK
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog List All Authn Mappings
tags:
- All
x-menu-order: 4
x-permission:
operator: OPEN
permissions: []
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/cases/projects:
get:
description: Get all projects.
operationId: GetProjects
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectsResponse'
description: OK
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'403':
$ref: '#/components/responses/ForbiddenResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- cases_read
summary: Datadog Get All Projects
tags:
- All
x-menu-order: 2
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/container_images:
get:
description: Get all Container Images for your organization.
operationId: ListContainerImages
parameters:
- description: Comma-separated list of tags to filter Container Images by.
example: short_image:redis,status:running
in: query
name: filter[tags]
required: false
schema:
type: string
- description: Comma-separated list of tags to group Container Images by.
example: registry,image_tags
in: query
name: group_by
required: false
schema:
type: string
- description: Attribute to sort Container Images by.
example: container_count
in: query
name: sort
required: false
schema:
type: string
- description: Maximum number of results returned.
in: query
name: page[size]
required: false
schema:
default: 1000
format: int32
maximum: 10000
minimum: 1
type: integer
example: 42
- description: 'String to query the next page of results.
This key is provided with each valid response from the API in `meta.pagination.next_cursor`.'
in: query
name: page[cursor]
required: false
schema:
type: string
example: example_value
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ContainerImagesResponse'
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'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ: []
summary: Datadog Get All Container Images
tags:
- All
x-menu-order: 1
x-pagination:
cursorParam: page[cursor]
cursorPath: meta.pagination.next_cursor
limitParam: page[size]
resultsPath: data
x-permission:
operator: OPEN
permissions: []
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/containers:
get:
description: Get all containers for your organization.
operationId: ListContainers
parameters:
- description: Comma-separated list of tags to filter containers by.
example: env:prod,short_image:cassandra
in: query
name: filter[tags]
required: false
schema:
type: string
- description: Comma-separated list of tags to group containers by.
example: datacenter,cluster
in: query
name: group_by
required: false
schema:
type: string
- description: Attribute to sort containers by.
example: started_at
in: query
name: sort
required: false
schema:
type: string
- description: Maximum number of results returned.
in: query
name: page[size]
required: false
schema:
default: 1000
format: int32
maximum: 10000
minimum: 1
type: integer
example: 42
- description: 'String to query the next page of results.
This key is provided with each valid response from the API in `meta.pagination.next_cursor`.'
in: query
name: page[cursor]
required: false
schema:
type: string
example: example_value
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ContainersResponse'
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'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ: []
summary: Datadog Get All Containers
tags:
- All
x-menu-order: 1
x-pagination:
cursorParam: page[cursor]
cursorPath: meta.pagination.next_cursor
limitParam: page[size]
resultsPath: data
x-permission:
operator: OPEN
permissions: []
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/csm/onboarding/agents:
get:
description: Get the list of all CSM Agents running on your hosts and containers.
operationId: ListAllCSMAgents
parameters:
- description: The page index for pagination (zero-based).
in: query
name: page
required: false
schema:
example: 2
format: int32
maximum: 1000000
minimum: 0
type: integer
example: 2
- description: The number of items to include in a single page.
in: query
name: size
required: false
schema:
example: 12
format: int32
maximum: 100
minimum: 0
type: integer
example: 12
- description: A search query string to filter results (for example, `hostname:COMP-T2H4J27423`).
in: query
name: query
required: false
schema:
example: hostname:COMP-T2H4J27423
type: string
example: hostname:COMP-T2H4J27423
- description: The sort direction for results. Use `asc` for ascending or `desc` for descending.
in: query
name: order_direction
required: false
schema:
$ref: '#/components/schemas/OrderDirection'
example: example_value
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CsmAgentsResponse'
description: OK
'403':
$ref: '#/components/responses/NotAuthorizedResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog Get All Csm Agents
tags:
- All
x-menu-order: 3
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/csm/onboarding/serverless/agents:
get:
description: Get the list of all CSM Serverless Agents running on your hosts and containers.
operationId: ListAllCSMServerlessAgents
parameters:
- description: The page index for pagination (zero-based).
in: query
name: page
required: false
schema:
example: 2
format: int32
maximum: 1000000
minimum: 0
type: integer
example: 2
- description: The number of items to include in a single page.
in: query
name: size
required: false
schema:
example: 12
format: int32
maximum: 100
minimum: 0
type: integer
example: 12
- description: A search query string to filter results (for example, `hostname:COMP-T2H4J27423`).
in: query
name: query
required: false
schema:
example: hostname:COMP-T2H4J27423
type: string
example: hostname:COMP-T2H4J27423
- description: The sort direction for results. Use `asc` for ascending or `desc` for descending.
in: query
name: order_direction
required: false
schema:
$ref: '#/components/schemas/OrderDirection'
example: example_value
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CsmAgentsResponse'
description: OK
'403':
$ref: '#/components/responses/NotAuthorizedResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog Get All Csm Serverless Agents
tags:
- All
x-menu-order: 3
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/current_user/application_keys:
get:
description: List all application keys available for current user
operationId: ListCurrentUserApplicationKeys
parameters:
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageNumber'
- $ref: '#/components/parameters/ApplicationKeysSortParameter'
- $ref: '#/components/parameters/ApplicationKeyFilterParameter'
- $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtStartParameter'
- $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtEndParameter'
- $ref: '#/components/parameters/ApplicationKeyIncludeParameter'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListApplicationKeysResponse'
description: OK
'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':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog Get All Application Keys Owned by Current User
tags:
- All
x-menu-order: 5
x-permission:
operator: OR
permissions:
- user_app_keys
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/downtime:
get:
description: Get all scheduled downtimes.
operationId: ListDowntimes
parameters:
- description: Only return downtimes that are active when the request is made.
in: query
name: current_only
required: false
schema:
type: boolean
example: true
- description: 'Comma-separated list of resource paths for related resources to include in the response. Supported resource
paths are `created_by` and `monitor`.'
in: query
name: include
required: false
schema:
example: created_by,monitor
type: string
example: created_by,monitor
- $ref: '#/components/parameters/PageOffset'
- description: Maximum number of downtimes in the response.
example: 100
in: query
name: page[limit]
required: false
schema:
default: 30
format: int64
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListDowntimesResponse'
description: OK
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- monitors_downtime
summary: Datadog Get All Downtimes
tags:
- All
x-menu-order: 1
x-pagination:
limitParam: page[limit]
pageOffsetParam: page[offset]
resultsPath: data
x-permission:
operator: OR
permissions:
- monitors_downtime
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/integration/aws/accounts:
get:
description: Get a list of AWS Account Integration Configs.
operationId: ListAWSAccounts
parameters:
- description: Optional query parameter to filter accounts by AWS Account ID. If not provided, all accounts are returned.
example: '123456789012'
in: query
name: aws_account_id
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AWSAccountsResponse'
description: AWS Accounts List object
'403':
$ref: '#/components/responses/ForbiddenResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog List All Aws Integrations
tags:
- All
x-menu-order: 1
x-permission:
operator: OR
permissions:
- aws_configuration_read
x-undo:
type: safe
x-unstable: '**Note: This endpoint is in Preview. 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/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:
- All
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/integration/ms-teams/configuration/tenant-based-handles:
x-merge-override:
get: true
post: true
get:
description: Get a list of all tenant-based handles from the Datadog Microsoft Teams integration.
operationId: ListTenantBasedHandles
parameters:
- $ref: '#/components/parameters/MicrosoftTeamsTenantIDQueryParameter'
- $ref: '#/components/parameters/MicrosoftTeamsHandleNameQueryParameter'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandlesResponse'
description: OK
'400':
$ref: '#/components/responses/BadRequestResponse'
'403':
$ref: '#/components/responses/ForbiddenResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'412':
$ref: '#/components/responses/PreconditionFailedResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog Get All Tenant-based Handles
tags:
- All
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/ms-teams/configuration/workflows-webhook-handles:
get:
description: Get a list of all Workflows webhook handles from the Datadog Microsoft Teams integration.
operationId: ListWorkflowsWebhookHandles
parameters:
- $ref: '#/components/parameters/MicrosoftTeamsWorkflowsWebhookHandleNameQueryParameter'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandlesResponse'
description: OK
'400':
$ref: '#/components/responses/BadRequestResponse'
'403':
$ref: '#/components/responses/ForbiddenResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'412':
$ref: '#/components/responses/PreconditionFailedResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog Get All Workflows Webhook Handles
tags:
- All
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/opsgenie/services:
x-merge-override:
get: true
post: true
get:
description: Get a list of all services from the Datadog Opsgenie integration.
operationId: ListOpsgenieServices
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OpsgenieServicesResponse'
description: OK
'403':
$ref: '#/components/responses/ForbiddenResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog Get All Service Objects
tags:
- All
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/logs/config/archives:
get:
description: Get the list of configured logs archives with their definitions.
operationId: ListLogsArchives
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LogsArchives'
description: OK
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog Get All Archives
tags:
- All
x-menu-order: 1
x-permission:
operator: OR
permissions:
- logs_read_archives
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/logs/config/custom-destinations:
get:
description: Get the list of configured custom destinations in your organization with their definitions.
operationId: ListLogsCustomDestinations
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomDestinationsResponse'
description: OK
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog Get All Custom Destinations
tags:
- All
x-menu-order: 1
x-permission:
operator: OR
permissions:
- logs_read_data
- logs_read_config
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/logs/config/metrics:
get:
description: Get the list of configured log-based metrics with their definitions.
operationId: ListLogsMetrics
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LogsMetricsResponse'
description: OK
'403':
$ref: '#/components/responses/NotAuthorizedResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog Get All Log-based Metrics
tags:
- All
x-menu-order: 1
x-permission:
operator: OR
permissions:
- logs_read_config
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/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:
- All
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
/api/v2/monitor/notification_rule:
get:
description: Returns a list of all monitor notification rules.
operationId: GetMonitorNotificationRules
parameters:
- description: 'Comma-separated list of resource paths for related resources to include in the response. Supported resource
path is `created_by`.'
in: query
name: include
required: false
schema:
example: created_by
type: string
example: created_by
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MonitorNotificationRuleListResponse'
description: OK
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- monitors_read
summary: Datadog Get All Monitor Notification Rules
tags:
- All
x-menu-order: 15
x-permission:
operator: OR
permissions:
- monitors_read
x-undo:
type: safe
x-unstable: '**Note**: This endpoint is in Preview. 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/monitor/policy:
get:
description: Get all monitor configuration policies.
operationId: ListMonitorConfigPolicies
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MonitorConfigPolicyListResponse'
description: OK
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- monitors_read
summary: Datadog Get All Monitor Configuration Policies
tags:
- All
x-menu-order: 10
x-permission:
operator: OR
permissions:
- monitors_read
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/network/connections/aggregate:
get:
description: Get all aggregated connections.
operationId: GetAggregatedConnections
parameters:
- description: Unix timestamp (number of seconds since epoch) of the start of the query window. If not provided, the start of the query window is 15 minutes before the `to` timestamp. If neither `from` nor `to` are provided, the query window is `[now - 15m, now]`.
in: query
name: from
schema:
format: int64
type: integer
example: 42
- description: Unix timestamp (number of seconds since epoch) of the end of the query window. If not provided, the end of the query window is the current time. If neither `from` nor `to` are provided, the query window is `[now - 15m, now]`.
in: query
name: to
schema:
format: int64
type: integer
example: 42
- description: Comma-separated list of fields to group connections by.
in: query
name: group_by
schema:
type: string
example: example_value
- description: Comma-separated list of tags to filter connections by.
in: query
name: tags
schema:
type: string
example: env:production
- description: The number of connections to be returned. The maximum value is 5000.
in: query
name: limit
schema:
default: 100
format: int32
maximum: 5000
minimum: 1
type: integer
example: 42
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SingleAggregatedConnectionResponseArray'
description: OK
'400':
$ref: '#/components/responses/BadRequestResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog Get All Aggregated Connections
tags:
- All
x-menu-order: 1
x-undo:
type: safe
x-unstable: '**Note**: This endpoint is in Preview. 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/powerpacks:
get:
description: Get a list of all powerpacks.
operationId: ListPowerpacks
parameters:
- description: Maximum number of powerpacks in the response.
example: 25
in: query
name: page[limit]
required: false
schema:
default: 25
format: int64
maximum: 1000
type: integer
- $ref: '#/components/parameters/PageOffset'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListPowerpacksResponse'
description: OK
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- dashboards_read
summary: Datadog Get All Powerpacks
tags:
- All
x-menu-order: 1
x-pagination:
limitParam: page[limit]
pageOffsetParam: page[offset]
resultsPath: data
x-permission:
operator: OR
permissions:
- dashboards_read
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/processes:
get:
description: Get all processes for your organization.
operationId: ListProcesses
parameters:
- description: String to search processes by.
in: query
name: search
required: false
schema:
type: string
example: example_value
- description: Comma-separated list of tags to filter processes by.
example: account:prod,user:admin
in: query
name: tags
required: false
schema:
type: string
- description: 'Unix timestamp (number of seconds since epoch) of the start of the query window.
If not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither
`from` nor `to` are provided, the query window will be `[now - 15m, now]`.'
in: query
name: from
required: false
schema:
format: int64
type: integer
example: 42
- description: 'Unix timestamp (number of seconds since epoch) of the end of the query window.
If not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither
`from` nor `to` are provided, the query window will be `[now - 15m, now]`.'
in: query
name: to
required: false
schema:
format: int64
type: integer
example: 42
- description: Maximum number of results returned.
in: query
name: page[limit]
required: false
schema:
default: 1000
format: int32
maximum: 10000
minimum: 1
type: integer
example: 42
- description: 'String to query the next page of results.
This key is provided with each valid response from the API in `meta.page.after`.'
in: query
name: page[cursor]
required: false
schema:
type: string
example: example_value
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessSummariesResponse'
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'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ: []
summary: Datadog Get All Processes
tags:
- All
x-menu-order: 1
x-pagination:
cursorParam: page[cursor]
cursorPath: meta.page.after
limitParam: page[limit]
resultsPath: data
x-permission:
operator: OPEN
permissions: []
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/remote_config/products/asm/waf/custom_rules:
get:
description: Retrieve a list of WAF custom rule.
operationId: ListApplicationSecurityWAFCustomRules
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleListResponse'
description: OK
'403':
$ref: '#/components/responses/NotAuthorizedResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog List All Waf Custom Rules
tags:
- All
x-menu-order: 13
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/remote_config/products/asm/waf/exclusion_filters:
get:
description: Retrieve a list of WAF exclusion filters.
operationId: ListApplicationSecurityWafExclusionFilters
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFiltersResponse'
description: OK
'403':
$ref: '#/components/responses/NotAuthorizedResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog List All Waf Exclusion Filters
tags:
- All
x-menu-order: 3
x-permission:
operator: AND
permissions:
- appsec_protect_read
x-terraform-resource: appsec_waf_exclusion_filter
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/remote_config/products/cws/agent_rules:
get:
description: 'Get the list of Workload Protection agent rules.
**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.'
operationId: ListCSMThreatsAgentRules
parameters:
- $ref: '#/components/parameters/CloudWorkloadSecurityQueryAgentPolicyID'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRulesListResponse'
description: OK
'403':
$ref: '#/components/responses/NotAuthorizedResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog Get All Workload Protection Agent Rules
tags:
- All
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/remote_config/products/cws/policy:
get:
description: 'Get the list of Workload Protection policies.
**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.'
operationId: ListCSMThreatsAgentPolicies
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CloudWorkloadSecurityAgentPoliciesListResponse'
description: OK
'403':
$ref: '#/components/responses/NotAuthorizedResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog Get All Workload Protection Policies
tags:
- All
x-menu-order: 6
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/roles/{role_id}/users:
get:
description: Gets all users of a role.
operationId: ListRoleUsers
parameters:
- $ref: '#/components/parameters/RoleID'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageNumber'
- description: 'User attribute to order results by. Sort order is **ascending** by default.
Sort order is **descending** if the field is prefixed by a negative sign,
for example `sort=-name`. Options: `name`, `email`, `status`.'
in: query
name: sort
required: false
schema:
default: name
type: string
example: example_value
- description: Filter all users by the given string. Defaults to no filtering.
in: query
name: filter
required: false
schema:
type: string
example: example_value
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UsersResponse'
description: OK
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Not found
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- user_access_read
summary: Datadog Get All Users of a Role
tags:
- All
x-menu-order: 9
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/rum/applications:
x-merge-override:
get: false
post: false
get:
description: List all the RUM applications in your organization.
operationId: GetRUMApplications
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RUMApplicationsResponse'
description: OK
'404':
$ref: '#/components/responses/NotFoundResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog List All the Rum Applications
tags:
- All
x-menu-order: 8
x-permission:
operator: OR
permissions:
- rum_apps_read
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/rum/applications/{app_id}/retention_filters:
get:
description: Get the list of RUM retention filters for a RUM application.
operationId: ListRetentionFilters
parameters:
- $ref: '#/components/parameters/RumApplicationIDParameter'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RumRetentionFiltersResponse'
description: OK
'403':
$ref: '#/components/responses/NotAuthorizedResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog Get All Rum Retention Filters
tags:
- All
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/rum/config/metrics:
get:
description: Get the list of configured rum-based metrics with their definitions.
operationId: ListRumMetrics
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RumMetricsResponse'
description: OK
'403':
$ref: '#/components/responses/NotAuthorizedResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog Get All Rum-based Metrics
tags:
- All
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/scorecard/outcomes:
get:
description: Fetches all rule outcomes.
operationId: ListScorecardOutcomes
parameters:
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageOffset'
- description: Include related rule details in the response.
in: query
name: include
required: false
schema:
example: rule
type: string
example: rule
- description: Return only specified values in the outcome attributes.
in: query
name: fields[outcome]
required: false
schema:
example: state, service_name
type: string
example: state, service_name
- description: Return only specified values in the included rule details.
in: query
name: fields[rule]
required: false
schema:
example: name
type: string
example: name
- description: Filter the outcomes on a specific service name.
in: query
name: filter[outcome][service_name]
required: false
schema:
example: web-store
type: string
example: web-store
- description: Filter the outcomes by a specific state.
in: query
name: filter[outcome][state]
required: false
schema:
example: fail
type: string
example: fail
- description: Filter outcomes on whether a rule is enabled/disabled.
in: query
name: filter[rule][enabled]
required: false
schema:
example: true
type: boolean
example: true
- description: Filter outcomes based on rule ID.
in: query
name: filter[rule][id]
required: false
schema:
example: f4485c79-0762-449c-96cf-c31e54a659f6
type: string
example: f4485c79-0762-449c-96cf-c31e54a659f6
- description: Filter outcomes based on rule name.
in: query
name: filter[rule][name]
required: false
schema:
example: SLOs Defined
type: string
example: SLOs Defined
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OutcomesResponse'
description: OK
'400':
$ref: '#/components/responses/BadRequestResponse'
'403':
$ref: '#/components/responses/ForbiddenResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- apm_service_catalog_read
summary: Datadog List All Rule Outcomes
tags:
- All
x-menu-order: 2
x-pagination:
limitParam: page[size]
pageOffsetParam: page[offset]
resultsPath: data
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/scorecard/rules:
get:
description: Fetch all rules.
operationId: ListScorecardRules
parameters:
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageOffset'
- description: Include related scorecard details in the response.
in: query
name: include
required: false
schema:
example: scorecard
type: string
example: scorecard
- description: Filter the rules on a rule ID.
in: query
name: filter[rule][id]
required: false
schema:
example: 37d2f990-c885-4972-949b-8b798213a166
type: string
example: 37d2f990-c885-4972-949b-8b798213a166
- description: Filter for enabled rules only.
in: query
name: filter[rule][enabled]
required: false
schema:
example: true
type: boolean
example: true
- description: Filter for custom rules only.
in: query
name: filter[rule][custom]
required: false
schema:
example: true
type: boolean
example: true
- description: Filter rules on the rule name.
in: query
name: filter[rule][name]
required: false
schema:
example: Code Repos Defined
type: string
example: Code Repos Defined
- description: Filter rules on the rule description.
in: query
name: filter[rule][description]
required: false
schema:
example: Identifying
type: string
example: Identifying
- description: Return only specific fields in the response for rule attributes.
in: query
name: fields[rule]
required: false
schema:
example: name, description
type: string
example: name, description
- description: Return only specific fields in the included response for scorecard attributes.
in: query
name: fields[scorecard]
required: false
schema:
example: name
type: string
example: name
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListRulesResponse'
description: OK
'400':
$ref: '#/components/responses/BadRequestResponse'
'403':
$ref: '#/components/responses/ForbiddenResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- apm_service_catalog_read
summary: Datadog List All Rules
tags:
- All
x-menu-order: 2
x-pagination:
limitParam: page[size]
pageOffsetParam: page[offset]
resultsPath: data
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/security_monitoring/cloud_workload_security/agent_rules:
get:
description: 'Get the list of agent rules.
**Note**: This endpoint should only be used for the Government (US1-FED) site.'
operationId: ListCloudWorkloadSecurityAgentRules
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRulesListResponse'
description: OK
'403':
$ref: '#/components/responses/NotAuthorizedResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog Get All Workload Protection Agent Rules (us1-fed)
tags:
- All
x-menu-order: 12
x-permission:
operator: OR
permissions:
- security_monitoring_cws_agent_rules_read
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/security_monitoring/configuration/security_filters:
get:
description: Get the list of configured security filters with their definitions.
operationId: ListSecurityFilters
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SecurityFiltersResponse'
description: OK
'403':
$ref: '#/components/responses/NotAuthorizedResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- security_monitoring_filters_read
summary: Datadog Get All Security Filters
tags:
- All
x-menu-order: 18
x-permission:
operator: OR
permissions:
- security_monitoring_filters_read
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/security_monitoring/configuration/suppressions:
get:
description: Get the list of all suppression rules.
operationId: ListSecurityMonitoringSuppressions
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SecurityMonitoringSuppressionsResponse'
description: OK
'403':
$ref: '#/components/responses/NotAuthorizedResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- security_monitoring_suppressions_read
summary: Datadog Get All Suppression Rules
tags:
- All
x-menu-order: 0
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/services:
get:
deprecated: true
description: Get all incident services uploaded for the requesting user's organization. If the `include[users]` query parameter is provided, the included attribute will contain the users related to these incident services.
operationId: ListIncidentServices
parameters:
- $ref: '#/components/parameters/IncidentServiceIncludeQueryParameter'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageOffset'
- $ref: '#/components/parameters/IncidentServiceSearchQueryParameter'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/IncidentServicesResponse'
description: OK
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'403':
$ref: '#/components/responses/ForbiddenResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- incident_read
summary: Datadog Get a List of All Incident Services
tags:
- All
x-menu-order: 4
x-permission:
operator: OR
permissions:
- incident_read
x-undo:
type: safe
x-unstable: '**Note**: This endpoint is deprecated.'
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/services/definitions:
get:
description: Get a list of all service definitions from the Datadog Service Catalog.
operationId: ListServiceDefinitions
parameters:
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageNumber'
- $ref: '#/components/parameters/SchemaVersion'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceDefinitionsListResponse'
description: OK
'403':
$ref: '#/components/responses/ForbiddenResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- apm_service_catalog_read
summary: Datadog Get All Service Definitions
tags:
- All
x-menu-order: 1
x-pagination:
limitParam: page[size]
pageParam: page[number]
resultsPath: data
x-permission:
operator: OR
permissions:
- apm_service_catalog_read
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/team:
x-merge-override:
get: false
post: false
get:
description: 'Get all teams.
Can be used to search for teams using the `filter[keyword]` and `filter[me]` query parameters.'
operationId: ListTeams
parameters:
- $ref: '#/components/parameters/PageNumber'
- $ref: '#/components/parameters/PageSize'
- description: Specifies the order of the returned teams
in: query
name: sort
required: false
schema:
$ref: '#/components/schemas/ListTeamsSort'
example: example_value
- description: 'Included related resources optionally requested. Allowed enum values: `team_links, user_team_permissions`'
in: query
name: include
required: false
schema:
items:
$ref: '#/components/schemas/ListTeamsInclude'
type: array
- description: Search query. Can be team name, team handle, or email of team member
in: query
name: filter[keyword]
required: false
schema:
type: string
example: example_value
- description: When true, only returns teams the current user belongs to
in: query
name: filter[me]
required: false
schema:
type: boolean
example: true
- description: List of fields that need to be fetched.
explode: false
in: query
name: fields[team]
required: false
schema:
items:
$ref: '#/components/schemas/TeamsField'
type: array
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TeamsResponse'
description: OK
'403':
$ref: '#/components/responses/ForbiddenResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- teams_read
summary: Datadog Get All Teams
tags:
- All
x-menu-order: 1
x-pagination:
limitParam: page[size]
pageParam: page[number]
resultsPath: data
x-permission:
operator: OR
permissions:
- teams_read
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/teams:
get:
deprecated: true
description: Get all incident teams for the requesting user's organization. If the `include[users]` query parameter is provided, the included attribute will contain the users related to these incident teams.
operationId: ListIncidentTeams
parameters:
- $ref: '#/components/parameters/IncidentTeamIncludeQueryParameter'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageOffset'
- $ref: '#/components/parameters/IncidentTeamSearchQueryParameter'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/IncidentTeamsResponse'
description: OK
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'403':
$ref: '#/components/responses/ForbiddenResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- incident_read
summary: Datadog Get a List of All Incident Teams
tags:
- All
x-menu-order: 4
x-permission:
operator: OR
permissions:
- incident_read
x-undo:
type: safe
x-unstable: '**Note**: This endpoint is deprecated. See the [Teams API endpoints](https://docs.datadoghq.com/api/latest/teams/).'
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/users:
get:
description: 'Get the list of all users in the organization. This list includes
all users even if they are deactivated or unverified.'
operationId: ListUsers
parameters:
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageNumber'
- description: 'User attribute to order results by. Sort order is ascending by default.
Sort order is descending if the field
is prefixed by a negative sign, for example `sort=-name`. Options: `name`,
`modified_at`, `user_count`.'
in: query
name: sort
required: false
schema:
default: name
example: name
type: string
example: name
- description: 'Direction of sort. Options: `asc`, `desc`.'
in: query
name: sort_dir
required: false
schema:
$ref: '#/components/schemas/QuerySortOrder'
example: example_value
- description: Filter all users by the given string. Defaults to no filtering.
in: query
name: filter
required: false
schema:
type: string
example: example_value
- description: 'Filter on status attribute.
Comma separated list, with possible values `Active`, `Pending`, and `Disabled`.
Defaults to no filtering.'
in: query
name: filter[status]
required: false
schema:
example: Active
type: string
example: Active
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UsersResponse'
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'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- user_access_read
summary: Datadog List All Users
tags:
- All
x-codegen-request-body-name: body
x-menu-order: 1
x-pagination:
limitParam: page[size]
pageParam: page[number]
resultsPath: data
x-permission:
operator: OR
permissions:
- user_access_read
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
ServiceDefinitionV2:
description: Service definition V2 for providing service metadata and integrations.
properties:
contacts:
description: A list of contacts related to the services.
items:
$ref: '#/components/schemas/ServiceDefinitionV2Contact'
type: array
dd-service:
description: Unique identifier of the service. Must be unique across all services and is used to match with a service in Datadog.
example: my-service
type: string
dd-team:
description: Experimental feature. A Team handle that matches a Team in the Datadog Teams product.
example: my-team
type: string
docs:
description: A list of documentation related to the services.
items:
$ref: '#/components/schemas/ServiceDefinitionV2Doc'
type: array
extensions:
additionalProperties: {}
description: Extensions to V2 schema.
example:
myorg/extension: extensionValue
type: object
integrations:
$ref: '#/components/schemas/ServiceDefinitionV2Integrations'
links:
description: A list of links related to the services.
items:
$ref: '#/components/schemas/ServiceDefinitionV2Link'
type: array
repos:
description: A list of code repositories related to the services.
items:
$ref: '#/components/schemas/ServiceDefinitionV2Repo'
type: array
schema-version:
$ref: '#/components/schemas/ServiceDefinitionV2Version'
tags:
description: A set of custom tags.
example:
- my:tag
- service:tag
items:
type: string
type: array
team:
description: Team that owns the service.
example: my-team
type: string
required:
- schema-version
- dd-service
type: object
LogsArchiveDestinationAzure:
description: The Azure archive destination.
properties:
container:
description: The container where the archive will be stored.
example: container-name
type: string
integration:
$ref: '#/components/schemas/LogsArchiveIntegrationAzure'
path:
description: The archive path.
type: string
example: example_value
region:
description: The region where the archive will be stored.
type: string
example: example_value
storage_account:
description: The associated storage account.
example: account-name
type: string
type:
$ref: '#/components/schemas/LogsArchiveDestinationAzureType'
required:
- storage_account
- container
- integration
- type
type: object
AWSMetricsConfig:
description: AWS Metrics Collection config.
properties:
automute_enabled:
description: Enable EC2 automute for AWS metrics. Defaults to `true`.
example: true
type: boolean
collect_cloudwatch_alarms:
description: Enable CloudWatch alarms collection. Defaults to `false`.
example: false
type: boolean
collect_custom_metrics:
description: Enable custom metrics collection. Defaults to `false`.
example: false
type: boolean
enabled:
description: Enable AWS metrics collection. Defaults to `true`.
example: true
type: boolean
namespace_filters:
$ref: '#/components/schemas/AWSNamespaceFilters'
tag_filters:
description: AWS Metrics collection tag filters list. Defaults to `[]`.
items:
$ref: '#/components/schemas/AWSNamespaceTagFilter'
type: array
type: object
ContainerImageFlavor:
description: Container Image breakdown by supported platform.
properties:
built_at:
description: Time the platform-specific Container Image was built.
type: string
example: example_value
os_architecture:
description: Operating System architecture supported by the Container Image.
type: string
example: example_value
os_name:
description: Operating System name supported by the Container Image.
type: string
example: Example Monitor
os_version:
description: Operating System version supported by the Container Image.
type: string
example: example_value
size:
description: Size of the platform-specific Container Image.
format: int64
type: integer
example: 42
type: object
DowntimeRelationshipsMonitorData:
description: Data for the monitor.
nullable: true
properties:
id:
description: Monitor ID of the downtime.
example: '12345'
type: string
type:
$ref: '#/components/schemas/DowntimeIncludedMonitorType'
type: object
ListRulesResponseLinks:
description: Links attributes.
properties:
next:
description: Link for the next set of rules.
example: /api/v2/scorecard/rules?page%5Blimit%5D=2&page%5Boffset%5D=2&page%5Bsize%5D=2
type: string
type: object
ServiceDefinitionV2Dot1SlackType:
description: Contact type.
enum:
- slack
example: slack
type: string
x-enum-varnames:
- SLACK
OrganizationAttributes:
description: Attributes of the organization.
properties:
created_at:
description: Creation time of the organization.
format: date-time
type: string
example: example_value
description:
description: Description of the organization.
type: string
example: example_value
disabled:
description: Whether or not the organization is disabled.
type: boolean
example: true
modified_at:
description: Time of last organization modification.
format: date-time
type: string
example: example_value
name:
description: Name of the organization.
type: string
example: Example Monitor
public_id:
description: Public ID of the organization.
type: string
example: abc-123-def
sharing:
description: Sharing type of the organization.
type: string
example: example_value
url:
description: URL of the site that this organization exists at.
type: string
example: https://app.datadoghq.com
type: object
TeamLink:
description: Team link
properties:
attributes:
$ref: '#/components/schemas/TeamLinkAttributes'
id:
description: The team link's identifier
example: b8626d7e-cedd-11eb-abf5-da7ad0900001
type: string
type:
$ref: '#/components/schemas/TeamLinkType'
required:
- attributes
- id
- type
type: object
x-merge-override:
required: false
RelationshipToRuleDataObject:
description: Rule relationship data.
properties:
id:
description: The unique ID for a scorecard.
example: q8MQxk8TCqrHnWkp
type: string
type:
$ref: '#/components/schemas/ScorecardType'
type: object
RelationshipToTeamLinks:
description: Relationship between a team and a team link
properties:
data:
description: Related team links
items:
$ref: '#/components/schemas/RelationshipToTeamLinkData'
type: array
links:
$ref: '#/components/schemas/TeamRelationshipsLinks'
type: object
x-merge-override:
required: false
MicrosoftTeamsWorkflowsWebhookHandlesResponse:
description: Response with a list of Workflows webhook handles.
properties:
data:
description: An array of Workflows webhook handles.
example:
- attributes:
name: general-handle
id: 596da4af-0563-4097-90ff-07230c3f9db3
type: workflows-webhook-handle
- attributes:
name: general-handle-2
id: 596da4af-0563-4097-90ff-07230c3f9db4
type: workflows-webhook-handle
items:
$ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponseData'
type: array
required:
- data
type: object
IncidentServicesResponse:
description: Response with a list of incident service payloads.
properties:
data:
description: An array of incident services.
example:
- id: 00000000-0000-0000-0000-000000000000
type: services
items:
$ref: '#/components/schemas/IncidentServiceResponseData'
type: array
included:
description: Included related resources which the user requested.
items:
$ref: '#/components/schemas/IncidentServiceIncludedItems'
readOnly: true
type: array
meta:
$ref: '#/components/schemas/IncidentResponseMeta'
required:
- data
type: object
DowntimeScheduleRecurrenceRrule:
description: 'The `RRULE` standard for defining recurring events.
For example, to have a recurring event on the first day of each month, set the type to `rrule` and set the `FREQ` to `MONTHLY` and `BYMONTHDAY` to `1`.
Most common `rrule` options from the [iCalendar Spec](https://tools.ietf.org/html/rfc5545) are supported.
**Note**: Attributes specifying the duration in `RRULE` are not supported (for example, `DTSTART`, `DTEND`, `DURATION`).
More examples available in this [downtime guide](https://docs.datadoghq.com/monitors/guide/suppress-alert-with-downtimes/?tab=api).'
example: FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1
type: string
MonitorConfigPolicyListResponse:
description: Response for retrieving all monitor configuration policies.
properties:
data:
description: An array of monitor configuration policies.
items:
$ref: '#/components/schemas/MonitorConfigPolicyResponseData'
type: array
type: object
WidgetLiveSpan:
description: The available timeframes depend on the widget you are using.
enum:
- 1m
- 5m
- 10m
- 15m
- 30m
- 1h
- 4h
- 1d
- 2d
- 1w
- 1mo
- 3mo
- 6mo
- 1y
- alert
example: 5m
type: string
x-enum-varnames:
- PAST_ONE_MINUTE
- PAST_FIVE_MINUTES
- PAST_TEN_MINUTES
- PAST_FIFTEEN_MINUTES
- PAST_THIRTY_MINUTES
- PAST_ONE_HOUR
- PAST_FOUR_HOURS
- PAST_ONE_DAY
- PAST_TWO_DAYS
- PAST_ONE_WEEK
- PAST_ONE_MONTH
- PAST_THREE_MONTHS
- PAST_SIX_MONTHS
- PAST_ONE_YEAR
- ALERT
UserResponseIncludedItem:
description: An object related to a user.
oneOf:
- $ref: '#/components/schemas/Organization'
- $ref: '#/components/schemas/Permission'
- $ref: '#/components/schemas/Role'
MicrosoftTeamsTenantBasedHandleInfoResponseAttributes:
description: Tenant-based handle attributes.
properties:
channel_id:
description: Channel id.
example: fake-channel-id
maxLength: 255
type: string
channel_name:
description: Channel name.
example: fake-channel-name
maxLength: 255
type: string
name:
description: Tenant-based handle name.
example: fake-handle-name
maxLength: 255
type: string
team_id:
description: Team id.
example: 00000000-0000-0000-0000-000000000000
maxLength: 255
type: string
team_name:
description: Team name.
example: fake-team-name
maxLength: 255
type: string
tenant_id:
description: Tenant id.
example: 00000000-0000-0000-0000-000000000001
maxLength: 255
type: string
tenant_name:
description: Tenant name.
example: fake-tenant-name
maxLength: 255
type: string
type: object
x-merge-override:
required: false
ApplicationSecurityWafExclusionFilterOnMatch:
description: The action taken when the exclusion filter matches. When set to `monitor`, security traces are emitted but the requests are not blocked. By default, security traces are not emitted and the requests are not blocked.
enum:
- monitor
type: string
x-enum-varnames:
- MONITOR
AuthNMappingResourceType:
description: The type of resource being mapped to.
enum:
- role
- team
type: string
x-enum-varnames:
- ROLE
- TEAM
ApplicationSecurityWafCustomRuleListResponse:
description: Response object that includes a list of WAF custom rules.
properties:
data:
description: The WAF custom rule data.
items:
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleData'
type: array
type: object
TeamsResponseMeta:
description: Teams response metadata.
properties:
pagination:
$ref: '#/components/schemas/TeamsResponseMetaPagination'
type: object
ApplicationSecurityWafCustomRuleConditionInputAddress:
description: Input from the request on which the condition should apply.
enum:
- server.db.statement
- server.io.fs.file
- server.io.net.url
- server.sys.shell.cmd
- server.request.method
- server.request.uri.raw
- server.request.path_params
- server.request.query
- server.request.headers.no_cookies
- server.request.cookies
- server.request.trailers
- server.request.body
- server.response.status
- server.response.headers.no_cookies
- server.response.trailers
- grpc.server.request.metadata
- grpc.server.request.message
- grpc.server.method
- graphql.server.all_resolvers
- usr.id
- http.client_ip
example: server.db.statement
type: string
x-enum-varnames:
- SERVER_DB_STATEMENT
- SERVER_IO_FS_FILE
- SERVER_IO_NET_URL
- SERVER_SYS_SHELL_CMD
- SERVER_REQUEST_METHOD
- SERVER_REQUEST_URI_RAW
- SERVER_REQUEST_PATH_PARAMS
- SERVER_REQUEST_QUERY
- SERVER_REQUEST_HEADERS_NO_COOKIES
- SERVER_REQUEST_COOKIES
- SERVER_REQUEST_TRAILERS
- SERVER_REQUEST_BODY
- SERVER_RESPONSE_STATUS
- SERVER_RESPONSE_HEADERS_NO_COOKIES
- SERVER_RESPONSE_TRAILERS
- GRPC_SERVER_REQUEST_METADATA
- GRPC_SERVER_REQUEST_MESSAGE
- GRPC_SERVER_METHOD
- GRAPHQL_SERVER_ALL_RESOLVERS
- USR_ID
- HTTP_CLIENT_IP
SingleAggregatedConnectionResponseData:
description: Object describing an aggregated connection.
properties:
attributes:
$ref: '#/components/schemas/SingleAggregatedConnectionResponseDataAttributes'
id:
description: A unique identifier for the aggregated connection based on the group by values.
type: string
example: abc-123-def
type:
$ref: '#/components/schemas/SingleAggregatedConnectionResponseDataType'
type: object
ContainerAttributes:
description: Attributes for a container.
properties:
container_id:
description: The ID of the container.
type: string
example: abc-123-def
created_at:
description: Time the container was created.
type: string
example: example_value
host:
description: Hostname of the host running the container.
type: string
example: example_value
image_digest:
description: Digest of the compressed image manifest.
nullable: true
type: string
example: example_value
image_name:
description: Name of the associated container image.
type: string
example: Example Monitor
image_tags:
description: List of image tags associated with the container image.
items:
type: string
nullable: true
type: array
name:
description: Name of the container.
type: string
example: Example Monitor
started_at:
description: Time the container was started.
type: string
example: example_value
state:
description: State of the container. This depends on the container runtime.
type: string
example: example_value
tags:
description: List of tags associated with the container.
items:
type: string
type: array
type: object
RelationshipToUser:
description: Relationship to user.
properties:
data:
$ref: '#/components/schemas/RelationshipToUserData'
required:
- data
type: object
ServiceDefinitionV2Link:
description: Service's external links.
properties:
name:
description: Link name.
example: Runbook
type: string
type:
$ref: '#/components/schemas/ServiceDefinitionV2LinkType'
url:
description: Link URL.
example: https://my-runbook
type: string
required:
- name
- type
- url
type: object
RelationshipToTeamData:
description: Relationship to Team object.
properties:
id:
description: The unique identifier of the team.
example: f9bb8444-af7f-11ec-ac2c-da7ad0900001
type: string
type:
$ref: '#/components/schemas/TeamType'
type: object
x-merge-override:
required: false
AWSAccountID:
description: AWS Account ID.
example: '123456789012'
type: string
RelationshipToPermissionData:
description: Relationship to permission object.
properties:
id:
description: ID of the permission.
type: string
example: abc-123-def
type:
$ref: '#/components/schemas/PermissionsType'
type: object
x-merge-override:
required: false
TeamRelationships:
description: Resources related to a team
properties:
team_links:
$ref: '#/components/schemas/RelationshipToTeamLinks'
user_team_permissions:
$ref: '#/components/schemas/RelationshipToUserTeamPermission'
type: object
RUMApplicationsResponse:
description: RUM applications response.
properties:
data:
description: RUM applications array response.
items:
$ref: '#/components/schemas/RUMApplicationList'
type: array
type: object
IncidentResponseMetaPagination:
description: Pagination properties.
properties:
next_offset:
description: The index of the first element in the next page of results. Equal to page size added to the current offset.
example: 1000
format: int64
type: integer
offset:
description: The index of the first element in the results.
example: 10
format: int64
type: integer
size:
description: Maximum size of pages to return.
example: 1000
format: int64
type: integer
type: object
CloudWorkloadSecurityAgentRuleAction:
description: The action the rule can perform if triggered
properties:
filter:
description: SECL expression used to target the container to apply the action on
type: string
example: example_value
kill:
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleKill'
metadata:
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActionMetadata'
set:
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActionSet'
type: object
DowntimeMessage:
description: 'A message to include with notifications for this downtime. Email notifications can be sent to specific users
by using the same `@username` notation as events.'
example: Message about the downtime
nullable: true
type: string
UsersResponse:
description: Response containing information about multiple users.
properties:
data:
description: Array of returned users.
items:
$ref: '#/components/schemas/User'
type: array
included:
description: Array of objects related to the users.
items:
$ref: '#/components/schemas/UserResponseIncludedItem'
type: array
meta:
$ref: '#/components/schemas/ResponseMetaAttributes'
readOnly: true
type: object
OutcomesBatchResponseAttributes:
description: The JSON:API attributes for an outcome.
properties:
created_at:
description: Creation time of the rule outcome.
format: date-time
type: string
example: example_value
modified_at:
description: Time of last rule outcome modification.
format: date-time
type: string
example: example_value
remarks:
description: Any remarks regarding the scorecard rule's evaluation, and supports HTML hyperlinks.
example: 'See: Services'
type: string
service_name:
description: The unique name for a service in the catalog.
example: my-service
type: string
state:
$ref: '#/components/schemas/State'
type: object
SpansMetricResponseCompute:
description: The compute rule to compute the span-based metric.
properties:
aggregation_type:
$ref: '#/components/schemas/SpansMetricComputeAggregationType'
include_percentiles:
$ref: '#/components/schemas/SpansMetricComputeIncludePercentiles'
path:
description: The path to the value the span-based metric will aggregate on (only used if the aggregation type is a "distribution").
example: '@duration'
type: string
type: object
IncidentResponseMeta:
description: The metadata object containing pagination metadata.
properties:
pagination:
$ref: '#/components/schemas/IncidentResponseMetaPagination'
readOnly: true
type: object
CloudWorkloadSecurityAgentRuleUpdaterAttributes:
description: The attributes of the user who last updated the Agent rule
properties:
handle:
description: The handle of the user
example: datadog.user@example.com
type: string
name:
description: The name of the user
example: Datadog User
nullable: true
type: string
type: object
ServiceDefinitionV2Version:
default: v2
description: Schema version being used.
enum:
- v2
example: v2
type: string
x-enum-varnames:
- V2
ProcessSummariesMeta:
description: Response metadata object.
properties:
page:
$ref: '#/components/schemas/ProcessSummariesMetaPage'
type: object
CloudWorkloadSecurityAgentPoliciesListResponse:
description: Response object that includes a list of Agent policies
properties:
data:
description: A list of Agent policy objects
items:
$ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyData'
type: array
type: object
PowerpackGroupWidgetDefinition:
description: Powerpack group widget object.
properties:
layout_type:
description: Layout type of widgets.
example: ordered
type: string
show_title:
description: Boolean indicating whether powerpack group title should be visible or not.
example: true
type: boolean
title:
description: Name for the group widget.
example: Sample Powerpack
type: string
type:
description: Type of widget, must be group.
example: group
type: string
widgets:
description: Widgets inside the powerpack.
example:
- definition:
content: example
type: note
layout:
height: 5
width: 10
x: 0
y: 0
items:
$ref: '#/components/schemas/PowerpackInnerWidgets'
type: array
required:
- widgets
- layout_type
- type
type: object
Permission:
description: Permission object.
properties:
attributes:
$ref: '#/components/schemas/PermissionAttributes'
id:
description: ID of the permission.
type: string
example: abc-123-def
type:
$ref: '#/components/schemas/PermissionsType'
required:
- type
type: object
ServiceDefinitionDataAttributes:
description: Service definition attributes.
properties:
meta:
$ref: '#/components/schemas/ServiceDefinitionMeta'
schema:
$ref: '#/components/schemas/ServiceDefinitionSchema'
type: object
LogsArchiveIntegrationGCS:
description: The GCS archive's integration destination.
properties:
client_email:
description: A client email.
example: youremail@example.com
type: string
project_id:
description: A project ID.
example: project-id
type: string
required:
- client_email
type: object
OutcomesResponseIncludedRuleAttributes:
description: Details of a rule.
properties:
name:
description: Name of the rule.
example: Team Defined
type: string
scorecard_name:
description: The scorecard name to which this rule must belong.
example: Observability Best Practices
type: string
type: object
DowntimeScheduleRecurrenceResponse:
description: An RRULE-based recurring downtime.
properties:
duration:
$ref: '#/components/schemas/DowntimeScheduleRecurrenceDuration'
rrule:
$ref: '#/components/schemas/DowntimeScheduleRecurrenceRrule'
start:
description: 'ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the
downtime starts the moment it is created.'
example: 2020-01-02T03:04
type: string
type: object
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
ServiceDefinitionV2Dot2:
description: Service definition v2.2 for providing service metadata and integrations.
properties:
application:
description: Identifier for a group of related services serving a product feature, which the service is a part of.
example: my-app
type: string
ci-pipeline-fingerprints:
description: A set of CI fingerprints.
example:
- j88xdEy0J5lc
- eZ7LMljCk8vo
items:
type: string
type: array
contacts:
description: A list of contacts related to the services.
items:
$ref: '#/components/schemas/ServiceDefinitionV2Dot2Contact'
type: array
dd-service:
description: Unique identifier of the service. Must be unique across all services and is used to match with a service in Datadog.
example: my-service
type: string
description:
description: A short description of the service.
example: My service description
type: string
extensions:
additionalProperties: {}
description: Extensions to v2.2 schema.
example:
myorg/extension: extensionValue
type: object
integrations:
$ref: '#/components/schemas/ServiceDefinitionV2Dot2Integrations'
languages:
description: 'The service''s programming language. Datadog recognizes the following languages: `dotnet`, `go`, `java`, `js`, `php`, `python`, `ruby`, and `c++`.'
example:
- dotnet
- go
- java
- js
- php
- python
- ruby
- c++
items:
type: string
type: array
lifecycle:
description: The current life cycle phase of the service.
example: sandbox
type: string
links:
description: A list of links related to the services.
items:
$ref: '#/components/schemas/ServiceDefinitionV2Dot2Link'
type: array
schema-version:
$ref: '#/components/schemas/ServiceDefinitionV2Dot2Version'
tags:
description: A set of custom tags.
example:
- my:tag
- service:tag
items:
type: string
type: array
team:
description: Team that owns the service. It is used to locate a team defined in Datadog Teams if it exists.
example: my-team
type: string
tier:
description: Importance of the service.
example: High
type: string
type:
$ref: '#/components/schemas/ServiceDefinitionV2Dot2Type'
required:
- schema-version
- dd-service
type: object
PowerpackAttributes:
description: Powerpack attribute object.
properties:
description:
description: Description of this powerpack.
example: Powerpack for ABC
type: string
group_widget:
$ref: '#/components/schemas/PowerpackGroupWidget'
name:
description: Name of the powerpack.
example: Sample Powerpack
type: string
tags:
description: List of tags to identify this powerpack.
example:
- tag:foo1
items:
maxLength: 80
type: string
maxItems: 8
type: array
template_variables:
description: List of template variables for this powerpack.
example:
- defaults:
- '*'
name: test
items:
$ref: '#/components/schemas/PowerpackTemplateVariable'
type: array
required:
- group_widget
- name
type: object
ServiceDefinitionsListResponse:
description: Create service definitions response.
properties:
data:
description: Data representing service definitions.
items:
$ref: '#/components/schemas/ServiceDefinitionData'
type: array
type: object
QuerySortOrder:
default: desc
description: Direction of sort.
enum:
- asc
- desc
type: string
x-enum-varnames:
- ASC
- DESC
RUMApplicationList:
description: RUM application list.
properties:
attributes:
$ref: '#/components/schemas/RUMApplicationListAttributes'
id:
description: RUM application ID.
example: abcd1234-0000-0000-abcd-1234abcd5678
type: string
x-merge-override:
format: false
type:
$ref: '#/components/schemas/RUMApplicationListType'
required:
- attributes
- type
type: object
x-merge-override:
required: false
AuthNMappingRelationships:
description: All relationships associated with AuthN Mapping.
properties:
role:
$ref: '#/components/schemas/RelationshipToRole'
saml_assertion_attribute:
$ref: '#/components/schemas/RelationshipToSAMLAssertionAttribute'
team:
$ref: '#/components/schemas/RelationshipToTeam'
type: object
ServiceDefinitionV2Dot2Version:
default: v2.2
description: Schema version being used.
enum:
- v2.2
example: v2.2
type: string
x-enum-varnames:
- V2_2
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
RumRetentionFilterType:
default: retention_filters
description: The type of the resource. The value should always be retention_filters.
enum:
- retention_filters
example: retention_filters
type: string
x-enum-varnames:
- RETENTION_FILTERS
ServiceDefinitionV2Dot1MSTeamsType:
description: Contact type.
enum:
- microsoft-teams
example: microsoft-teams
type: string
x-enum-varnames:
- MICROSOFT_TEAMS
ContainerImageGroupRelationshipsLinks:
description: Links attributes.
properties:
related:
description: Link to related Container Images.
type: string
example: example_value
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
XRayServicesIncludeAll:
description: Include all services.
properties:
include_all:
description: Include all services.
example: false
type: boolean
required:
- include_all
type: object
LogsMetricID:
description: The name of the log-based metric.
example: logs.page.load.count
type: string
SpansMetricResponseFilter:
description: The span-based metric filter. Spans matching this filter will be aggregated in this metric.
properties:
query:
description: The search query - following the span search syntax.
example: '@http.status_code:200 service:my-service'
type: string
type: object
RumMetricEventType:
description: The type of RUM events to filter on.
enum:
- session
- view
- action
- error
- resource
- long_task
- vital
example: session
type: string
x-enum-varnames:
- SESSION
- VIEW
- ACTION
- ERROR
- RESOURCE
- LONG_TASK
- VITAL
RunRetentionFilterName:
description: The name of a RUM retention filter.
example: Retention filter for session
type: string
UserTeamPermissionAttributes:
description: User team permission attributes
properties:
permissions:
description: Object of team permission actions and boolean values that a logged in user can perform on this team.
readOnly: true
type: object
type: object
PowerpacksResponseMeta:
description: Powerpack response metadata.
properties:
pagination:
$ref: '#/components/schemas/PowerpacksResponseMetaPagination'
type: object
ApplicationSecurityWafCustomRuleConditionInput:
description: Input from the request on which the condition should apply.
properties:
address:
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleConditionInputAddress'
key_path:
description: Specific path for the input.
items:
type: string
type: array
required:
- address
type: object
State:
description: The state of the rule evaluation.
enum:
- pass
- fail
- skip
example: pass
type: string
x-enum-varnames:
- PASS
- FAIL
- SKIP
DowntimeRelationships:
description: All relationships associated with downtime.
properties:
created_by:
$ref: '#/components/schemas/DowntimeRelationshipsCreatedBy'
monitor:
$ref: '#/components/schemas/DowntimeRelationshipsMonitor'
type: object
LogsArchiveEncryptionS3:
description: The S3 encryption settings.
properties:
key:
description: An Amazon Resource Name (ARN) used to identify an AWS KMS key.
example: arn:aws:kms:us-east-1:012345678901:key/DatadogIntegrationRoleKms
type: string
type:
$ref: '#/components/schemas/LogsArchiveEncryptionS3Type'
required:
- type
type: object
SecurityMonitoringSuppressionsResponse:
description: Response object containing the available suppression rules.
properties:
data:
description: A list of suppressions objects.
items:
$ref: '#/components/schemas/SecurityMonitoringSuppression'
type: array
type: object
AWSNamespaceTagFilter:
description: 'AWS Metrics Collection tag filters list. Defaults to `[]`.
The array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.
Wildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.
For EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.
For example, `env:production,instance-type:c?.*,!region:us-east-1`.'
properties:
namespace:
description: The AWS service for which the tag filters defined in `tags` will be applied.
example: AWS/EC2
type: string
tags:
description: The AWS resource tags to filter on for the service specified by `namespace`.
items:
description: Tag in the form `key:value`.
example: datadog:true
type: string
nullable: true
type: array
type: object
ContainerImageVulnerabilities:
description: Vulnerability counts associated with the Container Image.
properties:
asset_id:
description: ID of the Container Image.
type: string
example: abc-123-def
critical:
description: Number of vulnerabilities with CVSS Critical severity.
format: int64
type: integer
example: 42
high:
description: Number of vulnerabilities with CVSS High severity.
format: int64
type: integer
example: 42
low:
description: Number of vulnerabilities with CVSS Low severity.
format: int64
type: integer
example: 42
medium:
description: Number of vulnerabilities with CVSS Medium severity.
format: int64
type: integer
example: 42
none:
description: Number of vulnerabilities with CVSS None severity.
format: int64
type: integer
example: 42
unknown:
description: Number of vulnerabilities with an unknown CVSS severity.
format: int64
type: integer
example: 42
type: object
ApplicationSecurityWafCustomRuleActionParameters:
description: The definition of `ApplicationSecurityWafCustomRuleActionParameters` object.
properties:
location:
description: The location to redirect to when the WAF custom rule triggers.
example: /blocking
type: string
status_code:
default: 403
description: The status code to return when the WAF custom rule triggers.
example: 403
format: int64
type: integer
type: object
ApplicationSecurityWafCustomRuleScope:
description: The scope of the WAF custom rule.
properties:
env:
description: The environment scope for the WAF custom rule.
example: prod
type: string
service:
description: The service scope for the WAF custom rule.
example: billing-service
type: string
required:
- service
- env
type: object
AWSAuthConfigKeys:
description: AWS Authentication config to integrate your account using an access key pair.
properties:
access_key_id:
description: AWS Access Key ID.
example: AKIAIOSFODNN7EXAMPLE
type: string
secret_access_key:
description: AWS Secret Access Key.
example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
minLength: 1
type: string
writeOnly: true
required:
- access_key_id
type: object
XRayServicesList:
description: AWS X-Ray services to collect traces from. Defaults to `include_only`.
oneOf:
- $ref: '#/components/schemas/XRayServicesIncludeAll'
- $ref: '#/components/schemas/XRayServicesIncludeOnly'
MonitorNotificationRuleResponseIncludedItem:
description: An object related to a monitor notification rule.
oneOf:
- $ref: '#/components/schemas/User'
ServiceDefinitionV2Dot1MSTeams:
description: Service owner's Microsoft Teams.
properties:
contact:
description: Contact value.
example: https://teams.microsoft.com/myteam
type: string
name:
description: Contact Microsoft Teams.
example: My team channel
type: string
type:
$ref: '#/components/schemas/ServiceDefinitionV2Dot1MSTeamsType'
required:
- type
- contact
type: object
ContainerGroupType:
default: container_group
description: Type of container group.
enum:
- container_group
example: container_group
type: string
x-enum-varnames:
- CONTAINER_GROUP
TeamsResponse:
description: Response with multiple teams
properties:
data:
description: Teams response data
items:
$ref: '#/components/schemas/Team'
type: array
included:
description: Resources related to the team
items:
$ref: '#/components/schemas/TeamIncluded'
type: array
links:
$ref: '#/components/schemas/TeamsResponseLinks'
meta:
$ref: '#/components/schemas/TeamsResponseMeta'
type: object
DowntimeNotifyEndStateActions:
description: Action that will trigger a monitor notification if the downtime is in the `notify_end_types` state.
enum:
- canceled
- expired
example: canceled
type: string
x-enum-varnames:
- CANCELED
- EXPIRED
OpsgenieServiceType:
default: opsgenie-service
description: Opsgenie service resource type.
enum:
- opsgenie-service
example: opsgenie-service
type: string
x-enum-varnames:
- OPSGENIE_SERVICE
RelationshipToSAMLAssertionAttribute:
description: AuthN Mapping relationship to SAML Assertion Attribute.
properties:
data:
$ref: '#/components/schemas/RelationshipToSAMLAssertionAttributeData'
required:
- data
type: object
MonitorConfigPolicyPolicy:
description: Configuration for the policy.
oneOf:
- $ref: '#/components/schemas/MonitorConfigPolicyTagPolicy'
AWSNamespaceFilters:
description: AWS Metrics namespace filters. Defaults to `exclude_only`.
oneOf:
- $ref: '#/components/schemas/AWSNamespaceFiltersExcludeOnly'
- $ref: '#/components/schemas/AWSNamespaceFiltersIncludeOnly'
LogsArchiveDestinationGCS:
description: The GCS archive destination.
properties:
bucket:
description: The bucket where the archive will be stored.
example: bucket-name
type: string
integration:
$ref: '#/components/schemas/LogsArchiveIntegrationGCS'
path:
description: The archive path.
type: string
example: example_value
type:
$ref: '#/components/schemas/LogsArchiveDestinationGCSType'
required:
- bucket
- integration
- type
type: object
RumRetentionFilterEnabled:
description: Whether the retention filter is enabled.
example: true
type: boolean
ApplicationSecurityWafExclusionFilterScope:
description: Deploy on services based on their environment and/or service name.
properties:
env:
description: Deploy on this environment.
example: www
type: string
service:
description: Deploy on this service.
example: prod
type: string
type: object
AWSAccountsResponse:
description: AWS Accounts response body.
properties:
data:
description: List of AWS Account Integration Configs.
items:
$ref: '#/components/schemas/AWSAccountResponseData'
type: array
required:
- data
type: object
LogsArchiveState:
description: The state of the archive.
enum:
- UNKNOWN
- WORKING
- FAILING
- WORKING_AUTH_LEGACY
example: WORKING
type: string
x-enum-varnames:
- UNKNOWN
- WORKING
- FAILING
- WORKING_AUTH_LEGACY
RuleId:
description: The unique ID for a scorecard rule.
example: q8MQxk8TCqrHnWkx
type: string
LeakedKeyType:
default: leaked_keys
description: The definition of LeakedKeyType object.
enum:
- leaked_keys
example: leaked_keys
type: string
x-enum-varnames:
- LEAKED_KEYS
RelationshipToOrganizations:
description: Relationship to organizations.
properties:
data:
description: Relationships to organization objects.
example: []
items:
$ref: '#/components/schemas/RelationshipToOrganizationData'
type: array
required:
- data
type: object
ContainerImagesResponseLinks:
description: Pagination links.
properties:
first:
description: Link to the first page.
type: string
example: example_value
last:
description: Link to the last page.
nullable: true
type: string
example: example_value
next:
description: Link to the next page.
nullable: true
type: string
example: example_value
prev:
description: Link to previous page.
nullable: true
type: string
example: example_value
self:
description: Link to current page.
type: string
example: example_value
type: object
SecurityFilterType:
default: security_filters
description: The type of the resource. The value should always be `security_filters`.
enum:
- security_filters
example: security_filters
type: string
x-enum-varnames:
- SECURITY_FILTERS
TeamRelationshipsLinks:
description: Links attributes.
properties:
related:
description: Related link.
example: /api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links
type: string
type: object
NullableRelationshipToUser:
description: Relationship to user.
nullable: true
properties:
data:
$ref: '#/components/schemas/NullableRelationshipToUserData'
required:
- data
type: object
RUMApplicationListAttributes:
description: RUM application list attributes.
properties:
application_id:
description: ID of the RUM application.
example: abcd1234-0000-0000-abcd-1234abcd5678
type: string
x-merge-override:
format: false
created_at:
description: Timestamp in ms of the creation date.
example: 1659479836169
format: int64
type: integer
created_by_handle:
description: Handle of the creator user.
example: john.doe
type: string
hash:
description: Hash of the RUM application. Optional.
type: string
example: example_value
is_active:
description: Indicates if the RUM application is active.
example: true
type: boolean
name:
description: Name of the RUM application.
example: my_rum_application
type: string
org_id:
description: Org ID of the RUM application.
example: 999
format: int32
maximum: 2147483647
type: integer
type:
description: Type of the RUM application. Supported values are `browser`, `ios`, `android`, `react-native`, `flutter`, `roku`, `electron`, `unity`, `kotlin-multiplatform`.
example: browser
type: string
updated_at:
description: Timestamp in ms of the last update date.
example: 1659479836169
format: int64
type: integer
updated_by_handle:
description: Handle of the updater user.
example: jane.doe
type: string
required:
- application_id
- created_at
- created_by_handle
- name
- org_id
- type
- updated_at
- updated_by_handle
type: object
CustomDestinationsResponse:
description: The available custom destinations.
properties:
data:
description: A list of custom destinations.
items:
$ref: '#/components/schemas/CustomDestinationResponseDefinition'
type: array
type: object
LogsMetricResponseData:
description: The log-based metric properties.
properties:
attributes:
$ref: '#/components/schemas/LogsMetricResponseAttributes'
id:
$ref: '#/components/schemas/LogsMetricID'
type:
$ref: '#/components/schemas/LogsMetricType'
type: object
AWSResourcesConfig:
description: AWS Resources Collection config.
properties:
cloud_security_posture_management_collection:
description: Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.
example: false
type: boolean
extended_collection:
description: Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.
example: true
type: boolean
type: object
MonitorNotificationRuleFilter:
description: Filter used to associate the notification rule with monitors.
oneOf:
- $ref: '#/components/schemas/MonitorNotificationRuleFilterTags'
AWSAccountResponseAttributes:
description: AWS Account response attributes.
properties:
account_tags:
$ref: '#/components/schemas/AWSAccountTags'
auth_config:
$ref: '#/components/schemas/AWSAuthConfig'
aws_account_id:
$ref: '#/components/schemas/AWSAccountID'
aws_partition:
$ref: '#/components/schemas/AWSAccountPartition'
aws_regions:
$ref: '#/components/schemas/AWSRegions'
created_at:
description: Timestamp of when the account integration was created.
format: date-time
readOnly: true
type: string
example: example_value
logs_config:
$ref: '#/components/schemas/AWSLogsConfig'
metrics_config:
$ref: '#/components/schemas/AWSMetricsConfig'
modified_at:
description: Timestamp of when the account integration was updated.
format: date-time
readOnly: true
type: string
example: example_value
resources_config:
$ref: '#/components/schemas/AWSResourcesConfig'
traces_config:
$ref: '#/components/schemas/AWSTracesConfig'
required:
- aws_account_id
type: object
DowntimeScheduleOneTimeResponse:
description: A one-time downtime definition.
properties:
end:
description: ISO-8601 Datetime to end the downtime.
example: '2020-01-02T03:04:00.000Z'
format: date-time
nullable: true
type: string
start:
description: ISO-8601 Datetime to start the downtime.
example: '2020-01-02T03:04:00.000Z'
format: date-time
type: string
required:
- start
type: object
RetentionFiltersResponse:
description: An ordered list of retention filters.
properties:
data:
description: A list of retention filters objects.
items:
$ref: '#/components/schemas/RetentionFilterAll'
type: array
required:
- data
type: object
CloudWorkloadSecurityAgentPolicyAttributes:
description: A Cloud Workload Security Agent policy returned by the API
properties:
blockingRulesCount:
description: The number of rules with the blocking feature in this policy
example: 100
format: int32
maximum: 2147483647
type: integer
datadogManaged:
description: Whether the policy is managed by Datadog
example: false
type: boolean
description:
description: The description of the policy
example: My agent policy
type: string
disabledRulesCount:
description: The number of rules that are disabled in this policy
example: 100
format: int32
maximum: 2147483647
type: integer
enabled:
description: Whether the Agent policy is enabled
example: true
type: boolean
hostTags:
description: The host tags defining where this policy is deployed
items:
type: string
type: array
hostTagsLists:
description: The host tags defining where this policy is deployed, the inner values are linked with AND, the outer values are linked with OR
items:
items:
type: string
type: array
type: array
monitoringRulesCount:
description: The number of rules in the monitoring state in this policy
example: 100
format: int32
maximum: 2147483647
type: integer
name:
description: The name of the policy
example: my_agent_policy
type: string
policyVersion:
description: The version of the policy
example: '1'
type: string
priority:
description: The priority of the policy
example: 10
format: int64
type: integer
ruleCount:
description: The number of rules in this policy
example: 100
format: int32
maximum: 2147483647
type: integer
updateDate:
description: Timestamp in milliseconds when the policy was last updated
example: 1624366480320
format: int64
type: integer
updatedAt:
description: When the policy was last updated, timestamp in milliseconds
example: 1624366480320
format: int64
type: integer
updater:
$ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyUpdaterAttributes'
type: object
ResponseMetaAttributes:
description: Object describing meta attributes of response.
properties:
page:
$ref: '#/components/schemas/Pagination'
type: object
x-merge-override:
properties: false
LogsMetricType:
default: logs_metrics
description: The type of the resource. The value should always be logs_metrics.
enum:
- logs_metrics
example: logs_metrics
type: string
x-enum-varnames:
- LOGS_METRICS
ServiceDefinitionV1:
deprecated: true
description: Deprecated - Service definition V1 for providing additional service metadata and integrations.
properties:
contact:
$ref: '#/components/schemas/ServiceDefinitionV1Contact'
extensions:
additionalProperties: {}
description: Extensions to V1 schema.
example:
myorg/extension: extensionValue
type: object
external-resources:
description: A list of external links related to the services.
items:
$ref: '#/components/schemas/ServiceDefinitionV1Resource'
type: array
info:
$ref: '#/components/schemas/ServiceDefinitionV1Info'
integrations:
$ref: '#/components/schemas/ServiceDefinitionV1Integrations'
org:
$ref: '#/components/schemas/ServiceDefinitionV1Org'
schema-version:
$ref: '#/components/schemas/ServiceDefinitionV1Version'
tags:
description: A set of custom tags.
example:
- my:tag
- service:tag
items:
type: string
type: array
required:
- schema-version
- info
type: object
ProjectRelationships:
description: Project relationships
properties:
member_team:
$ref: '#/components/schemas/RelationshipToTeamLinks'
member_user:
$ref: '#/components/schemas/UsersRelationship'
type: object
ApplicationSecurityWafCustomRuleType:
default: custom_rule
description: The type of the resource. The value should always be `custom_rule`.
enum:
- custom_rule
example: custom_rule
type: string
x-enum-varnames:
- CUSTOM_RULE
AWSAccountConfigID:
description: 'Unique Datadog ID of the AWS Account Integration Config.
To get the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations)
endpoint and query by AWS Account ID.'
example: 00000000-abcd-0001-0000-000000000000
type: string
LogsMetricResponseFilter:
description: The log-based metric filter. Logs matching this filter will be aggregated in this metric.
properties:
query:
description: The search query - following the log search syntax.
example: service:web* AND @http.status_code:[200 TO 299]
type: string
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
PowerpackTemplateVariable:
description: Powerpack template variables.
properties:
available_values:
description: The list of values that the template variable drop-down is limited to.
example:
- my-host
- host1
- host2
items:
description: Template variable value.
type: string
nullable: true
type: array
defaults:
description: One or many template variable default values within the saved view, which are unioned together using `OR` if more than one is specified.
items:
description: One or many default values of the template variable.
minLength: 1
type: string
type: array
name:
description: The name of the variable.
example: datacenter
type: string
prefix:
description: The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.
example: host
nullable: true
type: string
required:
- name
type: object
ContainerImageItem:
description: Possible Container Image models.
oneOf:
- $ref: '#/components/schemas/ContainerImage'
- $ref: '#/components/schemas/ContainerImageGroup'
Project:
description: A Project
properties:
attributes:
$ref: '#/components/schemas/ProjectAttributes'
id:
description: The Project's identifier
example: aeadc05e-98a8-11ec-ac2c-da7ad0900001
type: string
relationships:
$ref: '#/components/schemas/ProjectRelationships'
type:
$ref: '#/components/schemas/ProjectResourceType'
required:
- id
- type
- attributes
type: object
AuthNMappingIncluded:
description: Included data in the AuthN Mapping response.
oneOf:
- $ref: '#/components/schemas/SAMLAssertionAttribute'
- $ref: '#/components/schemas/Role'
- $ref: '#/components/schemas/AuthNMappingTeam'
CustomDestinationResponseHttpDestinationAuthCustomHeader:
description: Custom header access authentication.
properties:
header_name:
description: The header name of the authentication.
example: CUSTOM-HEADER-NAME
type: string
type:
$ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuthCustomHeaderType'
required:
- type
- header_name
type: object
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
DowntimeScheduleResponse:
description: 'The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules:
one-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are
provided, the downtime will begin immediately and never end.'
oneOf:
- $ref: '#/components/schemas/DowntimeScheduleRecurrencesResponse'
- $ref: '#/components/schemas/DowntimeScheduleOneTimeResponse'
DowntimeRelationshipsCreatedByData:
description: Data for the user who created the downtime.
nullable: true
properties:
id:
description: User ID of the downtime creator.
example: 00000000-0000-1234-0000-000000000000
type: string
type:
$ref: '#/components/schemas/UsersType'
type: object
APIKeyRelationships:
description: Resources related to the API key.
properties:
created_by:
$ref: '#/components/schemas/RelationshipToUser'
modified_by:
$ref: '#/components/schemas/NullableRelationshipToUser'
type: object
ServiceDefinitionSchema:
description: Service definition schema.
oneOf:
- $ref: '#/components/schemas/ServiceDefinitionV1'
- $ref: '#/components/schemas/ServiceDefinitionV2'
- $ref: '#/components/schemas/ServiceDefinitionV2Dot1'
- $ref: '#/components/schemas/ServiceDefinitionV2Dot2'
LeakedKeyAttributes:
description: The definition of LeakedKeyAttributes object.
properties:
date:
description: The LeakedKeyAttributes date.
example: '2017-07-21T17:32:28Z'
format: date-time
type: string
leak_source:
description: The LeakedKeyAttributes leak_source.
type: string
example: example_value
required:
- date
type: object
RelationshipToUserTeamPermission:
description: Relationship between a user team permission and a team
properties:
data:
$ref: '#/components/schemas/RelationshipToUserTeamPermissionData'
links:
$ref: '#/components/schemas/TeamRelationshipsLinks'
type: object
x-merge-override:
required: false
AWSRegionsIncludeAll:
description: Include all regions. Defaults to `true`.
properties:
include_all:
description: Include all regions.
example: true
type: boolean
required:
- include_all
type: object
MonitorNotificationRuleId:
description: The ID of the monitor notification rule.
example: 00000000-0000-1234-0000-000000000000
type: string
LogsArchiveStorageClassS3Type:
default: STANDARD
description: The storage class where the archive will be stored.
enum:
- STANDARD
- STANDARD_IA
- ONEZONE_IA
- INTELLIGENT_TIERING
- GLACIER_IR
example: STANDARD
type: string
x-enum-varnames:
- STANDARD
- STANDARD_IA
- ONEZONE_IA
- INTELLIGENT_TIERING
- GLACIER_IR
AWSRegions:
description: AWS Regions to collect data from. Defaults to `include_all`.
oneOf:
- $ref: '#/components/schemas/AWSRegionsIncludeAll'
- $ref: '#/components/schemas/AWSRegionsIncludeOnly'
CustomDestinationAttributeTagsRestrictionListType:
default: ALLOW_LIST
description: 'How `forward_tags_restriction_list` parameter should be interpreted.
If `ALLOW_LIST`, then only tags whose keys on the forwarded logs match the ones on the restriction list
are forwarded.
`BLOCK_LIST` works the opposite way. It does not forward the tags matching the ones on the list.'
enum:
- ALLOW_LIST
- BLOCK_LIST
example: ALLOW_LIST
type: string
x-enum-varnames:
- ALLOW_LIST
- BLOCK_LIST
ServiceDefinitionV2EmailType:
description: Contact type.
enum:
- email
example: email
type: string
x-enum-varnames:
- EMAIL
DowntimeIncludedMonitorType:
default: monitors
description: Monitor resource type.
enum:
- monitors
example: monitors
type: string
x-enum-varnames:
- MONITORS
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
ContainerGroupRelationshipsData:
description: Links data.
items:
description: A link data.
type: string
type: array
CsmAgentsAttributes:
description: A CSM Agent returned by the API.
properties:
agent_version:
description: Version of the Datadog Agent.
type: string
example: example_value
aws_fargate:
description: AWS Fargate details.
type: string
example: example_value
cluster_name:
description: List of cluster names associated with the Agent.
items:
type: string
type: array
datadog_agent:
description: Unique identifier for the Datadog Agent.
type: string
example: example_value
ecs_fargate_task_arn:
description: ARN of the ECS Fargate task.
type: string
example: example_value
envs:
description: List of environments associated with the Agent.
items:
type: string
nullable: true
type: array
host_id:
description: ID of the host.
format: int64
type: integer
example: 42
hostname:
description: Name of the host.
type: string
example: Example Monitor
install_method_installer_version:
description: Version of the installer used for installing the Datadog Agent.
type: string
example: example_value
install_method_tool:
description: Tool used for installing the Datadog Agent.
type: string
example: example_value
is_csm_vm_containers_enabled:
description: Indicates if CSM VM Containers is enabled.
nullable: true
type: boolean
example: true
is_csm_vm_hosts_enabled:
description: Indicates if CSM VM Hosts is enabled.
nullable: true
type: boolean
example: true
is_cspm_enabled:
description: Indicates if CSPM is enabled.
nullable: true
type: boolean
example: true
is_cws_enabled:
description: Indicates if CWS is enabled.
nullable: true
type: boolean
example: true
is_cws_remote_configuration_enabled:
description: Indicates if CWS Remote Configuration is enabled.
nullable: true
type: boolean
example: true
is_remote_configuration_enabled:
description: Indicates if Remote Configuration is enabled.
nullable: true
type: boolean
example: true
os:
description: Operating system of the host.
type: string
example: example_value
type: object
CsmAgentData:
description: Single Agent Data.
properties:
attributes:
$ref: '#/components/schemas/CsmAgentsAttributes'
id:
description: The ID of the Agent.
example: fffffc5505f6a006fdf7cf5aae053653
type: string
type:
$ref: '#/components/schemas/CSMAgentsType'
type: object
AWSLambdaForwarderConfig:
description: 'Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing
and new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.'
properties:
lambdas:
description: List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.
items:
example: arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder
type: string
type: array
sources:
description: 'List of service IDs set to enable automatic log collection. Discover the list of available services with the
[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.'
items:
example: s3
type: string
type: array
type: object
DowntimeMeta:
description: Pagination metadata returned by the API.
properties:
page:
$ref: '#/components/schemas/DowntimeMetaPage'
type: object
UserTeamPermissionType:
default: user_team_permissions
description: User team permission type
enum:
- user_team_permissions
example: user_team_permissions
type: string
x-enum-varnames:
- USER_TEAM_PERMISSIONS
APIKeysType:
default: api_keys
description: API Keys resource type.
enum:
- api_keys
example: api_keys
type: string
x-enum-varnames:
- API_KEYS
DowntimeDisplayTimezone:
default: UTC
description: 'The timezone in which to display the downtime''s start and end times in Datadog applications. This is not used
as an offset for scheduling.'
example: America/New_York
nullable: true
type: string
LogsMetricResponseGroupBy:
description: A group by rule.
properties:
path:
description: The path to the value the log-based metric will be aggregated over.
example: '@http.status_code'
type: string
tag_name:
description: Eventual name of the tag that gets created. By default, the path attribute is used as the tag name.
example: status_code
type: string
type: object
DowntimeResponseAttributes:
description: Downtime details.
properties:
canceled:
description: Time that the downtime was canceled.
example: 2020-01-02T03:04:05.282979+0000
format: date-time
nullable: true
type: string
created:
description: Creation time of the downtime.
example: 2020-01-02T03:04:05.282979+0000
format: date-time
type: string
display_timezone:
$ref: '#/components/schemas/DowntimeDisplayTimezone'
message:
$ref: '#/components/schemas/DowntimeMessage'
modified:
description: Time that the downtime was last modified.
example: 2020-01-02T03:04:05.282979+0000
format: date-time
type: string
monitor_identifier:
$ref: '#/components/schemas/DowntimeMonitorIdentifier'
mute_first_recovery_notification:
$ref: '#/components/schemas/DowntimeMuteFirstRecoveryNotification'
notify_end_states:
$ref: '#/components/schemas/DowntimeNotifyEndStates'
notify_end_types:
$ref: '#/components/schemas/DowntimeNotifyEndTypes'
schedule:
$ref: '#/components/schemas/DowntimeScheduleResponse'
scope:
$ref: '#/components/schemas/DowntimeScope'
status:
$ref: '#/components/schemas/DowntimeStatus'
type: object
ServiceDefinitionV2SlackType:
description: Contact type.
enum:
- slack
example: slack
type: string
x-enum-varnames:
- SLACK
RelationshipToOrganization:
description: Relationship to an organization.
properties:
data:
$ref: '#/components/schemas/RelationshipToOrganizationData'
required:
- data
type: object
IncidentTeamResponseAttributes:
description: The incident team's attributes from a response.
properties:
created:
description: Timestamp of when the incident team was created.
format: date-time
readOnly: true
type: string
example: example_value
modified:
description: Timestamp of when the incident team was modified.
format: date-time
readOnly: true
type: string
example: example_value
name:
description: Name of the incident team.
example: team name
type: string
type: object
ApplicationKeyResponseIncludedItem:
description: An object related to an application key.
oneOf:
- $ref: '#/components/schemas/User'
- $ref: '#/components/schemas/Role'
- $ref: '#/components/schemas/LeakedKey'
ContainerImageMeta:
description: Response metadata object.
properties:
pagination:
$ref: '#/components/schemas/ContainerImageMetaPage'
type: object
ServiceDefinitionV2Integrations:
description: Third party integrations that Datadog supports.
properties:
opsgenie:
$ref: '#/components/schemas/ServiceDefinitionV2Opsgenie'
pagerduty:
$ref: '#/components/schemas/ServiceDefinitionV2Pagerduty'
type: object
OutcomesResponseData:
description: List of rule outcomes.
items:
$ref: '#/components/schemas/OutcomesResponseDataItem'
type: array
IncidentTeamIncludedItems:
description: An object related to an incident team which is present in the included payload.
oneOf:
- $ref: '#/components/schemas/User'
ServiceDefinitionV2Dot2Integrations:
description: Third party integrations that Datadog supports.
properties:
opsgenie:
$ref: '#/components/schemas/ServiceDefinitionV2Dot2Opsgenie'
pagerduty:
$ref: '#/components/schemas/ServiceDefinitionV2Dot2Pagerduty'
type: object
ApplicationSecurityWafCustomRuleData:
description: Object for a single WAF custom rule.
properties:
attributes:
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleAttributes'
id:
description: The ID of the custom rule.
example: 2857c47d-1e3a-4300-8b2f-dc24089c084b
readOnly: true
type: string
type:
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleType'
type: object
ServiceDefinitionMetaWarnings:
description: Schema validation warnings.
properties:
instance-location:
description: The warning instance location.
type: string
example: example_value
keyword-location:
description: The warning keyword location.
type: string
example: example_value
message:
description: The warning message.
type: string
example: CPU usage is high on {{host.name}}
type: object
TeamType:
default: team
description: Team type
enum:
- team
example: team
type: string
x-enum-varnames:
- TEAM
SAMLAssertionAttributeAttributes:
description: Key/Value pair of attributes used in SAML assertion attributes.
properties:
attribute_key:
description: Key portion of a key/value pair of the attribute sent from the Identity Provider.
example: member-of
type: string
attribute_value:
description: Value portion of a key/value pair of the attribute sent from the Identity Provider.
example: Development
type: string
type: object
CSMAgentsMetadata:
description: Metadata related to the paginated response.
properties:
page_index:
description: The index of the current page in the paginated results.
example: 0
format: int64
type: integer
page_size:
description: The number of items per page in the paginated results.
example: 10
format: int64
type: integer
total_filtered:
description: Total number of items that match the filter criteria.
example: 128697
format: int64
type: integer
type: object
LogsArchiveDestinationS3Type:
default: s3
description: Type of the S3 archive destination.
enum:
- s3
example: s3
type: string
x-enum-varnames:
- S3
ServiceDefinitionV2Dot2Pagerduty:
description: PagerDuty integration for the service.
properties:
service-url:
description: PagerDuty service url.
example: https://my-org.pagerduty.com/service-directory/PMyService
type: string
type: object
x-ignore-duplicate-object: true
ApplicationKeyRelationships:
description: Resources related to the application key.
properties:
owned_by:
$ref: '#/components/schemas/RelationshipToUser'
type: object
x-merge-override:
properties: false
LeakedKey:
description: The definition of LeakedKey object.
properties:
attributes:
$ref: '#/components/schemas/LeakedKeyAttributes'
id:
description: The LeakedKey id.
example: id
type: string
type:
$ref: '#/components/schemas/LeakedKeyType'
required:
- attributes
- id
- type
type: object
UserTeamPermission:
description: A user's permissions for a given team
properties:
attributes:
$ref: '#/components/schemas/UserTeamPermissionAttributes'
id:
description: The user team permission's identifier
example: UserTeamPermissions-aeadc05e-98a8-11ec-ac2c-da7ad0900001-416595
type: string
type:
$ref: '#/components/schemas/UserTeamPermissionType'
required:
- id
- type
type: object
x-merge-override:
required: false
OpsgenieServiceResponseAttributes:
description: The attributes from an Opsgenie service response.
properties:
custom_url:
description: The custom URL for a custom region.
example: null
nullable: true
type: string
name:
description: The name for the Opsgenie service.
example: fake-opsgenie-service-name
maxLength: 100
type: string
region:
$ref: '#/components/schemas/OpsgenieServiceRegionType'
type: object
x-merge-override:
required: false
MicrosoftTeamsTenantBasedHandlesResponse:
description: Response with a list of tenant-based handles.
properties:
data:
description: An array of tenant-based handles.
example:
- attributes:
channelId: 19:b41k24b14bn1nwffkernfkwrnfneubgkr@thread.tacv2
channelName: General
name: general-handle
teamId: 00000000-0000-0000-0000-000000000000
teamName: Example Team
tenantId: 00000000-0000-0000-0000-000000000001
tenantName: Company, Inc.
id: 596da4af-0563-4097-90ff-07230c3f9db3
type: ms-teams-tenant-based-handle-info
- attributes:
channelId: 19:b41k24b14bn1nwffkernfkwrnfneubgk1@thread.tacv2
channelName: General2
name: general-handle-2
teamId: 00000000-0000-0000-0000-000000000002
teamName: Example Team 2
tenantId: 00000000-0000-0000-0000-000000000003
tenantName: Company, Inc.
id: 596da4af-0563-4097-90ff-07230c3f9db4
type: ms-teams-tenant-based-handle-info
items:
$ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleInfoResponseData'
type: array
required:
- data
type: object
ApplicationSecurityWafExclusionFilterResource:
description: A JSON:API resource for an WAF exclusion filter.
properties:
attributes:
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterAttributes'
id:
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterID'
type:
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterType'
type: object
ServiceDefinitionV2Opsgenie:
description: Opsgenie integration for the service.
properties:
region:
$ref: '#/components/schemas/ServiceDefinitionV2OpsgenieRegion'
service-url:
description: Opsgenie service url.
example: https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000
type: string
required:
- service-url
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
DowntimeRelationshipsCreatedBy:
description: The user who created the downtime.
properties:
data:
$ref: '#/components/schemas/DowntimeRelationshipsCreatedByData'
type: object
SecurityMonitoringSuppressionType:
default: suppressions
description: The type of the resource. The value should always be `suppressions`.
enum:
- suppressions
example: suppressions
type: string
x-enum-varnames:
- SUPPRESSIONS
RumRetentionFilterQuery:
description: The query string for a RUM retention filter.
example: '@session.has_replay:true'
type: string
SecurityMonitoringSuppressionAttributes:
description: The attributes of the suppression rule.
properties:
creation_date:
description: A Unix millisecond timestamp given the creation date of the suppression rule.
format: int64
type: integer
example: 42
creator:
$ref: '#/components/schemas/SecurityMonitoringUser'
data_exclusion_query:
description: An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.
example: source:cloudtrail account_id:12345
type: string
description:
description: A description for the suppression rule.
example: This rule suppresses low-severity signals in staging environments.
type: string
editable:
description: Whether the suppression rule is editable.
example: true
type: boolean
enabled:
description: Whether the suppression rule is enabled.
example: true
type: boolean
expiration_date:
description: A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore.
example: 1703187336000
format: int64
type: integer
name:
description: The name of the suppression rule.
example: Custom suppression
type: string
rule_query:
description: The rule query of the suppression rule, with the same syntax as the search bar for detection rules.
example: type:log_detection source:cloudtrail
type: string
start_date:
description: A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.
example: 1703187336000
format: int64
type: integer
suppression_query:
description: The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.
example: env:staging status:low
type: string
update_date:
description: A Unix millisecond timestamp given the update date of the suppression rule.
format: int64
type: integer
example: 42
updater:
$ref: '#/components/schemas/SecurityMonitoringUser'
version:
description: The version of the suppression rule; it starts at 1, and is incremented at each update.
example: 42
format: int32
maximum: 2147483647
type: integer
type: object
DowntimeNotifyEndStates:
description: States that will trigger a monitor notification when the `notify_end_types` action occurs.
example:
- alert
- warn
items:
$ref: '#/components/schemas/DowntimeNotifyEndStateTypes'
type: array
ServiceDefinitionV2Dot1Email:
description: Service owner's email.
properties:
contact:
description: Contact value.
example: contact@datadoghq.com
type: string
name:
description: Contact email.
example: Team Email
type: string
type:
$ref: '#/components/schemas/ServiceDefinitionV2Dot1EmailType'
required:
- type
- contact
type: object
CloudWorkloadSecurityAgentPolicyData:
description: Object for a single Agent policy
properties:
attributes:
$ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyAttributes'
id:
description: The ID of the Agent policy
example: 6517fcc1-cec7-4394-a655-8d6e9d085255
type: string
type:
$ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyType'
type: object
RumMetricResponseAttributes:
description: The object describing a Datadog rum-based metric.
properties:
compute:
$ref: '#/components/schemas/RumMetricResponseCompute'
event_type:
$ref: '#/components/schemas/RumMetricEventType'
filter:
$ref: '#/components/schemas/RumMetricResponseFilter'
group_by:
description: The rules for the group by.
items:
$ref: '#/components/schemas/RumMetricResponseGroupBy'
type: array
uniqueness:
$ref: '#/components/schemas/RumMetricResponseUniqueness'
type: object
RumRetentionFilterSampleRate:
description: The sample rate for a RUM retention filter, between 0 and 100.
example: 25
format: int64
maximum: 100
minimum: 0
type: integer
RoleResponseRelationships:
description: Relationships of the role object returned by the API.
properties:
permissions:
$ref: '#/components/schemas/RelationshipToPermissions'
type: object
ServiceDefinitionV2Dot1OpsgenieRegion:
description: Opsgenie instance region.
enum:
- US
- EU
example: US
type: string
x-enum-varnames:
- US
- EU
RumRetentionFilterID:
description: ID of retention filter in UUID.
example: 051601eb-54a0-abc0-03f9-cc02efa18892
type: string
MicrosoftTeamsWorkflowsWebhookHandleType:
default: workflows-webhook-handle
description: Specifies the Workflows webhook handle resource type.
enum:
- workflows-webhook-handle
example: workflows-webhook-handle
type: string
x-enum-varnames:
- WORKFLOWS_WEBHOOK_HANDLE
MonitorNotificationRuleListResponse:
description: Response for retrieving all monitor notification rules.
properties:
data:
description: A list of monitor notification rules.
items:
$ref: '#/components/schemas/MonitorNotificationRuleData'
type: array
included:
description: Array of objects related to the monitor notification rules.
items:
$ref: '#/components/schemas/MonitorNotificationRuleResponseIncludedItem'
type: array
type: object
OutcomesResponseLinks:
description: Links attributes.
properties:
next:
description: Link for the next set of results.
example: /api/v2/scorecard/outcomes?include=rule&page%5Blimit%5D=100&page%5Boffset%5D=100
type: string
type: object
SecurityFilterExclusionFilterResponse:
description: A single exclusion filter.
properties:
name:
description: The exclusion filter name.
example: Exclude staging
type: string
query:
description: The exclusion filter query.
example: source:staging
type: string
type: object
CustomDestinationResponseForwardDestination:
description: A custom destination's location to forward logs.
oneOf:
- $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationHttp'
- $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationSplunk'
- $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationElasticsearch'
RelationshipToRule:
description: Scorecard create rule response relationship.
properties:
scorecard:
$ref: '#/components/schemas/RelationshipToRuleData'
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
ApplicationSecurityWafExclusionFilterType:
default: exclusion_filter
description: Type of the resource. The value should always be `exclusion_filter`.
enum:
- exclusion_filter
example: exclusion_filter
type: string
x-enum-varnames:
- EXCLUSION_FILTER
OpsgenieServiceResponseData:
description: Opsgenie service data from a response.
properties:
attributes:
$ref: '#/components/schemas/OpsgenieServiceResponseAttributes'
id:
description: The ID of the Opsgenie service.
example: 596da4af-0563-4097-90ff-07230c3f9db3
maxLength: 100
minLength: 1
type: string
type:
$ref: '#/components/schemas/OpsgenieServiceType'
required:
- id
- type
- attributes
type: object
x-merge-override:
required: false
ServiceDefinitionV2Pagerduty:
description: PagerDuty service URL for the service.
example: https://my-org.pagerduty.com/service-directory/PMyService
type: string
ApplicationSecurityWafCustomRuleAttributes:
description: A WAF custom rule.
properties:
action:
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleAction'
blocking:
description: Indicates whether the WAF custom rule will block the request.
example: false
type: boolean
conditions:
description: 'Conditions for which the WAF Custom Rule will triggers, all conditions needs to match in order for the WAF
rule to trigger.'
items:
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleCondition'
type: array
enabled:
description: Indicates whether the WAF custom rule is enabled.
example: false
type: boolean
metadata:
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleMetadata'
name:
description: The Name of the WAF custom rule.
example: Block request from bad useragent
type: string
path_glob:
description: The path glob for the WAF custom rule.
example: /api/search/*
type: string
scope:
description: The scope of the WAF custom rule.
items:
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleScope'
type: array
tags:
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleTags'
required:
- enabled
- blocking
- name
- tags
- conditions
type: object
TeamAttributes:
description: Team attributes
properties:
avatar:
description: Unicode representation of the avatar for the team, limited to a single grapheme
example: 🥑
nullable: true
type: string
banner:
description: Banner selection for the team
format: int64
nullable: true
type: integer
example: 42
created_at:
description: Creation date of the team
format: date-time
type: string
example: example_value
description:
description: Free-form markdown description/content for the team's homepage
nullable: true
type: string
example: example_value
handle:
description: The team's identifier
example: example-team
maxLength: 195
type: string
hidden_modules:
description: Collection of hidden modules for the team
items:
description: String identifier of the module
type: string
type: array
link_count:
description: The number of links belonging to the team
format: int32
maximum: 2147483647
readOnly: true
type: integer
example: 42
modified_at:
description: Modification date of the team
format: date-time
type: string
example: example_value
name:
description: The name of the team
example: Example Team
maxLength: 200
type: string
summary:
description: A brief summary of the team, derived from the `description`
maxLength: 120
nullable: true
type: string
example: example_value
user_count:
description: The number of users belonging to the team
format: int32
maximum: 2147483647
readOnly: true
type: integer
example: 42
visible_modules:
description: Collection of visible modules for the team
items:
description: String identifier of the module
type: string
type: array
required:
- handle
- name
type: object
Role:
description: Role object returned by the API.
properties:
attributes:
$ref: '#/components/schemas/RoleAttributes'
id:
description: The unique identifier of the role.
type: string
example: abc-123-def
relationships:
$ref: '#/components/schemas/RoleResponseRelationships'
type:
$ref: '#/components/schemas/RolesType'
required:
- type
type: object
x-merge-override:
required: false
IncidentTeamResponseData:
description: Incident Team data from a response.
properties:
attributes:
$ref: '#/components/schemas/IncidentTeamResponseAttributes'
id:
description: The incident team's ID.
example: 00000000-7ea3-0000-000a-000000000000
type: string
relationships:
$ref: '#/components/schemas/IncidentTeamRelationships'
type:
$ref: '#/components/schemas/IncidentTeamType'
type: object
CustomDestinationResponseElasticsearchDestinationAuth:
additionalProperties:
description: Basic access authentication.
description: Basic access authentication.
type: object
DowntimeRelationshipsMonitor:
description: The monitor identified by the downtime.
properties:
data:
$ref: '#/components/schemas/DowntimeRelationshipsMonitorData'
type: object
AuthNMappingsType:
default: authn_mappings
description: AuthN Mappings resource type.
enum:
- authn_mappings
example: authn_mappings
type: string
x-enum-varnames:
- AUTHN_MAPPINGS
ListDowntimesResponse:
description: Response for retrieving all downtimes.
properties:
data:
description: An array of downtimes.
items:
$ref: '#/components/schemas/DowntimeResponseData'
type: array
included:
description: Array of objects related to the downtimes.
items:
$ref: '#/components/schemas/DowntimeResponseIncludedItem'
type: array
meta:
$ref: '#/components/schemas/DowntimeMeta'
type: object
APIKeysResponseMetaPage:
description: Additional information related to the API keys response.
properties:
total_filtered_count:
description: Total filtered application key count.
format: int64
type: integer
example: 42
type: object
ProcessSummary:
description: Process summary object.
properties:
attributes:
$ref: '#/components/schemas/ProcessSummaryAttributes'
id:
description: Process ID.
type: string
example: abc-123-def
type:
$ref: '#/components/schemas/ProcessSummaryType'
type: object
x-merge-override:
required: false
SAMLAssertionAttributesType:
default: saml_assertion_attributes
description: SAML assertion attributes resource type.
enum:
- saml_assertion_attributes
example: saml_assertion_attributes
type: string
x-enum-varnames:
- SAML_ASSERTION_ATTRIBUTES
ServiceDefinitionV2Dot1Pagerduty:
description: PagerDuty integration for the service.
properties:
service-url:
description: PagerDuty service url.
example: https://my-org.pagerduty.com/service-directory/PMyService
type: string
type: object
x-ignore-duplicate-object: true
OutcomesResponseDataItem:
description: A single rule outcome.
properties:
attributes:
$ref: '#/components/schemas/OutcomesBatchResponseAttributes'
id:
description: The unique ID for a rule outcome.
type: string
example: abc-123-def
relationships:
$ref: '#/components/schemas/RuleOutcomeRelationships'
type:
$ref: '#/components/schemas/OutcomeType'
type: object
ServiceDefinitionV2Dot1Contact:
description: Service owner's contacts information.
oneOf:
- $ref: '#/components/schemas/ServiceDefinitionV2Dot1Email'
- $ref: '#/components/schemas/ServiceDefinitionV2Dot1Slack'
- $ref: '#/components/schemas/ServiceDefinitionV2Dot1MSTeams'
OpsgenieServicesResponse:
description: Response with a list of Opsgenie services.
properties:
data:
description: An array of Opsgenie services.
example:
- attributes:
custom_url: null
name: fake-opsgenie-service-name
region: us
id: 596da4af-0563-4097-90ff-07230c3f9db3
type: opsgenie-service
- attributes:
custom_url: null
name: fake-opsgenie-service-name-2
region: eu
id: 0d2937f1-b561-44fa-914a-99910f848014
type: opsgenie-service
items:
$ref: '#/components/schemas/OpsgenieServiceResponseData'
type: array
required:
- data
type: object
LogsArchiveDestinationS3:
description: The S3 archive destination.
properties:
bucket:
description: The bucket where the archive will be stored.
example: bucket-name
type: string
encryption:
$ref: '#/components/schemas/LogsArchiveEncryptionS3'
integration:
$ref: '#/components/schemas/LogsArchiveIntegrationS3'
path:
description: The archive path.
type: string
example: example_value
storage_class:
$ref: '#/components/schemas/LogsArchiveStorageClassS3Type'
type:
$ref: '#/components/schemas/LogsArchiveDestinationS3Type'
required:
- bucket
- integration
- type
type: object
IncidentServiceIncludedItems:
description: An object related to an incident service which is present in the included payload.
oneOf:
- $ref: '#/components/schemas/User'
MonitorNotificationRuleRecipients:
description: A list of recipients to notify. Uses the same format as the monitor `message` field. Must not start with an '@'.
example:
- slack-test-channel
- jira-test
items:
description: individual recipient.
maxLength: 255
type: string
maxItems: 20
minItems: 1
type: array
uniqueItems: true
SecurityFiltersResponse:
description: All the available security filters objects.
properties:
data:
description: A list of security filters objects.
items:
$ref: '#/components/schemas/SecurityFilter'
type: array
meta:
$ref: '#/components/schemas/SecurityFilterMeta'
type: object
ServiceDefinitionV2Dot2Opsgenie:
description: Opsgenie integration for the service.
properties:
region:
$ref: '#/components/schemas/ServiceDefinitionV2Dot2OpsgenieRegion'
service-url:
description: Opsgenie service url.
example: https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000
type: string
required:
- service-url
type: object
RelationshipToRoles:
description: Relationship to roles.
properties:
data:
description: An array containing type and the unique identifier of a role.
items:
$ref: '#/components/schemas/RelationshipToRoleData'
type: array
type: object
x-merge-override:
required: false
Team:
description: A team
properties:
attributes:
$ref: '#/components/schemas/TeamAttributes'
id:
description: The team's identifier
example: aeadc05e-98a8-11ec-ac2c-da7ad0900001
type: string
relationships:
$ref: '#/components/schemas/TeamRelationships'
type:
$ref: '#/components/schemas/TeamType'
required:
- attributes
- id
- type
type: object
x-merge-override:
required: false
ServiceDefinitionV2Dot2Link:
description: Service's external links.
properties:
name:
description: Link name.
example: Runbook
type: string
provider:
description: Link provider.
example: Github
type: string
type:
description: 'Link type. Datadog recognizes the following types: `runbook`, `doc`, `repo`, `dashboard`, and `other`.'
example: runbook
type: string
url:
description: Link URL.
example: https://my-runbook
type: string
required:
- name
- type
- url
type: object
Pagination:
description: Pagination object.
properties:
total_count:
description: Total count.
format: int64
type: integer
example: 42
total_filtered_count:
description: Total count of elements matched by the filter.
format: int64
type: integer
example: 42
type: object
SingleAggregatedConnectionResponseArray:
description: List of aggregated connections.
example:
data:
- attributes:
bytes_sent_by_client: 100
bytes_sent_by_server: 200
group_bys:
client_team:
- networks
server_service:
- hucklebuck
packets_sent_by_client: 10
packets_sent_by_server: 20
rtt_micro_seconds: 800
tcp_closed_connections: 30
tcp_established_connections: 40
tcp_refusals: 7
tcp_resets: 5
tcp_retransmits: 30
tcp_timeouts: 6
id: client_team:networks, server_service:hucklebuck
type: aggregated_connection
properties:
data:
description: Array of aggregated connection objects.
items:
$ref: '#/components/schemas/SingleAggregatedConnectionResponseData'
type: array
type: object
CustomDestinationResponseDefinition:
description: The definition of a custom destination.
properties:
attributes:
$ref: '#/components/schemas/CustomDestinationResponseAttributes'
id:
description: The custom destination ID.
example: be5d7a69-d0c8-4d4d-8ee8-bba292d98139
readOnly: true
type: string
type:
$ref: '#/components/schemas/CustomDestinationType'
type: object
SingleAggregatedConnectionResponseDataType:
default: aggregated_connection
description: Aggregated connection resource type.
enum:
- aggregated_connection
type: string
x-enum-varnames:
- AGGREGATED_CONNECTION
ServiceDefinitionV2LinkType:
description: Link type.
enum:
- doc
- wiki
- runbook
- url
- repo
- dashboard
- oncall
- code
- link
example: runbook
type: string
x-enum-varnames:
- DOC
- WIKI
- RUNBOOK
- URL
- REPO
- DASHBOARD
- ONCALL
- CODE
- LINK
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
PartialAPIKeyAttributes:
description: Attributes of a partial API key.
properties:
category:
description: The category of the API key.
type: string
example: example_value
created_at:
description: Creation date of the API key.
example: '2020-11-23T10:00:00.000Z'
readOnly: true
type: string
x-merge-override:
format: false
last4:
description: The last four characters of the API key.
example: abcd
maxLength: 4
minLength: 4
readOnly: true
type: string
x-secret: true
modified_at:
description: Date the API key was last modified.
example: '2020-11-23T10:00:00.000Z'
readOnly: true
type: string
x-merge-override:
format: false
name:
description: Name of the API key.
example: API Key for submitting metrics
type: string
remote_config_read_enabled:
description: The remote config read enabled status.
type: boolean
example: true
type: object
RumMetricResponseFilter:
description: The rum-based metric filter. RUM events matching this filter will be aggregated in this metric.
properties:
query:
description: The search query - following the RUM search syntax.
example: service:web* AND @http.status_code:[200 TO 299]
type: string
type: object
RelationshipToOutcomeData:
description: The JSON:API relationship to an outcome, which returns the related rule id.
properties:
id:
$ref: '#/components/schemas/RuleId'
type:
$ref: '#/components/schemas/RuleType'
type: object
LogsArchiveEncryptionS3Type:
description: Type of S3 encryption for a destination.
enum:
- NO_OVERRIDE
- SSE_S3
- SSE_KMS
example: SSE_S3
type: string
x-enum-varnames:
- NO_OVERRIDE
- SSE_S3
- SSE_KMS
ApplicationSecurityWafExclusionFiltersResponse:
description: Response object for multiple WAF exclusion filters.
properties:
data:
description: A list of WAF exclusion filters.
items:
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterResource'
type: array
type: object
RumRetentionFilterData:
description: The RUM retention filter.
properties:
attributes:
$ref: '#/components/schemas/RumRetentionFilterAttributes'
id:
$ref: '#/components/schemas/RumRetentionFilterID'
type:
$ref: '#/components/schemas/RumRetentionFilterType'
type: object
LogsArchives:
description: The available archives.
properties:
data:
description: A list of archives.
items:
$ref: '#/components/schemas/LogsArchiveDefinition'
type: array
type: object
ApplicationSecurityWafExclusionFilterRulesTarget:
description: Target WAF rules based either on an identifier or tags.
properties:
rule_id:
description: Target a single WAF rule based on its identifier.
example: dog-913-009
type: string
tags:
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterRulesTargetTags'
type: object
SpansMetricType:
default: spans_metrics
description: The type of resource. The value should always be spans_metrics.
enum:
- spans_metrics
example: spans_metrics
type: string
x-enum-varnames:
- SPANS_METRICS
LogsMetricComputeIncludePercentiles:
description: 'Toggle to include or exclude percentile aggregations for distribution metrics.
Only present when the `aggregation_type` is `distribution`.'
example: true
type: boolean
CloudWorkloadSecurityAgentRulesListResponse:
description: Response object that includes a list of Agent rule
properties:
data:
description: A list of Agent rules objects
items:
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleData'
type: array
type: object
DowntimeScope:
description: The scope to which the downtime applies. Must follow the [common search syntax](https://docs.datadoghq.com/logs/explorer/search_syntax/).
example: env:(staging OR prod) AND datacenter:us-east-1
type: string
AWSAccountPartition:
description: 'AWS partition your AWS account is scoped to. Defaults to `aws`.
See [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.'
enum:
- aws
- aws-cn
- aws-us-gov
example: aws
type: string
x-enum-varnames:
- AWS
- AWS_CN
- AWS_US_GOV
AuthNMappingAttributes:
description: Attributes of AuthN Mapping.
properties:
attribute_key:
description: Key portion of a key/value pair of the attribute sent from the Identity Provider.
example: member-of
type: string
attribute_value:
description: Value portion of a key/value pair of the attribute sent from the Identity Provider.
example: Development
type: string
created_at:
description: Creation time of the AuthN Mapping.
format: date-time
readOnly: true
type: string
example: example_value
modified_at:
description: Time of last AuthN Mapping modification.
format: date-time
readOnly: true
type: string
example: example_value
saml_assertion_attribute_id:
description: The ID of the SAML assertion attribute.
example: '0'
type: string
type: object
RolesType:
default: roles
description: Roles type.
enum:
- roles
example: roles
type: string
x-enum-varnames:
- ROLES
RelationshipToPermissions:
description: Relationship to multiple permissions objects.
properties:
data:
description: Relationships to permission objects.
items:
$ref: '#/components/schemas/RelationshipToPermissionData'
type: array
type: object
x-merge-override:
required: false
IncidentTeamRelationships:
description: The incident team's relationships.
properties:
created_by:
$ref: '#/components/schemas/RelationshipToUser'
last_modified_by:
$ref: '#/components/schemas/RelationshipToUser'
readOnly: true
type: object
ProcessSummariesMetaPage:
description: Paging attributes.
properties:
after:
description: 'The cursor used to get the next results, if any. To make the next request, use the same
parameters with the addition of the `page[cursor]`.'
example: 911abf1204838d9cdfcb9a96d0b6a1bd03e1b514074f1ce1737c4cbd
type: string
size:
description: Number of results returned.
format: int32
maximum: 10000
minimum: 0
type: integer
example: 42
type: object
ServiceDefinitionV2MSTeamsType:
description: Contact type.
enum:
- microsoft-teams
example: microsoft-teams
type: string
x-enum-varnames:
- MICROSOFT_TEAMS
LogsArchiveDestinationGCSType:
default: gcs
description: Type of the GCS archive destination.
enum:
- gcs
example: gcs
type: string
x-enum-varnames:
- GCS
PowerpackRelationships:
description: Powerpack relationship object.
properties:
author:
$ref: '#/components/schemas/RelationshipToUser'
type: object
UsersType:
default: users
description: Users resource type.
enum:
- users
example: users
type: string
x-enum-varnames:
- USERS
ServiceDefinitionV1Org:
description: Org related information about the service.
properties:
application:
description: App feature this service supports.
example: E-Commerce
type: string
team:
description: Team that owns the service.
example: my-team
type: string
type: object
RUMApplicationListType:
default: rum_application
description: RUM application list type.
enum:
- rum_application
example: rum_application
type: string
x-enum-varnames:
- RUM_APPLICATION
ContainerGroupRelationships:
description: Relationships to containers inside a container group.
properties:
containers:
$ref: '#/components/schemas/ContainerGroupRelationshipsLink'
type: object
ApplicationSecurityWafCustomRuleTagsCategory:
description: The category of the WAF Rule, can be either `business_logic`, `attack_attempt` or `security_response`.
enum:
- attack_attempt
- business_logic
- security_response
example: business_logic
type: string
x-enum-varnames:
- ATTACK_ATTEMPT
- BUSINESS_LOGIC
- SECURITY_RESPONSE
ContainerImageGroupAttributes:
description: Attributes for a Container Image Group.
properties:
count:
description: Number of Container Images in the group.
format: int64
type: integer
example: 42
name:
description: Name of the Container Image group.
type: string
example: Example Monitor
tags:
description: Tags from the group name parsed in key/value format.
type: object
type: object
TeamLinkAttributes:
description: Team link attributes
properties:
label:
description: The link's label
example: Link label
maxLength: 256
type: string
position:
description: The link's position, used to sort links for the team
format: int32
maximum: 2147483647
type: integer
example: 42
team_id:
description: ID of the team the link is associated with
readOnly: true
type: string
example: abc-123-def
url:
description: The URL for the link
example: https://example.com
type: string
required:
- label
- url
type: object
ContainersResponse:
description: List of containers.
properties:
data:
description: Array of Container objects.
items:
$ref: '#/components/schemas/ContainerItem'
type: array
links:
$ref: '#/components/schemas/ContainersResponseLinks'
meta:
$ref: '#/components/schemas/ContainerMeta'
type: object
LogsArchiveDestination:
description: An archive's destination.
nullable: true
oneOf:
- $ref: '#/components/schemas/LogsArchiveDestinationAzure'
- $ref: '#/components/schemas/LogsArchiveDestinationGCS'
- $ref: '#/components/schemas/LogsArchiveDestinationS3'
type: object
CSMAgentsType:
default: datadog_agent
description: The type of the resource. The value should always be `datadog_agent`.
enum:
- datadog_agent
example: datadog_agent
type: string
x-enum-varnames:
- DATADOG_AGENT
SecurityMonitoringSuppressionID:
description: The ID of the suppression rule.
example: 3dd-0uc-h1s
type: string
ContainerItem:
description: Possible Container models.
oneOf:
- $ref: '#/components/schemas/Container'
- $ref: '#/components/schemas/ContainerGroup'
ContainerImage:
description: Container Image object.
properties:
attributes:
$ref: '#/components/schemas/ContainerImageAttributes'
id:
description: Container Image ID.
type: string
example: abc-123-def
type:
$ref: '#/components/schemas/ContainerImageType'
type: object
AuthNMappingsResponse:
description: Array of AuthN Mappings response.
properties:
data:
description: Array of returned AuthN Mappings.
items:
$ref: '#/components/schemas/AuthNMapping'
type: array
included:
description: Included data in the AuthN Mapping response.
items:
$ref: '#/components/schemas/AuthNMappingIncluded'
type: array
meta:
$ref: '#/components/schemas/ResponseMetaAttributes'
type: object
PermissionAttributes:
description: Attributes of a permission.
properties:
created:
description: Creation time of the permission.
format: date-time
type: string
example: example_value
description:
description: Description of the permission.
type: string
example: example_value
display_name:
description: Displayed name for the permission.
type: string
example: Example Monitor
display_type:
description: Display type.
type: string
example: metric alert
group_name:
description: Name of the permission group.
type: string
example: Example Monitor
name:
description: Name of the permission.
type: string
example: Example Monitor
restricted:
description: Whether or not the permission is restricted.
type: boolean
example: true
type: object
RelationshipToOutcome:
description: The JSON:API relationship to a scorecard outcome.
properties:
data:
$ref: '#/components/schemas/RelationshipToOutcomeData'
type: object
RumMetricType:
default: rum_metrics
description: The type of the resource. The value should always be rum_metrics.
enum:
- rum_metrics
example: rum_metrics
type: string
x-enum-varnames:
- RUM_METRICS
APIKeyResponseIncludedItem:
description: An object related to an API key.
oneOf:
- $ref: '#/components/schemas/User'
- $ref: '#/components/schemas/LeakedKey'
UserRelationshipData:
description: Relationship to user object.
properties:
id:
description: A unique identifier that represents the user.
example: 00000000-0000-0000-0000-000000000000
type: string
type:
$ref: '#/components/schemas/UserResourceType'
required:
- id
- type
type: object
SpansMetricResponseAttributes:
description: The object describing a Datadog span-based metric.
properties:
compute:
$ref: '#/components/schemas/SpansMetricResponseCompute'
filter:
$ref: '#/components/schemas/SpansMetricResponseFilter'
group_by:
description: The rules for the group by.
items:
$ref: '#/components/schemas/SpansMetricResponseGroupBy'
type: array
type: object
ServiceDefinitionV2Dot1Integrations:
description: Third party integrations that Datadog supports.
properties:
opsgenie:
$ref: '#/components/schemas/ServiceDefinitionV2Dot1Opsgenie'
pagerduty:
$ref: '#/components/schemas/ServiceDefinitionV2Dot1Pagerduty'
type: object
RumMetricComputeAggregationType:
description: The type of aggregation to use.
enum:
- count
- distribution
example: distribution
type: string
x-enum-varnames:
- COUNT
- DISTRIBUTION
RumRetentionFilterAttributes:
description: The object describing attributes of a RUM retention filter.
properties:
enabled:
$ref: '#/components/schemas/RumRetentionFilterEnabled'
event_type:
$ref: '#/components/schemas/RumRetentionFilterEventType'
name:
$ref: '#/components/schemas/RunRetentionFilterName'
query:
$ref: '#/components/schemas/RumRetentionFilterQuery'
sample_rate:
$ref: '#/components/schemas/RumRetentionFilterSampleRate'
type: object
ApplicationSecurityWafCustomRuleConditionOperator:
description: Operator to use for the WAF Condition.
enum:
- match_regex
- '!match_regex'
- phrase_match
- '!phrase_match'
- is_xss
- is_sqli
- exact_match
- '!exact_match'
- ip_match
- '!ip_match'
- capture_data
example: match_regex
type: string
x-enum-varnames:
- MATCH_REGEX
- NOT_MATCH_REGEX
- PHRASE_MATCH
- NOT_PHRASE_MATCH
- IS_XSS
- IS_SQLI
- EXACT_MATCH
- NOT_EXACT_MATCH
- IP_MATCH
- NOT_IP_MATCH
- CAPTURE_DATA
Container:
description: Container object.
properties:
attributes:
$ref: '#/components/schemas/ContainerAttributes'
id:
description: Container ID.
type: string
example: abc-123-def
type:
$ref: '#/components/schemas/ContainerType'
type: object
CustomDestinationResponseHttpDestinationAuth:
description: Authentication method of the HTTP requests.
oneOf:
- $ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuthBasic'
- $ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuthCustomHeader'
CloudWorkloadSecurityAgentRuleData:
description: Object for a single Agent rule
properties:
attributes:
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleAttributes'
id:
description: The ID of the Agent rule
example: 3dd-0uc-h1s
type: string
type:
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleType'
type: object
AWSAccountResponseData:
description: AWS Account response data.
properties:
attributes:
$ref: '#/components/schemas/AWSAccountResponseAttributes'
id:
$ref: '#/components/schemas/AWSAccountConfigID'
type:
$ref: '#/components/schemas/AWSAccountType'
required:
- id
- type
type: object
MicrosoftTeamsTenantBasedHandleInfoResponseData:
description: Tenant-based handle data from a response.
properties:
attributes:
$ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleInfoResponseAttributes'
id:
description: The ID of the tenant-based handle.
example: 596da4af-0563-4097-90ff-07230c3f9db3
maxLength: 100
minLength: 1
type: string
type:
$ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleInfoType'
type: object
x-merge-override:
required: false
ServiceDefinitionV2Dot1Version:
default: v2.1
description: Schema version being used.
enum:
- v2.1
example: v2.1
type: string
x-enum-varnames:
- V2_1
ApplicationSecurityWafCustomRuleActionAction:
default: block_request
description: Override the default action to take when the WAF custom rule would block.
enum:
- redirect_request
- block_request
example: block_request
type: string
x-enum-varnames:
- REDIRECT_REQUEST
- BLOCK_REQUEST
RelationshipToTeam:
description: Relationship to team.
properties:
data:
$ref: '#/components/schemas/RelationshipToTeamData'
type: object
x-merge-override:
required: false
ServiceDefinitionMeta:
description: Metadata about a service definition.
properties:
github-html-url:
description: GitHub HTML URL.
type: string
example: https://app.datadoghq.com
ingested-schema-version:
description: Ingestion schema version.
type: string
example: example_value
ingestion-source:
description: Ingestion source of the service definition.
type: string
example: example_value
last-modified-time:
description: Last modified time of the service definition.
type: string
example: '2026-04-17T12:00:00Z'
origin:
description: User defined origin of the service definition.
type: string
example: example_value
origin-detail:
description: User defined origin's detail of the service definition.
type: string
example: example_value
warnings:
description: A list of schema validation warnings.
items:
$ref: '#/components/schemas/ServiceDefinitionMetaWarnings'
type: array
type: object
ContainerImageGroup:
description: Container Image Group object.
properties:
attributes:
$ref: '#/components/schemas/ContainerImageGroupAttributes'
id:
description: Container Image Group ID.
type: string
example: abc-123-def
relationships:
$ref: '#/components/schemas/ContainerImageGroupRelationships'
type:
$ref: '#/components/schemas/ContainerImageGroupType'
type: object
SecurityMonitoringUser:
description: A user.
properties:
handle:
description: The handle of the user.
example: john.doe@datadoghq.com
type: string
name:
description: The name of the user.
example: John Doe
nullable: true
type: string
type: object
RuleType:
default: rule
description: The JSON:API type for scorecard rules.
enum:
- rule
example: rule
type: string
x-enum-varnames:
- RULE
RelationshipToRole:
description: Relationship to role.
properties:
data:
$ref: '#/components/schemas/RelationshipToRoleData'
type: object
x-merge-override:
required: false
LogsArchiveAttributes:
description: The attributes associated with the archive.
properties:
destination:
$ref: '#/components/schemas/LogsArchiveDestination'
include_tags:
default: false
description: 'To store the tags in the archive, set the value "true".
If it is set to "false", the tags will be deleted when the logs are sent to the archive.'
example: false
type: boolean
name:
description: The archive name.
example: Nginx Archive
type: string
query:
description: The archive query/filter. Logs matching this query are included in the archive.
example: source:nginx
type: string
rehydration_max_scan_size_in_gb:
description: Maximum scan size for rehydration from this archive.
example: 100
format: int64
nullable: true
type: integer
rehydration_tags:
description: An array of tags to add to rehydrated logs from an archive.
example:
- team:intake
- team:app
items:
description: A given tag in the `:` format.
type: string
type: array
state:
$ref: '#/components/schemas/LogsArchiveState'
required:
- name
- query
- destination
type: object
MonitorNotificationRuleRelationshipsCreatedBy:
description: The user who created the monitor notification rule.
properties:
data:
$ref: '#/components/schemas/MonitorNotificationRuleRelationshipsCreatedByData'
type: object
LogsMetricsResponse:
description: All the available log-based metric objects.
properties:
data:
description: A list of log-based metric objects.
items:
$ref: '#/components/schemas/LogsMetricResponseData'
type: array
type: object
ProjectAttributes:
description: Project attributes
properties:
key:
description: The project's key
example: CASEM
type: string
name:
description: Project's name
type: string
example: Example Monitor
type: object
DowntimeMuteFirstRecoveryNotification:
description: If the first recovery notification during a downtime should be muted.
example: false
type: boolean
IncidentServiceType:
default: services
description: Incident service resource type.
enum:
- services
example: services
type: string
x-enum-varnames:
- SERVICES
RelationshipToRuleData:
description: Relationship data for a rule.
properties:
data:
$ref: '#/components/schemas/RelationshipToRuleDataObject'
type: object
ServiceDefinitionV2Email:
description: Service owner's email.
properties:
contact:
description: Contact value.
example: contact@datadoghq.com
type: string
name:
description: Contact email.
example: Team Email
type: string
type:
$ref: '#/components/schemas/ServiceDefinitionV2EmailType'
required:
- type
- contact
type: object
ApplicationSecurityWafExclusionFilterRulesTargetTags:
additionalProperties:
type: string
description: Target multiple WAF rules based on their tags.
properties:
category:
description: The category of the targeted WAF rules.
example: attack_attempt
type: string
type:
description: The type of the targeted WAF rules.
example: lfi
type: string
type: object
DowntimeMonitorIdentifier:
description: Monitor identifier for the downtime.
oneOf:
- $ref: '#/components/schemas/DowntimeMonitorIdentifierId'
- $ref: '#/components/schemas/DowntimeMonitorIdentifierTags'
LogsArchiveDestinationAzureType:
default: azure
description: Type of the Azure archive destination.
enum:
- azure
example: azure
type: string
x-enum-varnames:
- AZURE
LogsArchiveIntegrationS3:
description: The S3 Archive's integration destination.
properties:
account_id:
description: The account ID for the integration.
example: '123456789012'
type: string
role_name:
description: The path of the integration.
example: role-name
type: string
required:
- role_name
- account_id
type: object
MonitorConfigPolicyAttributeResponse:
description: Policy and policy type for a monitor configuration policy.
properties:
policy:
$ref: '#/components/schemas/MonitorConfigPolicyPolicy'
policy_type:
$ref: '#/components/schemas/MonitorConfigPolicyType'
type: object
CloudWorkloadSecurityAgentRuleCreatorAttributes:
description: The attributes of the user who created the Agent rule
properties:
handle:
description: The handle of the user
example: datadog.user@example.com
type: string
name:
description: The name of the user
example: Datadog User
nullable: true
type: string
type: object
ContainerImageAttributes:
description: Attributes for a Container Image.
properties:
container_count:
description: Number of containers running the image.
format: int64
type: integer
example: 42
image_flavors:
description: 'List of platform-specific images associated with the image record.
The list contains more than 1 entry for multi-architecture images.'
items:
$ref: '#/components/schemas/ContainerImageFlavor'
type: array
image_tags:
description: List of image tags associated with the Container Image.
items:
description: An image tag associated with the Container Image.
type: string
type: array
images_built_at:
description: 'List of build times associated with the Container Image.
The list contains more than 1 entry for multi-architecture images.'
items:
description: Time the platform-specific Container Image was built.
type: string
type: array
name:
description: Name of the Container Image.
type: string
example: Example Monitor
os_architectures:
description: List of Operating System architectures supported by the Container Image.
items:
description: Operating System architecture supported by the Container Image.
example: amd64
type: string
type: array
os_names:
description: List of Operating System names supported by the Container Image.
items:
description: Operating System supported by the Container Image.
example: linux
type: string
type: array
os_versions:
description: List of Operating System versions supported by the Container Image.
items:
description: Operating System version supported by the Container Image.
type: string
type: array
published_at:
description: Time the image was pushed to the container registry.
type: string
example: example_value
registry:
description: Registry the Container Image was pushed to.
type: string
example: example_value
repo_digest:
description: Digest of the compressed image manifest.
type: string
example: example_value
repository:
description: Repository where the Container Image is stored in.
type: string
example: example_value
short_image:
description: Short version of the Container Image name.
type: string
example: example_value
sizes:
description: 'List of size for each platform-specific image associated with the image record.
The list contains more than 1 entry for multi-architecture images.'
items:
description: Size of the platform-specific Container Image.
format: int64
type: integer
type: array
sources:
description: List of sources where the Container Image was collected from.
items:
description: Source where the Container Image was collected from.
type: string
type: array
tags:
description: List of tags associated with the Container Image.
items:
description: A tag associated with the Container Image.
type: string
type: array
vulnerability_count:
$ref: '#/components/schemas/ContainerImageVulnerabilities'
type: object
RumRetentionFiltersResponse:
description: All RUM retention filters for a RUM application.
properties:
data:
description: A list of RUM retention filters.
items:
$ref: '#/components/schemas/RumRetentionFilterData'
type: array
type: object
DowntimeMonitorIncludedAttributes:
description: Attributes of the monitor identified by the downtime.
properties:
name:
description: The name of the monitor identified by the downtime.
example: A monitor name
type: string
type: object
ListPowerpacksResponse:
description: Response object which includes all powerpack configurations.
properties:
data:
description: List of powerpack definitions.
items:
$ref: '#/components/schemas/PowerpackData'
type: array
included:
description: Array of objects related to the users.
items:
$ref: '#/components/schemas/User'
type: array
links:
$ref: '#/components/schemas/PowerpackResponseLinks'
meta:
$ref: '#/components/schemas/PowerpacksResponseMeta'
type: object
MonitorNotificationRuleName:
description: The name of the monitor notification rule.
example: A notification rule name
maxLength: 1000
minLength: 1
type: string
ListRulesResponseData:
description: Array of rule details.
items:
$ref: '#/components/schemas/ListRulesResponseDataItem'
type: array
ProcessSummariesResponse:
description: List of process summaries.
properties:
data:
description: Array of process summary objects.
items:
$ref: '#/components/schemas/ProcessSummary'
type: array
meta:
$ref: '#/components/schemas/ProcessSummariesMeta'
type: object
DowntimeResponseData:
description: Downtime data.
properties:
attributes:
$ref: '#/components/schemas/DowntimeResponseAttributes'
id:
description: The downtime ID.
example: 00000000-0000-1234-0000-000000000000
type: string
relationships:
$ref: '#/components/schemas/DowntimeRelationships'
type:
$ref: '#/components/schemas/DowntimeResourceType'
type: object
AuthNMappingTeam:
description: Team.
properties:
attributes:
$ref: '#/components/schemas/AuthNMappingTeamAttributes'
id:
description: The ID of the Team.
example: f9bb8444-af7f-11ec-ac2c-da7ad0900001
type: string
type:
$ref: '#/components/schemas/TeamType'
type: object
ServiceDefinitionV2Dot1EmailType:
description: Contact type.
enum:
- email
example: email
type: string
x-enum-varnames:
- EMAIL
ProcessSummaryAttributes:
description: Attributes for a process summary.
properties:
cmdline:
description: Process command line.
type: string
example: example_value
host:
description: Host running the process.
type: string
example: example_value
pid:
description: Process ID.
format: int64
type: integer
example: 42
ppid:
description: Parent process ID.
format: int64
type: integer
example: 42
start:
description: Time the process was started.
type: string
example: example_value
tags:
description: List of tags associated with the process.
items:
description: A tag associated with the process.
type: string
type: array
timestamp:
description: Time the process was seen.
type: string
example: '2026-04-17T12:00:00Z'
user:
description: Process owner.
type: string
example: example_value
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
ApplicationSecurityWafCustomRuleMetadata:
description: Metadata associated with the WAF Custom Rule.
properties:
added_at:
description: The date and time the WAF custom rule was created.
example: '2021-01-01T00:00:00Z'
format: date-time
type: string
added_by:
description: The handle of the user who created the WAF custom rule.
example: john.doe@datadoghq.com
type: string
added_by_name:
description: The name of the user who created the WAF custom rule.
example: John Doe
type: string
modified_at:
description: The date and time the WAF custom rule was last updated.
example: '2021-01-01T00:00:00Z'
format: date-time
type: string
modified_by:
description: The handle of the user who last updated the WAF custom rule.
example: john.doe@datadoghq.com
type: string
modified_by_name:
description: The name of the user who last updated the WAF custom rule.
example: John Doe
type: string
readOnly: true
type: object
ScorecardType:
default: scorecard
description: The JSON:API type for scorecard.
enum:
- scorecard
example: scorecard
type: string
x-enum-varnames:
- SCORECARD
UserResponseRelationships:
description: Relationships of the user object returned by the API.
properties:
org:
$ref: '#/components/schemas/RelationshipToOrganization'
other_orgs:
$ref: '#/components/schemas/RelationshipToOrganizations'
other_users:
$ref: '#/components/schemas/RelationshipToUsers'
roles:
$ref: '#/components/schemas/RelationshipToRoles'
type: object
x-merge-override:
properties: false
PowerpackResponseLinks:
description: Links attributes.
properties:
first:
description: Link to last page.
type: string
example: example_value
last:
description: Link to first page.
example: https://app.datadoghq.com/api/v2/powerpacks?page[offset]=0&page[limit]=25
nullable: true
type: string
next:
description: Link for the next set of results.
example: https://app.datadoghq.com/api/v2/powerpacks?page[offset]=25&page[limit]=25
type: string
prev:
description: Link for the previous set of results.
nullable: true
type: string
example: example_value
self:
description: Link to current page.
example: https://app.datadoghq.com/api/v2/powerpacks
type: string
type: object
ContainerMeta:
description: Response metadata object.
properties:
pagination:
$ref: '#/components/schemas/ContainerMetaPage'
type: object
DowntimeMonitorIncludedItem:
description: Information about the monitor identified by the downtime.
properties:
attributes:
$ref: '#/components/schemas/DowntimeMonitorIncludedAttributes'
id:
description: ID of the monitor identified by the downtime.
example: 12345
format: int64
type: integer
type:
$ref: '#/components/schemas/DowntimeIncludedMonitorType'
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
ServiceDefinitionV2Dot2OpsgenieRegion:
description: Opsgenie instance region.
enum:
- US
- EU
example: US
type: string
x-enum-varnames:
- US
- EU
ContainerGroupAttributes:
description: Attributes for a container group.
properties:
count:
description: Number of containers in the group.
format: int64
type: integer
example: 42
tags:
description: Tags from the group name parsed in key/value format.
type: object
type: object
ServiceDefinitionV2Slack:
description: Service owner's Slack channel.
properties:
contact:
description: Slack Channel.
example: https://yourcompany.slack.com/archives/channel123
type: string
name:
description: Contact Slack.
example: Team Slack
type: string
type:
$ref: '#/components/schemas/ServiceDefinitionV2SlackType'
required:
- type
- contact
type: object
ApplicationSecurityWafExclusionFilterAttributes:
description: Attributes describing a WAF exclusion filter.
properties:
description:
description: A description for the exclusion filter.
example: Exclude false positives on a path
type: string
enabled:
description: Indicates whether the exclusion filter is enabled.
example: true
type: boolean
event_query:
description: The event query matched by the legacy exclusion filter. Cannot be created nor updated.
type: string
example: avg:system.cpu.user{*}
ip_list:
description: The client IP addresses matched by the exclusion filter (CIDR notation is supported).
items:
example: 198.51.100.72
type: string
type: array
metadata:
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterMetadata'
on_match:
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterOnMatch'
parameters:
description: A list of parameters matched by the exclusion filter in the HTTP query string and HTTP request body. Nested parameters can be matched by joining fields with a dot character.
items:
example: list.search.query
type: string
type: array
path_glob:
description: The HTTP path glob expression matched by the exclusion filter.
example: /accounts/*
type: string
rules_target:
description: The WAF rules targeted by the exclusion filter.
items:
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterRulesTarget'
type: array
scope:
description: The services where the exclusion filter is deployed.
items:
$ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterScope'
type: array
search_query:
description: Generated event search query for traces matching the exclusion filter.
readOnly: true
type: string
example: avg:system.cpu.user{*}
type: object
ContainerMetaPage:
description: Paging attributes.
properties:
cursor:
description: The cursor used to get the current results, if any.
type: string
example: example_value
limit:
description: Number of results returned
format: int32
maximum: 10000
minimum: 0
type: integer
example: 42
next_cursor:
description: The cursor used to get the next results, if any.
type: string
example: example_value
prev_cursor:
description: The cursor used to get the previous results, if any.
nullable: true
type: string
example: example_value
total:
description: Total number of records that match the query.
format: int64
type: integer
example: 42
type:
$ref: '#/components/schemas/ContainerMetaPageType'
type: object
RumMetricUniquenessWhen:
description: When to count updatable events. `match` when the event is first seen, or `end` when the event is complete.
enum:
- match
- end
example: match
type: string
x-enum-varnames:
- WHEN_MATCH
- WHEN_END
LogsMetricResponseCompute:
description: The compute rule to compute the log-based metric.
properties:
aggregation_type:
$ref: '#/components/schemas/LogsMetricResponseComputeAggregationType'
include_percentiles:
$ref: '#/components/schemas/LogsMetricComputeIncludePercentiles'
path:
description: The path to the value the log-based metric will aggregate on (only used if the aggregation type is a "distribution").
example: '@duration'
type: string
type: object
MonitorNotificationRuleFilterTags:
additionalProperties: false
description: Filter monitors by tags. Monitors must match all tags.
properties:
tags:
description: A list of monitor tags.
example:
- team:product
- host:abc
items:
maxLength: 255
type: string
maxItems: 20
minItems: 1
type: array
uniqueItems: true
required:
- tags
type: object
PowerpacksResponseMetaPagination:
description: Powerpack response pagination metadata.
properties:
first_offset:
description: The first offset.
format: int64
type: integer
example: 42
last_offset:
description: The last offset.
format: int64
nullable: true
type: integer
example: 42
limit:
description: Pagination limit.
format: int64
type: integer
example: 42
next_offset:
description: The next offset.
format: int64
type: integer
example: 42
offset:
description: The offset.
format: int64
type: integer
example: 42
prev_offset:
description: The previous offset.
format: int64
type: integer
example: 42
total:
description: Total results.
format: int64
type: integer
example: 42
type:
description: Offset type.
type: string
example: metric alert
type: object
DowntimeMonitorIdentifierTags:
additionalProperties: {}
description: Object of the monitor tags.
properties:
monitor_tags:
description: 'A list of monitor tags. For example, tags that are applied directly to monitors,
not tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.
The resulting downtime applies to monitors that match **all** provided monitor tags. Setting `monitor_tags`
to `[*]` configures the downtime to mute all monitors for the given scope.'
example:
- service:postgres
- team:frontend
items:
description: A list of monitor tags.
example: service:postgres
type: string
minItems: 1
type: array
required:
- monitor_tags
type: object
ApplicationSecurityWafExclusionFilterMetadata:
description: Extra information about the exclusion filter.
properties:
added_at:
description: The creation date of the exclusion filter.
format: date-time
type: string
example: example_value
added_by:
description: The handle of the user who created the exclusion filter.
type: string
example: example_value
added_by_name:
description: The name of the user who created the exclusion filter.
type: string
example: Example Monitor
modified_at:
description: The last modification date of the exclusion filter.
format: date-time
type: string
example: example_value
modified_by:
description: The handle of the user who last modified the exclusion filter.
type: string
example: example_value
modified_by_name:
description: The name of the user who last modified the exclusion filter.
type: string
example: Example Monitor
readOnly: true
type: object
AuthNMappingsSort:
description: Sorting options for AuthN Mappings.
enum:
- created_at
- -created_at
- role_id
- -role_id
- saml_assertion_attribute_id
- -saml_assertion_attribute_id
- role.name
- -role.name
- saml_assertion_attribute.attribute_key
- -saml_assertion_attribute.attribute_key
- saml_assertion_attribute.attribute_value
- -saml_assertion_attribute.attribute_value
type: string
x-enum-varnames:
- CREATED_AT_ASCENDING
- CREATED_AT_DESCENDING
- ROLE_ID_ASCENDING
- ROLE_ID_DESCENDING
- SAML_ASSERTION_ATTRIBUTE_ID_ASCENDING
- SAML_ASSERTION_ATTRIBUTE_ID_DESCENDING
- ROLE_NAME_ASCENDING
- ROLE_NAME_DESCENDING
- SAML_ASSERTION_ATTRIBUTE_KEY_ASCENDING
- SAML_ASSERTION_ATTRIBUTE_KEY_DESCENDING
- SAML_ASSERTION_ATTRIBUTE_VALUE_ASCENDING
- SAML_ASSERTION_ATTRIBUTE_VALUE_DESCENDING
RumMetricResponseCompute:
description: The compute rule to compute the rum-based metric.
properties:
aggregation_type:
$ref: '#/components/schemas/RumMetricComputeAggregationType'
include_percentiles:
$ref: '#/components/schemas/RumMetricComputeIncludePercentiles'
path:
description: 'The path to the value the rum-based metric will aggregate on.
Only present when `aggregation_type` is `distribution`.'
example: '@duration'
type: string
type: object
SpansMetricsResponse:
description: All the available span-based metric objects.
properties:
data:
description: A list of span-based metric objects.
items:
$ref: '#/components/schemas/SpansMetricResponseData'
type: array
type: object
ContainerImageGroupRelationshipsData:
description: Links data.
items:
description: A link data.
type: string
type: array
TeamsResponseMetaPagination:
description: Teams response metadata.
properties:
first_offset:
description: The first offset.
format: int64
type: integer
example: 42
last_offset:
description: The last offset.
format: int64
type: integer
example: 42
limit:
description: Pagination limit.
format: int64
type: integer
example: 42
next_offset:
description: The next offset.
format: int64
type: integer
example: 42
offset:
description: The offset.
format: int64
type: integer
example: 42
prev_offset:
description: The previous offset.
format: int64
type: integer
example: 42
total:
description: Total results.
format: int64
type: integer
example: 42
type:
description: Offset type.
type: string
example: metric alert
type: object
Organization:
description: Organization object.
properties:
attributes:
$ref: '#/components/schemas/OrganizationAttributes'
id:
description: ID of the organization.
type: string
example: abc-123-def
type:
$ref: '#/components/schemas/OrganizationsType'
required:
- type
type: object
CustomDestinationResponseHttpDestinationAuthBasicType:
default: basic
description: Type of the basic access authentication.
enum:
- basic
example: basic
type: string
x-enum-varnames:
- BASIC
ContainerImageGroupRelationships:
description: Relationships inside a Container Image Group.
properties:
container_images:
$ref: '#/components/schemas/ContainerImageGroupImagesRelationshipsLink'
type: object
RumMetricResponseData:
description: The rum-based metric properties.
properties:
attributes:
$ref: '#/components/schemas/RumMetricResponseAttributes'
id:
$ref: '#/components/schemas/RumMetricID'
type:
$ref: '#/components/schemas/RumMetricType'
type: object
RelationshipToUsers:
description: Relationship to users.
properties:
data:
description: Relationships to user objects.
example: []
items:
$ref: '#/components/schemas/RelationshipToUserData'
type: array
required:
- data
type: object
ServiceDefinitionV1Info:
description: Basic information about a service.
properties:
dd-service:
description: Unique identifier of the service. Must be unique across all services and is used to match with a service in Datadog.
example: myservice
type: string
description:
description: A short description of the service.
example: A shopping cart service
type: string
display-name:
description: A friendly name of the service.
example: My Service
type: string
service-tier:
description: Service tier.
example: Tier 1
type: string
required:
- dd-service
type: object
CloudWorkloadSecurityAgentRuleAttributes:
description: A Cloud Workload Security Agent rule returned by the API
properties:
actions:
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActions'
agentConstraint:
description: The version of the Agent
type: string
example: example_value
blocking:
description: The blocking policies that the rule belongs to
items:
type: string
type: array
category:
description: The category of the Agent rule
example: Process Activity
type: string
creationAuthorUuId:
description: The ID of the user who created the rule
example: e51c9744-d158-11ec-ad23-da7ad0900002
type: string
creationDate:
description: When the Agent rule was created, timestamp in milliseconds
example: 1624366480320
format: int64
type: integer
creator:
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleCreatorAttributes'
defaultRule:
description: Whether the rule is included by default
example: false
type: boolean
description:
description: The description of the Agent rule
example: My Agent rule
type: string
disabled:
description: The disabled policies that the rule belongs to
items:
type: string
type: array
enabled:
description: Whether the Agent rule is enabled
example: true
type: boolean
expression:
description: The SECL expression of the Agent rule
example: exec.file.name == "sh"
type: string
filters:
description: The platforms the Agent rule is supported on
items:
type: string
type: array
monitoring:
description: The monitoring policies that the rule belongs to
items:
type: string
type: array
name:
description: The name of the Agent rule
example: my_agent_rule
type: string
product_tags:
description: The list of product tags associated with the rule
items:
type: string
type: array
updateAuthorUuId:
description: The ID of the user who updated the rule
example: e51c9744-d158-11ec-ad23-da7ad0900002
type: string
updateDate:
description: Timestamp in milliseconds when the Agent rule was last updated
example: 1624366480320
format: int64
type: integer
updatedAt:
description: When the Agent rule was last updated, timestamp in milliseconds
example: 1624366480320
format: int64
type: integer
updater:
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleUpdaterAttributes'
version:
description: The version of the Agent rule
example: 23
format: int64
type: integer
type: object
OutcomeType:
default: outcome
description: The JSON:API type for an outcome.
enum:
- outcome
example: outcome
type: string
x-enum-varnames:
- OUTCOME
CustomDestinationResponseForwardDestinationHttpType:
default: http
description: Type of the HTTP destination.
enum:
- http
example: http
type: string
x-enum-varnames:
- HTTP
OutcomesResponse:
description: Scorecard outcomes - the result of a rule for a service.
properties:
data:
$ref: '#/components/schemas/OutcomesResponseData'
included:
$ref: '#/components/schemas/OutcomesResponseIncluded'
links:
$ref: '#/components/schemas/OutcomesResponseLinks'
type: object
NullableRelationshipToUserData:
description: Relationship to user object.
nullable: true
properties:
id:
description: A unique identifier that represents the user.
example: 00000000-0000-0000-0000-000000000000
type: string
type:
$ref: '#/components/schemas/UsersType'
required:
- id
- type
type: object
x-merge-override:
required: false
LogsMetricResponseComputeAggregationType:
description: The type of aggregation to use.
enum:
- count
- distribution
example: distribution
type: string
x-enum-varnames:
- COUNT
- DISTRIBUTION
PermissionsType:
default: permissions
description: Permissions resource type.
enum:
- permissions
example: permissions
type: string
x-enum-varnames:
- PERMISSIONS
ApplicationKeyResponseMetaPage:
description: Additional information related to the application key response.
properties:
total_filtered_count:
description: Total filtered application key count.
format: int64
type: integer
example: 42
type: object
PartialApplicationKey:
description: Partial Datadog application key.
properties:
attributes:
$ref: '#/components/schemas/PartialApplicationKeyAttributes'
id:
description: ID of the application key.
type: string
example: abc-123-def
relationships:
$ref: '#/components/schemas/ApplicationKeyRelationships'
type:
$ref: '#/components/schemas/ApplicationKeysType'
type: object
x-merge-override:
required: false
SecurityFilter:
description: The security filter's properties.
properties:
attributes:
$ref: '#/components/schemas/SecurityFilterAttributes'
id:
$ref: '#/components/schemas/SecurityFilterID'
type:
$ref: '#/components/schemas/SecurityFilterType'
type: object
ListTeamsSort:
description: Specifies the order of the returned teams
enum:
- name
- -name
- user_count
- -user_count
type: string
x-enum-varnames:
- NAME
- _NAME
- USER_COUNT
- _USER_COUNT
ServiceDefinitionV1Contact:
description: Contact information about the service.
properties:
email:
description: Service owner’s email.
example: contact@datadoghq.com
type: string
slack:
description: Service owner’s Slack channel.
example: https://yourcompany.slack.com/archives/channel123
type: string
type: object
CloudWorkloadSecurityAgentPolicyType:
default: policy
description: The type of the resource, must always be `policy`
enum:
- policy
example: policy
type: string
x-enum-varnames:
- POLICY
RuleAttributes:
description: Details of a rule.
properties:
category:
deprecated: true
description: The scorecard name to which this rule must belong.
type: string
example: example_value
created_at:
description: Creation time of the rule outcome.
format: date-time
type: string
example: example_value
custom:
description: Defines if the rule is a custom rule.
type: boolean
example: true
description:
description: Explanation of the rule.
type: string
example: example_value
enabled:
description: If enabled, the rule is calculated as part of the score.
example: true
type: boolean
modified_at:
description: Time of the last rule outcome modification.
format: date-time
type: string
example: example_value
name:
description: Name of the rule.
example: Team Defined
type: string
owner:
description: Owner of the rule.
type: string
example: example_value
scorecard_name:
description: The scorecard name to which this rule must belong.
example: Deployments automated via Deployment Trains
type: string
type: object
ServiceDefinitionV2Dot1Link:
description: Service's external links.
properties:
name:
description: Link name.
example: Runbook
type: string
provider:
description: Link provider.
example: Github
type: string
type:
$ref: '#/components/schemas/ServiceDefinitionV2Dot1LinkType'
url:
description: Link URL.
example: https://my-runbook
type: string
required:
- name
- type
- url
type: object
UserResourceType:
default: user
description: User resource type.
enum:
- user
example: user
type: string
x-enum-varnames:
- USER
CustomDestinationType:
default: custom_destination
description: The type of the resource. The value should always be `custom_destination`.
enum:
- custom_destination
example: custom_destination
type: string
x-enum-varnames:
- CUSTOM_DESTINATION
PowerpackInnerWidgetLayout:
description: Powerpack inner widget layout.
properties:
height:
description: The height of the widget. Should be a non-negative integer.
example: 0
format: int64
minimum: 0
type: integer
width:
description: The width of the widget. Should be a non-negative integer.
example: 0
format: int64
minimum: 0
type: integer
x:
description: The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
example: 0
format: int64
minimum: 0
type: integer
y:
description: The position of the widget on the y (vertical) axis. Should be a non-negative integer.
example: 0
format: int64
minimum: 0
type: integer
required:
- x
- y
- width
- height
type: object
MicrosoftTeamsWorkflowsWebhookResponseAttributes:
description: Workflows Webhook handle attributes.
properties:
name:
description: Workflows Webhook handle name.
example: fake-handle-name
maxLength: 255
type: string
type: object
ServiceDefinitionV2MSTeams:
description: Service owner's Microsoft Teams.
properties:
contact:
description: Contact value.
example: https://teams.microsoft.com/myteam
type: string
name:
description: Contact Microsoft Teams.
example: My team channel
type: string
type:
$ref: '#/components/schemas/ServiceDefinitionV2MSTeamsType'
required:
- type
- contact
type: object
IncidentServiceResponseData:
description: Incident Service data from responses.
properties:
attributes:
$ref: '#/components/schemas/IncidentServiceResponseAttributes'
id:
description: The incident service's ID.
example: 00000000-0000-0000-0000-000000000000
type: string
relationships:
$ref: '#/components/schemas/IncidentServiceRelationships'
type:
$ref: '#/components/schemas/IncidentServiceType'
required:
- id
- type
type: object
MonitorNotificationRuleRelationshipsCreatedByData:
description: Data for the user who created the monitor notification rule.
nullable: true
properties:
id:
description: User ID of the monitor notification rule creator.
example: 00000000-0000-1234-0000-000000000000
type: string
type:
$ref: '#/components/schemas/UsersType'
type: object
OutcomesResponseIncludedItem:
description: Attributes of the included rule.
properties:
attributes:
$ref: '#/components/schemas/OutcomesResponseIncludedRuleAttributes'
id:
$ref: '#/components/schemas/RuleId'
type:
$ref: '#/components/schemas/RuleType'
type: object
APIKeysResponseMeta:
description: Additional information related to api keys response.
properties:
max_allowed:
description: Max allowed number of API keys.
format: int64
type: integer
example: 42
page:
$ref: '#/components/schemas/APIKeysResponseMetaPage'
type: object
AWSAccountTags:
description: Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.
items:
description: Tag in the form `key:value`.
example: env:prod
type: string
nullable: true
type: array
AWSAuthConfigRole:
description: AWS Authentication config to integrate your account using an IAM role.
properties:
external_id:
description: AWS IAM External ID for associated role.
type: string
example: abc-123-def
role_name:
description: AWS IAM Role name.
example: DatadogIntegrationRole
maxLength: 576
minLength: 1
type: string
required:
- role_name
type: object
IncidentTeamType:
default: teams
description: Incident Team resource type.
enum:
- teams
example: teams
type: string
x-enum-varnames:
- TEAMS
MonitorNotificationRuleRelationships:
description: All relationships associated with monitor notification rule.
properties:
created_by:
$ref: '#/components/schemas/MonitorNotificationRuleRelationshipsCreatedBy'
type: object
CloudWorkloadSecurityAgentRuleActionSet:
description: The set action applied on the scope matching the rule
properties:
append:
description: Whether the value should be appended to the field
type: boolean
example: true
field:
description: The field of the set action
type: string
example: example_value
name:
description: The name of the set action
type: string
example: Example Monitor
scope:
description: The scope of the set action
type: string
example: example_value
size:
description: The size of the set action
format: int64
type: integer
example: 42
ttl:
description: The time to live of the set action
format: int64
type: integer
example: 42
value:
description: The value of the set action
type: string
example: example_value
type: object
ServiceDefinitionV1Integrations:
description: Third party integrations that Datadog supports.
properties:
pagerduty:
$ref: '#/components/schemas/ServiceDefinitionV1Pagerduty'
type: object
PartialAPIKey:
description: Partial Datadog API key.
properties:
attributes:
$ref: '#/components/schemas/PartialAPIKeyAttributes'
id:
description: ID of the API key.
type: string
example: abc-123-def
relationships:
$ref: '#/components/schemas/APIKeyRelationships'
type:
$ref: '#/components/schemas/APIKeysType'
type: object
x-merge-override:
required: false
ApplicationSecurityWafCustomRuleAction:
description: The definition of `ApplicationSecurityWafCustomRuleAction` object.
properties:
action:
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleActionAction'
parameters:
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleActionParameters'
type: object
CloudWorkloadSecurityAgentRuleKill:
description: Kill system call applied on the container matching the rule
properties:
signal:
description: Supported signals for the kill system call
type: string
example: example_value
type: object
DowntimeScheduleCurrentDowntimeResponse:
description: 'The most recent actual start and end dates for a recurring downtime. For a canceled downtime,
this is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled
downtimes it is the upcoming downtime.'
properties:
end:
description: The end of the current downtime.
example: '2020-01-02T03:04:00.000Z'
format: date-time
nullable: true
type: string
start:
description: The start of the current downtime.
example: '2020-01-02T03:04:00.000Z'
format: date-time
type: string
type: object
SpansMetricComputeIncludePercentiles:
description: 'Toggle to include or exclude percentile aggregations for distribution metrics.
Only present when the `aggregation_type` is `distribution`.'
example: false
type: boolean
OutcomesResponseIncluded:
description: Array of rule details.
items:
$ref: '#/components/schemas/OutcomesResponseIncludedItem'
type: array
ServiceDefinitionV2Dot1LinkType:
description: Link type.
enum:
- doc
- repo
- runbook
- dashboard
- other
example: runbook
type: string
x-enum-varnames:
- DOC
- REPO
- RUNBOOK
- DASHBOARD
- OTHER
ServiceDefinitionSchemaVersions:
description: Schema versions
enum:
- v1
- v2
- v2.1
- v2.2
type: string
x-enum-varnames:
- V1
- V2
- V2_1
- V2_2
AWSLogsConfig:
description: AWS Logs Collection config.
properties:
lambda_forwarder:
$ref: '#/components/schemas/AWSLambdaForwarderConfig'
type: object
RelationshipToSAMLAssertionAttributeData:
description: Data of AuthN Mapping relationship to SAML Assertion Attribute.
properties:
id:
description: The ID of the SAML assertion attribute.
example: '0'
type: string
type:
$ref: '#/components/schemas/SAMLAssertionAttributesType'
required:
- id
- type
type: object
x-merge-override:
required: false
UserAttributes:
description: Attributes of user object returned by the API.
properties:
created_at:
description: Creation time of the user.
format: date-time
type: string
example: example_value
disabled:
description: Whether the user is disabled.
type: boolean
example: true
email:
description: Email of the user.
type: string
example: user@example.com
handle:
description: Handle of the user.
type: string
example: example_value
icon:
description: URL of the user's icon.
type: string
example: example_value
mfa_enabled:
description: If user has MFA enabled.
readOnly: true
type: boolean
example: true
modified_at:
description: Time that the user was last modified.
format: date-time
type: string
example: example_value
name:
description: Name of the user.
nullable: true
type: string
example: Example Monitor
service_account:
description: Whether the user is a service account.
type: boolean
example: true
status:
description: Status of the user.
type: string
example: OK
title:
description: Title of the user.
nullable: true
type: string
example: Example Monitor
verified:
description: Whether the user is verified.
type: boolean
example: true
type: object
LogsMetricResponseAttributes:
description: The object describing a Datadog log-based metric.
properties:
compute:
$ref: '#/components/schemas/LogsMetricResponseCompute'
filter:
$ref: '#/components/schemas/LogsMetricResponseFilter'
group_by:
description: The rules for the group by.
items:
$ref: '#/components/schemas/LogsMetricResponseGroupBy'
type: array
type: object
ApplicationSecurityWafCustomRuleConditionParameters:
description: The scope of the WAF custom rule.
properties:
data:
description: Identifier of a list of data from the denylist. Can only be used as substitution from the list parameter.
example: blocked_users
type: string
inputs:
description: List of inputs on which at least one should match with the given operator.
items:
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleConditionInput'
type: array
list:
description: 'List of value to use with the condition. Only used with the phrase_match, !phrase_match, exact_match and
!exact_match operator.'
items:
type: string
type: array
options:
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleConditionOptions'
regex:
description: Regex to use with the condition. Only used with match_regex and !match_regex operator.
example: path.*
type: string
value:
description: Store the captured value in the specified tag name. Only used with the capture_data operator.
example: custom_tag
type: string
required:
- inputs
type: object
MonitorConfigPolicyTagPolicy:
description: Tag attributes of a monitor configuration policy.
properties:
tag_key:
description: The key of the tag.
example: datacenter
maxLength: 255
type: string
tag_key_required:
description: If a tag key is required for monitor creation.
example: true
type: boolean
valid_tag_values:
description: Valid values for the tag.
example:
- prod
- staging
items:
maxLength: 255
type: string
type: array
type: object
ContainerImageGroupType:
default: container_image_group
description: Type of Container Image Group.
enum:
- container_image_group
example: container_image_group
type: string
x-enum-varnames:
- CONTAINER_IMAGE_GROUP
MonitorNotificationRuleResponseAttributes:
additionalProperties: {}
description: Attributes of the monitor notification rule.
properties:
created:
description: Creation time of the monitor notification rule.
example: '2020-01-02T03:04:00.000Z'
format: date-time
type: string
filter:
$ref: '#/components/schemas/MonitorNotificationRuleFilter'
modified:
description: Time the monitor notification rule was last modified.
example: '2020-01-02T03:04:00.000Z'
format: date-time
type: string
name:
$ref: '#/components/schemas/MonitorNotificationRuleName'
recipients:
$ref: '#/components/schemas/MonitorNotificationRuleRecipients'
type: object
SecurityFilterMeta:
description: Optional metadata associated to the response.
properties:
warning:
description: A warning message.
example: All the security filters are disabled. As a result, no logs are being analyzed.
type: string
type: object
ListApplicationKeysResponse:
description: Response for a list of application keys.
properties:
data:
description: Array of application keys.
items:
$ref: '#/components/schemas/PartialApplicationKey'
type: array
included:
description: Array of objects related to the application key.
items:
$ref: '#/components/schemas/ApplicationKeyResponseIncludedItem'
type: array
meta:
$ref: '#/components/schemas/ApplicationKeyResponseMeta'
type: object
ApplicationSecurityWafCustomRuleCondition:
description: One condition of the WAF Custom Rule.
properties:
operator:
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleConditionOperator'
parameters:
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleConditionParameters'
required:
- operator
- parameters
type: object
RoleAttributes:
description: Attributes of the role.
properties:
created_at:
description: Creation time of the role.
format: date-time
readOnly: true
type: string
example: example_value
modified_at:
description: Time of last role modification.
format: date-time
readOnly: true
type: string
example: example_value
name:
description: The name of the role. The name is neither unique nor a stable identifier of the role.
type: string
example: Example Monitor
user_count:
description: Number of users with that role.
format: int64
readOnly: true
type: integer
example: 42
type: object
ServiceDefinitionData:
description: Service definition data.
properties:
attributes:
$ref: '#/components/schemas/ServiceDefinitionDataAttributes'
id:
description: Service definition id.
type: string
example: abc-123-def
type:
description: Service definition type.
type: string
example: metric alert
type: object
LogsArchiveIntegrationAzure:
description: The Azure archive's integration destination.
properties:
client_id:
description: A client ID.
example: aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa
type: string
tenant_id:
description: A tenant ID.
example: aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa
type: string
required:
- tenant_id
- client_id
type: object
APIKeysSort:
default: name
description: Sorting options
enum:
- created_at
- -created_at
- last4
- -last4
- modified_at
- -modified_at
- name
- -name
type: string
x-enum-varnames:
- CREATED_AT_ASCENDING
- CREATED_AT_DESCENDING
- LAST4_ASCENDING
- LAST4_DESCENDING
- MODIFIED_AT_ASCENDING
- MODIFIED_AT_DESCENDING
- NAME_ASCENDING
- NAME_DESCENDING
User:
description: User object returned by the API.
properties:
attributes:
$ref: '#/components/schemas/UserAttributes'
id:
description: ID of the user.
type: string
example: abc-123-def
relationships:
$ref: '#/components/schemas/UserResponseRelationships'
type:
$ref: '#/components/schemas/UsersType'
type: object
x-merge-override:
required: false
AuthNMapping:
description: The AuthN Mapping object returned by API.
properties:
attributes:
$ref: '#/components/schemas/AuthNMappingAttributes'
id:
description: ID of the AuthN Mapping.
example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d
type: string
relationships:
$ref: '#/components/schemas/AuthNMappingRelationships'
type:
$ref: '#/components/schemas/AuthNMappingsType'
required:
- id
- type
type: object
x-merge-override:
required: false
ContainerImagesResponse:
description: List of Container Images.
properties:
data:
description: Array of Container Image objects.
items:
$ref: '#/components/schemas/ContainerImageItem'
type: array
links:
$ref: '#/components/schemas/ContainerImagesResponseLinks'
meta:
$ref: '#/components/schemas/ContainerImageMeta'
type: object
ContainerGroupRelationshipsLink:
description: Relationships to Containers inside a Container Group.
properties:
data:
$ref: '#/components/schemas/ContainerGroupRelationshipsData'
links:
$ref: '#/components/schemas/ContainerGroupRelationshipsLinks'
type: object
IncidentServiceRelationships:
description: The incident service's relationships.
properties:
created_by:
$ref: '#/components/schemas/RelationshipToUser'
last_modified_by:
$ref: '#/components/schemas/RelationshipToUser'
readOnly: true
type: object
RelationshipToUserData:
description: Relationship to user object.
properties:
id:
description: A unique identifier that represents the user.
example: 00000000-0000-0000-2345-000000000000
type: string
type:
$ref: '#/components/schemas/UsersType'
required:
- id
- type
type: object
x-merge-override:
required: false
ServiceDefinitionV1Version:
default: v1
description: Schema version being used.
enum:
- v1
example: v1
type: string
x-enum-varnames:
- V1
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
ProjectsResponse:
description: Response with projects
properties:
data:
description: Projects response data
items:
$ref: '#/components/schemas/Project'
type: array
type: object
MicrosoftTeamsWorkflowsWebhookHandleResponseData:
description: Workflows Webhook handle data from a response.
properties:
attributes:
$ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookResponseAttributes'
id:
description: The ID of the Workflows webhook handle.
example: 596da4af-0563-4097-90ff-07230c3f9db3
maxLength: 100
minLength: 1
type: string
type:
$ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleType'
type: object
ContainerImageGroupImagesRelationshipsLink:
description: Relationships to Container Images inside a Container Image Group.
properties:
data:
$ref: '#/components/schemas/ContainerImageGroupRelationshipsData'
links:
$ref: '#/components/schemas/ContainerImageGroupRelationshipsLinks'
type: object
CustomDestinationResponseHttpDestinationAuthBasic:
description: Basic access authentication.
properties:
type:
$ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuthBasicType'
required:
- type
type: object
CloudWorkloadSecurityAgentRuleActions:
description: The array of actions the rule can perform if triggered
items:
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleAction'
nullable: true
type: array
ContainerImageType:
default: container_image
description: Type of Container Image.
enum:
- container_image
example: container_image
type: string
x-enum-varnames:
- CONTAINER_IMAGE
ListTeamsInclude:
description: Included related resources optionally requested.
enum:
- team_links
- user_team_permissions
type: string
x-enum-varnames:
- TEAM_LINKS
- USER_TEAM_PERMISSIONS
TeamsField:
description: Supported teams field.
enum:
- id
- name
- handle
- summary
- description
- avatar
- banner
- visible_modules
- hidden_modules
- created_at
- modified_at
- user_count
- link_count
- team_links
- user_team_permissions
type: string
x-enum-varnames:
- ID
- NAME
- HANDLE
- SUMMARY
- DESCRIPTION
- AVATAR
- BANNER
- VISIBLE_MODULES
- HIDDEN_MODULES
- CREATED_AT
- MODIFIED_AT
- USER_COUNT
- LINK_COUNT
- TEAM_LINKS
- USER_TEAM_PERMISSIONS
RuleOutcomeRelationships:
description: The JSON:API relationship to a scorecard rule.
properties:
rule:
$ref: '#/components/schemas/RelationshipToOutcome'
type: object
SAMLAssertionAttribute:
description: SAML assertion attribute.
properties:
attributes:
$ref: '#/components/schemas/SAMLAssertionAttributeAttributes'
id:
description: The ID of the SAML assertion attribute.
example: '0'
type: string
type:
$ref: '#/components/schemas/SAMLAssertionAttributesType'
required:
- id
- type
type: object
x-merge-override:
required: false
PowerpackData:
description: Powerpack data object.
properties:
attributes:
$ref: '#/components/schemas/PowerpackAttributes'
id:
description: ID of the powerpack.
type: string
example: abc-123-def
relationships:
$ref: '#/components/schemas/PowerpackRelationships'
type:
description: Type of widget, must be powerpack.
example: powerpack
type: string
type: object
x-merge-override:
required: false
MonitorConfigPolicyResponseData:
description: A monitor configuration policy data.
properties:
attributes:
$ref: '#/components/schemas/MonitorConfigPolicyAttributeResponse'
id:
description: ID of this monitor configuration policy.
example: 00000000-0000-1234-0000-000000000000
type: string
type:
$ref: '#/components/schemas/MonitorConfigPolicyResourceType'
type: object
ProcessSummaryType:
default: process
description: Type of process summary.
enum:
- process
example: process
type: string
x-enum-varnames:
- PROCESS
SecurityFilterID:
description: The ID of the security filter.
example: 3dd-0uc-h1s
type: string
DowntimeScheduleRecurrenceDuration:
description: The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.
example: 123d
type: string
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
MonitorNotificationRuleResourceType:
default: monitor-notification-rule
description: Monitor notification rule resource type.
enum:
- monitor-notification-rule
example: monitor-notification-rule
type: string
x-enum-varnames:
- MONITOR_NOTIFICATION_RULE
IncidentTeamsResponse:
description: Response with a list of incident team payloads.
properties:
data:
description: An array of incident teams.
example:
- attributes:
name: team name
id: 00000000-7ea3-0000-0000-000000000000
type: teams
items:
$ref: '#/components/schemas/IncidentTeamResponseData'
type: array
included:
description: Included related resources which the user requested.
items:
$ref: '#/components/schemas/IncidentTeamIncludedItems'
readOnly: true
type: array
meta:
$ref: '#/components/schemas/IncidentResponseMeta'
required:
- data
type: object
RumMetricID:
description: The name of the rum-based metric.
example: rum.sessions.webui.count
type: string
RumMetricResponseGroupBy:
description: A group by rule.
properties:
path:
description: The path to the value the rum-based metric will be aggregated over.
example: '@http.status_code'
type: string
tag_name:
description: Eventual name of the tag that gets created. By default, `path` is used as the tag name.
example: status_code
type: string
type: object
OrganizationsType:
default: orgs
description: Organizations resource type.
enum:
- orgs
example: orgs
type: string
x-enum-varnames:
- ORGS
ServiceDefinitionV2OpsgenieRegion:
description: Opsgenie instance region.
enum:
- US
- EU
example: US
type: string
x-enum-varnames:
- US
- EU
CustomDestinationResponseHttpDestinationAuthCustomHeaderType:
default: custom_header
description: Type of the custom header access authentication.
enum:
- custom_header
example: custom_header
type: string
x-enum-varnames:
- CUSTOM_HEADER
ServiceDefinitionV1Pagerduty:
description: PagerDuty service URL for the service.
example: https://my-org.pagerduty.com/service-directory/PMyService
type: string
MonitorNotificationRuleData:
description: Monitor notification rule data.
properties:
attributes:
$ref: '#/components/schemas/MonitorNotificationRuleResponseAttributes'
id:
$ref: '#/components/schemas/MonitorNotificationRuleId'
relationships:
$ref: '#/components/schemas/MonitorNotificationRuleRelationships'
type:
$ref: '#/components/schemas/MonitorNotificationRuleResourceType'
type: object
ApplicationSecurityWafCustomRuleConditionOptions:
description: Options for the operator of this condition.
properties:
case_sensitive:
default: false
description: Evaluate the value as case sensitive.
type: boolean
example: true
min_length:
default: 0
description: Only evaluate this condition if the value has a minimum amount of characters.
format: int64
type: integer
example: 42
type: object
ApplicationKeysType:
default: application_keys
description: Application Keys resource type.
enum:
- application_keys
example: application_keys
type: string
x-enum-varnames:
- APPLICATION_KEYS
TeamsResponseLinks:
description: Teams response links.
properties:
first:
description: First link.
type: string
example: example_value
last:
description: Last link.
nullable: true
type: string
example: example_value
next:
description: Next link.
type: string
example: example_value
prev:
description: Previous link.
nullable: true
type: string
example: example_value
self:
description: Current link.
type: string
example: example_value
type: object
RumMetricComputeIncludePercentiles:
description: 'Toggle to include or exclude percentile aggregations for distribution metrics.
Only present when `aggregation_type` is `distribution`.'
example: true
type: boolean
AWSNamespaceFiltersIncludeOnly:
description: Include only these namespaces.
properties:
include_only:
description: Include only these namespaces.
example:
- AWS/EC2
items:
example: AWS/EC2
type: string
type: array
required:
- include_only
type: object
MonitorConfigPolicyType:
default: tag
description: The monitor configuration policy type.
enum:
- tag
example: tag
type: string
x-enum-varnames:
- TAG
RelationshipToUserTeamPermissionData:
description: Related user team permission data
properties:
id:
description: The ID of the user team permission
example: UserTeamPermissions-aeadc05e-98a8-11ec-ac2c-da7ad0900001-416595
type: string
type:
$ref: '#/components/schemas/UserTeamPermissionType'
required:
- id
- type
type: object
x-merge-override:
required: false
SecurityMonitoringSuppression:
description: The suppression rule's properties.
properties:
attributes:
$ref: '#/components/schemas/SecurityMonitoringSuppressionAttributes'
id:
$ref: '#/components/schemas/SecurityMonitoringSuppressionID'
type:
$ref: '#/components/schemas/SecurityMonitoringSuppressionType'
type: object
ContainerMetaPageType:
default: cursor_limit
description: Type of Container pagination.
enum:
- cursor_limit
example: cursor_limit
type: string
x-enum-varnames:
- CURSOR_LIMIT
ServiceDefinitionV2Dot1:
description: Service definition v2.1 for providing service metadata and integrations.
properties:
application:
description: Identifier for a group of related services serving a product feature, which the service is a part of.
example: my-app
type: string
contacts:
description: A list of contacts related to the services.
items:
$ref: '#/components/schemas/ServiceDefinitionV2Dot1Contact'
type: array
dd-service:
description: Unique identifier of the service. Must be unique across all services and is used to match with a service in Datadog.
example: my-service
type: string
description:
description: A short description of the service.
example: My service description
type: string
extensions:
additionalProperties: {}
description: Extensions to v2.1 schema.
example:
myorg/extension: extensionValue
type: object
integrations:
$ref: '#/components/schemas/ServiceDefinitionV2Dot1Integrations'
lifecycle:
description: The current life cycle phase of the service.
example: sandbox
type: string
links:
description: A list of links related to the services.
items:
$ref: '#/components/schemas/ServiceDefinitionV2Dot1Link'
type: array
schema-version:
$ref: '#/components/schemas/ServiceDefinitionV2Dot1Version'
tags:
description: A set of custom tags.
example:
- my:tag
- service:tag
items:
type: string
type: array
team:
description: Team that owns the service. It is used to locate a team defined in Datadog Teams if it exists.
example: my-team
type: string
tier:
description: Importance of the service.
example: High
type: string
required:
- schema-version
- dd-service
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
UsersRelationship:
description: Relationship to users.
properties:
data:
description: Relationships to user objects.
example: []
items:
$ref: '#/components/schemas/UserRelationshipData'
type: array
required:
- data
type: object
MicrosoftTeamsTenantBasedHandleInfoType:
default: ms-teams-tenant-based-handle-info
description: Tenant-based handle resource type.
enum:
- ms-teams-tenant-based-handle-info
example: ms-teams-tenant-based-handle-info
type: string
x-enum-varnames:
- MS_TEAMS_TENANT_BASED_HANDLE_INFO
CloudWorkloadSecurityAgentRuleActionMetadata:
description: The metadata action applied on the scope matching the rule
properties:
image_tag:
description: The image tag of the metadata action
type: string
example: env:production
service:
description: The service of the metadata action
type: string
example: example_value
short_image:
description: The short image of the metadata action
type: string
example: example_value
type: object
RumMetricResponseUniqueness:
description: The rule to count updatable events. Is only set if `event_type` is `session` or `view`.
properties:
when:
$ref: '#/components/schemas/RumMetricUniquenessWhen'
type: object
RumRetentionFilterEventType:
description: The type of RUM events to filter on.
enum:
- session
- view
- action
- error
- resource
- long_task
- vital
example: session
type: string
x-enum-varnames:
- SESSION
- VIEW
- ACTION
- ERROR
- RESOURCE
- LONG_TASK
- VITAL
ServiceDefinitionV2Doc:
description: Service documents.
properties:
name:
description: Document name.
example: Architecture
type: string
provider:
description: Document provider.
example: google drive
type: string
url:
description: Document URL.
example: https://gdrive/mydoc
type: string
required:
- name
- url
type: object
ServiceDefinitionV2Dot2Type:
description: The type of service.
example: web
type: string
ServiceDefinitionV2Contact:
description: Service owner's contacts information.
oneOf:
- $ref: '#/components/schemas/ServiceDefinitionV2Email'
- $ref: '#/components/schemas/ServiceDefinitionV2Slack'
- $ref: '#/components/schemas/ServiceDefinitionV2MSTeams'
AWSNamespaceFiltersExcludeOnly:
description: 'Exclude only these namespaces from metrics collection. Defaults to `["AWS/SQS", "AWS/ElasticMapReduce"]`.
`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.'
properties:
exclude_only:
description: 'Exclude only these namespaces from metrics collection. Defaults to `["AWS/SQS", "AWS/ElasticMapReduce"]`.
`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.'
example:
- AWS/SQS
- AWS/ElasticMapReduce
items:
example: AWS/SQS
type: string
type: array
required:
- exclude_only
type: object
ApplicationSecurityWafCustomRuleTags:
additionalProperties:
type: string
description: 'Tags associated with the WAF Custom Rule. The concatenation of category and type will form the security
activity field associated with the traces.'
maxProperties: 32
properties:
category:
$ref: '#/components/schemas/ApplicationSecurityWafCustomRuleTagsCategory'
type:
description: The type of the WAF rule, associated with the category will form the security activity.
example: users.login.success
type: string
required:
- category
- type
type: object
ApplicationKeyResponseMeta:
description: Additional information related to the application key response.
properties:
max_allowed_per_user:
description: Max allowed number of application keys per user.
format: int64
type: integer
example: 42
page:
$ref: '#/components/schemas/ApplicationKeyResponseMetaPage'
type: object
LogsArchiveDefinition:
description: The definition of an archive.
properties:
attributes:
$ref: '#/components/schemas/LogsArchiveAttributes'
id:
description: The archive ID.
example: a2zcMylnM4OCHpYusxIi3g
readOnly: true
type: string
type:
default: archives
description: The type of the resource. The value should always be archives.
example: archives
readOnly: true
type: string
required:
- type
type: object
SpansMetricResponseGroupBy:
description: A group by rule.
properties:
path:
description: The path to the value the span-based metric will be aggregated over.
example: resource_name
type: string
tag_name:
description: Eventual name of the tag that gets created. By default, the path attribute is used as the tag name.
example: resource_name
type: string
type: object
SpansMetricID:
description: The name of the span-based metric.
example: my.metric
type: string
ContainerGroup:
description: Container group object.
properties:
attributes:
$ref: '#/components/schemas/ContainerGroupAttributes'
id:
description: Container Group ID.
type: string
example: abc-123-def
relationships:
$ref: '#/components/schemas/ContainerGroupRelationships'
type:
$ref: '#/components/schemas/ContainerGroupType'
type: object
ServiceDefinitionV2Repo:
description: Service code repositories.
properties:
name:
description: Repository name.
example: Source Code
type: string
provider:
description: Repository provider.
example: GitHub
type: string
url:
description: Repository URL.
example: https://github.com/DataDog/schema
type: string
required:
- name
- url
type: object
ServiceDefinitionV1Resource:
description: Service's external links.
properties:
name:
description: Link name.
example: Runbook
type: string
type:
$ref: '#/components/schemas/ServiceDefinitionV1ResourceType'
url:
description: Link URL.
example: https://my-runbook
type: string
required:
- name
- type
- url
type: object
IncidentServiceResponseAttributes:
description: The incident service's attributes from a response.
properties:
created:
description: Timestamp of when the incident service was created.
format: date-time
readOnly: true
type: string
example: example_value
modified:
description: Timestamp of when the incident service was modified.
format: date-time
readOnly: true
type: string
example: example_value
name:
description: Name of the incident service.
example: service name
type: string
type: object
RelationshipToRoleData:
description: Relationship to role object.
properties:
id:
description: The unique identifier of the role.
example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d
type: string
type:
$ref: '#/components/schemas/RolesType'
type: object
x-merge-override:
required: false
ContainerType:
default: container
description: Type of container.
enum:
- container
example: container
type: string
x-enum-varnames:
- CONTAINER
ServiceDefinitionV2Dot1Slack:
description: Service owner's Slack channel.
properties:
contact:
description: Slack Channel.
example: https://yourcompany.slack.com/archives/channel123
type: string
name:
description: Contact Slack.
example: Team Slack
type: string
type:
$ref: '#/components/schemas/ServiceDefinitionV2Dot1SlackType'
required:
- type
- contact
type: object
ListRulesResponse:
description: Scorecard rules response.
properties:
data:
$ref: '#/components/schemas/ListRulesResponseData'
links:
$ref: '#/components/schemas/ListRulesResponseLinks'
type: object
RelationshipToOrganizationData:
description: Relationship to organization object.
properties:
id:
description: ID of the organization.
example: 00000000-0000-beef-0000-000000000000
type: string
type:
$ref: '#/components/schemas/OrganizationsType'
required:
- id
- type
type: object
ContainerImageMetaPageType:
default: cursor_limit
description: Type of Container Image pagination.
enum:
- cursor_limit
example: cursor_limit
type: string
x-enum-varnames:
- CURSOR_LIMIT
PartialApplicationKeyAttributes:
description: Attributes of a partial application key.
properties:
created_at:
description: Creation date of the application key.
example: '2020-11-23T10:00:00.000Z'
readOnly: true
type: string
x-merge-override:
format: false
last4:
description: The last four characters of the application key.
example: abcd
maxLength: 4
minLength: 4
readOnly: true
type: string
x-secret: true
name:
description: Name of the application key.
example: Application Key for managing dashboards
type: string
scopes:
description: Array of scopes to grant the application key.
example:
- dashboards_read
- dashboards_write
- dashboards_public_share
items:
description: Name of scope.
type: string
nullable: true
type: array
type: object
MonitorConfigPolicyResourceType:
default: monitor-config-policy
description: Monitor configuration policy resource type.
enum:
- monitor-config-policy
example: monitor-config-policy
type: string
x-enum-varnames:
- MONITOR_CONFIG_POLICY
RelationshipToTeamLinkData:
description: Relationship between a link and a team
properties:
id:
description: The team link's identifier
example: f9bb8444-af7f-11ec-ac2c-da7ad0900001
type: string
type:
$ref: '#/components/schemas/TeamLinkType'
required:
- id
- type
type: object
x-merge-override:
required: false
CustomDestinationResponseForwardDestinationElasticsearch:
description: The Elasticsearch destination.
properties:
auth:
$ref: '#/components/schemas/CustomDestinationResponseElasticsearchDestinationAuth'
endpoint:
description: 'The destination for which logs will be forwarded to.
Must have HTTPS scheme and forwarding back to Datadog is not allowed.'
example: https://example.com
type: string
index_name:
description: Name of the Elasticsearch index (must follow [Elasticsearch's criteria](https://www.elastic.co/guide/en/elasticsearch/reference/8.11/indices-create-index.html#indices-create-api-path-params)).
example: nginx-logs
type: string
index_rotation:
description: 'Date pattern with US locale and UTC timezone to be appended to the index name after adding `-`
(that is, `${index_name}-${indexPattern}`).
You can customize the index rotation naming pattern by choosing one of these options:
- Hourly: `yyyy-MM-dd-HH` (as an example, it would render: `2022-10-19-09`)
- Daily: `yyyy-MM-dd` (as an example, it would render: `2022-10-19`)
- Weekly: `yyyy-''W''ww` (as an example, it would render: `2022-W42`)
- Monthly: `yyyy-MM` (as an example, it would render: `2022-10`)
If this field is missing or is blank, it means that the index name will always be the same
(that is, no rotation).'
example: yyyy-MM-dd
type: string
type:
$ref: '#/components/schemas/CustomDestinationResponseForwardDestinationElasticsearchType'
required:
- type
- endpoint
- auth
- index_name
type: object
CustomDestinationResponseForwardDestinationElasticsearchType:
default: elasticsearch
description: Type of the Elasticsearch destination.
enum:
- elasticsearch
example: elasticsearch
type: string
x-enum-varnames:
- ELASTICSEARCH
XRayServicesIncludeOnly:
description: Include only these services. Defaults to `[]`.
nullable: true
properties:
include_only:
description: Include only these services.
example:
- AWS/AppSync
items:
example: AWS/AppSync
type: string
type: array
required:
- include_only
type: object
DowntimeNotifyEndTypes:
description: Actions that will trigger a monitor notification if the downtime is in the `notify_end_types` state.
example:
- canceled
- expired
items:
$ref: '#/components/schemas/DowntimeNotifyEndStateActions'
type: array
OrderDirection:
description: The sort direction for results.
enum:
- asc
- desc
example: asc
type: string
x-enum-varnames:
- ASC
- DESC
AWSAccountType:
default: account
description: AWS Account resource type.
enum:
- account
example: account
type: string
x-enum-varnames:
- ACCOUNT
SpansMetricResponseData:
description: The span-based metric properties.
properties:
attributes:
$ref: '#/components/schemas/SpansMetricResponseAttributes'
id:
$ref: '#/components/schemas/SpansMetricID'
type:
$ref: '#/components/schemas/SpansMetricType'
type: object
AWSTracesConfig:
description: AWS Traces Collection config.
properties:
xray_services:
$ref: '#/components/schemas/XRayServicesList'
type: object
PowerpackGroupWidget:
description: Powerpack group widget definition object.
properties:
definition:
$ref: '#/components/schemas/PowerpackGroupWidgetDefinition'
layout:
$ref: '#/components/schemas/PowerpackGroupWidgetLayout'
live_span:
$ref: '#/components/schemas/WidgetLiveSpan'
required:
- definition
type: object
CustomDestinationResponseAttributes:
description: The attributes associated with the custom destination.
properties:
enabled:
default: true
description: Whether logs matching this custom destination should be forwarded or not.
example: true
type: boolean
forward_tags:
default: true
description: Whether tags from the forwarded logs should be forwarded or not.
example: true
type: boolean
forward_tags_restriction_list:
default: []
description: 'List of [keys of tags](https://docs.datadoghq.com/getting_started/tagging/#define-tags) to be filtered.
An empty list represents no restriction is in place and either all or no tags will be
forwarded depending on `forward_tags_restriction_list_type` parameter.'
example:
- datacenter
- host
items:
description: The [key part of a tag](https://docs.datadoghq.com/getting_started/tagging/#define-tags).
type: string
maxItems: 10
minItems: 0
type: array
forward_tags_restriction_list_type:
$ref: '#/components/schemas/CustomDestinationAttributeTagsRestrictionListType'
forwarder_destination:
$ref: '#/components/schemas/CustomDestinationResponseForwardDestination'
name:
description: The custom destination name.
example: Nginx logs
type: string
query:
default: ''
description: The custom destination query filter. Logs matching this query are forwarded to the destination.
example: source:nginx
type: string
type: object
SecurityFilterFilteredDataType:
description: The filtered data type.
enum:
- logs
example: logs
type: string
x-enum-varnames:
- LOGS
DowntimeResourceType:
default: downtime
description: Downtime resource type.
enum:
- downtime
example: downtime
type: string
x-enum-varnames:
- DOWNTIME
ServiceDefinitionV1ResourceType:
description: Link type.
enum:
- doc
- wiki
- runbook
- url
- repo
- dashboard
- oncall
- code
- link
example: runbook
type: string
x-enum-varnames:
- DOC
- WIKI
- RUNBOOK
- URL
- REPO
- DASHBOARD
- ONCALL
- CODE
- LINK
OpsgenieServiceRegionType:
description: The region for the Opsgenie service.
enum:
- us
- eu
- custom
example: us
type: string
x-enum-varnames:
- US
- EU
- CUSTOM
CustomDestinationResponseForwardDestinationSplunkType:
default: splunk_hec
description: Type of the Splunk HTTP Event Collector (HEC) destination.
enum:
- splunk_hec
example: splunk_hec
type: string
x-enum-varnames:
- SPLUNK_HEC
AWSRegionsIncludeOnly:
description: Include only these regions.
properties:
include_only:
description: Include only these regions.
example:
- us-east-1
items:
example: us-east-1
type: string
type: array
required:
- include_only
type: object
CloudWorkloadSecurityAgentPolicyUpdaterAttributes:
description: The attributes of the user who last updated the policy
properties:
handle:
description: The handle of the user
example: datadog.user@example.com
type: string
name:
description: The name of the user
example: Datadog User
nullable: true
type: string
type: object
ProjectResourceType:
default: project
description: Project resource type
enum:
- project
example: project
type: string
x-enum-varnames:
- PROJECT
TeamLinkType:
default: team_links
description: Team link type
enum:
- team_links
example: team_links
type: string
x-enum-varnames:
- TEAM_LINKS
DowntimeMonitorIdentifierId:
additionalProperties: {}
description: Object of the monitor identifier.
properties:
monitor_id:
description: ID of the monitor to prevent notifications.
example: 123
format: int64
type: integer
required:
- monitor_id
type: object
APIKeysResponse:
description: Response for a list of API keys.
properties:
data:
description: Array of API keys.
items:
$ref: '#/components/schemas/PartialAPIKey'
type: array
included:
description: Array of objects related to the API key.
items:
$ref: '#/components/schemas/APIKeyResponseIncludedItem'
type: array
x-merge-override:
items: false
meta:
$ref: '#/components/schemas/APIKeysResponseMeta'
type: object
DowntimeMetaPage:
description: Object containing the total filtered count.
properties:
total_filtered_count:
description: Total count of elements matched by the filter.
format: int64
type: integer
example: 42
type: object
ApplicationKeysSort:
default: name
description: Sorting options
enum:
- created_at
- -created_at
- last4
- -last4
- name
- -name
type: string
x-enum-varnames:
- CREATED_AT_ASCENDING
- CREATED_AT_DESCENDING
- LAST4_ASCENDING
- LAST4_DESCENDING
- NAME_ASCENDING
- NAME_DESCENDING
ServiceDefinitionV2Dot2Contact:
description: Service owner's contacts information.
properties:
contact:
description: Contact value.
example: https://teams.microsoft.com/myteam
type: string
name:
description: Contact Name.
example: My team channel
type: string
type:
description: 'Contact type. Datadog recognizes the following types: `email`, `slack`, and `microsoft-teams`.'
example: slack
type: string
required:
- type
- contact
type: object
SingleAggregatedConnectionResponseDataAttributes:
description: Attributes for an aggregated connection.
properties:
bytes_sent_by_client:
description: The total number of bytes sent by the client over the given period.
format: int64
type: integer
example: 42
bytes_sent_by_server:
description: The total number of bytes sent by the server over the given period.
format: int64
type: integer
example: 42
group_bys:
additionalProperties:
description: The values for each group by.
items:
type: string
type: array
description: The key, value pairs for each group by.
type: object
packets_sent_by_client:
description: The total number of packets sent by the client over the given period.
format: int64
type: integer
example: 42
packets_sent_by_server:
description: The total number of packets sent by the server over the given period.
format: int64
type: integer
example: 42
rtt_micro_seconds:
description: Measured as TCP smoothed round trip time in microseconds (the time between a TCP frame being sent and acknowledged).
format: int64
type: integer
example: 42
tcp_closed_connections:
description: The number of TCP connections in a closed state. Measured in connections per second from the client.
format: int64
type: integer
example: 42
tcp_established_connections:
description: The number of TCP connections in an established state. Measured in connections per second from the client.
format: int64
type: integer
example: 42
tcp_refusals:
description: The number of TCP connections that were refused by the server. Typically this indicates an attempt to connect to an IP/port that is not receiving connections, or a firewall/security misconfiguration.
format: int64
type: integer
example: 42
tcp_resets:
description: The number of TCP connections that were reset by the server.
format: int64
type: integer
example: 42
tcp_retransmits:
description: TCP Retransmits represent detected failures that are retransmitted to ensure delivery. Measured in count of retransmits from the client.
format: int64
type: integer
example: 42
tcp_timeouts:
description: The number of TCP connections that timed out from the perspective of the operating system. This can indicate general connectivity and latency issues.
format: int64
type: integer
example: 42
type: object
ContainerImageMetaPage:
description: Paging attributes.
properties:
cursor:
description: The cursor used to get the current results, if any.
type: string
example: example_value
limit:
description: Number of results returned
format: int32
maximum: 10000
minimum: 0
type: integer
example: 42
next_cursor:
description: The cursor used to get the next results, if any.
type: string
example: example_value
prev_cursor:
description: The cursor used to get the previous results, if any.
nullable: true
type: string
example: example_value
total:
description: Total number of records that match the query.
format: int64
type: integer
example: 42
type:
$ref: '#/components/schemas/ContainerImageMetaPageType'
type: object
CustomDestinationResponseForwardDestinationSplunk:
description: The Splunk HTTP Event Collector (HEC) destination.
properties:
endpoint:
description: 'The destination for which logs will be forwarded to.
Must have HTTPS scheme and forwarding back to Datadog is not allowed.'
example: https://example.com
type: string
type:
$ref: '#/components/schemas/CustomDestinationResponseForwardDestinationSplunkType'
required:
- type
- endpoint
type: object
RumMetricsResponse:
description: All the available rum-based metric objects.
properties:
data:
description: A list of rum-based metric objects.
items:
$ref: '#/components/schemas/RumMetricResponseData'
type: array
type: object
AuthNMappingTeamAttributes:
description: Team attributes.
properties:
avatar:
description: Unicode representation of the avatar for the team, limited to a single grapheme
example: 🥑
nullable: true
type: string
banner:
description: Banner selection for the team
format: int64
nullable: true
type: integer
example: 42
handle:
description: The team's identifier
example: example-team
maxLength: 195
type: string
link_count:
description: The number of links belonging to the team
format: int32
maximum: 2147483647
readOnly: true
type: integer
example: 42
name:
description: The name of the team
example: Example Team
maxLength: 200
type: string
summary:
description: A brief summary of the team, derived from the `description`
maxLength: 120
nullable: true
type: string
example: example_value
user_count:
description: The number of users belonging to the team
format: int32
maximum: 2147483647
readOnly: true
type: integer
example: 42
type: object
PowerpackGroupWidgetLayout:
description: Powerpack group widget layout.
properties:
height:
description: The height of the widget. Should be a non-negative integer.
example: 0
format: int64
minimum: 0
type: integer
width:
description: The width of the widget. Should be a non-negative integer.
example: 0
format: int64
minimum: 0
type: integer
x:
description: The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
example: 0
format: int64
minimum: 0
type: integer
y:
description: The position of the widget on the y (vertical) axis. Should be a non-negative integer.
example: 0
format: int64
minimum: 0
type: integer
required:
- x
- y
- width
- height
type: object
TeamIncluded:
description: Included resources related to the team
oneOf:
- $ref: '#/components/schemas/User'
- $ref: '#/components/schemas/TeamLink'
- $ref: '#/components/schemas/UserTeamPermission'
ContainerGroupRelationshipsLinks:
description: Links attributes.
properties:
related:
description: Link to related containers.
type: string
example: example_value
type: object
CustomDestinationResponseForwardDestinationHttp:
description: The HTTP destination.
properties:
auth:
$ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuth'
endpoint:
description: 'The destination for which logs will be forwarded to.
Must have HTTPS scheme and forwarding back to Datadog is not allowed.'
example: https://example.com
type: string
type:
$ref: '#/components/schemas/CustomDestinationResponseForwardDestinationHttpType'
required:
- type
- endpoint
- auth
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
ListRulesResponseDataItem:
description: Rule details.
properties:
attributes:
$ref: '#/components/schemas/RuleAttributes'
id:
$ref: '#/components/schemas/RuleId'
relationships:
$ref: '#/components/schemas/RelationshipToRule'
type:
$ref: '#/components/schemas/RuleType'
type: object
CsmAgentsResponse:
description: Response object that includes a list of CSM Agents.
properties:
data:
description: A list of Agents.
items:
$ref: '#/components/schemas/CsmAgentData'
type: array
meta:
$ref: '#/components/schemas/CSMAgentsMetadata'
type: object
DowntimeStatus:
description: The current status of the downtime.
enum:
- active
- canceled
- ended
- scheduled
example: active
type: string
x-enum-varnames:
- ACTIVE
- CANCELED
- ENDED
- SCHEDULED
CloudWorkloadSecurityAgentRuleType:
default: agent_rule
description: The type of the resource, must always be `agent_rule`
enum:
- agent_rule
example: agent_rule
type: string
x-enum-varnames:
- AGENT_RULE
DowntimeNotifyEndStateTypes:
description: State that will trigger a monitor notification when the `notify_end_types` action occurs.
enum:
- alert
- no data
- warn
example: alert
type: string
x-enum-varnames:
- ALERT
- NO_DATA
- WARN
DowntimeScheduleRecurrencesResponse:
description: A recurring downtime schedule definition.
properties:
current_downtime:
$ref: '#/components/schemas/DowntimeScheduleCurrentDowntimeResponse'
recurrences:
description: A list of downtime recurrences.
items:
$ref: '#/components/schemas/DowntimeScheduleRecurrenceResponse'
maxItems: 5
minItems: 1
type: array
timezone:
default: UTC
description: 'The timezone in which to schedule the downtime. This affects recurring start and end dates.
Must match `display_timezone`.'
example: America/New_York
type: string
required:
- recurrences
type: object
ServiceDefinitionV2Dot1Opsgenie:
description: Opsgenie integration for the service.
properties:
region:
$ref: '#/components/schemas/ServiceDefinitionV2Dot1OpsgenieRegion'
service-url:
description: Opsgenie service url.
example: https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000
type: string
required:
- service-url
type: object
ApplicationSecurityWafExclusionFilterID:
description: The identifier of the WAF exclusion filter.
example: 3dd-0uc-h1s
readOnly: true
type: string
DowntimeResponseIncludedItem:
description: An object related to a downtime.
oneOf:
- $ref: '#/components/schemas/User'
- $ref: '#/components/schemas/DowntimeMonitorIncludedItem'
ContainersResponseLinks:
description: Pagination links.
properties:
first:
description: Link to the first page.
type: string
example: example_value
last:
description: Link to the last page.
nullable: true
type: string
example: example_value
next:
description: Link to the next page.
nullable: true
type: string
example: example_value
prev:
description: Link to previous page.
nullable: true
type: string
example: example_value
self:
description: Link to current page.
type: string
example: example_value
type: object
AWSAuthConfig:
description: AWS Authentication config.
oneOf:
- $ref: '#/components/schemas/AWSAuthConfigKeys'
- $ref: '#/components/schemas/AWSAuthConfigRole'
IncidentRelatedObject:
description: Object related to an incident.
enum:
- users
- attachments
type: string
x-enum-varnames:
- USERS
- ATTACHMENTS
PowerpackInnerWidgets:
description: Powerpack group widget definition of individual widgets.
properties:
definition:
additionalProperties: {}
description: Information about widget.
example:
definition:
content: example
type: note
type: object
layout:
$ref: '#/components/schemas/PowerpackInnerWidgetLayout'
required:
- definition
type: object
SecurityFilterAttributes:
description: The object describing a security filter.
properties:
exclusion_filters:
description: The list of exclusion filters applied in this security filter.
items:
$ref: '#/components/schemas/SecurityFilterExclusionFilterResponse'
type: array
filtered_data_type:
$ref: '#/components/schemas/SecurityFilterFilteredDataType'
is_builtin:
description: Whether the security filter is the built-in filter.
example: false
type: boolean
is_enabled:
description: Whether the security filter is enabled.
example: false
type: boolean
name:
description: The security filter name.
example: Custom security filter
type: string
query:
description: The security filter query. Logs accepted by this query will be accepted by this filter.
example: service:api
type: string
version:
description: The version of the security filter.
example: 1
format: int32
maximum: 2147483647
type: integer
type: object
SpansMetricComputeAggregationType:
description: The type of aggregation to use.
enum:
- count
- distribution
example: distribution
type: string
x-enum-varnames:
- COUNT
- DISTRIBUTION
parameters:
ApplicationKeyFilterCreatedAtEndParameter:
description: Only include application keys created on or before the specified date.
in: query
name: filter[created_at][end]
required: false
schema:
example: '2020-11-24T18:46:21+00:00'
type: string
x-merge-override:
format: false
APIKeyFilterParameter:
description: Filter API keys by the specified string.
in: query
name: filter
required: false
schema:
type: string
IncidentServiceSearchQueryParameter:
description: A search query that filters services by name.
in: query
name: filter
required: false
schema:
example: ExampleServiceName
type: string
APIKeyFilterCreatedAtEndParameter:
description: Only include API keys created on or before the specified date.
in: query
name: filter[created_at][end]
required: false
schema:
example: '2020-11-24T18:46:21+00:00'
type: string
x-merge-override:
format: false
APIKeyCategoryParameter:
description: Filter API keys by category.
in: query
name: filter[category]
required: false
schema:
type: string
RumApplicationIDParameter:
description: RUM application ID.
in: path
name: app_id
required: true
schema:
type: string
ApplicationKeyFilterCreatedAtStartParameter:
description: Only include application keys created on or after the specified date.
in: query
name: filter[created_at][start]
required: false
schema:
example: '2020-11-24T18:46:21+00:00'
type: string
x-merge-override:
format: false
ApplicationKeyIncludeParameter:
description: Resource path for related resources to include in the response. Only `owned_by` is supported.
in: query
name: include
required: false
schema:
example: owned_by
type: string
IncidentTeamIncludeQueryParameter:
description: Specifies which types of related objects should be included in the response.
in: query
name: include
required: false
schema:
$ref: '#/components/schemas/IncidentRelatedObject'
MicrosoftTeamsTenantIDQueryParameter:
description: Your tenant id.
in: query
name: tenant_id
required: false
schema:
type: string
RoleID:
description: The unique identifier of the role.
in: path
name: role_id
required: true
schema:
type: string
APIKeyReadConfigReadEnabledParameter:
description: Filter API keys by remote config read enabled status.
in: query
name: filter[remote_config_read_enabled]
required: false
schema:
type: boolean
APIKeyFilterCreatedAtStartParameter:
description: Only include API keys created on or after the specified date.
in: query
name: filter[created_at][start]
required: false
schema:
example: '2020-11-24T18:46:21+00:00'
type: string
x-merge-override:
format: false
SchemaVersion:
description: The schema version desired in the response.
in: query
name: schema_version
required: false
schema:
$ref: '#/components/schemas/ServiceDefinitionSchemaVersions'
PageSize:
description: Size for a given page. The maximum allowed value is 100.
in: query
name: page[size]
required: false
schema:
default: 10
example: 10
format: int64
type: integer
PageOffset:
description: Specific offset to use as the beginning of the returned page.
in: query
name: page[offset]
required: false
schema:
default: 0
example: 0
format: int64
type: integer
IncidentTeamSearchQueryParameter:
description: A search query that filters teams by name.
in: query
name: filter
required: false
schema:
example: ExampleTeamName
type: string
APIKeyFilterModifiedAtEndParameter:
description: Only include API keys modified on or before the specified date.
in: query
name: filter[modified_at][end]
required: false
schema:
example: '2020-11-24T18:46:21+00:00'
type: string
x-merge-override:
format: false
APIKeysSortParameter:
description: 'API key attribute used to sort results. Sort order is ascending
by default. In order to specify a descending sort, prefix the
attribute with a minus sign.'
in: query
name: sort
required: false
schema:
$ref: '#/components/schemas/APIKeysSort'
APIKeyFilterModifiedAtStartParameter:
description: Only include API keys modified on or after the specified date.
in: query
name: filter[modified_at][start]
required: false
schema:
example: '2020-11-24T18:46:21+00:00'
type: string
x-merge-override:
format: false
MicrosoftTeamsHandleNameQueryParameter:
description: Your tenant-based handle name.
in: query
name: name
required: false
schema:
type: string
MicrosoftTeamsWorkflowsWebhookHandleNameQueryParameter:
description: Your Workflows webhook handle name.
in: query
name: name
required: false
schema:
type: string
APIKeyIncludeParameter:
description: Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`.
in: query
name: include
required: false
schema:
example: created_by,modified_by
type: string
ApplicationKeyFilterParameter:
description: Filter application keys by the specified string.
in: query
name: filter
required: false
schema:
type: string
PageNumber:
description: Specific page number to return.
in: query
name: page[number]
required: false
schema:
default: 0
example: 0
format: int64
type: integer
CloudWorkloadSecurityQueryAgentPolicyID:
description: The ID of the Agent policy
example: 6517fcc1-cec7-4394-a655-8d6e9d085255
in: query
name: policy_id
required: false
schema:
type: string
ApplicationKeysSortParameter:
description: 'Application key attribute used to sort results. Sort order is ascending
by default. In order to specify a descending sort, prefix the
attribute with a minus sign.'
in: query
name: sort
required: false
schema:
$ref: '#/components/schemas/ApplicationKeysSort'
RestrictionQueryUserID:
description: The ID of the user.
in: path
name: user_id
required: true
schema:
type: string
IncidentServiceIncludeQueryParameter:
description: Specifies which types of related objects should be included in the response.
in: query
name: include
required: false
schema:
$ref: '#/components/schemas/IncidentRelatedObject'
responses:
PreconditionFailedResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Failed Precondition
NotAuthorizedResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Not Authorized
NotFoundResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Not Found
ForbiddenResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
TooManyRequestsResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
UnauthorizedResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Unauthorized
BadRequestResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
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