Set the retention mark
curl --request PUT \
--url https://api-datahub.octoparse.com/v1/datasets/{dataset_id}/retention \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"retained": true
}
'import requests
url = "https://api-datahub.octoparse.com/v1/datasets/{dataset_id}/retention"
payload = { "retained": True }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({retained: true})
};
fetch('https://api-datahub.octoparse.com/v1/datasets/{dataset_id}/retention', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-datahub.octoparse.com/v1/datasets/{dataset_id}/retention",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'retained' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-datahub.octoparse.com/v1/datasets/{dataset_id}/retention"
payload := strings.NewReader("{\n \"retained\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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))
}HttpResponse<String> response = Unirest.put("https://api-datahub.octoparse.com/v1/datasets/{dataset_id}/retention")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"retained\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-datahub.octoparse.com/v1/datasets/{dataset_id}/retention")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"retained\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"dataset_id": "<string>",
"retained": true
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Datasets
Set the retention mark
Run result data is retained for 90 days (from creation time); datasets carrying the retention mark are excluded from expiry cleanup. The mark is a user’s explicit declaration — reading does not renew it; setting and clearing are both idempotent.
You can only mark datasets you own: someone else’s, platform public seed sets and nonexistent ones all return 404 — the marking gate is narrower than the visibility gate (you can see a seed set, but it is not your output and does not participate in cleanup, so marking it would be meaningless).
PUT
/
v1
/
datasets
/
{dataset_id}
/
retention
Set the retention mark
curl --request PUT \
--url https://api-datahub.octoparse.com/v1/datasets/{dataset_id}/retention \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"retained": true
}
'import requests
url = "https://api-datahub.octoparse.com/v1/datasets/{dataset_id}/retention"
payload = { "retained": True }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({retained: true})
};
fetch('https://api-datahub.octoparse.com/v1/datasets/{dataset_id}/retention', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-datahub.octoparse.com/v1/datasets/{dataset_id}/retention",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'retained' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-datahub.octoparse.com/v1/datasets/{dataset_id}/retention"
payload := strings.NewReader("{\n \"retained\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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))
}HttpResponse<String> response = Unirest.put("https://api-datahub.octoparse.com/v1/datasets/{dataset_id}/retention")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"retained\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-datahub.octoparse.com/v1/datasets/{dataset_id}/retention")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"retained\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"dataset_id": "<string>",
"retained": true
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
DataHub API Key
Path Parameters
Body
application/json
Retention mark request body: true sets the mark, false revokes it (idempotent).
Response
Successful Response
Show child attributes
Show child attributes