How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Datadog Custom API

The Custom API from Datadog — 8 operation(s) for custom.

Datadog Custom API is one of 186 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 Custom. 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 13 operations across 5 paths, and defines 84 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 3 base URLs: https://{subdomain}.{site}, {protocol}://{name}, https://{subdomain}.{site}.

13 operations 5 paths 84 schemas 4 DELETE5 GET1 PATCH3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.datadoghq.com
Authentication
OAuth 2.0, API Key, API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 4

Datadog Custom 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 13

Across 5 paths, the API surfaces 13 operations — 4 DELETE, 5 GET, 1 PATCH, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Custom 13
DELETE
/api/v2/cloud_security_management/custom_frameworks/{handle}/{version}
Datadog Delete a Custom Framework
DeleteCustomFramework 2 params → 200400429500
GET
/api/v2/cloud_security_management/custom_frameworks/{handle}/{version}
Datadog Get a Custom Framework
GetCustomFramework 2 params → 200400429500
PUT
/api/v2/cloud_security_management/custom_frameworks/{handle}/{version}
Datadog Update a Custom Framework
UpdateCustomFramework 2 params body → 200400429500
GET
/api/v2/cost/custom_costs
Datadog List Custom Costs Files
ListCustomCostsFiles → 200403429
PUT
/api/v2/cost/custom_costs
Datadog Upload Custom Costs File
UploadCustomCostsFile body → 202403429
DELETE
/api/v2/cost/custom_costs/{file_id}
Datadog Delete Custom Costs File
DeleteCustomCostsFile 1 param → 204403429
GET
/api/v2/cost/custom_costs/{file_id}
Datadog Get Custom Costs File
GetCustomCostsFile 1 param → 200403429
DELETE
/api/v2/logs/config/custom-destinations/{custom_destination_id}
Datadog Delete a Custom Destination
DeleteLogsCustomDestination 1 param → 204400403404429
GET
/api/v2/logs/config/custom-destinations/{custom_destination_id}
Datadog Get a Custom Destination
GetLogsCustomDestination 1 param → 200400403404429
PATCH
/api/v2/logs/config/custom-destinations/{custom_destination_id}
Datadog Update a Custom Destination
UpdateLogsCustomDestination 1 param body → 200400403404409429
DELETE
/api/v2/remote_config/products/asm/waf/custom_rules/{custom_rule_id}
Datadog Delete a Waf Custom Rule
DeleteApplicationSecurityWafCustomRule 1 param → 204403404409429
GET
/api/v2/remote_config/products/asm/waf/custom_rules/{custom_rule_id}
Datadog Get a Waf Custom Rule
GetApplicationSecurityWafCustomRule 1 param → 200403429
PUT
/api/v2/remote_config/products/asm/waf/custom_rules/{custom_rule_id}
Datadog Update a Waf Custom Rule
UpdateApplicationSecurityWafCustomRule 1 param body → 200400403404409429

Schemas 84

The contract defines 84 schemas that model the data the API accepts and returns. The most detailed are ApplicationSecurityWafCustomRuleAttributes (9 properties), CustomCostsFileMetadataWithContent (9 properties), CustomCostsFileMetadata (8 properties), ApplicationSecurityWafCustomRuleUpdateAttributes (8 properties). Each schema is shown below with its type and property counts.

APIErrorResponse
object
API error response.
1 property 1 required
CustomDestinationResponseForwardDestinationElasticsearchType
string
Type of the Elasticsearch destination.
CustomDestinationResponseForwardDestinationHttp
object
The HTTP destination.
3 properties 3 required
ApplicationSecurityWafCustomRuleActionAction
string
Override the default action to take when the WAF custom rule would block.
CustomDestinationResponseElasticsearchDestinationAuth
object
Basic access authentication.
CustomDestinationForwardDestinationSplunkType
string
Type of the Splunk HTTP Event Collector (HEC) destination.
CustomDestinationResponseForwardDestinationSplunk
object
The Splunk HTTP Event Collector (HEC) destination.
2 properties 2 required
CustomDestinationForwardDestinationHttp
object
The HTTP destination.
3 properties 3 required
CustomCostsFileMetadataWithContentHighLevel
object
JSON API format of for a Custom Costs file with content.
3 properties
ApplicationSecurityWafCustomRuleMetadata
object
Metadata associated with the WAF Custom Rule.
6 properties
CustomDestinationResponseForwardDestinationElasticsearch
object
The Elasticsearch destination.
5 properties 4 required
FullCustomFrameworkDataAttributes
object
Full Framework Data Attributes.
5 properties 4 required
CustomFrameworkDataAttributes
object
Framework Data Attributes.
6 properties 4 required
CustomDestinationResponseForwardDestinationHttpType
string
Type of the HTTP destination.
CustomCostsFileMetadata
object
Schema of a Custom Costs metadata.
8 properties
CustomDestinationResponseForwardDestinationSplunkType
string
Type of the Splunk HTTP Event Collector (HEC) destination.
FrameworkHandleAndVersionResponseData
object
Contains type and attributes for custom frameworks.
3 properties 3 required
UpdateCustomFrameworkRequest
object
Request object to update a custom framework.
1 property 1 required
ApplicationSecurityWafCustomRuleResponse
object
Response object that includes a single WAF custom rule.
1 property
CustomCostsFileUsageChargePeriod
object
Usage charge period of a Custom Costs file.
2 properties
ApplicationSecurityWafCustomRuleConditionOperator
string
Operator to use for the WAF Condition.
CustomCostsUser
object
Metadata of the user that has uploaded the Custom Costs file.
3 properties
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…
ApplicationSecurityWafCustomRuleConditionParameters
object
The scope of the WAF custom rule.
6 properties 1 required
CustomDestinationUpdateRequestDefinition
object
The definition of a custom destination.
3 properties 2 required
CustomDestinationHttpDestinationAuth
Authentication method of the HTTP requests.
CustomDestinationHttpDestinationAuthBasicType
string
Type of the basic access authentication.
CustomDestinationResponseHttpDestinationAuthCustomHeaderType
string
Type of the custom header access authentication.
ApplicationSecurityWafCustomRuleScope
object
The scope of the WAF custom rule.
2 properties 2 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
ApplicationSecurityWafCustomRuleConditionInputAddress
string
Input from the request on which the condition should apply.
ApplicationSecurityWafCustomRuleType
string
The type of the resource. The value should always be customrule.
CustomDestinationResponseHttpDestinationAuthBasicType
string
Type of the basic access authentication.
CustomCostsFileMetadataWithContent
object
Schema of a cost file's metadata.
9 properties
FullCustomFrameworkData
object
Contains type and attributes for custom frameworks.
3 properties 3 required
ApplicationSecurityWafCustomRuleTagsCategory
string
The category of the WAF Rule, can be either businesslogic, attackattempt or securityresponse.
GetCustomFrameworkResponse
object
Response object to get a custom framework.
1 property 1 required
CustomCostsFileMetadataHighLevel
object
JSON API format for a Custom Costs file.
3 properties
CustomFrameworkRequirement
object
Framework Requirement.
2 properties 2 required
CustomDestinationResponseHttpDestinationAuth
Authentication method of the HTTP requests.
CustomFrameworkMetadata
object
Metadata for custom frameworks.
3 properties
CustomDestinationForwardDestinationElasticsearch
object
The Elasticsearch destination.
5 properties 4 required
CustomDestinationResponseForwardDestination
A custom destination's location to forward logs.
CustomDestinationResponseAttributes
object
The attributes associated with the custom destination.
7 properties
ApplicationSecurityWafCustomRuleUpdateAttributes
object
Update a WAF custom rule.
8 properties 5 required
CustomFrameworkDataHandleAndVersion
object
Framework Handle and Version.
2 properties
CustomDestinationHttpDestinationAuthBasic
object
Basic access authentication.
3 properties 3 required
CustomDestinationResponseHttpDestinationAuthCustomHeader
object
Custom header access authentication.
2 properties 2 required
CustomDestinationResponse
object
The custom destination.
1 property
ApplicationSecurityWafCustomRuleConditionInput
object
Input from the request on which the condition should apply.
2 properties 1 required
ApplicationSecurityWafCustomRuleConditionOptions
object
Options for the operator of this condition.
2 properties
CustomDestinationResponseDefinition
object
The definition of a custom destination.
3 properties
ApplicationSecurityWafCustomRuleAction
object
The definition of ApplicationSecurityWafCustomRuleAction object.
2 properties
CustomDestinationHttpDestinationAuthCustomHeaderType
string
Type of the custom header access authentication.
CustomDestinationUpdateRequestAttributes
object
The attributes associated with the custom destination.
7 properties
CustomFrameworkType
string
The type of the resource. The value must be customframework.
CustomDestinationForwardDestinationHttpType
string
Type of the HTTP destination.
CustomDestinationForwardDestinationElasticsearchType
string
Type of the Elasticsearch destination.
ApplicationSecurityWafCustomRuleUpdateRequest
object
Request object that includes the Custom Rule to update.
1 property 1 required
CustomFrameworkWithoutRequirements
object
Framework without requirements.
5 properties 3 required
CustomCostUploadResponseMeta
object
Meta for the response from the Upload Custom Costs endpoints.
1 property
CustomCostsFileLineItem
object
Line item details from a Custom Costs file.
7 properties
ApplicationSecurityWafCustomRuleData
object
Object for a single WAF custom rule.
3 properties
ApplicationSecurityWafCustomRuleCondition
object
One condition of the WAF Custom Rule.
2 properties 2 required
CustomDestinationHttpDestinationAuthCustomHeader
object
Custom header access authentication.
3 properties 3 required
CustomCostsFileGetResponse
object
Response for Get Custom Costs files.
2 properties
CustomCostsFileUploadResponse
object
Response for Uploaded Custom Costs files.
2 properties
UpdateCustomFrameworkResponse
object
Response object to update a custom framework.
1 property 1 required
ApplicationSecurityWafCustomRuleAttributes
object
A WAF custom rule.
9 properties 5 required
CustomDestinationUpdateRequest
object
The custom destination.
1 property
CustomDestinationType
string
The type of the resource. The value should always be customdestination.
ApplicationSecurityWafCustomRuleUpdateData
object
Object for a single WAF Custom Rule.
2 properties 2 required
CustomDestinationElasticsearchDestinationAuth
object
Basic access authentication.
2 properties 2 required
CustomDestinationResponseHttpDestinationAuthBasic
object
Basic access authentication.
1 property 1 required
CustomCostsFileUploadRequest
array
Request for uploading a Custom Costs file.
ApplicationSecurityWafCustomRuleActionParameters
object
The definition of ApplicationSecurityWafCustomRuleActionParameters object.
2 properties
CustomFrameworkControl
object
Framework Control.
2 properties 2 required
DeleteCustomFrameworkResponse
object
Response object to delete a custom framework.
1 property 1 required
CustomCostListResponseMeta
object
Meta for the response from the List Custom Costs endpoints.
2 properties
CustomDestinationForwardDestination
A custom destination's location to forward logs.
CustomFrameworkData
object
Contains type and attributes for custom frameworks.
2 properties 2 required
CustomDestinationForwardDestinationSplunk
object
The Splunk HTTP Event Collector (HEC) destination.
3 properties 3 required
CustomCostsFileListResponse
object
Response for List Custom Costs files.
2 properties
CustomCostGetResponseMeta
object
Meta for the response from the Get Custom Costs endpoints.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

datadog-custom-api-openapi.yml Raw ↑

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
Where this information came from

This is an independent, third-party profile of Datadog Custom 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.