Skip to main content
PUT
Upsert Collection S3 Source

Authorizations

X-API-Key
string
header
required

Path Parameters

collection_id
integer
required

Cookies

wos-session
string
datalab_active_team
string

Body

application/json
bucket
string
required
Required string length: 1 - 255
prefix
string | null
Maximum string length: 1024
region
string | null
Maximum string length: 64
aws_access_key_id
string | null
Maximum string length: 255
aws_secret_access_key
string | null
reuse_aws_secret_access_key
boolean
default:false

Response

Successful Response

id
integer
required
bucket
string
required
prefix
string | null
required
region
string | null
required
credentials_type
enum<string>
required
Available options:
access_key,
public
aws_access_key_id
string
required
aws_secret_access_key_redacted
string
required
sync_status
string
required
last_sync_started_at
string<date-time> | null
required
last_sync_completed_at
string<date-time> | null
required
last_sync_file_count
integer
required
last_sync_error
string | null
required
output_bucket
string | null
required
output_prefix
string | null
required
output_region
string | null
required
output_credentials_type
enum<string>
required
Available options:
source,
access_key
output_aws_access_key_id
string
required
output_aws_secret_access_key_redacted
string
required
writeback_status
string
required
last_writeback_run_id
integer | null
required
last_writeback_started_at
string<date-time> | null
required
last_writeback_completed_at
string<date-time> | null
required
last_writeback_file_count
integer
required
last_writeback_total_file_count
integer
required
last_writeback_failed_file_count
integer
required
last_writeback_error
string | null
required
last_writeback_error_code
string | null
required
last_writeback_manifest_uri
string | null
required