Reference > PyDo > Library Reference > tags > get()

Was this page helpful?

Give Feedback

pydo.tags.get()

Generated on 25 November 2024 from pydo version v0.6.0

Description

To retrieve an individual tag, you can send a GET request to /v2/tags/$TAG_NAME.

Parameters

Name	Type	Required	Description	Default Value
`tag_id`	string	True	The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag.

Request Sample

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

resp = client.tags.get(tag_id="awesome")

Responses

See the API spec for this endpoint to view additional detail on responses, headers, parameters, and more.

200
401
404
429
500
default

The response will be a JSON object with a key called tag. The value of this will be a tag object containing the standard tag attributes.

Click to expand an example response.

{
  "tag": {
    "tag": {
      "name": "extra-awesome",
      "resources": {
        "count": 5,
        "last_tagged_uri": "https://api.digitalocean.com/v2/images/7555620",
        "droplets": {
          "count": 1,
          "last_tagged_uri": "https://api.digitalocean.com/v2/droplets/3164444"
        },
        "images": {
          "count": 1,
          "last_tagged_uri": "https://api.digitalocean.com/v2/images/7555620"
        },
        "volumes": {
          "count": 1,
          "last_tagged_uri": "https://api.digitalocean.com/v2/volumes/3d80cb72-342b-4aaa-b92e-4e4abb24a933"
        },
        "volume_snapshots": {
          "count": 1,
          "last_tagged_uri": "https://api.digitalocean.com/v2/snapshots/1f6f46e8-6b60-11e9-be4e-0a58ac144519"
        },
        "databases": {
          "count": 1,
          "last_tagged_uri": "https://api.digitalocean.com/v2/databases/b92438f6-ba03-416c-b642-e9236db91976"
        }
      }
    }
  }
}

Unauthorized

Click to expand an example response.

{
  "id": "unauthorized",
  "message": "Unable to authenticate you."
}

The resource was not found.

Click to expand an example response.

{
  "id": "not_found",
  "message": "The resource you requested could not be found."
}

API Rate limit exceeded

Click to expand an example response.

{
  "id": "too_many_requests",
  "message": "API Rate limit exceeded."
}

Server error.

Click to expand an example response.

{
  "id": "server_error",
  "message": "Unexpected server-side error"
}

Unexpected error

Click to expand an example response.

{
  "id": "example_error",
  "message": "some error message"
}