Create Tag
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Creates a tag. To invoke this operation, you need the create tag privilege on the input category.
Request
URLURL
https://{api_host}/rest/com/vmware/cis/tagging/tag
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Request Body
Request Body
Contains TaggingTagCreateRequestBody
of type application/json
(required)
{
"create_spec": {
"category_id": "string",
"description": "string",
"name": "string"
}
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | create_spec | TaggingTagCreateSpec |
Specification for the new tag to be created. |
Response
Response
Response BodyResponse Body
200 OK returns
TaggingTagCreateResponseBody
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.
{
"value": "string"
}| Property Name | Type | Description |
|---|---|---|
| value | string |
The identifier of the created tag. The result will be an identifier for the resource type: com.vmware.cis.tagging.Tag. |
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"create_spec":{"category_id":"string","description":"string","name":"string","tag_id":"string"}}' https://{api_host}/rest/com/vmware/cis/tagging/tag
Errors
| Code | Returns | Description |
|---|---|---|
| 400 | ErrorRest | com.vmware.vapi.std.errors.invalid_argument : if any of the input information in the createSpec is invalid. |
| 401 | ErrorRest | com.vmware.vapi.std.errors.unauthorized : if you do not have the privilege to create tag. |
| 404 | ErrorRest | com.vmware.vapi.std.errors.not_found : if the category for in the given createSpec does not exist in the system. |
| 409 | ErrorRest | 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. |
| default | ErrorRest | Not available |
On This Page
Tag Operations
get
post
get
patch
delete
post
post
