---
title: "Update destination connector"
method: PUT
path: "/api/v1/destinations/{destination_id}"
tags: ["destinations"]
---

# Update destination connector

`PUT /api/v1/destinations/{destination_id}`

Update the configuration of an existing destination connector.

## Path parameters

- `destination_id` union, required
  - string, uuid
  - string

## Headers

- `unstructured-api-key` string, nullable

## Request body

- UpdateDestinationConnector
  - `config` union, required
    - AstraDBConnectorConfigInput
      - `collection_name` string, required
      - `keyspace` string, nullable
      - `batch_size` integer
      - `binary_encode_vectors` boolean
      - `api_endpoint` string, required
      - `token` string, required
      - `flatten_metadata` boolean
    - CouchbaseDestinationConnectorConfigInput
      - `bucket` string, required
      - `connection_string` string, required
      - `scope` string, nullable
      - `collection` string, nullable
      - `batch_size` integer, required
      - `username` string, required
      - `password` string, required
    - DatabricksVolumesConnectorConfigInput
      - `host` string, required
      - `catalog` string, required
      - `schema` string
      - `volume` string, required
      - `volume_path` string, required
      - `client_secret` string, required
      - `client_id` string, required
    - DatabricksVDTDestinationConnectorConfigInput
      - `server_hostname` string, required
      - `http_path` string, required
      - `token` string, nullable
      - `client_id` string, nullable
      - `client_secret` string, nullable
      - `catalog` string, required
      - `database` string
      - `table_name` string, nullable
      - `schema` string
      - `volume` string, required
      - `volume_path` string, nullable
    - DeltaTableConnectorConfigInput
      - `aws_access_key_id` string, required
      - `aws_secret_access_key` string, required
      - `aws_region` string, required
      - `table_uri` string, required
    - ElasticsearchConnectorConfigInput
      - `hosts` string[], required
      - `index_name` string, required
      - `es_api_key` string, required
    - GCSDestinationConnectorConfigInput
      - `remote_url` string, required
      - `service_account_key` string, required
    - KafkaCloudDestinationConnectorConfigInput
      - `bootstrap_servers` string, required
      - `port` integer
      - `group_id` string, nullable
      - `topic` string, required
      - `kafka_api_key` string, required
      - `secret` string, required
      - `batch_size` integer
    - MilvusDestinationConnectorConfigInput
      - `uri` string, required
      - `user` string, nullable
      - `token` string, nullable
      - `password` string, nullable
      - `db_name` string, nullable
      - `collection_name` string, required
      - `record_id_key` string, required
      - `flatten_metadata` boolean
      - `fields_to_include` string[], nullable
    - MongoDBConnectorConfigInput
      - `database` string, required
      - `collection` string, required
      - `uri` string, required
    - Neo4jDestinationConnectorConfigInput
      - `uri` string, required
      - `database` string, required
      - `username` string, required
      - `password` string, required
      - `batch_size` integer
    - OneDriveDestinationConnectorConfigInput
      - `client_id` string, nullable
      - `user_pname` string, required
      - `tenant` string, required
      - `authority_url` string
      - `client_cred` string, nullable
      - `oauth_token` string, nullable
      - `refresh_token` string, nullable
      - `remote_url` string, required
    - PineconeDestinationConnectorConfigInput
      - `index_name` string, required
      - `api_key` string, required
      - `namespace` string, required
      - `batch_size` integer
    - PostgresDestinationConnectorConfigInput
      - `host` string, required
      - `database` string, required
      - `port` integer, required
      - `username` string, required
      - `password` string, required
      - `table_name` string, required
      - `batch_size` integer, required
    - RedisDestinationConnectorConfigInput
      - `host` string, required
      - `port` integer
      - `username` string, nullable
      - `password` string, nullable
      - `uri` string, nullable
      - `database` integer
      - `ssl` boolean
      - `batch_size` integer
    - QdrantCloudDestinationConnectorConfigInput
      - `url` string, required
      - `api_key` string, required
      - `collection_name` string, required
      - `batch_size` integer
    - SnowflakeDestinationConnectorConfigInput
      - `account` string, required
      - `role` string, required
      - `user` string, required
      - `password` string, required
      - `host` string, required
      - `port` integer
      - `database` string, required
      - `schema` string, required
      - `table_name` string
      - `batch_size` integer
      - `record_id_key` string, nullable
    - TeradataDestinationConnectorConfigInput
      - `host` string, required
      - `user` string, required
      - `password` string, required
      - `database` string, nullable
      - `dbs_port` integer
      - `table_name` string
      - `batch_size` integer
      - `record_id_key` string, nullable
    - WeaviateDestinationConnectorConfigInput
      - `cluster_url` string, required
      - `api_key` string, required
      - `collection` string, nullable
    - IBMWatsonxS3DestinationConnectorConfigInput
      - `iam_api_key` string, required
      - `access_key_id` string, required
      - `secret_access_key` string, required
      - `iceberg_endpoint` string, required
      - `object_storage_endpoint` string, required
      - `object_storage_region` string, required
      - `catalog` string, required
      - `account_id` string, nullable — IBM Cloud account ID for account-scoped (SaaS) watsonx.data instances. This is the `a/<...>` segment of the instance CRN, not the instance GUID. When set, the account-scoped Iceberg REST endpoint is used and the AccountId header is sent. Leave unset for instance-scoped deployments such as Cloud Pak for Data.
      - `max_retries_connection` integer — Maximum number of retries in case of a connection error
      - `namespace` string, required
      - `table` string, required
      - `max_retries` integer — Maximum number of retries to upload data
      - `record_id_key` string — Searchable key to find entries for the same record on previous runs
    - S3DestinationConnectorConfigInput
      - `remote_url` string, required
      - `anonymous` boolean
      - `ambient_credentials` boolean
      - `key` string, nullable
      - `secret` string, nullable
      - `token` string, nullable
      - `endpoint_url` string, nullable
      - `role_arn` string, nullable
      - `external_id` string, nullable
    - AzureDestinationConnectorConfigInput
      - `remote_url` string, required
      - `account_name` string, nullable
      - `account_key` string, nullable
      - `connection_string` string, nullable
      - `sas_token` string, nullable
    - object

## Response `200`

Successful Response

- DestinationConnectorInformation
  - `id` string, uuid, required
  - `name` string, required
  - `type` union, required
    - 'astradb' | 'couchbase' | 'databricks_volumes' | 'databricks_volume_delta_tables' | 'delta_table' | 'elasticsearch' | 'gcs' | 'kafka-cloud' | 'milvus' | 'mongodb' | 'motherduck' | 'neo4j' | 'onedrive' | 'pinecone' | 'postgres' | 'redis' | 'qdrant-cloud' | 'snowflake' | 'teradata' | 'weaviate-cloud' | 'ibm_watsonx_s3' | 's3' | 'azure'
    - string
  - `config` union, required
    - AstraDBConnectorConfig
      - `collection_name` string, required
      - `keyspace` string, nullable
      - `batch_size` integer, required
      - `binary_encode_vectors` boolean
      - `api_endpoint` string, required
      - `token` string, required
    - CouchbaseDestinationConnectorConfig
      - `bucket` string, required
      - `connection_string` string, required
      - `scope` string, nullable
      - `collection` string, nullable
      - `batch_size` integer, required
      - `username` string, required
      - `password` string, required
    - DatabricksVolumesConnectorConfig
      - `host` string, required
      - `catalog` string, required
      - `schema` string
      - `volume` string, required
      - `volume_path` string, required
      - `client_secret` string, required
      - `client_id` string, required
    - DatabricksVDTDestinationConnectorConfig
      - `server_hostname` string, required
      - `http_path` string, required
      - `token` string, nullable
      - `client_id` string, nullable
      - `client_secret` string, nullable
      - `catalog` string, required
      - `database` string
      - `table_name` string, nullable
      - `schema` string
      - `volume` string, required
      - `volume_path` string, nullable
    - DeltaTableConnectorConfig
      - `aws_access_key_id` string, required
      - `aws_secret_access_key` string, required
      - `aws_region` string, required
      - `table_uri` string, required
    - ElasticsearchConnectorConfig
      - `hosts` string[], required
      - `index_name` string, required
      - `es_api_key` string, required
    - GCSDestinationConnectorConfig
      - `remote_url` string, required
      - `service_account_key` string, required
    - KafkaCloudDestinationConnectorConfig
      - `bootstrap_servers` string, required
      - `port` integer, required
      - `group_id` string, nullable
      - `topic` string, required
      - `kafka_api_key` string, required
      - `secret` string, required
      - `batch_size` integer, required
    - MilvusDestinationConnectorConfig
      - `uri` string, required
      - `user` string, nullable
      - `token` string, nullable
      - `password` string, nullable
      - `db_name` string, nullable
      - `collection_name` string, required
      - `record_id_key` string, required
    - MongoDBConnectorConfig
      - `database` string, required
      - `collection` string, required
      - `uri` string, required
    - Neo4jDestinationConnectorConfig
      - `uri` string, required
      - `database` string, required
      - `username` string, required
      - `password` string, required
      - `batch_size` integer, required
    - OneDriveDestinationConnectorConfig
      - `client_id` string, nullable
      - `user_pname` string, required
      - `tenant` string, required
      - `authority_url` string
      - `client_cred` string, nullable
      - `oauth_token` string, nullable
      - `refresh_token` string, nullable
      - `remote_url` string, required
    - PineconeDestinationConnectorConfig
      - `index_name` string, required
      - `api_key` string, required
      - `namespace` string, required
      - `batch_size` integer, required
    - PostgresDestinationConnectorConfig
      - `host` string, required
      - `database` string, required
      - `port` integer, required
      - `username` string, required
      - `password` string, required
      - `table_name` string, required
      - `batch_size` integer, required
    - RedisDestinationConnectorConfig
      - `host` string, required
      - `port` integer, required
      - `username` string, nullable
      - `password` string, nullable
      - `uri` string, nullable
      - `database` integer, required
      - `ssl` boolean, required
      - `batch_size` integer, required
    - QdrantCloudDestinationConnectorConfig
      - `url` string, required
      - `api_key` string, required
      - `collection_name` string, required
      - `batch_size` integer, required
    - SnowflakeDestinationConnectorConfig
      - `account` string, required
      - `role` string, required
      - `user` string, required
      - `password` string, required
      - `host` string, required
      - `port` integer
      - `database` string, required
      - `schema` string, required
      - `table_name` string
      - `batch_size` integer
      - `record_id_key` string, nullable
    - TeradataDestinationConnectorConfig
      - `host` string, required
      - `user` string, required
      - `password` string, required
      - `database` string, nullable
      - `dbs_port` integer
      - `table_name` string
      - `batch_size` integer
      - `record_id_key` string, nullable
    - WeaviateDestinationConnectorConfig
      - `cluster_url` string, required
      - `api_key` string, required
      - `collection` string, nullable
    - IBMWatsonxS3DestinationConnectorConfig
      - `iam_api_key` string, required
      - `access_key_id` string, required
      - `secret_access_key` string, required
      - `iceberg_endpoint` string, required
      - `object_storage_endpoint` string, required
      - `object_storage_region` string, required
      - `catalog` string, required
      - `account_id` string, nullable — IBM Cloud account ID for account-scoped (SaaS) watsonx.data instances. This is the `a/<...>` segment of the instance CRN, not the instance GUID. When set, the account-scoped Iceberg REST endpoint is used and the AccountId header is sent. Leave unset for instance-scoped deployments such as Cloud Pak for Data.
      - `max_retries_connection` integer, required
      - `namespace` string, required
      - `table` string, required
      - `max_retries` integer, required
      - `record_id_key` string, required
    - S3DestinationConnectorConfig
      - `remote_url` string, required
      - `anonymous` boolean, required
      - `ambient_credentials` boolean, nullable
      - `key` string, nullable
      - `secret` string, nullable
      - `token` string, nullable
      - `endpoint_url` string, nullable
      - `role_arn` string, nullable
      - `external_id` string, nullable
    - AzureDestinationConnectorConfig
      - `remote_url` string, required
      - `account_name` string, nullable
      - `account_key` string, nullable
      - `connection_string` string, nullable
      - `sas_token` string, nullable
    - object
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, nullable
  - `key` string, nullable

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/unstructuredapp/apis/platform-api.md) · [All operations](https://skmtc.net/unstructuredapp/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/unstructuredapp/platform-api/versions/41676641a27c/schema)