Apache CloudStack 4.20.0.0 Root Admin API Reference

addAnnotation

add an annotation.

Request parameters

Parameter NameDescriptionRequired
adminsonlythe annotation is visible for admins onlyfalse
annotationthe annotation textfalse
entityidthe id of the entity to annotatefalse
entitytypeThe following entity types are allowed VM, VOLUME, SNAPSHOT, VM_SNAPSHOT, INSTANCE_GROUP, SSH_KEYPAIR, USER_DATA, NETWORK, VPC, PUBLIC_IP_ADDRESS, VPN_CUSTOMER_GATEWAY, TEMPLATE, ISO, KUBERNETES_CLUSTER, SERVICE_OFFERING, DISK_OFFERING, NETWORK_OFFERING, ZONE, POD, CLUSTER, HOST, DOMAIN, PRIMARY_STORAGE, SECONDARY_STORAGE, VR, SYSTEM_VM, AUTOSCALE_VM_GROUP, MANAGEMENT_SERVERfalse

Response Tags

Response NameDescription
idthe (uu)id of the annotation
adminsonlyTrue if the annotation is available for admins only
annotationthe contents of the annotation
createdthe creation timestamp for this annotation
entityidthe (uu)id of the entity to which this annotation pertains
entitynamethe name of the entity to which this annotation pertains
entitytypethe type of the annotated entity
removedthe removal timestamp for this annotation
useridThe (uu)id of the user that entered the annotation
usernameThe username of the user that entered the annotation