Report this

What is the reason for this report?

Finding droplets with a given tag in metadata API

Posted on October 25, 2018

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



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!

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.

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"

The developer cloud

Scale up as you grow — whether you're running one virtual machine or ten thousand.

Get started for free

Sign up and get $200 in credit for your first 60 days with DigitalOcean.*

*This promotional offer applies to new accounts only.