Vcenter Content Registries Harbor create

This operation is deprecated as of vSphere API 8.0.1.00200.

Creates a Harbor registry in the cluster.

This operation was added in vSphere API 7.0.0.0.

Returns an authorization error if you do not have all of the privileges described as follows:

Operation execution requires ContentLibrary.ManageRegistry.
The resource ClusterComputeResource referenced by the property Vcenter Content Registries Harbor CreateSpec.cluster requires ContentLibrary.ManageClusterRegistryResource.
The resource SpsStorageProfile referenced by the property Vcenter Content Registries Harbor StorageSpec.policy requires System.Read.

Request

URI

POST

https://{api_host}/api/vcenter/content/registries/harbor

COPY

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.

Request Body

Specification for creating the Harbor registry.

Vcenter Content Registries Harbor CreateSpec of type(s) application/json

Required

Show optional properties

{
    "storage": [
        {
            "policy": "string"
        }
    ]
}

{
    "cluster": "string",
    "garbage_collection": {
        "type": "string",
        "day_of_week": "string",
        "hour": 0,
        "minute": 0
    },
    "storage": [
        {
            "policy": "string",
            "limit": 0
        }
    ]
}

string

cluster

Optional

This property is deprecated as of vSphere API 8.0.1.00200.

Identifier of the cluster hosting the registry.

This property was added in vSphere API 7.0.0.0.

If missing or null, 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 schema as a parameter, the property must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this schema as a response, the property will be an identifier for the resource type: ClusterComputeResource.

garbage_collection

Optional

This property is deprecated as of vSphere API 8.0.1.00200.

Garbage collection configuration for the Harbor registry.

This property was added in vSphere API 7.0.0.0.

If missing or null, a default configuration is set, Recurrence#WEEKLY, DayOfWeek#SATURDAY, GarbageCollection#hour is 2, GarbageCollection#minute is 0.

array of object

storage

Required

This property is deprecated as of vSphere API 8.0.1.00200.

Storage associated with the Harbor registry. The list contains only one storage backing in this version.

This property was added in vSphere API 7.0.0.0.

Authentication

This operation uses the following authentication methods.

api_key_auth

Responses

201

Identifier of the deployed registry.

The response will be an identifier for the resource type: com.vmware.vcenter.content.Registry.

Returns string of type(s) application/json

Operation doesn't return any data structure

400

Vapi Std Errors AlreadyExists if a Harbor already exists in the associated cluster.

Vapi Std Errors Unsupported if Vcenter Content Registries Harbor CreateSpec.cluster does not have vSphere namespace enabled.

Vapi Std Errors InvalidArgument if spec contains any errors.

Returns Vapi Std Errors Error of type(s) application/json

"Vapi Std Errors Error Object"

array of object

messages

Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string

error_type

Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.

401

if the user can not be authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0

"Vapi Std Errors Unauthenticated Object"

string

challenge

Optional

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.

403

if the user does not have ContentLibrary.ManageRegistry and/or CertificateAuthority.Manage privilege, or user does not have ContentLibrary.ManageClusterRegistryResource privilege on Vcenter Content Registries Harbor CreateSpec.cluster.

Returns Vapi Std Errors Unauthorized of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors Unauthorized0

"Vapi Std Errors Unauthorized Object"

404

if resources/objects could not be located.

Returns Vapi Std Errors NotFound of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors NotFound0

"Vapi Std Errors NotFound Object"

500

if the system reports an error while responding to the request.

Returns Vapi Std Errors Error of type(s) application/json

"Vapi Std Errors Error Object"

array of object

messages

Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Some operations will not set this property when reporting errors.

string

error_type

Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"storage":["object"]}' https://{api_host}/api/vcenter/content/registries/harbor

Deprecated

On This Page

Description

Request

Header Parameters

Request Body

Authentication

Response

201 Response Body

Errors

Vcenter Content Registries Operations

GET