Update the org's KB audit retention policy / legal hold
PUT
/
v1
/
knowledge-base
/
retention-policy
Update the org's KB audit retention policy / legal hold
curl --request PUT \
--url https://api-sandbox.featherhq.com/v1/knowledge-base/retention-policy \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"retention_days": 91,
"legal_hold_enabled": true,
"legal_hold_reason": "<string>",
"archive_before_delete": true,
"archive_destination": "<string>"
}
'import requests
url = "https://api-sandbox.featherhq.com/v1/knowledge-base/retention-policy"
payload = {
"retention_days": 91,
"legal_hold_enabled": True,
"legal_hold_reason": "<string>",
"archive_before_delete": True,
"archive_destination": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
retention_days: 91,
legal_hold_enabled: true,
legal_hold_reason: '<string>',
archive_before_delete: true,
archive_destination: '<string>'
})
};
fetch('https://api-sandbox.featherhq.com/v1/knowledge-base/retention-policy', 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-sandbox.featherhq.com/v1/knowledge-base/retention-policy",
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([
'retention_days' => 91,
'legal_hold_enabled' => true,
'legal_hold_reason' => '<string>',
'archive_before_delete' => true,
'archive_destination' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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-sandbox.featherhq.com/v1/knowledge-base/retention-policy"
payload := strings.NewReader("{\n \"retention_days\": 91,\n \"legal_hold_enabled\": true,\n \"legal_hold_reason\": \"<string>\",\n \"archive_before_delete\": true,\n \"archive_destination\": \"<string>\"\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))
}HttpResponse<String> response = Unirest.put("https://api-sandbox.featherhq.com/v1/knowledge-base/retention-policy")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"retention_days\": 91,\n \"legal_hold_enabled\": true,\n \"legal_hold_reason\": \"<string>\",\n \"archive_before_delete\": true,\n \"archive_destination\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.featherhq.com/v1/knowledge-base/retention-policy")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"retention_days\": 91,\n \"legal_hold_enabled\": true,\n \"legal_hold_reason\": \"<string>\",\n \"archive_before_delete\": true,\n \"archive_destination\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"retention_days": 123,
"legal_hold_enabled": true,
"archive_before_delete": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"legal_hold_reason": "<string>",
"legal_hold_set_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"legal_hold_set_at": "2023-11-07T05:31:56Z",
"archive_destination": "<string>",
"policy_version": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Body
application/json
PUT body for the retention policy. retention_days floor is enforced
both here (422 at the edge) and in the service (defense in depth).
Response
Successful Response
Org audit-retention policy + legal-hold state.
Was this page helpful?
⌘I
Update the org's KB audit retention policy / legal hold
curl --request PUT \
--url https://api-sandbox.featherhq.com/v1/knowledge-base/retention-policy \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"retention_days": 91,
"legal_hold_enabled": true,
"legal_hold_reason": "<string>",
"archive_before_delete": true,
"archive_destination": "<string>"
}
'import requests
url = "https://api-sandbox.featherhq.com/v1/knowledge-base/retention-policy"
payload = {
"retention_days": 91,
"legal_hold_enabled": True,
"legal_hold_reason": "<string>",
"archive_before_delete": True,
"archive_destination": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
retention_days: 91,
legal_hold_enabled: true,
legal_hold_reason: '<string>',
archive_before_delete: true,
archive_destination: '<string>'
})
};
fetch('https://api-sandbox.featherhq.com/v1/knowledge-base/retention-policy', 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-sandbox.featherhq.com/v1/knowledge-base/retention-policy",
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([
'retention_days' => 91,
'legal_hold_enabled' => true,
'legal_hold_reason' => '<string>',
'archive_before_delete' => true,
'archive_destination' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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-sandbox.featherhq.com/v1/knowledge-base/retention-policy"
payload := strings.NewReader("{\n \"retention_days\": 91,\n \"legal_hold_enabled\": true,\n \"legal_hold_reason\": \"<string>\",\n \"archive_before_delete\": true,\n \"archive_destination\": \"<string>\"\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))
}HttpResponse<String> response = Unirest.put("https://api-sandbox.featherhq.com/v1/knowledge-base/retention-policy")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"retention_days\": 91,\n \"legal_hold_enabled\": true,\n \"legal_hold_reason\": \"<string>\",\n \"archive_before_delete\": true,\n \"archive_destination\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.featherhq.com/v1/knowledge-base/retention-policy")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"retention_days\": 91,\n \"legal_hold_enabled\": true,\n \"legal_hold_reason\": \"<string>\",\n \"archive_before_delete\": true,\n \"archive_destination\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"retention_days": 123,
"legal_hold_enabled": true,
"archive_before_delete": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"legal_hold_reason": "<string>",
"legal_hold_set_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"legal_hold_set_at": "2023-11-07T05:31:56Z",
"archive_destination": "<string>",
"policy_version": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}