Skip to main content
POST
/
api
/
v1
/
collections
/
{collection_id}
/
s3-source
/
output
/
writeback
Trigger Collection S3 Writeback
import requests

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

headers = {"X-API-Key": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)
curl --request POST \
  --url https://www.datalab.to/api/v1/collections/{collection_id}/s3-source/output/writeback \
  --header 'X-API-Key: <api-key>'
const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};

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

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

func main() {

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

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	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

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