Skip to main content
PUT
/
datasets
/
views
/
{view_id}
/
delivery_settings
cURL
curl --request PUT \
  --url https://api.brightdata.com/datasets/views/{view_id}/delivery_settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filename": {
    "extension": "json",
    "template": "bd_{[datetime]}",
    "tz_offset": "+00:00"
  },
  "flatten_csv": false,
  "deliver": {
    "type": "s3",
    "bucket": "my-bucket",
    "credentials": {
      "aws-access-key": "AKIAIOSFODNN7",
      "aws-secret-key": "wJalrXUtnFEMI"
    },
    "region": "us-east-1",
    "directory": "my/directory"
  },
  "tar": true,
  "compress": true,
  "batch_size": 1000
}
'
{
  "view_id": "v_id1"
}
Replaces the delivery configuration for a dataset view. The deliver.type field selects the destination and the remaining fields inside deliver must match the schema returned by Get destination type schema for that destination.

​
How to update a view

  1. Call Get delivery options to confirm the destination type is supported.
  2. Call Get destination type schema with that destination type to get the required fields.
  3. Send the PUT request documented on this page with the deliver object populated.
Setting tar: true bundles all output files into a single TAR archive. Setting compress: true gzips each delivered file. Both can be combined.
batch_size is the maximum number of records per output file. Use it to split large deliveries into smaller files. The maximum per-batch size is 5 GB.
To apply the same configuration to many views at once, use Bulk update view delivery settings instead.

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"

Body

application/json

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

Response

View delivery settings updated

​
view_id
string