Skip to main content
POST
/
api
/
v1
/
sources
/
Create source connector
curl --request POST \
  --url https://platform.unstructuredapp.io/api/v1/sources/ \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "type": "azure",
  "config": {
    "remote_url": "<string>",
    "account_name": "<string>",
    "account_key": "<string>",
    "connection_string": "<string>",
    "sas_token": "<string>",
    "recursive": true
  }
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "type": "azure",
  "config": {
    "remote_url": "<string>",
    "account_name": "<string>",
    "account_key": "<string>",
    "connection_string": "<string>",
    "sas_token": "<string>",
    "recursive": true
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Headers

​
unstructured-api-key
string | null

Body

application/json
​
name
string
required
​
type
enum<string>
required
Available options:
azure,
box,
confluence,
couchbase,
databricks_volumes,
dropbox,
elasticsearch,
gcs,
google_drive,
kafka-cloud,
mongodb,
onedrive,
outlook,
postgres,
s3,
salesforce,
sharepoint,
slack,
snowflake,
jira,
zendesk
​
config
object
required
  • AzureSourceConnectorConfigInput
  • BoxSourceConnectorConfigInput
  • ConfluenceSourceConnectorConfigInput
  • CouchbaseSourceConnectorConfigInput
  • DatabricksVolumesConnectorConfigInput
  • DropboxSourceConnectorConfigInput
  • ElasticsearchConnectorConfigInput
  • GCSSourceConnectorConfigInput
  • GoogleDriveSourceConnectorConfigInput
  • KafkaCloudSourceConnectorConfigInput
  • MongoDBConnectorConfigInput
  • OneDriveSourceConnectorConfigInput
  • OutlookSourceConnectorConfigInput
  • PostgresSourceConnectorConfigInput
  • S3SourceConnectorConfigInput
  • SalesforceSourceConnectorConfigInput
  • SharePointSourceConnectorConfigInput
  • SnowflakeSourceConnectorConfigInput
  • JiraSourceConnectorConfigInput
  • ZendeskSourceConnectorConfigInput
  • Config

Response

Successful Response

​
id
string<uuid>
required
​
name
string
required
​
type
enum<string>
required
Available options:
azure,
box,
confluence,
couchbase,
databricks_volumes,
dropbox,
elasticsearch,
gcs,
google_drive,
kafka-cloud,
mongodb,
onedrive,
outlook,
postgres,
s3,
salesforce,
sharepoint,
slack,
snowflake,
jira,
zendesk
​
config
object
required
  • AzureSourceConnectorConfig
  • BoxSourceConnectorConfig
  • ConfluenceSourceConnectorConfig
  • CouchbaseSourceConnectorConfig
  • DatabricksVolumesConnectorConfig
  • DropboxSourceConnectorConfig
  • ElasticsearchConnectorConfig
  • GCSSourceConnectorConfig
  • GoogleDriveSourceConnectorConfig
  • KafkaCloudSourceConnectorConfig
  • MongoDBConnectorConfig
  • OneDriveSourceConnectorConfig
  • OutlookSourceConnectorConfig
  • PostgresSourceConnectorConfig
  • S3SourceConnectorConfig
  • SalesforceSourceConnectorConfig
  • SharePointSourceConnectorConfig
  • SnowflakeSourceConnectorConfig
  • JiraSourceConnectorConfig
  • ZendeskSourceConnectorConfig
  • Config
​
created_at
string<date-time>
required
​
updated_at
string<date-time> | null
⌘I