How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

GoHarbor Retention API

The Retention API from GoHarbor — 7 operation(s) for retention.

GoHarbor Retention API is one of 38 APIs that GoHarbor publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Retention. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 10 operations across 7 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against 2 base URLs: http://localhost/api/v2.0, https://localhost/api/v2.0.

10 operations 7 paths 13 schemas 1 DELETE5 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://{host}/api/v2.0
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

GoHarbor Retention API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basic). By default, every request must be authenticated, though some operations may also be called without credentials.

Paths & Operations 10

Across 7 paths, the API surfaces 10 operations — 1 DELETE, 5 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Retention 10
GET
/retentions/metadatas
Get Retention Metadatas
getRentenitionMetadata 1 param → 200401500
POST
/retentions
Create Retention Policy
createRetention 1 param body → 201400401403500
GET
/retentions/{id}
Get Retention Policy
getRetention 2 params → 200401403500
PUT
/retentions/{id}
Update Retention Policy
updateRetention 2 params body → 200401403500
DELETE
/retentions/{id}
Delete Retention Policy
deleteRetention 2 params → 200401403500
POST
/retentions/{id}/executions
Trigger a Retention Execution
triggerRetentionExecution 2 params body → 200201401403500
GET
/retentions/{id}/executions
Get Retention executions
listRetentionExecutions 4 params → 200401403500
PATCH
/retentions/{id}/executions/{eid}
Stop a Retention execution
operateRetentionExecution 3 params body → 200401403500
GET
/retentions/{id}/executions/{eid}/tasks
Get Retention tasks
listRetentionTasks 5 params → 200401403500
GET
/retentions/{id}/executions/{eid}/tasks/{tid}
Get Retention job task log
getRetentionTaskLog 4 params → 200401403500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are RetentionExecutionTask (11 properties), RetentionRule (8 properties), RetentionExecution (7 properties), RetentionPolicy (5 properties). Each schema is shown below with its type and property counts.

Errors
object
The error array that describe the errors got during the handling of request
1 property
Error
object
a model for all the error response coming from harbor
2 properties
RetentionMetadata
object
the tag retention metadata
3 properties
RetentionExecutionTask
object
11 properties
RetentionRuleParamMetadata
object
rule param
3 properties
RetentionSelector
object
4 properties
RetentionRule
object
8 properties
RetentionRuleMetadata
object
the tag retention rule metadata
4 properties
RetentionExecution
object
7 properties
RetentionRuleTrigger
object
3 properties
RetentionPolicyScope
object
2 properties
RetentionSelectorMetadata
object
retention selector
3 properties
RetentionPolicy
object
retention policy
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

goharbor-retention-api-openapi.yml Raw ↑

Other APIs GoHarbor publishes across the network.

GoHarbor Health API
GoHarbor Replication API
GoHarbor Scan API
GoHarbor Search API
GoHarbor Artifact API
GoHarbor Configure API
GoHarbor Gc API
GoHarbor Icon API
GoHarbor Immutable API
GoHarbor Label API
GoHarbor Ldap API
GoHarbor Member API
Where this information came from

This is an independent, third-party profile of GoHarbor Retention API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.