79 lines
2.2 KiB
Markdown
79 lines
2.2 KiB
Markdown
---
|
|
name: retention-policies-routes
|
|
description: Handle 6 OpenAPI operation(s) under /retention_policies for the retention policies route group.
|
|
---
|
|
|
|
# retention policies API Routes
|
|
|
|
Handle 6 OpenAPI operation(s) under /retention_policies for the retention policies route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### get_retention_policies
|
|
|
|
- Operation ID: `get_retention_policies`
|
|
- Route: `GET /retention_policies`
|
|
- Mode: READ
|
|
- Summary: List retention policies
|
|
- Parameters:
|
|
- `policy_name` in `query`
|
|
- `policy_type` in `query`
|
|
- `created_by_user_id` in `query`
|
|
- `fields` in `query`
|
|
- `limit` in `query`
|
|
- `marker` in `query`
|
|
|
|
### post_retention_policies
|
|
|
|
- Operation ID: `post_retention_policies`
|
|
- Route: `POST /retention_policies`
|
|
- Mode: WRITE
|
|
- Summary: Create retention policy
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_retention_policies_id
|
|
|
|
- Operation ID: `get_retention_policies_id`
|
|
- Route: `GET /retention_policies/{retention_policy_id}`
|
|
- Mode: READ
|
|
- Summary: Get retention policy
|
|
- Parameters:
|
|
- `retention_policy_id` in `path` required
|
|
- `fields` in `query`
|
|
|
|
### put_retention_policies_id
|
|
|
|
- Operation ID: `put_retention_policies_id`
|
|
- Route: `PUT /retention_policies/{retention_policy_id}`
|
|
- Mode: WRITE
|
|
- Summary: Update retention policy
|
|
- Parameters:
|
|
- `retention_policy_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_retention_policies_id
|
|
|
|
- Operation ID: `delete_retention_policies_id`
|
|
- Route: `DELETE /retention_policies/{retention_policy_id}`
|
|
- Mode: WRITE
|
|
- Summary: Delete retention policy
|
|
- Parameters:
|
|
- `retention_policy_id` in `path` required
|
|
|
|
### get_retention_policies_id_assignments
|
|
|
|
- Operation ID: `get_retention_policies_id_assignments`
|
|
- Route: `GET /retention_policies/{retention_policy_id}/assignments`
|
|
- Mode: READ
|
|
- Summary: List retention policy assignments
|
|
- Parameters:
|
|
- `retention_policy_id` in `path` required
|
|
- `type` in `query`
|
|
- `fields` in `query`
|
|
- `marker` in `query`
|
|
- `limit` in `query`
|