Question

Finding droplets with a given tag in metadata API

I’m looking to form a cluster of distributed Elixir nodes on DigitalOcean.

I wish to use droplet tags to do node discovery identify which droplets are intended to belong to the cluster, as I would on EC2 using this library: https://github.com/kyleaa/libcluster_ec2

It would work by polling a DO API every few seconds, querying to get the IP addresses of all droplets with the specified tag. Once I have these IPs I can handle the connection logic without problem.

What is the recommended way to find droplets with a given tag? From the DO metadata API docs it seems it does not provide that functionality. Ideally it would be a simple JSON API call that requires no further authentication when called from the droplet itself.

Thanks, Louis

Submit an answer


This textbox defaults to using Markdown to format your answer.

You can type !ref in this text area to quickly search our full set of tutorials, documentation & marketplace offerings and insert the link!

Sign In or Sign Up to Answer

These answers are provided by our Community. If you find them useful, show some love by clicking the heart. If you run into issues leave a comment, or add your own answer to help others.

Andrew SB
DigitalOcean Employee
DigitalOcean Employee badge
• October 26, 2018
Accepted Answer

The aim of the metadata API is to allow a Droplet to access data about itself. This allows a Droplet to know what it is tagged with by calling:

curl http://169.254.169.254/metadata/v1/tags/

To list all Droplets with a specific tag, you would need to use the DigitalOcean public API. You can pass tag_name as a query parameter when listing your Droplets to only receive back ones with that tag. For example:

curl -X GET -H "Content-Type: application/json" \
    -H "Authorization: Bearer $TOKEN" \
    "https://api.digitalocean.com/v2/droplets?tag_name=database"

Try DigitalOcean for free

Click below to sign up and get $200 of credit to try our products over 60 days!

Sign up

card icon
Get our biweekly newsletter

Sign up for Infrastructure as a Newsletter.

Sign up
card icon
Hollie's Hub for Good

Working on improving health and education, reducing inequality, and spurring economic growth? We’d like to help.

Learn more
card icon
Become a contributor

You get paid; we donate to tech nonprofits.

Learn more
Featured on Community
Kubernetes CourseLearn Python 3Machine Learning in PythonGetting started with GoIntro to Kubernetes
DigitalOcean Products
CloudwaysVirtual MachinesManaged DatabasesManaged KubernetesBlock StorageObject StorageMarketplaceVPCLoad Balancers
Welcome to the developer cloud

DigitalOcean makes it simple to launch in the cloud and scale up as you grow – whether you’re running one virtual machine or ten thousand.

Learn more ->
DigitalOcean Cloud Control Panel
Get started for free

Enter your email to get $200 in credit for your first 60 days with DigitalOcean.

New accounts only. By submitting your email you agree to our Privacy Policy.

© 2023 DigitalOcean, LLC.