Update Category
If vSphere APIs begin with /rest (vs /api), any maps are consumed/returned instead as arrays of objects, each containing a key and a value property field.
Updates an existing category. To invoke this operation, you need the edit privilege on the category.
Request
URLURL
https://{api_host}/rest/com/vmware/cis/tagging/category/id:{category_id}
Parameters
Parameters
string
category_id
Required
The identifier of the input category.
The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
Example: b00db39f948d13ea1e59b4d6fce56389
Request Body
Request Body
TaggingCategoryUpdateRequestBody of type application/json (required){
"update_spec": {
"associable_types": [
"string"
],
"cardinality": "enum",
"description": "string",
"name": "string"
}
}cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"update_spec":{"associable_types":["string"],"cardinality":"enum","description":"string","name":"string"}}' https://{api_host}/rest/com/vmware/cis/tagging/category/id:{category_id}
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if any of the information in the updateSpec is invalid.
401
com.vmware.vapi.std.errors.unauthorized : if you do not have the privilege to update the category.
404
com.vmware.vapi.std.errors.not_found : if the category for the given categoryId does not exist in the system.
409
com.vmware.vapi.std.errors.already_exists : if the Category.UpdateSpec.name provided in the updateSpec is the name of an already existing category.
On This Page
Category Operations
get
post
get
patch
delete
