This API has a deprecated equivalent from v7.0U1.
Detach Tag Association
Detaches the tag from the given object. If the tag is already removed from the object, then this operation is a no-op and an error will not be thrown. To invoke this operation, you need the attach tag privilege on the tag and the read privilege on the object.
Request
URLURL
https://{api_host}/api/cis/tagging/tag-association/{tag_id}?action=detach
Path Parameters
Path Parameters
string
tag_id
Required
The identifier of the input tag. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Tag.
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
TaggingTagAssociationDetachRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"object_id": {
"id": "string",
"type": "string"
}
}
Authentication
This operation uses the following authentication methods.
Errors
Errors
403
com.vmware.vapi.std.errors.unauthorized : if you do not have the privilege to detach the tag or do not have the privilege to read the given object.
404
com.vmware.vapi.std.errors.not_found : if the tag for the given tagId does not exist in the system.
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
$StdDynamicID = Initialize-StdDynamicID -Type "MyType" -Id "MyId"
$TaggingTagAssociationDetachRequestBody = Initialize-TaggingTagAssociationDetachRequestBody -ObjectId $StdDynamicID
Invoke-DetachTagIdTagAssociation -TagId "MyTagId" -TaggingTagAssociationDetachRequestBody $TaggingTagAssociationDetachRequestBody
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{}' https://{api_host}/api/cis/tagging/tag-association/{tag_id}?action=detach
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/com/vmware/cis/tagging/tag-association/id:{tag_id}?~action=detach
x-vmw-doc-operation: detach
Availability
Added in 7.0U2
