REST API - create

vcenter hvc links: create

Creates a new hybrid link between the local and foreign PSC. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Request:

HTTP request

POST https://{server}/rest/hvc/links

Request Body Structure:

{
    "spec" : {
        "domain_name" : "string",
        "password" : "secret string",
        "psc_hostname" : "string",
        "port" : "string",
        "ssl_thumbprint" : "string",
        "username" : "string",
        "admin_groups" : [
            "string",
            "string"
        ]
    }
}

Request Body Parameters:

Name	Type	Description
bold = required
spec	create_spec	Specification for the new link to be created.
spec.psc_hostname	string	The PSC hostname for the domain to be linked. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
spec.port	string	The HTTPS port of the PSC to be linked. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Optional. If unset 443 will be used as default.
spec.domain_name	string	The domain to which the PSC belongs. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
spec.username	string	The administrator username of the PSC. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
spec.password	secret	The administrator password of the PSC. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
spec.ssl_thumbprint	string	The ssl thumbprint of the server. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Optional. if unset no thumbprint is passed.
spec.admin_groups	string[]	List of groups to be added to enable administrator access to. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Optional. if unset administrator access will not be set.

Response:

HTTP Status Code: 200

Representation:

{
"value" : "obj-103"
}

Response Type:

Name	Type	Description
bold = required
value	string	The identifier of the newly linked domain.

Errors:

HTTP Status Code	Type	Description
400	already_exists	If the link already exists.
400	invalid_argument	If the values of any of the fields of the `spec` parameter are not valid.
400	unsupported	If the PSC or the VC version is not supported.
403	unauthorized	If the user is not authorized.
400	unverified_peer	If the SSL certificate of the foreign PSC cannot be validated by comparing with the thumbprint provided in vcenter.hvc.links.create_spec.ssl_thumbprint or if vcenter.hvc.links.create_spec.ssl_thumbprint is unset. The value of the {@link UnverifiedPeer#data) field will be a structure that contains all the fields defined in vcenter.hvc.links.certificate_info.
500	error	if the system reports an error while responding to the request.