Create retention rule | Opik Documentation

POST/v1/private/retention/rulesCreate retention rule

Create a new retention rule. Auto-deactivates any existing active rule for the same scope.

Request body

application/json

objectRetentionRule_Write

apply_to_pastboolean

organization_levelboolean

Set to true to create an organization-level rule

project_idstring · uuid

retentionstringrequired

one of "short_14d", "base_60d", "extended_400d", "unlimited"

Example request

{
  "apply_to_past": true,
  "organization_level": true,
  "project_id": "00000000-0000-0000-0000-000000000000",
  "retention": "base_60d"
}

Responses

Headers

Location

objectRetentionRule_Public

apply_to_pastboolean

catch_up_cursorstring · uuid

Current position of historical data cleanup

catch_up_doneboolean

Whether historical catch-up is complete

created_atstring · date-time

created_bystring

enabledboolean

idstring · uuid

last_updated_atstring · date-time

last_updated_bystring

levelstring

Computed from projectId and organizationLevel

one of "organization", "workspace", "project"

project_idstring · uuid

retentionstringrequired

one of "short_14d", "base_60d", "extended_400d", "unlimited"

workspace_idstring

Example response

{
  "apply_to_past": true,
  "catch_up_cursor": "00000000-0000-0000-0000-000000000000",
  "catch_up_done": true,
  "created_at": "2026-06-09T00:00:00Z",
  "created_by": "string",
  "enabled": true,
  "id": "00000000-0000-0000-0000-000000000000",
  "last_updated_at": "2026-06-09T00:00:00Z",
  "last_updated_by": "string",
  "level": "organization",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "retention": "base_60d",
  "workspace_id": "string"
}

Examples

curl -X POST 'http://localhost:5173/api/v1/private/retention/rules' \
  -H 'Content-Type: application/json' \
  -d '{"apply_to_past":true,"organization_level":true,"project_id":"00000000-0000-0000-0000-000000000000","retention":"base_60d"}'

const response = await fetch('http://localhost:5173/api/v1/private/retention/rules', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"apply_to_past":true,"organization_level":true,"project_id":"00000000-0000-0000-0000-000000000000","retention":"base_60d"}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/retention/rules', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"apply_to_past\":true,\"organization_level\":true,\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"retention\":\"base_60d\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "http://localhost:5173/api/v1/private/retention/rules",
    headers={"Content-Type": "application/json"},
    data='{"apply_to_past":true,"organization_level":true,"project_id":"00000000-0000-0000-0000-000000000000","retention":"base_60d"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"apply_to_past":true,"organization_level":true,"project_id":"00000000-0000-0000-0000-000000000000","retention":"base_60d"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "http://localhost:5173/api/v1/private/retention/rules", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("http://localhost:5173/api/v1/private/retention/rules");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"apply_to_past\":true,\"organization_level\":true,\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"retention\":\"base_60d\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/retention/rules"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"apply_to_past\":true,\"organization_level\":true,\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"retention\":\"base_60d\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/retention/rules")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"apply_to_past\":true,\"organization_level\":true,\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"retention\":\"base_60d\"}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost:5173/api/v1/private/retention/rules");
request.Content = new StringContent("{\"apply_to_past\":true,\"organization_level\":true,\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"retention\":\"base_60d\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "apply_to_past": true,
  "catch_up_cursor": "00000000-0000-0000-0000-000000000000",
  "catch_up_done": true,
  "created_at": "2026-06-09T00:00:00Z",
  "created_by": "string",
  "enabled": true,
  "id": "00000000-0000-0000-0000-000000000000",
  "last_updated_at": "2026-06-09T00:00:00Z",
  "last_updated_by": "string",
  "level": "organization",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "retention": "base_60d",
  "workspace_id": "string"
}