This API has a deprecated equivalent from v7.0U1.
Create Tag
Creates a tag. To invoke this operation, you need the create tag privilege on the input category.
Request
URLURL
https://{api_host}/api/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
TaggingTagCreateSpec of mimetype application/json
Required
Specification for the new tag to be created.
{
"category_id": "string",
"description": "string",
"name": "string"
}
string
category_id
Required
The unique identifier of the parent category in which this tag will be created. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.cis.tagging.Category. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.cis.tagging.Category.
string
description
Required
The description of the tag.
string
name
Required
The display name of the tag. The name must be unique within its category.
string
tag_id
Optional
If unset an identifier will be generated by the server When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.cis.tagging.Tag. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.cis.tagging.Tag.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
201 Created returns
string of type application/json
The identifier of the created tag. The result will be an identifier for the resource type: com.vmware.cis.tagging.Tag.
Errors
400
com.vmware.vapi.std.errors.already_exists : if the Tag.CreateSpec.name provided in the createSpec is the name of an already existing tag in the input category. | com.vmware.vapi.std.errors.invalid_argument : if any of the input information in the createSpec is invalid.
404
com.vmware.vapi.std.errors.not_found : if the category for in the given createSpec does not exist in the system.
Code Samples
PowerCLI Client SDK Example
$TaggingTagCreateSpec = Initialize-TaggingTagCreateSpec -Name "MyName" -Description "MyDescription" -CategoryId "MyCategoryId"
Invoke-CreateTag -TaggingTagCreateSpec $TaggingTagCreateSpec
PowerCLI Client SDK All Parameters Example
$TaggingTagCreateSpec = Initialize-TaggingTagCreateSpec -Name "MyName" -Description "MyDescription" -CategoryId "MyCategoryId" -TagId "MyTagId"
Invoke-CreateTag -TaggingTagCreateSpec $TaggingTagCreateSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"category_id":"string","description":"string","name":"string","tag_id":"string"}' https://{api_host}/api/cis/tagging/tag
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
x-vmw-doc-operation: create
Availability
Added in 7.0U2
On This Page
Tag Operations
get
post
delete
get
patch
post
post
