retention job

retention job list

retention job list <PROJECT_NAME_OR_ID> [OPTIONS]

List retention jobs.

Arguments

PROJECT_NAME_OR_ID
Name or ID of the project to use. Prefix with 'id:' to specify an ID.
Type: text

Options

--id <POLICY_ID>
Retention policy ID. Overrides positional argument.
Type: integer

--page <PAGE>
(Advanced) Page to begin fetching from.
Type: integer
Default: 1

--page-size <PAGE_SIZE>
(Advanced) Results to fetch per API call.
Type: integer
Default: 10

--limit <LIMIT>
Maximum number of results to fetch.
Type: integer

retention job start <PROJECT_NAME_OR_ID> [OPTIONS]

Start a retention job.

Arguments

PROJECT_NAME_OR_ID
Name or ID of the project to use. Prefix with 'id:' to specify an ID.
Type: text

Options

--id <POLICY_ID>
Retention policy ID. Overrides positional argument.
Type: integer

--dry-run
Run job in dry run mode.
Type: boolean (flag)
Default: False

retention job stop <PROJECT_NAME_OR_ID> <JOB_ID> [OPTIONS]

Stop a retention job.

Arguments

PROJECT_NAME_OR_ID
Name or ID of the project to use. Prefix with 'id:' to specify an ID.
Type: text

JOB_ID
ID of the job to stop.
Type: integer
Required: ✅

Options

--id <POLICY_ID>
Retention policy ID. Overrides positional argument.
Type: integer