Skip to main content
GET
/
datasets
/
delivery_settings
/
options
cURL
curl --request GET \
  --url https://api.brightdata.com/datasets/delivery_settings/options \
  --header 'Authorization: Bearer <token>'
{
  "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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.brightdata.com/llms.txt

Use this file to discover all available pages before exploring further.

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

​
Authorization
string
header
required

Use your Bright Data API Key as a Bearer token in the Authorization header.

How to authenticate:

  1. Obtain your API Key from the Bright Data account settings at https://brightdata.com/cp/setting/users
  2. Include the API Key in the Authorization header of your requests
  3. Format: Authorization: Bearer YOUR_API_KEY

Example:

Authorization: Bearer b5648e1096c6442f60a6c4bbbe73f8d2234d3d8324554bd6a7ec8f3f251f07df

Learn how to get your Bright Data API key: https://docs.brightdata.com/api-reference/authentication

Response

Delivery settings options

​
deliver
object
​
flatten_csv
object
​
delivery_type
object
​
filename
object
​
batch_size
object