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
token <token>
, corresponds to temporary access tokens.
Body
application/json
Enabling this flag will fetch all available content from the source to be listed via list items endpoint
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.
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
Available 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
, DOCUMENT360
, JPG
, PNG
, JPEG
, MP3
, MP2
, AAC
, WAV
, FLAC
, PCM
, M4A
, OGG
, OPUS
, MPEG
, MPG
, MP4
, WMV
, AVI
, MOV
, MKV
, FLV
, WEBM
, EML
, MSG
Available options:
QUEUED_FOR_SYNCING
, SYNCING
, READY
, SYNC_ERROR
Available options:
ADD
, UPDATE
, CANCEL
, REVOKE