Skip to main content
POST
/
datasets
/
snapshots
/
{id}
/
deliver
cURL
curl --request POST \
  --url https://api.brightdata.com/datasets/snapshots/{id}/deliver \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "deliver": {
    "type": "azure",
    "filename": {
      "template": "<string>",
      "extension": "json"
    },
    "container": "<string>",
    "credentials": {
      "account": "<string>",
      "key": "aSDinaTvuI8gbWludGxpZnk=",
      "sas_token": "<string>"
    },
    "directory": "<string>"
  },
  "compress": false,
  "batch_size": 123
}
'
{
  "id": "<string>"
}

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

​
id
string
required

A Snapshot ID is a unique identifier for a specific data snapshot, used to retrieve results from a data collection job triggered via the API. Read more about Snapshot ID.

Example:

"snap_m2bxug4e2o352v1jv1"

Body

application/json
​
deliver
object

Deliver configuration

​
compress
boolean
default:false

Deliver file compressed in gzip format

​
batch_size
integer

Number of records per file. Use this to split large snapshots into multiple smaller files. Files are split by record count. Recommended for snapshots with more than 1 million records.

Example:

100000

Response

OK

​
id
string

ID of the delivery job