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.
default:
forward_tags_restriction_list_type
enum
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.
Allowed enum values: ALLOW_LIST,BLOCK_LIST
default: ALLOW_LIST
forwarder_destination
<oneOf>
A custom destination's location to forward logs.
Option 1
object
The HTTP destination.
auth [required]
<oneOf>
Authentication method of the HTTP requests.
Option 1
object
Basic access authentication.
type [required]
enum
Type of the basic access authentication.
Allowed enum values: basic
default: basic
Option 2
object
Custom header access authentication.
header_name [required]
string
The header name of the authentication.
type [required]
enum
Type of the custom header access authentication.
Allowed enum values: custom_header
default: custom_header
endpoint [required]
string
The destination for which logs will be forwarded to.
Must have HTTPS scheme and forwarding back to Datadog is not allowed.
type [required]
enum
Type of the HTTP destination.
Allowed enum values: http
default: http
Option 2
object
The Splunk HTTP Event Collector (HEC) destination.
endpoint [required]
string
The destination for which logs will be forwarded to.
Must have HTTPS scheme and forwarding back to Datadog is not allowed.
sourcetype
string
The Splunk sourcetype for the events sent to this Splunk destination.
If the field is absent from the request and no sourcetype has been previously set on this destination, the default sourcetype _json is used.
On update, if the field is absent from the request but a sourcetype was previously set, the previous value is kept.
If set to null, the sourcetype field is omitted from the forwarded event entirely.
Otherwise, the provided string value is used as the sourcetype.
type [required]
enum
Type of the Splunk HTTP Event Collector (HEC) destination.
Allowed enum values: splunk_hec
default: splunk_hec
Option 3
object
The Elasticsearch destination.
auth [required]
object
Basic access authentication.
<any-key>
Basic access authentication.
endpoint [required]
string
The destination for which logs will be forwarded to.
Must have HTTPS scheme and forwarding back to Datadog is not allowed.
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).
type [required]
enum
Type of the Elasticsearch destination.
Allowed enum values: elasticsearch
default: elasticsearch
Option 4
object
The Microsoft Sentinel destination.
client_id [required]
string
Client ID from the Datadog Azure integration.
data_collection_endpoint [required]
string
Azure data collection endpoint.
data_collection_rule_id [required]
string
Azure data collection rule ID.
stream_name [required]
string
Azure stream name.
tenant_id [required]
string
Tenant ID from the Datadog Azure integration.
type [required]
enum
Type of the Microsoft Sentinel destination.
Allowed enum values: microsoft_sentinel
default: microsoft_sentinel
name
string
The custom destination name.
query
string
The custom destination query filter. Logs matching this query are forwarded to the destination.
id
string
The custom destination ID.
type
enum
The type of the resource. The value should always be custom_destination.
Allowed enum values: custom_destination
"""
Get all custom destinations returns "OK" response
"""fromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.logs_custom_destinations_apiimportLogsCustomDestinationsApiconfiguration=Configuration()withApiClient(configuration)asapi_client:api_instance=LogsCustomDestinationsApi(api_client)response=api_instance.list_logs_custom_destinations()print(response)
# Get all custom destinations returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V2::LogsCustomDestinationsAPI.newpapi_instance.list_logs_custom_destinations()
// Get all custom destinations returns "OK" responsepackagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV2")funcmain(){ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewLogsCustomDestinationsApi(apiClient)resp,r,err:=api.ListLogsCustomDestinations(ctx)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `LogsCustomDestinationsApi.ListLogsCustomDestinations`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `LogsCustomDestinationsApi.ListLogsCustomDestinations`:\n%s\n",responseContent)}
// Get all custom destinations returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_logs_custom_destinations::LogsCustomDestinationsAPI;#[tokio::main]asyncfnmain(){letconfiguration=datadog::Configuration::new();letapi=LogsCustomDestinationsAPI::with_config(configuration);letresp=api.list_logs_custom_destinations().await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_API_KEY="<API-KEY>"DD_APP_KEY="<APP-KEY>"cargo run
/**
* Get all custom destinations returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv2.LogsCustomDestinationsApi(configuration);apiInstance.listLogsCustomDestinations().then((data: v2.CustomDestinationsResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
