Skip to content

Managed Private Registry

All operations require authentication.

13 operationsv2/publicCloud/project
View as Markdown (opens in a new tab)
Agent setup

List Managed Private Registry servicesProduction

GET
/v2/publicCloud/project/{projectId}/managedRegistry

Path parameters

projectId
required
string

Project ID

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200Registry[]successful operation
checksum
read-only
string

Checksum. Hash of the current targetSpec. Send it back in PUT .../managedRegistry/{managedRegistryId} to detect concurrent updates. Changes on every targetSpec update.

createdAt
read-only
stringdate-time

Creation date of the registry

currentState
read-only
RegistryCurrentState

Current state. Configuration applied to the registry. Reported by the service. See RegistryCurrentState.

currentTasks
read-only
CurrentTask[]

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.

id
read-only
stringuuid

Unique identifier of the registry

resourceStatus
read-only
ResourceStatusEnum

Resource status. Readiness of the registry. A new targetSpec is accepted only when it is READY. Reported by the service.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
RegistryTargetSpec

Target specification. Last configuration requested for the registry. Mutable through PUT .../managedRegistry/{managedRegistryId}. See RegistryTargetSpec.

updatedAt
read-only
stringdate-time

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"
ResponseExample
[ { "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

POST
/v2/publicCloud/project/{projectId}/managedRegistry

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

projectId
required
string

Project ID

Request body (required)

targetSpec
required
RegistryTargetSpec

Target specification. Configuration the registry is created with. Mutable through PUT .../managedRegistry/{managedRegistryId}, except region, which is immutable. See RegistryTargetSpec.

Response

200Registrysuccessful operation
checksum
read-only
string

Checksum. Hash of the current targetSpec. Send it back in PUT .../managedRegistry/{managedRegistryId} to detect concurrent updates. Changes on every targetSpec update.

createdAt
read-only
stringdate-time

Creation date of the registry

currentState
read-only
RegistryCurrentState

Current state. Configuration applied to the registry. Reported by the service. See RegistryCurrentState.

currentTasks
read-only
CurrentTask[]

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.

id
read-only
stringuuid

Unique identifier of the registry

resourceStatus
read-only
ResourceStatusEnum

Resource status. Readiness of the registry. A new targetSpec is accepted only when it is READY. Reported by the service.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
RegistryTargetSpec

Target specification. Last configuration requested for the registry. Mutable through PUT .../managedRegistry/{managedRegistryId}. See RegistryTargetSpec.

updatedAt
read-only
stringdate-time

Date of the last update of the registry

400objectError 400 response

Example uses projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedRegistry \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "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

GET
/v2/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}

Path parameters

managedRegistryId
required
stringuuid

Managed registry ID

projectId
required
string

Project ID

Response

200Registrysuccessful operation
checksum
read-only
string

Checksum. Hash of the current targetSpec. Send it back in PUT .../managedRegistry/{managedRegistryId} to detect concurrent updates. Changes on every targetSpec update.

createdAt
read-only
stringdate-time

Creation date of the registry

currentState
read-only
RegistryCurrentState

Current state. Configuration applied to the registry. Reported by the service. See RegistryCurrentState.

currentTasks
read-only
CurrentTask[]

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.

id
read-only
stringuuid

Unique identifier of the registry

resourceStatus
read-only
ResourceStatusEnum

Resource status. Readiness of the registry. A new targetSpec is accepted only when it is READY. Reported by the service.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
RegistryTargetSpec

Target specification. Last configuration requested for the registry. Mutable through PUT .../managedRegistry/{managedRegistryId}. See RegistryTargetSpec.

updatedAt
read-only
stringdate-time

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"
ResponseExample
{ "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

PUT
/v2/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}

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

managedRegistryId
required
stringuuid

Managed registry ID

projectId
required
string

Project ID

Request body (required)

checksum
string

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.

targetSpec
required
RegistryUpdateTargetSpec

Target specification. New configuration of the registry, replacing the previous one as a whole. See RegistryUpdateTargetSpec.

Response

200Registrysuccessful operation
checksum
read-only
string

Checksum. Hash of the current targetSpec. Send it back in PUT .../managedRegistry/{managedRegistryId} to detect concurrent updates. Changes on every targetSpec update.

createdAt
read-only
stringdate-time

Creation date of the registry

currentState
read-only
RegistryCurrentState

Current state. Configuration applied to the registry. Reported by the service. See RegistryCurrentState.

currentTasks
read-only
CurrentTask[]

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.

id
read-only
stringuuid

Unique identifier of the registry

resourceStatus
read-only
ResourceStatusEnum

Resource status. Readiness of the registry. A new targetSpec is accepted only when it is READY. Reported by the service.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
RegistryTargetSpec

Target specification. Last configuration requested for the registry. Mutable through PUT .../managedRegistry/{managedRegistryId}. See RegistryTargetSpec.

updatedAt
read-only
stringdate-time

Date of the last update of the registry

400objectError 400 response
409objectError 409 response

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"
ResponseExample
{ "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

DELETE
/v2/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}

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

managedRegistryId
required
stringuuid

Managed registry ID

projectId
required
string

Project ID

Response

200Registrysuccessful operation
checksum
read-only
string

Checksum. Hash of the current targetSpec. Send it back in PUT .../managedRegistry/{managedRegistryId} to detect concurrent updates. Changes on every targetSpec update.

createdAt
read-only
stringdate-time

Creation date of the registry

currentState
read-only
RegistryCurrentState

Current state. Configuration applied to the registry. Reported by the service. See RegistryCurrentState.

currentTasks
read-only
CurrentTask[]

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.

id
read-only
stringuuid

Unique identifier of the registry

resourceStatus
read-only
ResourceStatusEnum

Resource status. Readiness of the registry. A new targetSpec is accepted only when it is READY. Reported by the service.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
RegistryTargetSpec

Target specification. Last configuration requested for the registry. Mutable through PUT .../managedRegistry/{managedRegistryId}. See RegistryTargetSpec.

updatedAt
read-only
stringdate-time

Date of the last update of the registry

409objectError 409 response

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"
ResponseExample
{ "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

POST
/v2/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}/adminCredentials

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

managedRegistryId
required
stringuuid

Managed registry ID

projectId
required
string

Project ID

Response

200Credentialssuccessful operation
password
read-only
stringpassword

New password of the administrator account. The previous password stops working. Returned by the reset call only.

username
read-only
string

Username of the administrator account

409objectError 409 response

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"
ResponseExample
{ "password": "string", "username": "string"}

List plans a Managed Private Registry service can switch toProduction

GET
/v2/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}/capabilities/plan

Any name listed can be set as targetSpec.plan on PUT .../managedRegistry/{managedRegistryId}.

Path parameters

managedRegistryId
required
stringuuid

Managed registry ID

projectId
required
string

Project ID

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200Plan[]successful operation
features
read-only
PlanFeatures

Features included in the plan. See PlanFeatures.

limits
read-only
PlanLimits

Resource limits enforced by the plan. See PlanLimits.

name
read-only
PlanEnum

Name of the plan, to use as targetSpec.plan

ValuesLARGEMEDIUMSMALL

Example 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"
ResponseExample
[ { "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

GET
/v2/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}/capabilities/version

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

managedRegistryId
required
stringuuid

Managed registry ID

projectId
required
string

Project ID

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200Version[]successful operation
changelogUrl
read-only
string

URL of the Harbor release notes of the version

name
read-only
string

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"
ResponseExample
[ { "changelogUrl": "string", "name": "string" }]

List events of a Managed Private Registry serviceProduction

GET
/v2/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}/event

Path parameters

managedRegistryId
required
stringuuid

Managed registry ID

projectId
required
string

Project ID

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200Event[]successful operation
createdAt
read-only
stringdate-time

Creation date of the event

kind
read-only
string

Nature of the event

link
read-only
string

Link to the event related resource

message
read-only
string

Description of what happened on the event

type
read-only
EventTypeEnum

Type of the event

ValuesTARGET_SPEC_UPDATETASK_ERRORTASK_STARTTASK_SUCCESS

Example 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"
ResponseExample
[ { "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

GET
/v2/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}/task

Path parameters

managedRegistryId
required
stringuuid

Managed registry ID

projectId
required
string

Project ID

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200Task[]successful operation
createdAt
read-only
stringdate-time

Creation date of the task

errors
read-only
TaskError[]

Errors that occurred on the task

finishedAt
read-only
stringdate-time

Ending date of the task

id
read-only
stringuuid

Unique identifier of the task

link
read-only
string

Link to the related resource

message
read-only
string

Description of the task

progress
read-only
TaskProgress[]

Progress steps of the asynchronous operation

startedAt
read-only
stringdate-time

Starting date of the task

status
read-only
TaskStatusEnum

Current global status of the task

ValuesDONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUT
type
read-only
string

Type of the task

updatedAt
read-only
stringdate-time

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"
ResponseExample
[ { "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

GET
/v2/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}/task/{taskId}

Path parameters

managedRegistryId
required
stringuuid

Managed registry ID

projectId
required
string

Project ID

taskId
required
stringuuid

Task ID

Response

200Tasksuccessful operation
createdAt
read-only
stringdate-time

Creation date of the task

errors
read-only
TaskError[]

Errors that occurred on the task

finishedAt
read-only
stringdate-time

Ending date of the task

id
read-only
stringuuid

Unique identifier of the task

link
read-only
string

Link to the related resource

message
read-only
string

Description of the task

progress
read-only
TaskProgress[]

Progress steps of the asynchronous operation

startedAt
read-only
stringdate-time

Starting date of the task

status
read-only
TaskStatusEnum

Current global status of the task

ValuesDONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUT
type
read-only
string

Type of the task

updatedAt
read-only
stringdate-time

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"
ResponseExample
{ "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

GET
/v2/publicCloud/project/{projectId}/reference/managedRegistry/plan

Path parameters

projectId
required
string

Project ID

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200Plan[]successful operation
features
read-only
PlanFeatures

Features included in the plan. See PlanFeatures.

limits
read-only
PlanLimits

Resource limits enforced by the plan. See PlanLimits.

name
read-only
PlanEnum

Name of the plan, to use as targetSpec.plan

ValuesLARGEMEDIUMSMALL

Example uses projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/reference/managedRegistry/plan \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "features": { "vulnerabilityScanner": true }, "limits": { "artifactStorage": { "unit": "COUNT", "value": 0 }, "parallelRequests": 0 }, "name": "LARGE" }]

List regions available to create a Managed Private Registry serviceProduction

GET
/v2/publicCloud/project/{projectId}/reference/managedRegistry/region

Path parameters

projectId
required
string

Project ID

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200Region[]successful operation
name
read-only
string

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"
ResponseExample
[ { "name": "string" }]