artifact12

auditlog3

configure3

gc7

health1

icon1

immutable4

jobservice6

label5

Ldap4

member5

oidc1

permissions1

ping1

preheat19

project14

projectMetadata5

purge7

quota3

registry9

replication11

repository5

Retention10

get/retentions/metadatasGet Retention Metadatas
post/retentionsCreate Retention Policy
get/retentions/{id}Get Retention Policy
put/retentions/{id}Update Retention Policy
delete/retentions/{id}Delete Retention Policy
get/retentions/{id}/executionsGet Retention executions
post/retentions/{id}/executionsTrigger a Retention Execution
patch/retentions/{id}/executions/{eid}Stop a Retention execution
get/retentions/{id}/executions/{eid}/tasksGet Retention tasks
get/retentions/{id}/executions/{eid}/tasks/{tid}Get Retention job task log

robot6

scan3

scan data export4

scanAll6

scanner8

schedule2

search1

securityhub2

statistic1

SystemCVEAllowlist2

systeminfo3

user11

usergroup6

webhook10

webhookjob1

Retention

Trigger a Retention Execution

Trigger a Retention Execution, if dry_run is True, nothing would be deleted actually.

post/retentions/{id}/executions

Request

Base URL
http://localhost/api/v2.0
Auth
- HTTP basic
- or none
TypeScript
https://skmtc.dev/goharbor/apis/harbor-api/docs/retentions/:id/executions/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idinteger required

Retention ID.

Headers

X-Request-Idstring

An unique ID for the request

Request body

dry_runboolean

Response

Trigger a Retention job successfully.

Changes

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