Request parameters
Parameter Name | Description | Required |
adminsonly | the annotation is visible for admins only | false |
annotation | the annotation text | false |
entityid | the id of the entity to annotate | false |
entitytype | The 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_SERVER | false |
Response Tags
Response Name | Description |
id | the (uu)id of the annotation |
adminsonly | True if the annotation is available for admins only |
annotation | the contents of the annotation |
created | the creation timestamp for this annotation |
entityid | the (uu)id of the entity to which this annotation pertains |
entityname | the name of the entity to which this annotation pertains |
entitytype | the type of the annotated entity |
removed | the removal timestamp for this annotation |
userid | The (uu)id of the user that entered the annotation |
username | The username of the user that entered the annotation |