vcenter hvc links: delete with credentials
Deletes an existing hybrid link. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Request:
HTTP request
POST https://{server}/rest/hvc/links/{link}?action=delete
Path Parameters
Name | Type | Description |
---|---|---|
Required | ||
link | string | Identifier of the hybrid link. |
Request Body Structure:
{
"credentials" : {
"password" : "secret string",
"user_name" : "string"
}
}
"credentials" : {
"password" : "secret string",
"user_name" : "string"
}
}
Request Body Parameters:
Name | Type | Description |
---|---|---|
bold = required | ||
credentials | credentials | Optional. Credentials to use for authentication to the remote system. |
credentials.user_name | string | Name of the user to authenticate. 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. |
credentials.password | secret | Password for the user. 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. |
Response:
HTTP Status Code: 200
NoneErrors:
HTTP Status Code | Type | Description |
---|---|---|
404 | not_found | if the hybrid link associated with link does not exist. |
403 | unauthorized | if the user is not authorized. |
500 | error | if the system reports an error while responding to the request. |