Cis Tagging Tag create

Cis Tagging Tag create

Creates a tag. To invoke this operation, you need the create tag privilege on the input category.

Request
URI
POST
https://{api_host}/api/cis/tagging/tag
COPY
Request Body

Specification for the new tag to be created.

Cis Tagging Tag CreateSpec of type(s) application/json
Required

Show optional properties

{
    "name": "string",
    "description": "string",
    "category_id": "string"
}
{
    "name": "string",
    "description": "string",
    "category_id": "string",
    "tag_id": "string"
}
string
name
Required

The display name of the tag. The name must be unique within its category.

string
description
Required

The description of the tag.

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 schema as a parameter, the property must be an identifier for the resource type: com.vmware.cis.tagging.Category. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.cis.tagging.Category.

string
tag_id
Optional

This property was added in vSphere API 6.7.

If missing or null an identifier will be generated by the server

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.cis.tagging.Tag. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.cis.tagging.Tag.

Authentication
This operation uses the following authentication methods.
Responses
201

The identifier of the created tag.

The response will be an identifier for the resource type: com.vmware.cis.tagging.Tag.

Returns string of type(s) application/json
Operation doesn't return any data structure

400

Vapi Std Errors AlreadyExists if the Cis Tagging Tag CreateSpec.name provided in the createSpec is the name of an already existing tag in the input category.

Vapi Std Errors InvalidArgument if any of the input information in the createSpec is invalid.

Returns Vapi Std Errors Error of type(s) application/json
"Vapi Std Errors Error Object"
array of object
messages
Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object
data
Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string
error_type
Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.


403

if you do not have the privilege to create tag.

Returns Vapi Std Errors Unauthorized of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthorized0
"Vapi Std Errors Unauthorized Object"

404

if the category for in the given createSpec does not exist in the system.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0
"Vapi Std Errors NotFound Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"category_id:"string","description:"string","name:"string"}' https://{api_host}/api/cis/tagging/tag