> ## 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.
# Get destination type schema
> Retrieve the exact fields and credentials required to configure a specific delivery destination type such as s3, sftp, gcs or webhook.
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](/api-reference/marketplace-dataset-api/update-view-delivery-settings).
Use [Get delivery options](/api-reference/marketplace-dataset-api/get-delivery-options) first to list the valid values you can pass as `destination_type`.
## Example credential payloads and permissions
The values shown below are sample values. Replace them with your real credentials before sending a request.
Use [Get delivery options](/api-reference/marketplace-dataset-api/get-delivery-options) to list the supported `destination_type` values. Then call this endpoint with the selected `destination_type` and pass the required fields in the `deliver` object.
For cloud storage destinations, Bright Data may validate that delivered files are readable after upload. Make sure the credentials include the provider-specific upload and read permissions listed below. If read permission is missing, delivery upload may succeed, but read-after-upload validation can fail.
### Amazon S3
```json theme={null}
{
"bucket": "customer-bucket",
"region": "us-east-1",
"credentials": {
"access_key_id": "",
"secret_access_key": ""
}
}
```
Required permissions:
* `s3:PutObject`
* `s3:GetObject`
For restrictive multipart upload policies, multipart-related permissions may also be required, such as `s3:AbortMultipartUpload` and `s3:ListMultipartUploadParts`.
### Amazon S3 with IAM role
```json theme={null}
{
"bucket": "customer-bucket",
"region": "us-east-1",
"use_dca_delivery_role": true,
"assume_role": {
"role_arn": "arn:aws:iam:::role/",
"external_id": ""
}
}
```
Required permissions:
* `s3:PutObject`
* `s3:GetObject`
For restrictive multipart upload policies, multipart-related permissions may also be required, such as `s3:AbortMultipartUpload` and `s3:ListMultipartUploadParts`.
The IAM role trust policy must allow Bright Data’s delivery role to assume the customer role using the provided external ID.
### Azure Blob Storage
```json theme={null}
{
"container": "customer-container",
"credentials": {
"account": "",
"key": ""
}
}
```
Required permissions:
* blob create/write permission for upload
* blob read permission for read-after-upload validation
### Azure Blob Storage with SAS token
```json theme={null}
{
"container": "customer-container",
"credentials": {
"account": "",
"sas_token": ""
}
}
```
Required SAS permissions:
* `r`, read, required for read-after-upload validation
* `c`, create, required for creating new blobs
* `w`, write, required for uploading blob content
### Google Cloud Storage
```json theme={null}
{
"bucket": "customer-bucket",
"credentials": {
"type": "service_account",
"project_id": "",
"private_key_id": "",
"private_key": "-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n",
"client_email": "@.iam.gserviceaccount.com",
"client_id": ""
}
}
```
Required permissions:
* `storage.objects.create`
* `storage.objects.get`
### Ali OSS
```json theme={null}
{
"bucket": "customer-bucket",
"region": "oss-eu-central-1",
"endpoint": "oss-eu-central-1.aliyuncs.com",
"credentials": {
"access_key_id": "",
"secret_access_key": ""
}
}
```
Required permissions:
* `oss:PutObject`
* `oss:GetObject`
For restrictive multipart upload policies, multipart-related permissions may also be required.
### Webhook
```json theme={null}
{
"url": "https://customer.example.com/delivery",
"auth": "Bearer ",
"compress": "gzip"
}
```
Requirements:
* the endpoint must accept `POST` requests
* the endpoint must return a `2xx` response after receiving the payload
* for webhook payloads larger than `10 MB`, use cloud storage delivery instead of webhook
## OpenAPI
````yaml api-reference/dca-api GET /datasets/delivery_settings/{destination_type}/schema
openapi: 3.1.0
info:
title: Brightdata API
description: API for interaction with datasets marketplace
version: 1.0.0
servers:
- url: https://api.brightdata.com
security:
- bearerAuth: []
paths:
/datasets/delivery_settings/{destination_type}/schema:
get:
description: >-
Returns the exact fields required for a specific delivery destination
type (for example `s3`, `sftp`, `gcs`, `webhook`). Use this to discover
which credentials and parameters must be supplied when updating a view's
delivery settings.
parameters:
- name: destination_type
in: path
description: >-
The identifier of the delivery strategy. Supported values:
`api_pull`, `webhook`, `email`, `gcs`, `gcp_pubsub`, `s3`,
`snowflake`, `ali_oss`, `sftp`, `azure`.
required: true
schema:
type: string
example: s3
responses:
'200':
description: Schema for the requested destination type
content:
application/json:
schema:
type: object
properties:
name:
type: string
properties:
type: object
example:
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
'404':
description: Unknown destination type
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: Destination type not found
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: >-
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
bearerFormat: API Key
````