This API has a deprecated equivalent from v7.0U1.
Purge Registries Harbor Projects
DescriptionRemove all repositories, images and members in the project. Storage space of deleted images in the project will be reclaimed through next scheduled Harbor registry garbage collection.
Request
URLURL
https://{api_host}/api/vcenter/content/registries/harbor/{registry}/projects/{project}?action=purge
Path Parameters
Path Parameters
string
registry
Required
Identifier of the registry. The parameter must be an identifier for the resource type: com.vmware.vcenter.content.Registry.
string
project
Required
Identifier of the Harbor project. The parameter must be an identifier for the resource type: com.vmware.vcenter.content.Registry.Harbor.Project.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.not_allowed_in_current_state : if Harbor registry is being deleted or the project is not in READY status.
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have ContentLibrary.ManageRegistryProject privilege.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-PurgeRegistryProject -Registry "MyRegistry" -Project "MyProject"
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/content/registries/harbor/{registry}/projects/{project}?action=purge
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/vcenter/content/registries/harbor/{registry}/projects/{project}?action=purge
x-vmw-doc-operation: purge
Availability
Added in 7.0U2
