v1

latestOpenAPI 3.1.02026-07-26151126273.9 KB
collections

Upsert Collection S3 Source

Create or update a collection's S3 source and enqueue a sync.

put/api/v1/collections/{collection_id}/s3-source

Path parameters

collection_idinteger required

Cookies

wos-sessionstring
datalab_active_teamstring

Request body

bucketstring required
prefixstring nullable
regionstring nullable
aws_access_key_idstring nullable
aws_secret_access_keystring nullable
reuse_aws_secret_access_keyboolean

Response

Successful Response

idinteger required
bucketstring required
prefixstring nullable required
regionstring nullable required
credentials_type'access_key' | 'public' required
aws_access_key_idstring required
aws_secret_access_key_redactedstring required
sync_statusstring required
last_sync_started_atstring date-time nullable required
last_sync_completed_atstring date-time nullable required
last_sync_file_countinteger required
last_sync_errorstring nullable required
output_bucketstring nullable required
output_prefixstring nullable required
output_regionstring nullable required
output_credentials_type'source' | 'access_key' required
output_aws_access_key_idstring required
output_aws_secret_access_key_redactedstring required
writeback_statusstring required
last_writeback_run_idinteger nullable required
last_writeback_started_atstring date-time nullable required
last_writeback_completed_atstring date-time nullable required
last_writeback_file_countinteger required
last_writeback_total_file_countinteger required
last_writeback_failed_file_countinteger required
last_writeback_errorstring nullable required
last_writeback_error_codestring nullable required
last_writeback_manifest_uristring nullable required