Skip to main content
GET
/
datasets
/
views
/
{view_id}
/
delivery_settings
cURL
curl --request GET \
  --url https://api.brightdata.com/datasets/views/{view_id}/delivery_settings \
  --header 'Authorization: Bearer <token>'
{
  "deliver": {
    "type": "s3",
    "bucket": "bucket_name",
    "credentials": {
      "aws-access-key": "AWS_ACCESS_KEY",
      "aws-secret-key": "AWS_SECRET_KEY"
    },
    "region": "us-east-1",
    "filename": {
      "extension": "json",
      "template": "bd_{[datetime]}",
      "tz_offset": "+04:00"
    },
    "flatten_csv": false
  },
  "tar": false,
  "compress": false,
  "batch_size": 400
}

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.

Returns the full delivery configuration stored for the given dataset view. The deliver object contains the destination-specific fields (for example bucket, credentials, region for an S3 destination), and the top-level tar, compress, batch_size and filename fields describe how the output files are packaged.
Find the view_id by calling Get dataset views.

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

Path Parameters

​
view_id
string
required

Unique identifier for the dataset view.

Example:

"v_id1"

Response

Current delivery configuration for the view

Delivery configuration for a dataset view. Used by the view delivery settings GET, PUT and bulk PUT endpoints.

​
deliver
Microsoft Azure · object

Delivery destination configuration. The type field selects the destination (for example s3, sftp, webhook) and the remaining fields depend on the destination schema returned by /datasets/delivery_settings/{destination_type}/schema.

​
filename
object

Configuration for the output file name and format.

​
flatten_csv
boolean
default:false

When true, nested fields are flattened for CSV output.

​
tar
boolean
default:false

When true, delivered files are bundled into a TAR archive.

​
compress
boolean
default:false

When true, delivered files are gzip compressed.

​
batch_size
integer

Maximum records per batch file. Use to split large deliveries into smaller files. Maximum batch size is 5GB.

Example:

1000