Skip to main content
PUT
/
api
/
v1
/
collections
/
{collection_id}
/
s3-source
Upsert Collection S3 Source
import requests

url = "https://www.datalab.to/api/v1/collections/{collection_id}/s3-source"

payload = {
    "bucket": "<string>",
    "prefix": "<string>",
    "region": "<string>",
    "aws_access_key_id": "<string>",
    "aws_secret_access_key": "<string>",
    "reuse_aws_secret_access_key": False
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
curl --request PUT \
--url https://www.datalab.to/api/v1/collections/{collection_id}/s3-source \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"bucket": "<string>",
"prefix": "<string>",
"region": "<string>",
"aws_access_key_id": "<string>",
"aws_secret_access_key": "<string>",
"reuse_aws_secret_access_key": false
}
'
const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
bucket: '<string>',
prefix: '<string>',
region: '<string>',
aws_access_key_id: '<string>',
aws_secret_access_key: '<string>',
reuse_aws_secret_access_key: false
})
};

fetch('https://www.datalab.to/api/v1/collections/{collection_id}/s3-source', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://www.datalab.to/api/v1/collections/{collection_id}/s3-source"

payload := strings.NewReader("{\n \"bucket\": \"<string>\",\n \"prefix\": \"<string>\",\n \"region\": \"<string>\",\n \"aws_access_key_id\": \"<string>\",\n \"aws_secret_access_key\": \"<string>\",\n \"reuse_aws_secret_access_key\": false\n}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
{
  "id": 123,
  "bucket": "<string>",
  "prefix": "<string>",
  "region": "<string>",
  "aws_access_key_id": "<string>",
  "aws_secret_access_key_redacted": "<string>",
  "sync_status": "<string>",
  "last_sync_started_at": "2023-11-07T05:31:56Z",
  "last_sync_completed_at": "2023-11-07T05:31:56Z",
  "last_sync_file_count": 123,
  "last_sync_error": "<string>",
  "output_bucket": "<string>",
  "output_prefix": "<string>",
  "output_region": "<string>",
  "output_aws_access_key_id": "<string>",
  "output_aws_secret_access_key_redacted": "<string>",
  "writeback_status": "<string>",
  "last_writeback_run_id": 123,
  "last_writeback_started_at": "2023-11-07T05:31:56Z",
  "last_writeback_completed_at": "2023-11-07T05:31:56Z",
  "last_writeback_file_count": 123,
  "last_writeback_total_file_count": 123,
  "last_writeback_failed_file_count": 123,
  "last_writeback_error": "<string>",
  "last_writeback_error_code": "<string>",
  "last_writeback_manifest_uri": "<string>"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

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