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 Preheat API

The preheat API from GoHarbor — 11 operation(s) for preheat.

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

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

This API exposes 19 operations across 11 paths, and defines 10 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.

19 operations 11 paths 10 schemas 2 DELETE10 GET1 PATCH4 POST2 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 Preheat 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 19

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

preheat 19
GET
/p2p/preheat/providers
List P2P providers
ListProviders 1 param → 200400401403404500
POST
/p2p/preheat/instances/ping
Ping status of a instance
PingInstances 1 param body → 200400401404500
GET
/p2p/preheat/instances
List P2P provider instances
ListInstances 5 params → 200400401403404500
POST
/p2p/preheat/instances
Create p2p provider instances
CreateInstance 1 param body → 201400401403404409500
GET
/p2p/preheat/instances/{preheat_instance_name}
Get a P2P provider instance
GetInstance 2 params → 200400401403404500
DELETE
/p2p/preheat/instances/{preheat_instance_name}
Delete the specified P2P provider instance
DeleteInstance 2 params → 200401403404500
PUT
/p2p/preheat/instances/{preheat_instance_name}
Update the specified P2P provider instance
UpdateInstance 2 params body → 200400401403404500
POST
/projects/{project_name}/preheat/policies
Create a preheat policy under a project
CreatePolicy 2 params body → 201400401403409500
GET
/projects/{project_name}/preheat/policies
List preheat policies
ListPolicies 6 params → 200400401403500
GET
/projects/{project_name}/preheat/policies/{preheat_policy_name}
Get a preheat policy
GetPolicy 3 params → 200400401404403500
PUT
/projects/{project_name}/preheat/policies/{preheat_policy_name}
Update preheat policy
UpdatePolicy 3 params body → 200400401404403409500
POST
/projects/{project_name}/preheat/policies/{preheat_policy_name}
Manual preheat
ManualPreheat 3 params body → 201400401404403500
DELETE
/projects/{project_name}/preheat/policies/{preheat_policy_name}
Delete a preheat policy
DeletePolicy 3 params → 200400401404403500
GET
/projects/{project_name}/preheat/policies/{preheat_policy_name}/executions
List executions for the given policy
ListExecutions 7 params → 200400401404403500
GET
/projects/{project_name}/preheat/policies/{preheat_policy_name}/executions/{execution_id}
Get a execution detail by id
GetExecution 4 params → 200400401404403500
PATCH
/projects/{project_name}/preheat/policies/{preheat_policy_name}/executions/{execution_id}
Stop a execution
StopExecution 4 params body → 200400401404403500
GET
/projects/{project_name}/preheat/policies/{preheat_policy_name}/executions/{execution_id}/tasks
List all the related tasks for the given execution
ListTasks 8 params → 200400401404403500
GET
/projects/{project_name}/preheat/policies/{preheat_policy_name}/executions/{execution_id}/tasks/{task_id}/logs
Get the log text stream of the specified task for the given execution
GetPreheatLog 5 params → 200400401404403500
GET
/projects/{project_name}/preheat/providers
Get all providers at project level
ListProvidersUnderProject 2 params → 200400401403404500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are PreheatPolicy (12 properties), Instance (12 properties), Task (10 properties), Execution (10 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
ExtraAttrs
object
Error
object
a model for all the error response coming from harbor
2 properties
Instance
object
12 properties
Execution
object
10 properties
ProviderUnderProject
object
4 properties
PreheatPolicy
object
12 properties
Metrics
object
7 properties
Task
object
10 properties
Metadata
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

goharbor-preheat-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 Preheat 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.