The identity and technical contract details declared by the specification.
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
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Datadog publishes across the network.