Skip to main content
POST
/
webarchive
/
dump
Deliver a snapshot to Amazon S3, Azure Blob Storage or a Webhook
curl --request POST \
  --url https://api.brightdata.com/webarchive/dump \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "search_id": "<string>",
  "delivery": {
    "settings": {
      "bucket": "<string>",
      "assume_role": {
        "role_arn": "<string>"
      },
      "prefix": "<string>"
    }
  },
  "max_entries": 123
}
'
{
  "dump_id": "ucd_abc123-1234567890"
}

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.

To use S3 storage delivery, you will first need to do the following:
  • Create an AWS role which gives Bright Data access to your system.
    • During this setup, you will be asked by Amazon for an “external ID” that is used with the role.
    • Your external ID for S3 is your Bright Data Account ID that can be found within Account Settings
  • Once a role is created, you will need to allow the Bright Data delivery role to AssumeRole that role.
    • The Bright Data delivery role is: arn:aws:iam::422310177405:role/brd.ec2.zs-dca-delivery
The webhook delivery strategy is not suitable for large dumps unless you are hosting the webhook on your own infrastructure. Third-party inspection tools such as webhook.site impose strict request body size limits and will fail to receive payloads that can reach up to 1 GB in size. For large deliveries, use Amazon S3 or Azure Blob Storage instead.
Common dump parameters:
  • search_id (required): The search ID from a completed search
  • max_entries (optional): Limit the number of files to include in the dump
  • delivery (required): Delivery configuration (S3, Azure, or webhook)
If you’re running a linux/macos machine, you can simulate one of our delivery webhooks with the code on this page.

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

Body

application/json
​
search_id
string
required

Search ID from a completed search

​
delivery
Amazon S3 · object
required
​
max_entries
integer

Maximum number of files to include in the dump

Response

200 - application/json

Dump created successfully

​
dump_id
string
required

ID of the created dump

Example:

"ucd_abc123-1234567890"