Preview snapshot expirations
curl --request POST \
--url https://api-dev.narrative.io/datasets/{dataset_id}/retention-policy/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "expire_everything"
}
'import requests
url = "https://api-dev.narrative.io/datasets/{dataset_id}/retention-policy/preview"
payload = { "type": "expire_everything" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({type: 'expire_everything'})
};
fetch('https://api-dev.narrative.io/datasets/{dataset_id}/retention-policy/preview', 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-dev.narrative.io/datasets/{dataset_id}/retention-policy/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'type' => 'expire_everything'
]),
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-dev.narrative.io/datasets/{dataset_id}/retention-policy/preview"
payload := strings.NewReader("{\n \"type\": \"expire_everything\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api-dev.narrative.io/datasets/{dataset_id}/retention-policy/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"expire_everything\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-dev.narrative.io/datasets/{dataset_id}/retention-policy/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"expire_everything\"\n}"
response = http.request(request)
puts response.read_body{
"snapshots_to_expire": [
{
"snapshot_id": 8840810861846963000,
"created_at": "2022-01-28T16:25:47.987Z"
},
{
"snapshot_id": 6511121635994506000,
"created_at": "2022-01-28T16:58:59.264Z"
},
{
"snapshot_id": 4359653450296158700,
"created_at": "2022-01-28T17:33:25.560Z"
},
{
"snapshot_id": 7422070807769186000,
"created_at": "2022-01-28T18:58:45.856Z"
}
]
}Dataset Configuration
Preview snapshot expirations
Preview snapshot expirations given a retention policy.
POST
/
datasets
/
{dataset_id}
/
retention-policy
/
preview
Preview snapshot expirations
curl --request POST \
--url https://api-dev.narrative.io/datasets/{dataset_id}/retention-policy/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "expire_everything"
}
'import requests
url = "https://api-dev.narrative.io/datasets/{dataset_id}/retention-policy/preview"
payload = { "type": "expire_everything" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({type: 'expire_everything'})
};
fetch('https://api-dev.narrative.io/datasets/{dataset_id}/retention-policy/preview', 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-dev.narrative.io/datasets/{dataset_id}/retention-policy/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'type' => 'expire_everything'
]),
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-dev.narrative.io/datasets/{dataset_id}/retention-policy/preview"
payload := strings.NewReader("{\n \"type\": \"expire_everything\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api-dev.narrative.io/datasets/{dataset_id}/retention-policy/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"expire_everything\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-dev.narrative.io/datasets/{dataset_id}/retention-policy/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"expire_everything\"\n}"
response = http.request(request)
puts response.read_body{
"snapshots_to_expire": [
{
"snapshot_id": 8840810861846963000,
"created_at": "2022-01-28T16:25:47.987Z"
},
{
"snapshot_id": 6511121635994506000,
"created_at": "2022-01-28T16:58:59.264Z"
},
{
"snapshot_id": 4359653450296158700,
"created_at": "2022-01-28T17:33:25.560Z"
},
{
"snapshot_id": 7422070807769186000,
"created_at": "2022-01-28T18:58:45.856Z"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Unique identifier for a dataset.
Body
application/json
- Option 1
- Option 2
- Option 3
- Option 4
Backwards-compatible legacy payloads. Interpreted as snapshot-level retention on Iceberg. Returned response will be unified v1 shape with compat.mode=legacy.
Available options:
expire_everything Response
200 - application/json
OK
A list of the existing snapshots for the dataset
Show child attributes
Show child attributes
Was this page helpful?
⌘I

