Tags v4.175.0
Tags List
Tags are User-defined labels attached to objects in your Account, such as Linodes. They are used for specifying and grouping attributes of objects that are relevant to the User.
This endpoint returns a paginated list of Tags on your account.
Important: You must be an unrestricted User in order to access, add, or modify Tags information.
Authorizations
personalAccessToken | |
oauth | account:read_only |
Query Parameters
page |
The page of a collection to return. |
page_size |
The number of items to return per page. |
Request Samples
curl -H "Authorization: Bearer $TOKEN" \
https://api.linode.com/v4/tags
Response Samples
{
"data": null,
"page": 1,
"pages": 1,
"results": 1
}
{
"errors": null
}
Responses
data | [array] |
page | [integer] The current page. |
pages | [integer] The total number of pages. |
results | [integer] The total number of results. |
errors | [array] |
New Tag Create
Creates a new Tag and optionally tags requested objects with it immediately.
Important: You must be an unrestricted User in order to access, add, or modify Tags information.
Authorizations
personalAccessToken | |
oauth | account:read_write |
Request Samples
curl -H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN" \
-X POST -d '{
"label": "example tag",
"linodes": [123,456],
"volumes": [9082,10003]
}' \
https://api.linode.com/v4/tags
linode-cli tags create \
--label 'example tag' \
--linodes 123 \
--linodes 456 \
--volumes 9082 \
--volumes 10003
Request Body Schema
domains | [array] A list of Domain IDs to apply the new Tag to. You must be allowed to |
label Required | [string]
3..50
charactersThe new Tag. |
linodes | [array] A list of Linode IDs to apply the new Tag to. You must be allowed to |
nodebalancers | [array] A list of NodeBalancer IDs to apply the new Tag to. You must be allowed to |
volumes | [array] A list of Volume IDs to apply the new Tag to. You must be allowed to |
Response Samples
{
"label": "example tag"
}
{
"errors": null
}
Responses
label | [string] A Label used for organization of objects on your Account. |
errors | [array] |
Tag Delete
Remove a Tag from all objects and delete it.
Important: You must be an unrestricted User in order to access, add, or modify Tags information.
Authorizations
personalAccessToken | |
oauth | account:read_write |
Path Parameters
tagLabel | [string] Required |
Response Samples
{}
{
"errors": null
}
Responses
errors | [array] |
Tagged Objects List
Returns a paginated list of all objects you’ve tagged with the requested Tag. This is a mixed collection of all object types.
Important: You must be an unrestricted User in order to access, add, or modify Tags information.
Authorizations
personalAccessToken | |
oauth | account:read_only |
Path Parameters
tagLabel | [string] Required |
Query Parameters
page |
The page of a collection to return. |
page_size |
The number of items to return per page. |
Request Samples
curl -H "Authorization: Bearer $TOKEN" \
https://api.linode.com/v4/tags/$tagLabel
Response Samples
{
"data": null,
"page": 1,
"pages": 1,
"results": 1
}
{
"errors": null
}