Managed Private Registry
All operations require authentication.
List Managed Private Registry servicesProduction
Path parameters
Project ID
Headers
Pagination cursor
Pagination size
Response
Checksum. Hash of the current targetSpec. Send it back in PUT .../managedRegistry/{managedRegistryId} to detect concurrent updates. Changes on every targetSpec update.
Creation date of the registry
Current state. Configuration applied to the registry. Reported by the service. See RegistryCurrentState.
Current tasks. Asynchronous tasks running on the registry. Empty or null when none is running. Follow link to get a task. Reported by the service.
Unique identifier of the registry
Resource status. Readiness of the registry. A new targetSpec is accepted only when it is READY. Reported by the service.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGTarget specification. Last configuration requested for the registry. Mutable through PUT .../managedRegistry/{managedRegistryId}. See RegistryTargetSpec.
Date of the last update of the registry
Example uses projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedRegistry \
-H "authorization: Bearer $OVH_TOKEN"[ { "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "authentication": { "oidc": { "adminGroup": "string", "autoOnboard": true, "clientId": "string", "clientSecret": "string", "endpoint": "string", "groupFilter": "string", "groupsClaim": "string", "name": "string", "scope": "string", "userClaim": "string", "verifyCert": true }, "type": "IAM" }, "authorizedIps": { "rules": [ { "cidr": "192.0.2.0/24", "description": "string", "scopes": [ null ] } ] }, "name": "string", "plan": "LARGE", "region": "string", "url": "string", "usage": { "artifactStorage": { "limit": { "unit": "COUNT", "value": 0 }, "used": { "unit": "COUNT", "value": 0 } }, "measuredAt": "2024-01-01T12:00:00Z" }, "version": "string" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "authentication": { "oidc": { "adminGroup": "string", "autoOnboard": true, "clientId": "string", "clientSecret": "string", "endpoint": "string", "groupFilter": "string", "groupsClaim": "string", "name": "string", "scope": "string", "userClaim": "string", "verifyCert": true }, "type": "IAM" }, "authorizedIps": { "rules": [ { "cidr": "192.0.2.0/24", "description": "string", "scopes": [ null ] } ] }, "name": "string", "plan": "LARGE", "region": "string", "version": "string" }, "updatedAt": "2024-01-01T12:00:00Z" }]
Create a Managed Private Registry serviceProduction
The registry runs the latest available Harbor version. Change it later with targetSpec.version on PUT .../managedRegistry/{managedRegistryId}.
Asynchronous creation
The registry is returned with resourceStatus CREATING and a REGISTRY_CREATE task in currentTasks. Poll GET .../managedRegistry/{managedRegistryId} until resourceStatus is READY. currentState.url and currentState.usage are null until then. Once the registry is READY, generate the administrator password with POST .../managedRegistry/{managedRegistryId}/adminCredentials.
Immutable fields
region cannot change after creation. Create a new registry to change it.
Path parameters
Project ID
Request body (required)
Target specification. Configuration the registry is created with. Mutable through PUT .../managedRegistry/{managedRegistryId}, except region, which is immutable. See RegistryTargetSpec.
Response
Checksum. Hash of the current targetSpec. Send it back in PUT .../managedRegistry/{managedRegistryId} to detect concurrent updates. Changes on every targetSpec update.
Creation date of the registry
Current state. Configuration applied to the registry. Reported by the service. See RegistryCurrentState.
Current tasks. Asynchronous tasks running on the registry. Empty or null when none is running. Follow link to get a task. Reported by the service.
Unique identifier of the registry
Resource status. Readiness of the registry. A new targetSpec is accepted only when it is READY. Reported by the service.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGTarget specification. Last configuration requested for the registry. Mutable through PUT .../managedRegistry/{managedRegistryId}. See RegistryTargetSpec.
Date of the last update of the registry
Example uses projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedRegistry \
-H "authorization: Bearer $OVH_TOKEN"{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "authentication": { "oidc": { "adminGroup": "string", "autoOnboard": true, "clientId": "string", "clientSecret": "string", "endpoint": "string", "groupFilter": "string", "groupsClaim": "string", "name": "string", "scope": "string", "userClaim": "string", "verifyCert": true }, "type": "IAM" }, "authorizedIps": { "rules": [ { "cidr": "192.0.2.0/24", "description": "string", "scopes": [ "ADMINISTRATION" ] } ] }, "name": "string", "plan": "LARGE", "region": "string", "url": "string", "usage": { "artifactStorage": { "limit": { "unit": "COUNT", "value": 0 }, "used": { "unit": "COUNT", "value": 0 } }, "measuredAt": "2024-01-01T12:00:00Z" }, "version": "string" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "authentication": { "oidc": { "adminGroup": "string", "autoOnboard": true, "clientId": "string", "clientSecret": "string", "endpoint": "string", "groupFilter": "string", "groupsClaim": "string", "name": "string", "scope": "string", "userClaim": "string", "verifyCert": true }, "type": "IAM" }, "authorizedIps": { "rules": [ { "cidr": "192.0.2.0/24", "description": "string", "scopes": [ "ADMINISTRATION" ] } ] }, "name": "string", "plan": "LARGE", "region": "string", "version": "string" }, "updatedAt": "2024-01-01T12:00:00Z"}
Get a Managed Private Registry serviceProduction
Path parameters
Managed registry ID
Project ID
Response
Checksum. Hash of the current targetSpec. Send it back in PUT .../managedRegistry/{managedRegistryId} to detect concurrent updates. Changes on every targetSpec update.
Creation date of the registry
Current state. Configuration applied to the registry. Reported by the service. See RegistryCurrentState.
Current tasks. Asynchronous tasks running on the registry. Empty or null when none is running. Follow link to get a task. Reported by the service.
Unique identifier of the registry
Resource status. Readiness of the registry. A new targetSpec is accepted only when it is READY. Reported by the service.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGTarget specification. Last configuration requested for the registry. Mutable through PUT .../managedRegistry/{managedRegistryId}. See RegistryTargetSpec.
Date of the last update of the registry
Example uses managedRegistryId = 00000000-0000-0000-0000-000000000000, projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedRegistry/ {managedRegistryId} \
-H "authorization: Bearer $OVH_TOKEN"{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "authentication": { "oidc": { "adminGroup": "string", "autoOnboard": true, "clientId": "string", "clientSecret": "string", "endpoint": "string", "groupFilter": "string", "groupsClaim": "string", "name": "string", "scope": "string", "userClaim": "string", "verifyCert": true }, "type": "IAM" }, "authorizedIps": { "rules": [ { "cidr": "192.0.2.0/24", "description": "string", "scopes": [ "ADMINISTRATION" ] } ] }, "name": "string", "plan": "LARGE", "region": "string", "url": "string", "usage": { "artifactStorage": { "limit": { "unit": "COUNT", "value": 0 }, "used": { "unit": "COUNT", "value": 0 } }, "measuredAt": "2024-01-01T12:00:00Z" }, "version": "string" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "authentication": { "oidc": { "adminGroup": "string", "autoOnboard": true, "clientId": "string", "clientSecret": "string", "endpoint": "string", "groupFilter": "string", "groupsClaim": "string", "name": "string", "scope": "string", "userClaim": "string", "verifyCert": true }, "type": "IAM" }, "authorizedIps": { "rules": [ { "cidr": "192.0.2.0/24", "description": "string", "scopes": [ "ADMINISTRATION" ] } ] }, "name": "string", "plan": "LARGE", "region": "string", "version": "string" }, "updatedAt": "2024-01-01T12:00:00Z"}
Update a Managed Private Registry serviceProduction
Asynchronous update
The new targetSpec replaces the previous one, the registry moves to resourceStatus UPDATING and a REGISTRY_UPDATE task starts. Poll GET .../managedRegistry/{managedRegistryId} until resourceStatus is READY and currentState reflects the change.
Optimistic concurrency
Send the checksum read from the last GET. When another update happened in between, the checksums differ and the request is rejected: read the registry again and retry. Omitting checksum skips the check.
Immutable fields
region is set at creation and is not part of the update body. Create a new registry to change it.
Destructive updates
Changing authentication.type deletes every existing Harbor user of the registry once the update task completes. Robot accounts are kept.
Rejected requests
The request is rejected when resourceStatus is not READY, or when plan or version is neither the current value nor listed by GET .../managedRegistry/{managedRegistryId}/capabilities/plan or GET .../managedRegistry/{managedRegistryId}/capabilities/version.
Path parameters
Managed registry ID
Project ID
Request body (required)
Optimistic concurrency token. When set, it must match the checksum returned by GET .../managedRegistry/{managedRegistryId}, otherwise the request is rejected. When null or empty, the check is skipped and the update overwrites the current targetSpec.
Target specification. New configuration of the registry, replacing the previous one as a whole. See RegistryUpdateTargetSpec.
Response
Checksum. Hash of the current targetSpec. Send it back in PUT .../managedRegistry/{managedRegistryId} to detect concurrent updates. Changes on every targetSpec update.
Creation date of the registry
Current state. Configuration applied to the registry. Reported by the service. See RegistryCurrentState.
Current tasks. Asynchronous tasks running on the registry. Empty or null when none is running. Follow link to get a task. Reported by the service.
Unique identifier of the registry
Resource status. Readiness of the registry. A new targetSpec is accepted only when it is READY. Reported by the service.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGTarget specification. Last configuration requested for the registry. Mutable through PUT .../managedRegistry/{managedRegistryId}. See RegistryTargetSpec.
Date of the last update of the registry
Example uses managedRegistryId = 00000000-0000-0000-0000-000000000000, projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedRegistry/ {managedRegistryId} \
-H "authorization: Bearer $OVH_TOKEN"{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "authentication": { "oidc": { "adminGroup": "string", "autoOnboard": true, "clientId": "string", "clientSecret": "string", "endpoint": "string", "groupFilter": "string", "groupsClaim": "string", "name": "string", "scope": "string", "userClaim": "string", "verifyCert": true }, "type": "IAM" }, "authorizedIps": { "rules": [ { "cidr": "192.0.2.0/24", "description": "string", "scopes": [ "ADMINISTRATION" ] } ] }, "name": "string", "plan": "LARGE", "region": "string", "url": "string", "usage": { "artifactStorage": { "limit": { "unit": "COUNT", "value": 0 }, "used": { "unit": "COUNT", "value": 0 } }, "measuredAt": "2024-01-01T12:00:00Z" }, "version": "string" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "authentication": { "oidc": { "adminGroup": "string", "autoOnboard": true, "clientId": "string", "clientSecret": "string", "endpoint": "string", "groupFilter": "string", "groupsClaim": "string", "name": "string", "scope": "string", "userClaim": "string", "verifyCert": true }, "type": "IAM" }, "authorizedIps": { "rules": [ { "cidr": "192.0.2.0/24", "description": "string", "scopes": [ "ADMINISTRATION" ] } ] }, "name": "string", "plan": "LARGE", "region": "string", "version": "string" }, "updatedAt": "2024-01-01T12:00:00Z"}
Delete a Managed Private Registry serviceProduction
Deletion is asynchronous: the registry moves to resourceStatus DELETING, the response echoes it, and a REGISTRY_DELETE task then removes it. Poll GET .../managedRegistry/{managedRegistryId} until the registry is no longer returned. Every artifact stored in the registry is deleted and cannot be recovered.
Path parameters
Managed registry ID
Project ID
Response
Checksum. Hash of the current targetSpec. Send it back in PUT .../managedRegistry/{managedRegistryId} to detect concurrent updates. Changes on every targetSpec update.
Creation date of the registry
Current state. Configuration applied to the registry. Reported by the service. See RegistryCurrentState.
Current tasks. Asynchronous tasks running on the registry. Empty or null when none is running. Follow link to get a task. Reported by the service.
Unique identifier of the registry
Resource status. Readiness of the registry. A new targetSpec is accepted only when it is READY. Reported by the service.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGTarget specification. Last configuration requested for the registry. Mutable through PUT .../managedRegistry/{managedRegistryId}. See RegistryTargetSpec.
Date of the last update of the registry
Example uses managedRegistryId = 00000000-0000-0000-0000-000000000000, projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedRegistry/ {managedRegistryId} \
-H "authorization: Bearer $OVH_TOKEN"{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "authentication": { "oidc": { "adminGroup": "string", "autoOnboard": true, "clientId": "string", "clientSecret": "string", "endpoint": "string", "groupFilter": "string", "groupsClaim": "string", "name": "string", "scope": "string", "userClaim": "string", "verifyCert": true }, "type": "IAM" }, "authorizedIps": { "rules": [ { "cidr": "192.0.2.0/24", "description": "string", "scopes": [ "ADMINISTRATION" ] } ] }, "name": "string", "plan": "LARGE", "region": "string", "url": "string", "usage": { "artifactStorage": { "limit": { "unit": "COUNT", "value": 0 }, "used": { "unit": "COUNT", "value": 0 } }, "measuredAt": "2024-01-01T12:00:00Z" }, "version": "string" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "authentication": { "oidc": { "adminGroup": "string", "autoOnboard": true, "clientId": "string", "clientSecret": "string", "endpoint": "string", "groupFilter": "string", "groupsClaim": "string", "name": "string", "scope": "string", "userClaim": "string", "verifyCert": true }, "type": "IAM" }, "authorizedIps": { "rules": [ { "cidr": "192.0.2.0/24", "description": "string", "scopes": [ "ADMINISTRATION" ] } ] }, "name": "string", "plan": "LARGE", "region": "string", "version": "string" }, "updatedAt": "2024-01-01T12:00:00Z"}
Reset the administrator password of a Managed Private Registry serviceProduction
Generates a new password for the Harbor administrator account and returns it. The previous password stops working immediately. The password is returned only in this response.
Path parameters
Managed registry ID
Project ID
Response
New password of the administrator account. The previous password stops working. Returned by the reset call only.
Username of the administrator account
Example uses managedRegistryId = 00000000-0000-0000-0000-000000000000, projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedRegistry/ {managedRegistryId}/ adminCredentials \
-H "authorization: Bearer $OVH_TOKEN"{ "password": "string", "username": "string"}
List plans a Managed Private Registry service can switch toProduction
Any name listed can be set as targetSpec.plan on PUT .../managedRegistry/{managedRegistryId}.
Path parameters
Managed registry ID
Project ID
Headers
Pagination cursor
Pagination size
Response
Features included in the plan. See PlanFeatures.
Resource limits enforced by the plan. See PlanLimits.
Name of the plan, to use as targetSpec.plan
LARGEMEDIUMSMALLExample uses managedRegistryId = 00000000-0000-0000-0000-000000000000, projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedRegistry/ {managedRegistryId}/ capabilities/ plan \
-H "authorization: Bearer $OVH_TOKEN"[ { "features": { "vulnerabilityScanner": true }, "limits": { "artifactStorage": { "unit": "COUNT", "value": 0 }, "parallelRequests": 0 }, "name": "LARGE" }]
List Harbor versions a Managed Private Registry service can be upgraded toProduction
Only versions available as an upgrade from the version the registry currently runs are listed. To upgrade, set a listed name as targetSpec.version on PUT .../managedRegistry/{managedRegistryId}.
Path parameters
Managed registry ID
Project ID
Headers
Pagination cursor
Pagination size
Response
URL of the Harbor release notes of the version
Harbor version, for example 2.14.2
Example uses managedRegistryId = 00000000-0000-0000-0000-000000000000, projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedRegistry/ {managedRegistryId}/ capabilities/ version \
-H "authorization: Bearer $OVH_TOKEN"[ { "changelogUrl": "string", "name": "string" }]
List events of a Managed Private Registry serviceProduction
Path parameters
Managed registry ID
Project ID
Headers
Pagination cursor
Pagination size
Response
Creation date of the event
Nature of the event
Link to the event related resource
Description of what happened on the event
Type of the event
TARGET_SPEC_UPDATETASK_ERRORTASK_STARTTASK_SUCCESSExample uses managedRegistryId = 00000000-0000-0000-0000-000000000000, projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedRegistry/ {managedRegistryId}/ event \
-H "authorization: Bearer $OVH_TOKEN"[ { "createdAt": "2024-01-01T12:00:00Z", "kind": "string", "link": "string", "message": "string", "type": "TARGET_SPEC_UPDATE" }]
List asynchronous tasks of a Managed Private Registry serviceProduction
Path parameters
Managed registry ID
Project ID
Headers
Pagination cursor
Pagination size
Response
Creation date of the task
Errors that occurred on the task
Ending date of the task
Unique identifier of the task
Link to the related resource
Description of the task
Progress steps of the asynchronous operation
Starting date of the task
Current global status of the task
DONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUTType of the task
Last update of the task
Example uses managedRegistryId = 00000000-0000-0000-0000-000000000000, projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedRegistry/ {managedRegistryId}/ task \
-H "authorization: Bearer $OVH_TOKEN"[ { "createdAt": "2024-01-01T12:00:00Z", "errors": [ { "message": "string" } ], "finishedAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "link": "string", "message": "string", "progress": [ { "name": "string", "status": "DONE" } ], "startedAt": "2024-01-01T12:00:00Z", "status": "DONE", "type": "string", "updatedAt": "2024-01-01T12:00:00Z" }]
Get an asynchronous task of a Managed Private Registry serviceProduction
Path parameters
Managed registry ID
Project ID
Task ID
Response
Creation date of the task
Errors that occurred on the task
Ending date of the task
Unique identifier of the task
Link to the related resource
Description of the task
Progress steps of the asynchronous operation
Starting date of the task
Current global status of the task
DONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUTType of the task
Last update of the task
Example uses managedRegistryId = 00000000-0000-0000-0000-000000000000, projectId = string, taskId = 00000000-0000-0000-0000-000000000000
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedRegistry/ {managedRegistryId}/ task/ {taskId} \
-H "authorization: Bearer $OVH_TOKEN"{ "createdAt": "2024-01-01T12:00:00Z", "errors": [ { "message": "string" } ], "finishedAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "link": "string", "message": "string", "progress": [ { "name": "string", "status": "DONE" } ], "startedAt": "2024-01-01T12:00:00Z", "status": "DONE", "type": "string", "updatedAt": "2024-01-01T12:00:00Z"}
List plans available to create a Managed Private Registry serviceProduction
Path parameters
Project ID
Headers
Pagination cursor
Pagination size
Response
Features included in the plan. See PlanFeatures.
Resource limits enforced by the plan. See PlanLimits.
Name of the plan, to use as targetSpec.plan
LARGEMEDIUMSMALLExample uses projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ reference/ managedRegistry/ plan \
-H "authorization: Bearer $OVH_TOKEN"[ { "features": { "vulnerabilityScanner": true }, "limits": { "artifactStorage": { "unit": "COUNT", "value": 0 }, "parallelRequests": 0 }, "name": "LARGE" }]
List regions available to create a Managed Private Registry serviceProduction
Path parameters
Project ID
Headers
Pagination cursor
Pagination size
Response
Region name, to use as targetSpec.region, for example EU-WEST-PAR
Example uses projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ reference/ managedRegistry/ region \
-H "authorization: Bearer $OVH_TOKEN"[ { "name": "string" }]