Skip to Content
veriom

Update workspace retention

Choose retention periods within the plan, as an admin with a recent step-up. A shorter period deletes older records at the next hourly retention sweep. `null` keeps what the plan includes. A period outside the plan's bounds is refused with `retention_out_of_range`.

PUT
/v1/workspaces/{workspace_id}/data-retention

Choose retention periods within the plan, as an admin with a recent step-up.

A shorter period deletes older records at the next hourly retention sweep. null keeps what the plan includes. A period outside the plan's bounds is refused with retention_out_of_range.

Authorization

workspaceToken
headerAuthorizationBearer <vat_<opaque-token>>

Expiring, hashed workspace token with explicit scopes.

Path Parameters

workspace_id*Workspace Id
Formatuuid

Request Body

application/json
  1. body
audit_log_days*|

Days to keep audit log events; null keeps what the plan includes.

resolved_finding_days*|

Days to keep resolved findings; null keeps what the plan includes.

version?|

The version last read; a different current version is refused (409).

Response Body

Successful Response

application/json
  1. response
audit_log*

Findings fixed or marked false positive, and unchanged for longer than the effective period, are deleted with their evidence, comments, and history.

plan*PlanId
Value in"trial""starter""growth""enterprise"
plan_enforced*Plan Enforced

When false no plan bound applies and only a chosen period removes records.

resolved_findings*

Findings fixed or marked false positive, and unchanged for longer than the effective period, are deleted with their evidence, comments, and history.

updated_at*|null
updated_by*|null
version*Version

Send back on update to detect a concurrent change.

Example Request
curl -X PUT 'https://api.veriom.ai/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/data-retention' \  -H 'Content-Type: application/json' \  -d '{  "audit_log_days": 30,  "resolved_finding_days": 30}'
Example Response
{  "audit_log": {    "configured_days": 0,    "effective_days": 0,    "maximum_days": 0,    "minimum_days": 0  },  "plan": "trial",  "plan_enforced": true,  "resolved_findings": {    "configured_days": 0,    "effective_days": 0,    "maximum_days": 0,    "minimum_days": 0  },  "updated_at": "2019-08-24T14:15:22Z",  "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",  "version": 0}