Skip to main content
GET
/
cloud
/
v1
/
instances
/
{project_id}
/
{region_id}
/
{instance_id}
/
metadata
/
{key}
Get instance tag
curl --request GET \
  --url https://api.gcore.com/cloud/v1/instances/{project_id}/{region_id}/{instance_id}/metadata/{key} \
  --header 'Authorization: <api-key>'
{
  "key": "<string>",
  "read_only": true,
  "value": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

​
project_id
integer
required

Project ID

​
region_id
integer
required

Region ID

​
instance_id
string
required

Instance ID

​
key
string
required

Tag key

Response

200 - application/json

Instance tag

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.

​
key
string
required

Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.

Example:

"my-tag"

​
read_only
boolean
required

If true, the tag is read-only and cannot be modified by the user

Example:

false

​
value
string
required

Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.

Example:

"my-tag-value"