S3
Sync S3 Connection
This endpoint can be used to connect S3 as well as Digital Ocean Spaces (S3 compatible)
For S3, create a new IAM user with permissions to:
<ol>
<li>List all buckets.</li>
<li>Read from the specific buckets and objects to sync with Carbon. Ensure any future buckets or objects carry
the same permissions.</li>
</ol>
Once created, generate an access key for this user and share the credentials with us. We recommend testing this key beforehand.
For Digital Ocean Spaces, generate the above credentials in your Applications and API page here https://cloud.digitalocean.com/account/api/spaces.
Endpoint URL is required to connect Digital Ocean Spaces. It should look like <<region>>.digitaloceanspaces.com
POST
/
integrations
/
s3
Authorizations
authorization
string
headerrequiredtoken <token>
, corresponds to temporary access tokens.
Body
application/json
access_key
string
requiredaccess_key_secret
string
requiredsync_source_items
boolean
default: trueEnabling this flag will fetch all available content from the source to be listed via list items endpoint
endpoint_url
string | null
You can specify a Digital Ocean endpoint URL to connect a Digital Ocean Space through this endpoint. The URL should be of format <region>.digitaloceanspaces.com. It's not required for S3 buckets.
data_source_tags
object
Tags to be associated with the data source. If the data source already has tags set, then an upsert will be performed.
Response
200 - application/json
id
integer
requireddata_source_external_id
string | null
requireddata_source_type
enum<string>
requiredAvailable options:
GOOGLE_CLOUD_STORAGE
, GOOGLE_DRIVE
, NOTION
, NOTION_DATABASE
, INTERCOM
, DROPBOX
, ONEDRIVE
, SHAREPOINT
, CONFLUENCE
, BOX
, ZENDESK
, ZOTERO
, S3
, AZURE_BLOB_STORAGE
, GMAIL
, OUTLOOK
, SERVICENOW
, TEXT
, CSV
, TSV
, PDF
, DOCX
, PPTX
, XLSX
, XLSM
, MD
, RTF
, JSON
, HTML
, RAW_TEXT
, WEB_SCRAPE
, RSS_FEED
, FRESHDESK
, GITBOOK
, SALESFORCE
, GITHUB
, SLACK
, GURU
, GONG
, JPG
, PNG
, JPEG
, MP3
, MP2
, AAC
, WAV
, FLAC
, PCM
, M4A
, OGG
, OPUS
, MPEG
, MPG
, MP4
, WMV
, AVI
, MOV
, MKV
, FLV
, WEBM
, EML
, MSG
token
object | null
requiredsync_status
enum<string>
requiredAvailable options:
QUEUED_FOR_SYNCING
, SYNCING
, READY
, SYNC_ERROR
source_items_synced_at
string | null
requiredorganization_user_id
integer
requiredorganization_id
integer
requiredorganization_supplied_user_id
string
requiredrevoked_access
boolean
requiredlast_synced_at
string
requiredlast_sync_action
enum<string>
requiredAvailable options:
ADD
, UPDATE
, CANCEL
, REVOKE
enable_auto_sync
boolean | null
requiredcreated_at
string
requiredupdated_at
string
requiredfiles_synced_at
string | null
requireddata_source_metadata
object
requiredtags
object
required