List retention policy rows

Módulo Settings

GET/retention-policiesretentionPolicies.list

Retention of soft-deleted rows per table. Returns a cursor page of retention policy rows the caller may see. The default order is `table_name` ascending. Supports sparse fieldsets and the filter grammar.

Requiere la capacidad data.retention.write.
Alcances de OAuth: data.
Paginación por cursor: se aplican limit, cursor, fields, sort y filter.
Estados de error: 400, 401, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

retentionPolicies.list: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
limit	Limit	No	Page size. Default 50, maximum 200.Restricciones: range 1 to 200
cursor	Cursor	No	Opaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any
fields	Fields	No	Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_](,[a-z_][a-z0-9_])*$
sort	Sort	No	Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Restricciones: pattern ^-?[a-z_][a-z0-9_](,-?[a-z_][a-z0-9_])*$
filter	Filter	No	Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND.

Respuesta 200: una página de RetentionPolicy

retentionPolicies.list: RetentionPolicy
Campo	Tipo	Obligatorio	Descripción
table_name	string	Sí	Table.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
basis	"Soft Deleted" \| "Age" \| null	Sí	What starts the retention clock.
time_column	string \| null	Sí	Column that starts the clock.Restricciones: length 1 to 300
retention	string \| null	Sí	How long rows are kept, as an interval.Restricciones: length 1 to 300
purge_method	"Delete" \| "Drop Partition" \| "Account Lifecycle" \| null	Sí	How expired rows leave.
redact_personal_data_after	string \| null	Sí	When personal data in the table is redacted, if ever.Restricciones: length 1 to 300
rationale	string \| null	Sí	Why the period was chosen.Restricciones: length 1 to 2000

{
  "data": [
    {
      "table_name": "app.activity_events",
      "basis": "Soft Deleted",
      "time_column": "deleted_at",
      "retention": "7 years",
      "purge_method": "Delete",
      "redact_personal_data_after": "90 days",
      "rationale": "Tax records are kept seven years."
    }
  ],
  "next_cursor": null
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/retention-policies" \
  -H "Authorization: Bearer $XOS_API_KEY"

for await (const row of xos.retentionPolicies.listAll()) {
  console.log(row);
}

for row in xos.retention_policies.list_all():
    print(row)

xos retention-policies list --all