This API has a deprecated equivalent from v7.0U1.
Delete Tag
DescriptionDeletes an existing tag. To invoke this operation, you need the delete privilege on the tag.
Request
URLURL
https://{api_host}/api/cis/tagging/tag/{tag_id}
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"
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 delete the tag.
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
Invoke-DeleteTagId -TagId "MyTagId"
cURL Command
curl -X DELETE -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/cis/tagging/tag/{tag_id}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: delete
x-vmw-doc-deprecated-path: /rest/com/vmware/cis/tagging/tag/id:{tag_id}
x-vmw-doc-operation: delete
Availability
Added in 7.0U2
On This Page
Tag Operations
get
post
get
patch
delete
post
post
