Get Bulk Export Destinations

Get the current workspace’s bulk export destinations

GET /api/v1/bulk-exports/destinations

Error

A valid request URL is required to generate request examples

200

[
  {
    "display_name": "<string>",
    "config": {
      "endpoint_url": "<string>",
      "prefix": "",
      "bucket_name": "<string>",
      "region": "<string>",
      "s3_additional_kwargs": {},
      "config_kwargs_s3": {
        "use_accelerate_endpoint": true,
        "payload_signing_enabled": true
      },
      "include_bucket_in_prefix": true,
      "aws_role_arn": "<string>"
    },
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "credentials_keys": [
      "<string>"
    ],
    "destination_type": "s3"
  }
]

Authorizations

API KeyTenant IDBearer Auth

X-API-Key · string · header · required

Response

200 - application/json

Successful Response

display_name · string · required

Minimum string length: 1

Pattern: ^[a-zA-Z0-9\-_ ']+$

config · BulkExportDestinationS3Config · object · required

Show child attributes

id · string<uuid> · required

tenant_id · string<uuid> · required

created_at · string<date-time> · required

updated_at · string<date-time> · required

credentials_keys · string[] · required

destination_type · enum<string> · default: s3

Available options: s3