This API has a deprecated equivalent from v7.0U1.
Delete With Credentials Links
Deletes an existing hybrid link. This API should be used when unlink is initiated from cloud vCenter. Usage beyond VMware Cloud on AWS is not supported.
Request
URLURL
https://{api_host}/api/hvc/links/{link}?action=delete
Path Parameters
Path Parameters
string
link
Required
Identifier of the hybrid link. The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.Links.
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"
Request Body
Request Body
HvcLinksDeleteWithCredentialsRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"credentials": {
"password": "string",
"user_name": "string"
}
}
credentials
Required
Credentials to use for authentication to the remote system. This parameter is currently required. In the future, it may become optional.
Authentication
This operation uses the following authentication methods.
Errors
Errors
404
com.vmware.vapi.std.errors.not_found : if the hybrid link associated with link does not exist.
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
$HvcLinksCredentials = Initialize-HvcLinksCredentials -UserName "MyUserName" -Password "MyPassword"
$HvcLinksDeleteWithCredentialsRequestBody = Initialize-HvcLinksDeleteWithCredentialsRequestBody -Credentials $HvcLinksCredentials
Invoke-DeleteLink -Link "MyLink" -HvcLinksDeleteWithCredentialsRequestBody $HvcLinksDeleteWithCredentialsRequestBody
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"credentials":{"password":"string","user_name":"string"}}' https://{api_host}/api/hvc/links/{link}?action=delete
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/hvc/links/{link}?action=delete
x-vmw-doc-operation: delete_with_credentials
Availability
Added in 7.0U2
On This Page
Links Operations
get
post
get
delete
