Skip to main content
GET
/
datasets
/
delivery_settings
/
{destination_type}
/
schema
cURL
curl --request GET \
  --url https://api.brightdata.com/datasets/delivery_settings/{destination_type}/schema \
  --header 'Authorization: Bearer <token>'
{
  "name": "s3",
  "properties": {
    "bucket": {
      "type": "string",
      "required": true
    },
    "credentials": {
      "type": "object",
      "required": false,
      "or": [
        {
          "aws-access-key": {
            "type": "string",
            "required": true
          },
          "aws-secret-key": {
            "type": "string",
            "required": true
          }
        },
        {
          "role_arn": {
            "type": "string",
            "required": true
          },
          "external_id": {
            "type": "string",
            "required": true
          }
        }
      ]
    },
    "region": {
      "type": "string",
      "required": false
    },
    "directory": {
      "type": "string",
      "required": false
    },
    "endpoint_url": {
      "type": "string",
      "required": false
    }
  }
}
Each delivery destination supported by Bright Data has its own field set. For example, s3 requires a bucket and either an access key/secret pair or an IAM role ARN plus external ID, while sftp requires host and credential fields. Call this endpoint with the destination type you plan to use, then supply the returned fields in the deliver object when you call Update view delivery settings.
Use Get delivery options first to list the valid values you can pass as destination_type.

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

​
destination_type
string
required

The identifier of the delivery strategy. Supported values: api_pull, webhook, email, gcs, gcp_pubsub, s3, snowflake, ali_oss, sftp, azure.

Example:

"s3"

Response

Schema for the requested destination type

​
name
string
​
properties
object