This API has a deprecated equivalent from v7.0U1.
Create Registries Harbor
Creates a Harbor registry in the cluster.
Request
URLURL
https://{api_host}/api/vcenter/content/registries/harbor
Header Parameters
Header Parameters
string
client_token
Optional
A unique token generated on the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can be used to guarantee idempotent creation. If not specified, creation is not idempotent.
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
ContentRegistriesHarborCreateSpec of mimetype application/json
Required
Specification for creating the Harbor registry.
{
"storage": [
{
"policy": "string"
}
]
}
array of
ContentRegistriesHarborStorageSpec
storage
Required
Storage associated with the Harbor registry. The list contains only one storage backing in this version.
string
cluster
Optional
Identifier of the cluster hosting the registry. If unset, registry will not be created on a specified cluster. This is required in current version, since Harbor can only be created on a cluster with Kubernetes enabled. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ClusterComputeResource.
garbage_collection
Optional
Garbage collection configuration for the Harbor registry. If unset, a default configuration is set, Recurrence#WEEKLY, DayOfWeek#SATURDAY, GarbageCollection#hour is 2, GarbageCollection#minute is 0.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
201 Created returns
string of type application/json
Identifier of the deployed registry. The result will be an identifier for the resource type: com.vmware.vcenter.content.Registry.
Code Samples
PowerCLI Client SDK Example
$ContentRegistriesHarborStorageSpec = Initialize-ContentRegistriesHarborStorageSpec -Policy "MyPolicy"
$ContentRegistriesHarborCreateSpec = Initialize-ContentRegistriesHarborCreateSpec -Storage $ContentRegistriesHarborStorageSpec
Invoke-CreateContentRegistriesHarbor -ContentRegistriesHarborCreateSpec $ContentRegistriesHarborCreateSpec
PowerCLI Client SDK All Parameters Example
$ContentRegistriesHarborGarbageCollection = Initialize-ContentRegistriesHarborGarbageCollection -Type "NONE" -DayOfWeek "SUNDAY" -Hour 0 -Minute 0
$ContentRegistriesHarborStorageSpec = Initialize-ContentRegistriesHarborStorageSpec -Policy "MyPolicy" -Limit 0
$ContentRegistriesHarborCreateSpec = Initialize-ContentRegistriesHarborCreateSpec -Cluster "MyCluster" -GarbageCollection $ContentRegistriesHarborGarbageCollection -Storage $ContentRegistriesHarborStorageSpec
Invoke-CreateContentRegistriesHarbor -ContentRegistriesHarborCreateSpec $ContentRegistriesHarborCreateSpec -ClientToken "MyClientToken"
cURL Command
curl -X POST -H "client_token: string" -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"cluster":"string","garbage_collection":{"day_of_week":"SUNDAY","hour":0,"minute":0,"type":"NONE"},"storage":[{"limit":0,"policy":"string"}]}' https://{api_host}/api/vcenter/content/registries/harbor
Errors
400
com.vmware.vapi.std.errors.already_exists : if a Harbor already exists in the associated cluster. | com.vmware.vapi.std.errors.unsupported : if Harbor.CreateSpec.cluster does not have vSphere namespace enabled. | com.vmware.vapi.std.errors.invalid_argument : if spec contains any errors.
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have ContentLibrary.ManageRegistry and/or CertificateAuthority.Manage privilege, or user does not have ContentLibrary.ManageClusterRegistryResource privilege on Harbor.CreateSpec.cluster.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
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
x-vmw-doc-operation: create
Availability
Added in 7.0U2
On This Page
Registries Harbor Operations
delete
