Sign in
project

List projects

This endpoint returns projects created by Harbor.

get/projects

Query parameters

qstring

Query string to query resources. Supported query patterns are "exact match(k=v)", "fuzzy match(k=v)", "range(k=[minmax])", "list with union releationship(k={v1 v2 v3})" and "list with intersetion relationship(k=(v1 v2 v3))". The value of range and list can be string(enclosed by " or '), integer or time(in format "2020-04-09 02:36:00"). All of these query patterns should be put in the query string "q=xxx" and splitted by ",". e.g. q=k1=v1,k2=v2,k3=[minmax]

pageinteger

The page number

page_sizeinteger

The size of per page

sortstring

Sort the resource list in ascending or descending order. e.g. sort by field1 in ascending order and field2 in descending order with "sort=field1,-field2"

namestring

The name of project.

publicboolean

The project is public or private.

ownerstring

The name of project owner.

with_detailboolean

Bool value indicating whether return detailed information of the project

Headers

X-Request-Idstring

An unique ID for the request

Response

Return all matched projects.

project_idinteger

Project ID

owner_idinteger

The owner ID of the project always means the creator of the project.

namestring

The name of the project.

registry_idinteger

The ID of referenced registry when the project is a proxy cache project.

creation_timestring date-time

The creation time of the project.

update_timestring date-time

The update time of the project.

deletedboolean

A deletion mark of the project.

owner_namestring

The owner name of the project.

togglableboolean

Correspond to the UI about whether the project's publicity is updatable (for UI)

current_user_role_idinteger

The role ID with highest permission of the current user who triggered the API (for UI). This attribute is deprecated and will be removed in future versions.

current_user_role_idsinteger[]

The list of role ID of the current user who triggered the API (for UI)

repo_countinteger

The number of the repositories under this project.

Changes