---
title: "Update source connector"
method: PUT
path: "/api/v1/sources/{source_id}"
tags: ["sources"]
---

# Update source connector

`PUT /api/v1/sources/{source_id}`

Update the configuration of an existing source connector.

## Path parameters

- `source_id` union, required
  - string, uuid
  - string

## Headers

- `unstructured-api-key` string, nullable

## Request body

- UpdateSourceConnector
  - `config` union, required
    - BoxSourceConnectorConfigInput
      - `box_app_config` string, nullable
      - `access_token` string, nullable
      - `refresh_token` string, nullable
      - `remote_url` string, required
      - `recursive` boolean
    - ConfluenceSourceConnectorConfigInput
      - `url` string, required
      - `username` string, nullable
      - `cloud_id` string, nullable
      - `password` string, nullable
      - `api_token` string, nullable
      - `token` string, nullable
      - `oauth_token` string, nullable
      - `refresh_token` string, nullable
      - `cloud` boolean
      - `extract_images` boolean
      - `extract_files` boolean
      - `max_num_of_spaces` integer
      - `max_num_of_docs_from_each_space` integer
      - `spaces` string[], nullable
    - CouchbaseSourceConnectorConfigInput
      - `bucket` string, required
      - `connection_string` string, required
      - `scope` string, nullable
      - `collection` string, nullable
      - `batch_size` integer, required
      - `username` string, required
      - `password` string, required
      - `collection_id` 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
    - DropboxSourceConnectorConfigInput
      - `token` string, required
      - `refresh_token` string, nullable
      - `remote_url` string, required
      - `recursive` boolean
    - ElasticsearchConnectorConfigInput
      - `hosts` string[], required
      - `index_name` string, required
      - `es_api_key` string, required
    - GCSSourceConnectorConfigInput
      - `remote_url` string, required
      - `service_account_key` union
        - SecretReference
          - `id` string, required
          - `type` 'rsa' | 'rsa_aes' | 'runtime_config'
        - string
      - `recursive` boolean
      - `oauth_token` string, nullable
      - `refresh_token` string, nullable
      - `oauth_client_id` string, nullable
      - `oauth_client_secret` string, nullable
    - GoogleDriveSourceConnectorConfigInput
      - `drive_id` string, required
      - `service_account_key` union
        - SecretReference
          - `id` string, required
          - `type` 'rsa' | 'rsa_aes' | 'runtime_config'
        - string
      - `oauth_token` union
        - SecretReference
          - `id` string, required
          - `type` 'rsa' | 'rsa_aes' | 'runtime_config'
        - string
      - `refresh_token` string, nullable
      - `extensions` string[], nullable
      - `recursive` boolean
    - KafkaCloudSourceConnectorConfigInput
      - `bootstrap_servers` string, required
      - `port` integer
      - `group_id` string, nullable
      - `topic` string, required
      - `kafka_api_key` string, required
      - `secret` string, required
      - `num_messages_to_consume` integer
    - MongoDBConnectorConfigInput
      - `database` string, required
      - `collection` string, required
      - `uri` string, required
    - OneDriveSourceConnectorConfigInput
      - `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
      - `recursive` boolean
      - `path` string, required
    - OutlookSourceConnectorConfigInput
      - `authority_url` string
      - `tenant` string, nullable
      - `client_id` string, nullable
      - `client_cred` string, nullable
      - `oauth_token` string, nullable
      - `refresh_token` string, nullable
      - `outlook_folders` string[], nullable
      - `recursive` boolean
      - `user_email` string, required
    - PostgresSourceConnectorConfigInput
      - `host` string, required
      - `database` string, required
      - `port` integer, required
      - `username` string, required
      - `password` string, required
      - `table_name` string, required
      - `batch_size` integer, required
      - `id_column` string
      - `fields` string[], nullable
    - SalesforceSourceConnectorConfigInput
      - `username` string, required
      - `consumer_key` string, required
      - `private_key` string, required
      - `categories` string[], required
    - SharePointSourceConnectorConfigInput
      - `site` string, required
      - `tenant` string, required
      - `authority_url` string
      - `user_pname` string, nullable
      - `client_id` string, nullable
      - `client_cred` string, nullable
      - `oauth_token` string, nullable
      - `refresh_token` string, nullable
      - `recursive` boolean
      - `path` string, nullable
    - SlackSourceConnectorConfigInput
      - `token` string, required
      - `refresh_token` string, nullable
      - `channels` string[], required
      - `start_date` string, nullable
      - `end_date` string, nullable
    - SnowflakeSourceConnectorConfigInput
      - `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, required
      - `batch_size` integer
      - `id_column` string, required
      - `fields` string[], nullable
    - TeradataSourceConnectorConfigInput
      - `host` string, required
      - `user` string, required
      - `password` string, required
      - `database` string, nullable
      - `dbs_port` integer
      - `id_column` string
      - `table_name` string, required
      - `batch_size` integer
      - `fields` string[], nullable
    - JiraSourceConnectorConfigInput
      - `url` string, required
      - `username` string, nullable
      - `cloud_id` string, nullable
      - `password` string, nullable
      - `token` string, nullable
      - `oauth_token` string, nullable
      - `refresh_token` string, nullable
      - `cloud` boolean, nullable
      - `projects` string[], nullable
      - `boards` string[], nullable
      - `issues` string[], nullable
      - `status_filters` string[], nullable
      - `download_attachments` boolean, nullable
    - ZendeskSourceConnectorConfigInput
      - `subdomain` string, required
      - `email` string, required
      - `api_token` string, required
      - `item_type` string, nullable
      - `batch_size` integer, nullable
    - S3SourceConnectorConfigInput
      - `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
      - `recursive` boolean
    - AzureSourceConnectorConfigInput
      - `remote_url` string, required
      - `account_name` string, nullable
      - `account_key` string, nullable
      - `connection_string` string, nullable
      - `sas_token` string, nullable
      - `recursive` boolean
    - object

## Response `200`

Successful Response

- SourceConnectorInformation
  - `id` string, uuid, required
  - `name` string, required
  - `type` union, required
    - 'box' | 'confluence' | 'couchbase' | 'databricks_volumes' | 'dropbox' | 'elasticsearch' | 'gcs' | 'google_drive' | 'kafka-cloud' | 'mongodb' | 'onedrive' | 'outlook' | 'postgres' | 'salesforce' | 'sharepoint' | 'slack' | 'snowflake' | 'teradata' | 'jira' | 'zendesk' | 's3' | 'azure'
    - string
  - `config` union, required
    - BoxSourceConnectorConfig
      - `box_app_config` string, nullable
      - `access_token` string, nullable
      - `refresh_token` string, nullable
      - `recursive` boolean, required
    - ConfluenceSourceConnectorConfig
      - `url` string, required
      - `username` string, nullable
      - `cloud_id` string, nullable
      - `password` string, nullable
      - `api_token` string, nullable
      - `token` string, nullable
      - `oauth_token` string, nullable
      - `refresh_token` string, nullable
      - `cloud` boolean, required
      - `extract_images` boolean
      - `extract_files` boolean
      - `max_num_of_spaces` integer, required
      - `max_num_of_docs_from_each_space` integer, required
      - `spaces` string[], nullable, required
    - CouchbaseSourceConnectorConfig
      - `bucket` string, required
      - `connection_string` string, required
      - `scope` string, nullable
      - `collection` string, nullable
      - `batch_size` integer, required
      - `username` string, required
      - `password` string, required
      - `collection_id` 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
    - DropboxSourceConnectorConfig
      - `token` string, required
      - `refresh_token` string, nullable
      - `remote_url` string, required
      - `recursive` boolean, required
    - ElasticsearchConnectorConfig
      - `hosts` string[], required
      - `index_name` string, required
      - `es_api_key` string, required
    - GCSSourceConnectorConfig
      - `remote_url` string, required
      - `service_account_key` union
        - SecretReference
          - `id` string, required
          - `type` 'rsa' | 'rsa_aes' | 'runtime_config'
        - string
      - `recursive` boolean, required
      - `oauth_token` string, nullable
      - `refresh_token` string, nullable
      - `oauth_client_id` string, nullable
      - `oauth_client_secret` string, nullable
    - GoogleDriveSourceConnectorConfig
      - `drive_id` string, required
      - `service_account_key` union
        - SecretReference
          - `id` string, required
          - `type` 'rsa' | 'rsa_aes' | 'runtime_config'
        - string
      - `oauth_token` union
        - SecretReference
          - `id` string, required
          - `type` 'rsa' | 'rsa_aes' | 'runtime_config'
        - string
      - `refresh_token` string, nullable
      - `extensions` string[], nullable
      - `recursive` boolean, required
    - KafkaCloudSourceConnectorConfig
      - `bootstrap_servers` string, required
      - `port` integer, required
      - `group_id` string, nullable
      - `topic` string, required
      - `kafka_api_key` string, required
      - `secret` string, required
      - `num_messages_to_consume` integer, required
    - MongoDBConnectorConfig
      - `database` string, required
      - `collection` string, required
      - `uri` string, required
    - OneDriveSourceConnectorConfig
      - `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
      - `recursive` boolean, required
      - `path` string, required
    - OutlookSourceConnectorConfig
      - `authority_url` string
      - `tenant` string, nullable
      - `client_id` string, nullable
      - `client_cred` string, nullable
      - `oauth_token` string, nullable
      - `refresh_token` string, nullable
      - `outlook_folders` string[], nullable
      - `recursive` boolean, required
      - `user_email` string, required
    - PostgresSourceConnectorConfig
      - `host` string, required
      - `database` string, required
      - `port` integer, required
      - `username` string, required
      - `password` string, required
      - `table_name` string, required
      - `batch_size` integer, required
      - `id_column` string, required
      - `fields` string[], nullable
    - SalesforceSourceConnectorConfig
      - `username` string, required
      - `consumer_key` string, required
      - `private_key` string, required
      - `categories` string[], required
    - SharePointSourceConnectorConfig
      - `site` string, required
      - `tenant` string, required
      - `authority_url` string
      - `user_pname` string, nullable
      - `client_id` string, nullable
      - `client_cred` string, nullable
      - `oauth_token` string, nullable
      - `refresh_token` string, nullable
      - `recursive` boolean, required
      - `path` string, nullable
    - SlackSourceConnectorConfig
      - `token` string, required
      - `refresh_token` string, nullable
      - `channels` string[], required
      - `start_date` string, nullable
      - `end_date` string, nullable
    - SnowflakeSourceConnectorConfig
      - `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, required
      - `batch_size` integer
      - `id_column` string, required
      - `fields` string[], nullable
    - TeradataSourceConnectorConfig
      - `host` string, required
      - `user` string, required
      - `password` string, required
      - `database` string, nullable
      - `dbs_port` integer
      - `id_column` string
      - `table_name` string, required
      - `batch_size` integer
      - `fields` string[], nullable
    - JiraSourceConnectorConfig
      - `url` string, required
      - `username` string, nullable
      - `cloud_id` string, nullable
      - `password` string, nullable
      - `token` string, nullable
      - `oauth_token` string, nullable
      - `refresh_token` string, nullable
      - `cloud` boolean, nullable
      - `projects` string[], nullable
      - `boards` string[], nullable
      - `issues` string[], nullable
      - `status_filters` string[], nullable
      - `download_attachments` boolean, nullable
    - ZendeskSourceConnectorConfig
      - `subdomain` string, required
      - `email` string, required
      - `api_token` string, required
      - `item_type` string, nullable
      - `batch_size` integer, nullable
    - S3SourceConnectorConfig
      - `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
      - `recursive` boolean, required
    - AzureSourceConnectorConfig
      - `remote_url` string, required
      - `account_name` string, nullable
      - `account_key` string, nullable
      - `connection_string` string, nullable
      - `sas_token` string, nullable
      - `recursive` boolean, required
    - 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)