Retention

Create Retention Policy Endpoint

Create a retention policy for the caller's (or target) application-id.

post/admin/retention-policies

Request

Base URL
https://api.pharia.example.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/aleph-alpha/apis/stateful-responses/docs/admin/retention-policies/post.ts
A function with typed inputs. Its response is checked against the schema.

application_idstring nullable

retention_periodstring required

expiry_action'soft-delete' | 'hard-delete'

What happens to a record when its retention period elapses.

grace_periodstring

hard_delete_after_graceboolean

schedulestring

Successful Response

unknown required

No recorded changes to this operation across all 1 revision of this API.