S3
Sync S3 Connection
Create a new IAM user with permissions to:
- List all buckets.
- Read from the specific buckets and objects to sync with Carbon. Ensure any future buckets or objects carry the same permissions.
Once created, generate an access key for this user and share the credentials with us. We recommend testing this key beforehand.
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
Response
200 - application/json
id
integer
requireddata_source_external_id
string | null
requireddata_source_type
enum<string>
requiredAvailable options:
GOOGLE_DRIVE
, NOTION
, NOTION_DATABASE
, INTERCOM
, DROPBOX
, ONEDRIVE
, SHAREPOINT
, CONFLUENCE
, BOX
, ZENDESK
, ZOTERO
, S3
, GMAIL
, OUTLOOK
, TEXT
, CSV
, TSV
, PDF
, DOCX
, PPTX
, XLSX
, MD
, RTF
, JSON
, HTML
, RAW_TEXT
, WEB_SCRAPE
, RSS_FEED
, FRESHDESK
, GITBOOK
, SALESFORCE
, GITHUB
, SLACK
, JPG
, PNG
, JPEG
, MP3
, MP2
, AAC
, WAV
, FLAC
, PCM
, M4A
, OGG
, OPUS
, MPEG
, MPG
, MP4
, WMV
, AVI
, MOV
, MKV
, FLV
, WEBM
, EML
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
required