Rename instance or update tags
API key for authentication. Make sure to include the word apikey, followed by a single space and then your token.
Example: apikey 1234$abcdef
Project ID
Region ID
Instance ID
Name
Update key-value tags using JSON Merge Patch semantics (RFC 7386). Provide key-value pairs to add or update tags. Set tag values to null to remove tags. Unspecified tags remain unchanged. Read-only tags are always preserved and cannot be modified.
Examples:
Add/update tags: {'tags': {'environment': 'production', 'team': 'backend'}} adds new tags or updates existing ones.
Delete tags: {'tags': {'old_tag': null}} removes specific tags.
Remove all tags: {'tags': null} removes all user-managed tags (read-only tags are preserved).
Partial update: {'tags': {'environment': 'staging'}} only updates specified tags.
Mixed operations: {'tags': {'environment': 'production', 'cost_center': 'engineering', 'deprecated_tag': null}} adds/updates 'environment' and 'cost_center' while removing 'deprecated_tag', preserving other existing tags.
Replace all: first delete existing tags with null values, then add new ones in the same request.
{
"my-tag": "my-tag-value",
"my-tag-to-remove": null
}OK
Map of network_name to list of addresses in that network
IP addresses of the instances that are blackholed by DDoS mitigation system
Datetime when instance was created
Task that created this entity
Advanced DDoS protection profile. It is always null if query parameter with_ddos=true is not set.
Fixed IP assigned to instance
Flavor
Instance ID
Instance description
"Instance description"
Instance isolation information
Instance name
Project ID
Region name
Region ID
Security groups
SSH key assigned to instance
Instance status
ACTIVE, BUILD, DELETED, ERROR, HARD_REBOOT, MIGRATING, PASSWORD, PAUSED, REBOOT, REBUILD, RESCUE, RESIZE, REVERT_RESIZE, SHELVED, SHELVED_OFFLOADED, SHUTOFF, SOFT_DELETED, SUSPENDED, UNKNOWN, VERIFY_RESIZE List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If null, the resource is not locked.
null
Task state
Virtual machine state (active)
active, building, deleted, error, paused, rescued, resized, shelved, shelved_offloaded, soft-deleted, stopped, suspended List of volumes