Tags v4.174.0

Tags List

GET https://api.linode.com/v4/tags

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
oauthaccount:read_only

Query Parameters

page
Type:
[integer] >= 1
Default: 1
Default:
1

The page of a collection to return.

page_size
Type:
[integer] 25..500
Default: 100
Default:
100

The number of items to return per page.

Request Samples

Response Samples

Responses

New Tag Create

POST https://api.linode.com/v4/tags

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
oauthaccount:read_write

Request Samples

Request Body Schema

domains
[array]

A list of Domain IDs to apply the new Tag to. You must be allowed to read_write all of the requested Domains, or the Tag will not be created and an error will be returned.

label
Required
[string] 3..50 characters

The new Tag.

linodes
[array]

A list of Linode IDs to apply the new Tag to. You must be allowed to read_write all of the requested Linodes, or the Tag will not be created and an error will be returned.

nodebalancers
[array]

A list of NodeBalancer IDs to apply the new Tag to. You must be allowed to read_write all of the requested NodeBalancers, or the Tag will not be created and an error will be returned.

volumes
[array]

A list of Volume IDs to apply the new Tag to. You must be allowed to read_write all of the requested Volumes, or the Tag will not be created and an error will be returned.

Response Samples

Responses

Tag Delete

DELETE https://api.linode.com/v4/tags/{tagLabel}

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
oauthaccount:read_write

Path Parameters

tagLabel[string]
Required

Response Samples

Responses

Tagged Objects List

GET https://api.linode.com/v4/tags/{tagLabel}

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
oauthaccount:read_only

Path Parameters

tagLabel[string]
Required

Query Parameters

page
Type:
[integer] >= 1
Default: 1
Default:
1

The page of a collection to return.

page_size
Type:
[integer] 25..500
Default: 100
Default:
100

The number of items to return per page.

Request Samples

Response Samples

Responses