Datadog All API
The All API from Datadog — 44 operation(s) for all.
Datadog All API is one of 290 APIs that Datadog publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 4 JSON Schema definitions.
Tagged areas include All. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, an API reference, and 4 JSON Schemas.
This API exposes 44 operations across 44 paths, and defines 509 schemas. It is described by OpenAPI 3.0.0, at version 1.0.
Requests are made against 3 base URLs: https://{subdomain}.{site}, {protocol}://{name}, https://{subdomain}.{site}.
44 operations
44 paths
509 schemas
44 GET
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 4
Datadog All API declares
4 security schemes
for authenticating requests.
It supports OAuth 2.0 (AuthZ) using the authorizationCode flow, exposing 68 scopes.
An API key is passed in the header as DD-API-KEY (apiKeyAuth).
An API key is passed in the header as DD-APPLICATION-KEY (appKeyAuth).
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
AuthZ— This API uses OAuth 2 with the implicit grant flow.apiKeyAuth— Your Datadog API Key.appKeyAuth— Your Datadog APP Key.
Paths & Operations 44
Across 44 paths, the API surfaces 44 operations — 44 GET. Each is listed below with its method, path, parameters, and response codes.
All 44
GET
/api/v2/api_keys
Datadog Get All Api Keys
GET
/api/v2/apm/config/metrics
Datadog Get All Span-based Metrics
GET
/api/v2/apm/config/retention-filters
Datadog List All Apm Retention Filters
GET
/api/v2/application_keys
Datadog Get All Application Keys
GET
/api/v2/authn_mappings
Datadog List All Authn Mappings
GET
/api/v2/cases/projects
Datadog Get All Projects
GET
/api/v2/container_images
Datadog Get All Container Images
GET
/api/v2/containers
Datadog Get All Containers
GET
/api/v2/csm/onboarding/agents
Datadog Get All Csm Agents
GET
/api/v2/csm/onboarding/serverless/agents
Datadog Get All Csm Serverless Agents
GET
/api/v2/current_user/application_keys
Datadog Get All Application Keys Owned by Current User
GET
/api/v2/downtime
Datadog Get All Downtimes
GET
/api/v2/integration/aws/accounts
Datadog List All Aws Integrations
GET
/api/v2/integration/gcp/accounts
Datadog List All Gcp Sts-enabled Service Accounts
GET
/api/v2/integration/ms-teams/configuration/tenant-based-handles
Datadog Get All Tenant-based Handles
GET
/api/v2/integration/ms-teams/configuration/workflows-webhook-handles
Datadog Get All Workflows Webhook Handles
GET
/api/v2/integration/opsgenie/services
Datadog Get All Service Objects
GET
/api/v2/logs/config/archives
Datadog Get All Archives
GET
/api/v2/logs/config/custom-destinations
Datadog Get All Custom Destinations
GET
/api/v2/logs/config/metrics
Datadog Get All Log-based Metrics
GET
/api/v2/logs/config/restriction_queries/user/{user_id}
Datadog Get All Restriction Queries for a Given User
GET
/api/v2/monitor/notification_rule
Datadog Get All Monitor Notification Rules
GET
/api/v2/monitor/policy
Datadog Get All Monitor Configuration Policies
GET
/api/v2/network/connections/aggregate
Datadog Get All Aggregated Connections
GET
/api/v2/powerpacks
Datadog Get All Powerpacks
GET
/api/v2/processes
Datadog Get All Processes
GET
/api/v2/remote_config/products/asm/waf/custom_rules
Datadog List All Waf Custom Rules
GET
/api/v2/remote_config/products/asm/waf/exclusion_filters
Datadog List All Waf Exclusion Filters
GET
/api/v2/remote_config/products/cws/agent_rules
Datadog Get All Workload Protection Agent Rules
GET
/api/v2/remote_config/products/cws/policy
Datadog Get All Workload Protection Policies
GET
/api/v2/roles/{role_id}/users
Datadog Get All Users of a Role
GET
/api/v2/rum/applications
Datadog List All the Rum Applications
GET
/api/v2/rum/applications/{app_id}/retention_filters
Datadog Get All Rum Retention Filters
GET
/api/v2/rum/config/metrics
Datadog Get All Rum-based Metrics
GET
/api/v2/scorecard/outcomes
Datadog List All Rule Outcomes
GET
/api/v2/scorecard/rules
Datadog List All Rules
GET
/api/v2/security_monitoring/cloud_workload_security/agent_rules
Datadog Get All Workload Protection Agent Rules (us1-fed)
GET
/api/v2/security_monitoring/configuration/security_filters
Datadog Get All Security Filters
GET
/api/v2/security_monitoring/configuration/suppressions
Datadog Get All Suppression Rules
GET
/api/v2/servicesdeprecated
Datadog Get a List of All Incident Services
GET
/api/v2/services/definitions
Datadog Get All Service Definitions
GET
/api/v2/team
Datadog Get All Teams
GET
/api/v2/teamsdeprecated
Datadog Get a List of All Incident Teams
GET
/api/v2/users
Datadog List All Users
Schemas 509
The contract defines 509 schemas that model the data the API accepts and returns. The most detailed are CloudWorkloadSecurityAgentRuleAttributes (21 properties), CsmAgentsAttributes (17 properties), ContainerImageAttributes (17 properties), CloudWorkloadSecurityAgentPolicyAttributes (15 properties). Each schema is shown below with its type and property counts.
ServiceDefinitionV2
object
Service definition V2 for providing service metadata and integrations.
11 properties
2 required
LogsArchiveDestinationAzure
object
The Azure archive destination.
6 properties
4 required
AWSMetricsConfig
object
AWS Metrics Collection config.
6 properties
ContainerImageFlavor
object
Container Image breakdown by supported platform.
5 properties
DowntimeRelationshipsMonitorData
object
Data for the monitor.
2 properties
ListRulesResponseLinks
object
Links attributes.
1 property
ServiceDefinitionV2Dot1SlackType
string
Contact type.
OrganizationAttributes
object
Attributes of the organization.
8 properties
TeamLink
object
Team link
3 properties
3 required
RelationshipToRuleDataObject
object
Rule relationship data.
2 properties
RelationshipToTeamLinks
object
Relationship between a team and a team link
2 properties
MicrosoftTeamsWorkflowsWebhookHandlesResponse
object
Response with a list of Workflows webhook handles.
1 property
1 required
IncidentServicesResponse
object
Response with a list of incident service payloads.
3 properties
1 required
DowntimeScheduleRecurrenceRrule
string
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…
MonitorConfigPolicyListResponse
object
Response for retrieving all monitor configuration policies.
1 property
WidgetLiveSpan
string
The available timeframes depend on the widget you are using.
UserResponseIncludedItem
An object related to a user.
MicrosoftTeamsTenantBasedHandleInfoResponseAttributes
object
Tenant-based handle attributes.
7 properties
ApplicationSecurityWafExclusionFilterOnMatch
string
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 tra…
AuthNMappingResourceType
string
The type of resource being mapped to.
ApplicationSecurityWafCustomRuleListResponse
object
Response object that includes a list of WAF custom rules.
1 property
TeamsResponseMeta
object
Teams response metadata.
1 property
ApplicationSecurityWafCustomRuleConditionInputAddress
string
Input from the request on which the condition should apply.
SingleAggregatedConnectionResponseData
object
Object describing an aggregated connection.
3 properties
ContainerAttributes
object
Attributes for a container.
10 properties
RelationshipToUser
object
Relationship to user.
1 property
1 required
ServiceDefinitionV2Link
object
Service's external links.
3 properties
3 required
RelationshipToTeamData
object
Relationship to Team object.
2 properties
AWSAccountID
string
AWS Account ID.
RelationshipToPermissionData
object
Relationship to permission object.
2 properties
TeamRelationships
object
Resources related to a team
2 properties
RUMApplicationsResponse
object
RUM applications response.
1 property
IncidentResponseMetaPagination
object
Pagination properties.
3 properties
CloudWorkloadSecurityAgentRuleAction
object
The action the rule can perform if triggered
4 properties
DowntimeMessage
string
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.
UsersResponse
object
Response containing information about multiple users.
3 properties
OutcomesBatchResponseAttributes
object
The JSON:API attributes for an outcome.
5 properties
SpansMetricResponseCompute
object
The compute rule to compute the span-based metric.
3 properties
IncidentResponseMeta
object
The metadata object containing pagination metadata.
1 property
CloudWorkloadSecurityAgentRuleUpdaterAttributes
object
The attributes of the user who last updated the Agent rule
2 properties
ServiceDefinitionV2Version
string
Schema version being used.
ProcessSummariesMeta
object
Response metadata object.
1 property
CloudWorkloadSecurityAgentPoliciesListResponse
object
Response object that includes a list of Agent policies
1 property
PowerpackGroupWidgetDefinition
object
Powerpack group widget object.
5 properties
3 required
Permission
object
Permission object.
3 properties
1 required
ServiceDefinitionDataAttributes
object
Service definition attributes.
2 properties
LogsArchiveIntegrationGCS
object
The GCS archive's integration destination.
2 properties
1 required
OutcomesResponseIncludedRuleAttributes
object
Details of a rule.
2 properties
DowntimeScheduleRecurrenceResponse
object
An RRULE-based recurring downtime.
3 properties
GCPSTSServiceAccountAttributes
object
Attributes associated with your service account.
11 properties
ServiceDefinitionV2Dot2
object
Service definition v2.2 for providing service metadata and integrations.
15 properties
2 required
PowerpackAttributes
object
Powerpack attribute object.
5 properties
2 required
ServiceDefinitionsListResponse
object
Create service definitions response.
1 property
QuerySortOrder
string
Direction of sort.
RUMApplicationList
object
RUM application list.
3 properties
2 required
AuthNMappingRelationships
object
All relationships associated with AuthN Mapping.
3 properties
ServiceDefinitionV2Dot2Version
string
Schema version being used.
RetentionFilterAll
object
The definition of the retention filter.
3 properties
3 required
RumRetentionFilterType
string
The type of the resource. The value should always be retentionfilters.
ServiceDefinitionV2Dot1MSTeamsType
string
Contact type.
ContainerImageGroupRelationshipsLinks
object
Links attributes.
1 property
APIErrorResponse
object
API error response.
1 property
1 required
XRayServicesIncludeAll
object
Include all services.
1 property
1 required
LogsMetricID
string
The name of the log-based metric.
SpansMetricResponseFilter
object
The span-based metric filter. Spans matching this filter will be aggregated in this metric.
1 property
RumMetricEventType
string
The type of RUM events to filter on.
RunRetentionFilterName
string
The name of a RUM retention filter.
UserTeamPermissionAttributes
object
User team permission attributes
1 property
PowerpacksResponseMeta
object
Powerpack response metadata.
1 property
ApplicationSecurityWafCustomRuleConditionInput
object
Input from the request on which the condition should apply.
2 properties
1 required
State
string
The state of the rule evaluation.
DowntimeRelationships
object
All relationships associated with downtime.
2 properties
LogsArchiveEncryptionS3
object
The S3 encryption settings.
2 properties
1 required
SecurityMonitoringSuppressionsResponse
object
Response object containing the available suppression rules.
1 property
AWSNamespaceTagFilter
object
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…
2 properties
ContainerImageVulnerabilities
object
Vulnerability counts associated with the Container Image.
7 properties
ApplicationSecurityWafCustomRuleActionParameters
object
The definition of ApplicationSecurityWafCustomRuleActionParameters object.
2 properties
ApplicationSecurityWafCustomRuleScope
object
The scope of the WAF custom rule.
2 properties
2 required
AWSAuthConfigKeys
object
AWS Authentication config to integrate your account using an access key pair.
2 properties
1 required
XRayServicesList
AWS X-Ray services to collect traces from. Defaults to includeonly.
MonitorNotificationRuleResponseIncludedItem
An object related to a monitor notification rule.
ServiceDefinitionV2Dot1MSTeams
object
Service owner's Microsoft Teams.
3 properties
2 required
ContainerGroupType
string
Type of container group.
TeamsResponse
object
Response with multiple teams
4 properties
DowntimeNotifyEndStateActions
string
Action that will trigger a monitor notification if the downtime is in the notifyendtypes state.
OpsgenieServiceType
string
Opsgenie service resource type.
RelationshipToSAMLAssertionAttribute
object
AuthN Mapping relationship to SAML Assertion Attribute.
1 property
1 required
MonitorConfigPolicyPolicy
Configuration for the policy.
AWSNamespaceFilters
AWS Metrics namespace filters. Defaults to excludeonly.
LogsArchiveDestinationGCS
object
The GCS archive destination.
4 properties
3 required
RumRetentionFilterEnabled
boolean
Whether the retention filter is enabled.
ApplicationSecurityWafExclusionFilterScope
object
Deploy on services based on their environment and/or service name.
2 properties
AWSAccountsResponse
object
AWS Accounts response body.
1 property
1 required
LogsArchiveState
string
The state of the archive.
RuleId
string
The unique ID for a scorecard rule.
LeakedKeyType
string
The definition of LeakedKeyType object.
RelationshipToOrganizations
object
Relationship to organizations.
1 property
1 required
ContainerImagesResponseLinks
object
Pagination links.
5 properties
SecurityFilterType
string
The type of the resource. The value should always be securityfilters.
TeamRelationshipsLinks
object
Links attributes.
1 property
NullableRelationshipToUser
object
Relationship to user.
1 property
1 required
RUMApplicationListAttributes
object
RUM application list attributes.
10 properties
8 required
CustomDestinationsResponse
object
The available custom destinations.
1 property
LogsMetricResponseData
object
The log-based metric properties.
3 properties
AWSResourcesConfig
object
AWS Resources Collection config.
2 properties
MonitorNotificationRuleFilter
Filter used to associate the notification rule with monitors.
AWSAccountResponseAttributes
object
AWS Account response attributes.
11 properties
1 required
DowntimeScheduleOneTimeResponse
object
A one-time downtime definition.
2 properties
1 required
RetentionFiltersResponse
object
An ordered list of retention filters.
1 property
1 required
CloudWorkloadSecurityAgentPolicyAttributes
object
A Cloud Workload Security Agent policy returned by the API
15 properties
ResponseMetaAttributes
object
Object describing meta attributes of response.
1 property
LogsMetricType
string
The type of the resource. The value should always be logsmetrics.
ServiceDefinitionV1
object
Deprecated - Service definition V1 for providing additional service metadata and integrations.
8 properties
2 required
ProjectRelationships
object
Project relationships
2 properties
ApplicationSecurityWafCustomRuleType
string
The type of the resource. The value should always be customrule.
AWSAccountConfigID
string
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/ap…
LogsMetricResponseFilter
object
The log-based metric filter. Logs matching this filter will be aggregated in this metric.
1 property
RestrictionQueryWithoutRelationships
object
Restriction query object returned by the API.
3 properties
PowerpackTemplateVariable
object
Powerpack template variables.
4 properties
1 required
ContainerImageItem
Possible Container Image models.
Project
object
A Project
4 properties
3 required
AuthNMappingIncluded
Included data in the AuthN Mapping response.
CustomDestinationResponseHttpDestinationAuthCustomHeader
object
Custom header access authentication.
2 properties
2 required
RestrictionQueryAttributes
object
Attributes of the restriction query.
3 properties
DowntimeScheduleResponse
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…
DowntimeRelationshipsCreatedByData
object
Data for the user who created the downtime.
2 properties
APIKeyRelationships
object
Resources related to the API key.
2 properties
ServiceDefinitionSchema
Service definition schema.
LeakedKeyAttributes
object
The definition of LeakedKeyAttributes object.
2 properties
1 required
RelationshipToUserTeamPermission
object
Relationship between a user team permission and a team
2 properties
AWSRegionsIncludeAll
object
Include all regions. Defaults to true.
1 property
1 required
MonitorNotificationRuleId
string
The ID of the monitor notification rule.
LogsArchiveStorageClassS3Type
string
The storage class where the archive will be stored.
AWSRegions
AWS Regions to collect data from. Defaults to includeall.
CustomDestinationAttributeTagsRestrictionListType
string
How forwardtagsrestrictionlist parameter should be interpreted. If ALLOWLIST, then only tags whose keys on the forwarded logs match the ones on the restriction…
ServiceDefinitionV2EmailType
string
Contact type.
DowntimeIncludedMonitorType
string
Monitor resource type.
RetentionFilterAllAttributes
object
The attributes of the retention filter.
12 properties
ContainerGroupRelationshipsData
array
Links data.
CsmAgentsAttributes
object
A CSM Agent returned by the API.
17 properties
CsmAgentData
object
Single Agent Data.
3 properties
AWSLambdaForwarderConfig
object
Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing and new logs for some services, ensuring…
2 properties
DowntimeMeta
object
Pagination metadata returned by the API.
1 property
UserTeamPermissionType
string
User team permission type
APIKeysType
string
API Keys resource type.
DowntimeDisplayTimezone
string
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.
LogsMetricResponseGroupBy
object
A group by rule.
2 properties
DowntimeResponseAttributes
object
Downtime details.
12 properties
ServiceDefinitionV2SlackType
string
Contact type.
RelationshipToOrganization
object
Relationship to an organization.
1 property
1 required
IncidentTeamResponseAttributes
object
The incident team's attributes from a response.
3 properties
ApplicationKeyResponseIncludedItem
An object related to an application key.
ContainerImageMeta
object
Response metadata object.
1 property
ServiceDefinitionV2Integrations
object
Third party integrations that Datadog supports.
2 properties
OutcomesResponseData
array
List of rule outcomes.
IncidentTeamIncludedItems
An object related to an incident team which is present in the included payload.
ServiceDefinitionV2Dot2Integrations
object
Third party integrations that Datadog supports.
2 properties
ApplicationSecurityWafCustomRuleData
object
Object for a single WAF custom rule.
3 properties
ServiceDefinitionMetaWarnings
object
Schema validation warnings.
3 properties
TeamType
string
Team type
SAMLAssertionAttributeAttributes
object
Key/Value pair of attributes used in SAML assertion attributes.
2 properties
CSMAgentsMetadata
object
Metadata related to the paginated response.
3 properties
LogsArchiveDestinationS3Type
string
Type of the S3 archive destination.
ServiceDefinitionV2Dot2Pagerduty
object
PagerDuty integration for the service.
1 property
ApplicationKeyRelationships
object
Resources related to the application key.
1 property
LeakedKey
object
The definition of LeakedKey object.
3 properties
3 required
UserTeamPermission
object
A user's permissions for a given team
3 properties
2 required
OpsgenieServiceResponseAttributes
object
The attributes from an Opsgenie service response.
3 properties
MicrosoftTeamsTenantBasedHandlesResponse
object
Response with a list of tenant-based handles.
1 property
1 required
ApplicationSecurityWafExclusionFilterResource
object
A JSON:API resource for an WAF exclusion filter.
3 properties
ServiceDefinitionV2Opsgenie
object
Opsgenie integration for the service.
2 properties
1 required
GCPSTSServiceAccountsResponse
object
Object containing all your STS enabled accounts.
1 property
DowntimeRelationshipsCreatedBy
object
The user who created the downtime.
1 property
SecurityMonitoringSuppressionType
string
The type of the resource. The value should always be suppressions.
RumRetentionFilterQuery
string
The query string for a RUM retention filter.
SecurityMonitoringSuppressionAttributes
object
The attributes of the suppression rule.
14 properties
DowntimeNotifyEndStates
array
States that will trigger a monitor notification when the notifyendtypes action occurs.
ServiceDefinitionV2Dot1Email
object
Service owner's email.
3 properties
2 required
CloudWorkloadSecurityAgentPolicyData
object
Object for a single Agent policy
3 properties
RumMetricResponseAttributes
object
The object describing a Datadog rum-based metric.
5 properties
RumRetentionFilterSampleRate
integer
The sample rate for a RUM retention filter, between 0 and 100.
RoleResponseRelationships
object
Relationships of the role object returned by the API.
1 property
ServiceDefinitionV2Dot1OpsgenieRegion
string
Opsgenie instance region.
RumRetentionFilterID
string
ID of retention filter in UUID.
MicrosoftTeamsWorkflowsWebhookHandleType
string
Specifies the Workflows webhook handle resource type.
MonitorNotificationRuleListResponse
object
Response for retrieving all monitor notification rules.
2 properties
OutcomesResponseLinks
object
Links attributes.
1 property
SecurityFilterExclusionFilterResponse
object
A single exclusion filter.
2 properties
CustomDestinationResponseForwardDestination
A custom destination's location to forward logs.
RelationshipToRule
object
Scorecard create rule response relationship.
1 property
ApmRetentionFilterType
string
The type of the resource.
ApplicationSecurityWafExclusionFilterType
string
Type of the resource. The value should always be exclusionfilter.
OpsgenieServiceResponseData
object
Opsgenie service data from a response.
3 properties
3 required
ServiceDefinitionV2Pagerduty
string
PagerDuty service URL for the service.
ApplicationSecurityWafCustomRuleAttributes
object
A WAF custom rule.
9 properties
5 required
TeamAttributes
object
Team attributes
12 properties
2 required
Role
object
Role object returned by the API.
4 properties
1 required
IncidentTeamResponseData
object
Incident Team data from a response.
4 properties
CustomDestinationResponseElasticsearchDestinationAuth
object
Basic access authentication.
DowntimeRelationshipsMonitor
object
The monitor identified by the downtime.
1 property
AuthNMappingsType
string
AuthN Mappings resource type.
ListDowntimesResponse
object
Response for retrieving all downtimes.
3 properties
APIKeysResponseMetaPage
object
Additional information related to the API keys response.
1 property
ProcessSummary
object
Process summary object.
3 properties
SAMLAssertionAttributesType
string
SAML assertion attributes resource type.
ServiceDefinitionV2Dot1Pagerduty
object
PagerDuty integration for the service.
1 property
OutcomesResponseDataItem
object
A single rule outcome.
4 properties
ServiceDefinitionV2Dot1Contact
Service owner's contacts information.
OpsgenieServicesResponse
object
Response with a list of Opsgenie services.
1 property
1 required
LogsArchiveDestinationS3
object
The S3 archive destination.
6 properties
3 required
IncidentServiceIncludedItems
An object related to an incident service which is present in the included payload.
MonitorNotificationRuleRecipients
array
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.
SecurityFiltersResponse
object
All the available security filters objects.
2 properties
ServiceDefinitionV2Dot2Opsgenie
object
Opsgenie integration for the service.
2 properties
1 required
RelationshipToRoles
object
Relationship to roles.
1 property
Team
object
A team
4 properties
3 required
ServiceDefinitionV2Dot2Link
object
Service's external links.
4 properties
3 required
Pagination
object
Pagination object.
2 properties
SingleAggregatedConnectionResponseArray
object
List of aggregated connections.
1 property
CustomDestinationResponseDefinition
object
The definition of a custom destination.
3 properties
SingleAggregatedConnectionResponseDataType
string
Aggregated connection resource type.
ServiceDefinitionV2LinkType
string
Link type.
GCPSTSServiceAccount
object
Info on your service account.
4 properties
PartialAPIKeyAttributes
object
Attributes of a partial API key.
6 properties
RumMetricResponseFilter
object
The rum-based metric filter. RUM events matching this filter will be aggregated in this metric.
1 property
RelationshipToOutcomeData
object
The JSON:API relationship to an outcome, which returns the related rule id.
2 properties
LogsArchiveEncryptionS3Type
string
Type of S3 encryption for a destination.
ApplicationSecurityWafExclusionFiltersResponse
object
Response object for multiple WAF exclusion filters.
1 property
RumRetentionFilterData
object
The RUM retention filter.
3 properties
LogsArchives
object
The available archives.
1 property
ApplicationSecurityWafExclusionFilterRulesTarget
object
Target WAF rules based either on an identifier or tags.
2 properties
SpansMetricType
string
The type of resource. The value should always be spansmetrics.
LogsMetricComputeIncludePercentiles
boolean
Toggle to include or exclude percentile aggregations for distribution metrics. Only present when the aggregationtype is distribution.
CloudWorkloadSecurityAgentRulesListResponse
object
Response object that includes a list of Agent rule
1 property
DowntimeScope
string
The scope to which the downtime applies. Must follow the [common search syntax](https://docs.datadoghq.com/logs/explorer/searchsyntax/).
AWSAccountPartition
string
AWS partition your AWS account is scoped to. Defaults to aws. See [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/pa…
AuthNMappingAttributes
object
Attributes of AuthN Mapping.
5 properties
RolesType
string
Roles type.
RelationshipToPermissions
object
Relationship to multiple permissions objects.
1 property
IncidentTeamRelationships
object
The incident team's relationships.
2 properties
ProcessSummariesMetaPage
object
Paging attributes.
2 properties
ServiceDefinitionV2MSTeamsType
string
Contact type.
LogsArchiveDestinationGCSType
string
Type of the GCS archive destination.
PowerpackRelationships
object
Powerpack relationship object.
1 property
UsersType
string
Users resource type.
ServiceDefinitionV1Org
object
Org related information about the service.
2 properties
RUMApplicationListType
string
RUM application list type.
ContainerGroupRelationships
object
Relationships to containers inside a container group.
1 property
ApplicationSecurityWafCustomRuleTagsCategory
string
The category of the WAF Rule, can be either businesslogic, attackattempt or securityresponse.
ContainerImageGroupAttributes
object
Attributes for a Container Image Group.
3 properties
TeamLinkAttributes
object
Team link attributes
4 properties
2 required
ContainersResponse
object
List of containers.
3 properties
LogsArchiveDestination
object
An archive's destination.
CSMAgentsType
string
The type of the resource. The value should always be datadogagent.
SecurityMonitoringSuppressionID
string
The ID of the suppression rule.
ContainerItem
Possible Container models.
ContainerImage
object
Container Image object.
3 properties
AuthNMappingsResponse
object
Array of AuthN Mappings response.
3 properties
PermissionAttributes
object
Attributes of a permission.
7 properties
RelationshipToOutcome
object
The JSON:API relationship to a scorecard outcome.
1 property
RumMetricType
string
The type of the resource. The value should always be rummetrics.
APIKeyResponseIncludedItem
An object related to an API key.
UserRelationshipData
object
Relationship to user object.
2 properties
2 required
SpansMetricResponseAttributes
object
The object describing a Datadog span-based metric.
3 properties
ServiceDefinitionV2Dot1Integrations
object
Third party integrations that Datadog supports.
2 properties
RumMetricComputeAggregationType
string
The type of aggregation to use.
RumRetentionFilterAttributes
object
The object describing attributes of a RUM retention filter.
5 properties
ApplicationSecurityWafCustomRuleConditionOperator
string
Operator to use for the WAF Condition.
Container
object
Container object.
3 properties
CustomDestinationResponseHttpDestinationAuth
Authentication method of the HTTP requests.
CloudWorkloadSecurityAgentRuleData
object
Object for a single Agent rule
3 properties
AWSAccountResponseData
object
AWS Account response data.
3 properties
2 required
MicrosoftTeamsTenantBasedHandleInfoResponseData
object
Tenant-based handle data from a response.
3 properties
ServiceDefinitionV2Dot1Version
string
Schema version being used.
ApplicationSecurityWafCustomRuleActionAction
string
Override the default action to take when the WAF custom rule would block.
RelationshipToTeam
object
Relationship to team.
1 property
ServiceDefinitionMeta
object
Metadata about a service definition.
7 properties
ContainerImageGroup
object
Container Image Group object.
4 properties
SecurityMonitoringUser
object
A user.
2 properties
RuleType
string
The JSON:API type for scorecard rules.
RelationshipToRole
object
Relationship to role.
1 property
LogsArchiveAttributes
object
The attributes associated with the archive.
7 properties
3 required
MonitorNotificationRuleRelationshipsCreatedBy
object
The user who created the monitor notification rule.
1 property
LogsMetricsResponse
object
All the available log-based metric objects.
1 property
ProjectAttributes
object
Project attributes
2 properties
DowntimeMuteFirstRecoveryNotification
boolean
If the first recovery notification during a downtime should be muted.
IncidentServiceType
string
Incident service resource type.
RelationshipToRuleData
object
Relationship data for a rule.
1 property
ServiceDefinitionV2Email
object
Service owner's email.
3 properties
2 required
ApplicationSecurityWafExclusionFilterRulesTargetTags
object
Target multiple WAF rules based on their tags.
2 properties
DowntimeMonitorIdentifier
Monitor identifier for the downtime.
LogsArchiveDestinationAzureType
string
Type of the Azure archive destination.
LogsArchiveIntegrationS3
object
The S3 Archive's integration destination.
2 properties
2 required
MonitorConfigPolicyAttributeResponse
object
Policy and policy type for a monitor configuration policy.
2 properties
CloudWorkloadSecurityAgentRuleCreatorAttributes
object
The attributes of the user who created the Agent rule
2 properties
ContainerImageAttributes
object
Attributes for a Container Image.
17 properties
RumRetentionFiltersResponse
object
All RUM retention filters for a RUM application.
1 property
DowntimeMonitorIncludedAttributes
object
Attributes of the monitor identified by the downtime.
1 property
ListPowerpacksResponse
object
Response object which includes all powerpack configurations.
4 properties
MonitorNotificationRuleName
string
The name of the monitor notification rule.
ListRulesResponseData
array
Array of rule details.
ProcessSummariesResponse
object
List of process summaries.
2 properties
DowntimeResponseData
object
Downtime data.
4 properties
AuthNMappingTeam
object
Team.
3 properties
ServiceDefinitionV2Dot1EmailType
string
Contact type.
ProcessSummaryAttributes
object
Attributes for a process summary.
8 properties
GCPServiceAccountType
string
The type of account.
ApplicationSecurityWafCustomRuleMetadata
object
Metadata associated with the WAF Custom Rule.
6 properties
ScorecardType
string
The JSON:API type for scorecard.
UserResponseRelationships
object
Relationships of the user object returned by the API.
4 properties
PowerpackResponseLinks
object
Links attributes.
5 properties
ContainerMeta
object
Response metadata object.
1 property
DowntimeMonitorIncludedItem
object
Information about the monitor identified by the downtime.
3 properties
GCPServiceAccountMeta
object
Additional information related to your service account.
1 property
ServiceDefinitionV2Dot2OpsgenieRegion
string
Opsgenie instance region.
ContainerGroupAttributes
object
Attributes for a container group.
2 properties
ServiceDefinitionV2Slack
object
Service owner's Slack channel.
3 properties
2 required
ApplicationSecurityWafExclusionFilterAttributes
object
Attributes describing a WAF exclusion filter.
11 properties
ContainerMetaPage
object
Paging attributes.
6 properties
RumMetricUniquenessWhen
string
When to count updatable events. match when the event is first seen, or end when the event is complete.
LogsMetricResponseCompute
object
The compute rule to compute the log-based metric.
3 properties
MonitorNotificationRuleFilterTags
object
Filter monitors by tags. Monitors must match all tags.
1 property
1 required
PowerpacksResponseMetaPagination
object
Powerpack response pagination metadata.
8 properties
DowntimeMonitorIdentifierTags
object
Object of the monitor tags.
1 property
1 required
ApplicationSecurityWafExclusionFilterMetadata
object
Extra information about the exclusion filter.
6 properties
AuthNMappingsSort
string
Sorting options for AuthN Mappings.
RumMetricResponseCompute
object
The compute rule to compute the rum-based metric.
3 properties
SpansMetricsResponse
object
All the available span-based metric objects.
1 property
ContainerImageGroupRelationshipsData
array
Links data.
TeamsResponseMetaPagination
object
Teams response metadata.
8 properties
Organization
object
Organization object.
3 properties
1 required
CustomDestinationResponseHttpDestinationAuthBasicType
string
Type of the basic access authentication.
ContainerImageGroupRelationships
object
Relationships inside a Container Image Group.
1 property
RumMetricResponseData
object
The rum-based metric properties.
3 properties
RelationshipToUsers
object
Relationship to users.
1 property
1 required
ServiceDefinitionV1Info
object
Basic information about a service.
4 properties
1 required
CloudWorkloadSecurityAgentRuleAttributes
object
A Cloud Workload Security Agent rule returned by the API
21 properties
OutcomeType
string
The JSON:API type for an outcome.
CustomDestinationResponseForwardDestinationHttpType
string
Type of the HTTP destination.
OutcomesResponse
object
Scorecard outcomes - the result of a rule for a service.
3 properties
NullableRelationshipToUserData
object
Relationship to user object.
2 properties
2 required
LogsMetricResponseComputeAggregationType
string
The type of aggregation to use.
PermissionsType
string
Permissions resource type.
ApplicationKeyResponseMetaPage
object
Additional information related to the application key response.
1 property
PartialApplicationKey
object
Partial Datadog application key.
4 properties
SecurityFilter
object
The security filter's properties.
3 properties
ListTeamsSort
string
Specifies the order of the returned teams
ServiceDefinitionV1Contact
object
Contact information about the service.
2 properties
CloudWorkloadSecurityAgentPolicyType
string
The type of the resource, must always be policy
RuleAttributes
object
Details of a rule.
9 properties
ServiceDefinitionV2Dot1Link
object
Service's external links.
4 properties
3 required
UserResourceType
string
User resource type.
CustomDestinationType
string
The type of the resource. The value should always be customdestination.
PowerpackInnerWidgetLayout
object
Powerpack inner widget layout.
4 properties
4 required
MicrosoftTeamsWorkflowsWebhookResponseAttributes
object
Workflows Webhook handle attributes.
1 property
ServiceDefinitionV2MSTeams
object
Service owner's Microsoft Teams.
3 properties
2 required
IncidentServiceResponseData
object
Incident Service data from responses.
4 properties
2 required
MonitorNotificationRuleRelationshipsCreatedByData
object
Data for the user who created the monitor notification rule.
2 properties
OutcomesResponseIncludedItem
object
Attributes of the included rule.
3 properties
APIKeysResponseMeta
object
Additional information related to api keys response.
2 properties
AWSAccountTags
array
Tags to apply to all hosts and metrics reporting for this account. Defaults to [].
AWSAuthConfigRole
object
AWS Authentication config to integrate your account using an IAM role.
2 properties
1 required
IncidentTeamType
string
Incident Team resource type.
MonitorNotificationRuleRelationships
object
All relationships associated with monitor notification rule.
1 property
CloudWorkloadSecurityAgentRuleActionSet
object
The set action applied on the scope matching the rule
7 properties
ServiceDefinitionV1Integrations
object
Third party integrations that Datadog supports.
1 property
PartialAPIKey
object
Partial Datadog API key.
4 properties
ApplicationSecurityWafCustomRuleAction
object
The definition of ApplicationSecurityWafCustomRuleAction object.
2 properties
CloudWorkloadSecurityAgentRuleKill
object
Kill system call applied on the container matching the rule
1 property
DowntimeScheduleCurrentDowntimeResponse
object
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,…
2 properties
SpansMetricComputeIncludePercentiles
boolean
Toggle to include or exclude percentile aggregations for distribution metrics. Only present when the aggregationtype is distribution.
OutcomesResponseIncluded
array
Array of rule details.
ServiceDefinitionV2Dot1LinkType
string
Link type.
ServiceDefinitionSchemaVersions
string
Schema versions
AWSLogsConfig
object
AWS Logs Collection config.
1 property
RelationshipToSAMLAssertionAttributeData
object
Data of AuthN Mapping relationship to SAML Assertion Attribute.
2 properties
2 required
UserAttributes
object
Attributes of user object returned by the API.
12 properties
LogsMetricResponseAttributes
object
The object describing a Datadog log-based metric.
3 properties
ApplicationSecurityWafCustomRuleConditionParameters
object
The scope of the WAF custom rule.
6 properties
1 required
MonitorConfigPolicyTagPolicy
object
Tag attributes of a monitor configuration policy.
3 properties
ContainerImageGroupType
string
Type of Container Image Group.
MonitorNotificationRuleResponseAttributes
object
Attributes of the monitor notification rule.
5 properties
SecurityFilterMeta
object
Optional metadata associated to the response.
1 property
ListApplicationKeysResponse
object
Response for a list of application keys.
3 properties
ApplicationSecurityWafCustomRuleCondition
object
One condition of the WAF Custom Rule.
2 properties
2 required
RoleAttributes
object
Attributes of the role.
4 properties
ServiceDefinitionData
object
Service definition data.
3 properties
LogsArchiveIntegrationAzure
object
The Azure archive's integration destination.
2 properties
2 required
APIKeysSort
string
Sorting options
User
object
User object returned by the API.
4 properties
AuthNMapping
object
The AuthN Mapping object returned by API.
4 properties
2 required
ContainerImagesResponse
object
List of Container Images.
3 properties
ContainerGroupRelationshipsLink
object
Relationships to Containers inside a Container Group.
2 properties
IncidentServiceRelationships
object
The incident service's relationships.
2 properties
RelationshipToUserData
object
Relationship to user object.
2 properties
2 required
ServiceDefinitionV1Version
string
Schema version being used.
GCPMetricNamespaceConfig
object
Configuration for a GCP metric namespace.
2 properties
ProjectsResponse
object
Response with projects
1 property
MicrosoftTeamsWorkflowsWebhookHandleResponseData
object
Workflows Webhook handle data from a response.
3 properties
ContainerImageGroupImagesRelationshipsLink
object
Relationships to Container Images inside a Container Image Group.
2 properties
CustomDestinationResponseHttpDestinationAuthBasic
object
Basic access authentication.
1 property
1 required
CloudWorkloadSecurityAgentRuleActions
array
The array of actions the rule can perform if triggered
ContainerImageType
string
Type of Container Image.
ListTeamsInclude
string
Included related resources optionally requested.
TeamsField
string
Supported teams field.
RuleOutcomeRelationships
object
The JSON:API relationship to a scorecard rule.
1 property
SAMLAssertionAttribute
object
SAML assertion attribute.
3 properties
2 required
PowerpackData
object
Powerpack data object.
4 properties
MonitorConfigPolicyResponseData
object
A monitor configuration policy data.
3 properties
ProcessSummaryType
string
Type of process summary.
SecurityFilterID
string
The ID of the security filter.
DowntimeScheduleRecurrenceDuration
string
The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.
SpansFilter
object
The spans filter used to index spans.
1 property
MonitorNotificationRuleResourceType
string
Monitor notification rule resource type.
IncidentTeamsResponse
object
Response with a list of incident team payloads.
3 properties
1 required
RumMetricID
string
The name of the rum-based metric.
RumMetricResponseGroupBy
object
A group by rule.
2 properties
OrganizationsType
string
Organizations resource type.
ServiceDefinitionV2OpsgenieRegion
string
Opsgenie instance region.
CustomDestinationResponseHttpDestinationAuthCustomHeaderType
string
Type of the custom header access authentication.
ServiceDefinitionV1Pagerduty
string
PagerDuty service URL for the service.
MonitorNotificationRuleData
object
Monitor notification rule data.
4 properties
ApplicationSecurityWafCustomRuleConditionOptions
object
Options for the operator of this condition.
2 properties
ApplicationKeysType
string
Application Keys resource type.
TeamsResponseLinks
object
Teams response links.
5 properties
RumMetricComputeIncludePercentiles
boolean
Toggle to include or exclude percentile aggregations for distribution metrics. Only present when aggregationtype is distribution.
AWSNamespaceFiltersIncludeOnly
object
Include only these namespaces.
1 property
1 required
MonitorConfigPolicyType
string
The monitor configuration policy type.
RelationshipToUserTeamPermissionData
object
Related user team permission data
2 properties
2 required
SecurityMonitoringSuppression
object
The suppression rule's properties.
3 properties
ContainerMetaPageType
string
Type of Container pagination.
ServiceDefinitionV2Dot1
object
Service definition v2.1 for providing service metadata and integrations.
12 properties
2 required
RetentionFilterAllType
string
The type of retention filter.
UsersRelationship
object
Relationship to users.
1 property
1 required
MicrosoftTeamsTenantBasedHandleInfoType
string
Tenant-based handle resource type.
CloudWorkloadSecurityAgentRuleActionMetadata
object
The metadata action applied on the scope matching the rule
3 properties
RumMetricResponseUniqueness
object
The rule to count updatable events. Is only set if eventtype is session or view.
1 property
RumRetentionFilterEventType
string
The type of RUM events to filter on.
ServiceDefinitionV2Doc
object
Service documents.
3 properties
2 required
ServiceDefinitionV2Dot2Type
string
The type of service.
ServiceDefinitionV2Contact
Service owner's contacts information.
AWSNamespaceFiltersExcludeOnly
object
Exclude only these namespaces from metrics collection. Defaults to ["AWS/SQS", "AWS/ElasticMapReduce"]. AWS/SQS and AWS/ElasticMapReduce are excluded by defaul…
1 property
1 required
ApplicationSecurityWafCustomRuleTags
object
Tags associated with the WAF Custom Rule. The concatenation of category and type will form the security activity field associated with the traces.
2 properties
2 required
ApplicationKeyResponseMeta
object
Additional information related to the application key response.
2 properties
LogsArchiveDefinition
object
The definition of an archive.
3 properties
1 required
SpansMetricResponseGroupBy
object
A group by rule.
2 properties
SpansMetricID
string
The name of the span-based metric.
ContainerGroup
object
Container group object.
4 properties
ServiceDefinitionV2Repo
object
Service code repositories.
3 properties
2 required
ServiceDefinitionV1Resource
object
Service's external links.
3 properties
3 required
IncidentServiceResponseAttributes
object
The incident service's attributes from a response.
3 properties
RelationshipToRoleData
object
Relationship to role object.
2 properties
ContainerType
string
Type of container.
ServiceDefinitionV2Dot1Slack
object
Service owner's Slack channel.
3 properties
2 required
ListRulesResponse
object
Scorecard rules response.
2 properties
RelationshipToOrganizationData
object
Relationship to organization object.
2 properties
2 required
ContainerImageMetaPageType
string
Type of Container Image pagination.
PartialApplicationKeyAttributes
object
Attributes of a partial application key.
4 properties
MonitorConfigPolicyResourceType
string
Monitor configuration policy resource type.
RelationshipToTeamLinkData
object
Relationship between a link and a team
2 properties
2 required
CustomDestinationResponseForwardDestinationElasticsearch
object
The Elasticsearch destination.
5 properties
4 required
CustomDestinationResponseForwardDestinationElasticsearchType
string
Type of the Elasticsearch destination.
XRayServicesIncludeOnly
object
Include only these services. Defaults to [].
1 property
1 required
DowntimeNotifyEndTypes
array
Actions that will trigger a monitor notification if the downtime is in the notifyendtypes state.
OrderDirection
string
The sort direction for results.
AWSAccountType
string
AWS Account resource type.
SpansMetricResponseData
object
The span-based metric properties.
3 properties
AWSTracesConfig
object
AWS Traces Collection config.
1 property
PowerpackGroupWidget
object
Powerpack group widget definition object.
3 properties
1 required
CustomDestinationResponseAttributes
object
The attributes associated with the custom destination.
7 properties
SecurityFilterFilteredDataType
string
The filtered data type.
DowntimeResourceType
string
Downtime resource type.
ServiceDefinitionV1ResourceType
string
Link type.
OpsgenieServiceRegionType
string
The region for the Opsgenie service.
CustomDestinationResponseForwardDestinationSplunkType
string
Type of the Splunk HTTP Event Collector (HEC) destination.
AWSRegionsIncludeOnly
object
Include only these regions.
1 property
1 required
CloudWorkloadSecurityAgentPolicyUpdaterAttributes
object
The attributes of the user who last updated the policy
2 properties
ProjectResourceType
string
Project resource type
TeamLinkType
string
Team link type
DowntimeMonitorIdentifierId
object
Object of the monitor identifier.
1 property
1 required
APIKeysResponse
object
Response for a list of API keys.
3 properties
DowntimeMetaPage
object
Object containing the total filtered count.
1 property
ApplicationKeysSort
string
Sorting options
ServiceDefinitionV2Dot2Contact
object
Service owner's contacts information.
3 properties
2 required
SingleAggregatedConnectionResponseDataAttributes
object
Attributes for an aggregated connection.
12 properties
ContainerImageMetaPage
object
Paging attributes.
6 properties
CustomDestinationResponseForwardDestinationSplunk
object
The Splunk HTTP Event Collector (HEC) destination.
2 properties
2 required
RumMetricsResponse
object
All the available rum-based metric objects.
1 property
AuthNMappingTeamAttributes
object
Team attributes.
7 properties
PowerpackGroupWidgetLayout
object
Powerpack group widget layout.
4 properties
4 required
TeamIncluded
Included resources related to the team
ContainerGroupRelationshipsLinks
object
Links attributes.
1 property
CustomDestinationResponseForwardDestinationHttp
object
The HTTP destination.
3 properties
3 required
RestrictionQueryListResponse
object
Response containing information about multiple restriction queries.
1 property
ListRulesResponseDataItem
object
Rule details.
4 properties
CsmAgentsResponse
object
Response object that includes a list of CSM Agents.
2 properties
DowntimeStatus
string
The current status of the downtime.
CloudWorkloadSecurityAgentRuleType
string
The type of the resource, must always be agentrule
DowntimeNotifyEndStateTypes
string
State that will trigger a monitor notification when the notifyendtypes action occurs.
DowntimeScheduleRecurrencesResponse
object
A recurring downtime schedule definition.
3 properties
1 required
ServiceDefinitionV2Dot1Opsgenie
object
Opsgenie integration for the service.
2 properties
1 required
ApplicationSecurityWafExclusionFilterID
string
The identifier of the WAF exclusion filter.
DowntimeResponseIncludedItem
An object related to a downtime.
ContainersResponseLinks
object
Pagination links.
5 properties
AWSAuthConfig
AWS Authentication config.
IncidentRelatedObject
string
Object related to an incident.
PowerpackInnerWidgets
object
Powerpack group widget definition of individual widgets.
2 properties
1 required
SecurityFilterAttributes
object
The object describing a security filter.
7 properties
SpansMetricComputeAggregationType
string
The type of aggregation to use.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Datadog 12
Other APIs Datadog publishes across the network.
Datadog Dashboards API
Datadog Synthetics API
Datadog Service Level Objectives API
Datadog Security Monitoring API
Datadog Service Definition API
Datadog Software Catalog API
Datadog Users API
Datadog Roles API
Datadog Key Management API
Datadog Organizations API
Datadog Downtimes API
Datadog RUM API
#All
Where this information came from
This is an independent, third-party profile of Datadog All API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.