Deliver a snapshot to Amazon S3, Azure Blob Storage or a Webhook
Web Archive API
Deliver snapshot to S3, Azure Blob or GCP
Deliver a Bright Data Archive API snapshot to Amazon S3, Azure Blob Storage, Google Cloud Storage or a webhook. POST /webarchive/dump returns a dump_id.
POST
Deliver a snapshot to Amazon S3, Azure Blob Storage or a Webhook
POST /webarchive/dump delivers the snapshot from a completed search to Amazon S3, Azure Blob Storage, Google Cloud Storage or a webhook, and returns a dump_id.
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
AssumeRolethat role.- The Bright Data delivery role is:
arn:aws:iam::422310177405:role/brd.ec2.zs-dca-delivery
- The Bright Data delivery role is:
To use Google Cloud Storage delivery, create a bucket and provide the required GCP delivery settings.
Common dump parameters:
search_id(required): The search ID from a completed searchmax_entries(optional): Limit the number of files to include in the dumpdelivery(required): Delivery configuration (S3, Azure, GCP, or webhook)
What causes a 400 response
POST /webarchive/dump returns HTTP 400 when the request body fails validation. The response carries an error summary and a details array naming each field that failed. Common causes:
search_idis missing.deliveryis missing.- The
delivery.settingsblock does not match the chosendelivery.strategy. Each strategy has its own required settings:bucketplusassume_rolefor Amazon S3,bucketfor Google Cloud Storage,containerpluscredentialsfor Azure Blob Storage andurlfor a webhook.
details[].path and resend the request.Authorizations
Use your Bright Data API Key as a Bearer token in the Authorization header.
How to authenticate:
- Obtain your API Key from the Bright Data account settings at https://brightdata.com/cp/setting/users
- Include the API Key in the Authorization header of your requests
- Format:
Authorization: Bearer YOUR_API_KEY
Example:
Learn how to get your Bright Data API key: https://docs.brightdata.com/api-reference/authentication
Body
application/json
Response
Dump created successfully
ID of the created dump
Example:
"ucd_abc123-1234567890"