cURL
curl --request GET \
--url https://api.brightdata.com/datasets/delivery_settings/options \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.brightdata.com/datasets/delivery_settings/options"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.brightdata.com/datasets/delivery_settings/options', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.brightdata.com/datasets/delivery_settings/options",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.brightdata.com/datasets/delivery_settings/options"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.brightdata.com/datasets/delivery_settings/options")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.brightdata.com/datasets/delivery_settings/options")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"deliver": {
"required": true,
"type": "object",
"deliver_types": [
"api_pull",
"webhook",
"email",
"gcs",
"gcp_pubsub",
"s3",
"snowflake",
"ali_oss",
"sftp",
"azure"
]
},
"flatten_csv": {
"required": false,
"type": "boolean"
},
"delivery_type": {
"required": false,
"type": "string",
"default": "deliver_results"
},
"filename": {
"required": false,
"template": {
"type": "string",
"default": "bd_{[datetime]}"
},
"extension": {
"values": [
"json",
"csv",
"xlsx",
"ndjson",
"parquet",
"jsonl"
],
"default": "json"
},
"tz_offset": {
"type": "string",
"pattern": "[+-](0\\d|1[01]):[0-5]\\d+",
"default": "+00:00"
}
},
"batch_size": {
"required": true,
"type": "number"
}
}{
"error": "Unauthorized"
}Delivery settings
Get delivery options
List the supported delivery destinations, filename templates and batch settings you can use when configuring delivery for a dataset view. Covers 250+ domains.
GET
/
datasets
/
delivery_settings
/
options
cURL
curl --request GET \
--url https://api.brightdata.com/datasets/delivery_settings/options \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.brightdata.com/datasets/delivery_settings/options"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.brightdata.com/datasets/delivery_settings/options', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.brightdata.com/datasets/delivery_settings/options",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.brightdata.com/datasets/delivery_settings/options"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.brightdata.com/datasets/delivery_settings/options")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.brightdata.com/datasets/delivery_settings/options")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"deliver": {
"required": true,
"type": "object",
"deliver_types": [
"api_pull",
"webhook",
"email",
"gcs",
"gcp_pubsub",
"s3",
"snowflake",
"ali_oss",
"sftp",
"azure"
]
},
"flatten_csv": {
"required": false,
"type": "boolean"
},
"delivery_type": {
"required": false,
"type": "string",
"default": "deliver_results"
},
"filename": {
"required": false,
"template": {
"type": "string",
"default": "bd_{[datetime]}"
},
"extension": {
"values": [
"json",
"csv",
"xlsx",
"ndjson",
"parquet",
"jsonl"
],
"default": "json"
},
"tz_offset": {
"type": "string",
"pattern": "[+-](0\\d|1[01]):[0-5]\\d+",
"default": "+00:00"
}
},
"batch_size": {
"required": true,
"type": "number"
}
}{
"error": "Unauthorized"
}Use this endpoint before configuring a dataset view delivery to discover which destination types are supported and which fields the filename and batch parameters accept. The response is the canonical source of truth. Supported destinations currently include
api_pull, webhook, email, gcs, gcp_pubsub, s3, snowflake, ali_oss, sftp and azure.
Call Get destination type schema next to retrieve the required fields for the specific destination you want to use.Authorizations
Use your Bright Data API Key as a Bearer token in the Authorization header.
How to authenticate:
- Obtain your API Key from the Bright Data account settings at https://brightdata.com/cp/setting/users
- Include the API Key in the Authorization header of your requests
- Format:
Authorization: Bearer YOUR_API_KEY
Example:
Authorization: Bearer YOUR_API_KEY
Learn how to get your Bright Data API key: https://docs.brightdata.com/api-reference/authentication
Was this page helpful?