Copy page

Cloud Platform

Tagging

Tags are labels that you can attach to instances, volumes, instance templates, and volume templates to organize and filter your resources.

Don't confuse them with image tags which serve a different purpose (see images).

Tag format

Tags can be up to 256 characters long and may contain alphanumeric characters plus -, +, _, ., :, and =. Each resource (instance, volume, instance template, volume template) can have up to 16 tags. You can currently only manage tags via the API. Kraftkit neither displays them nor allows you to edit them.

Adding tags

Add tags to a resource at creation time:

POST /instances
{
  "image": "...",
  "memory_mb": ...,
  "tags": [ "production", "customer_A" ]
}

Add tags to an existing resource ("op": "set" will replace all existing tags):

PATCH /instances
{
  "name": "example-instance",
  "prop": "tags",
  "op": "set",
  "value": ["testsystem", "customer_B"]
}

Add tags to a resource without replacing existing ones ("op": "add"):

PATCH /instances
{
  "name": "example-instance",
  "prop": "tags",
  "op": "add",
  "value": ["legacy"]
}

Removing tags

Remove specific tags from a resource ("op": "del"):

PATCH /instances
{
  "name": "example-instance",
  "prop": "tags",
  "op": "del",
  "value": ["legacy"]
}

Filtering by tag

Filter the instance list, volume list, instance template list, or volume template list by one or more tags. Only resources that have all the specified tags appear in the results.

Code
GET /instances?tags=production,customer_A

Separate tags by commas (,).

Tags in API responses

Each instance, volume, instance template, or volume template status response includes a tags array if at least one tag is present.

Learn more

• Unikraft Cloud's REST API reference, in particular the sections on instances and volumes