Wrapper for DigitalOcean HTTP API.

nimble install digitalocean

API reference

This library has no dependencies other than the Nim standard library.

About

Wraps many of the API endpoints that digital ocean has. If you need more of them wrapped feel free to open up an issue or add a pull request.

DigitalOcean API docs Here: https://developers.digitalocean.com/documentation/v2/

Imports

This library really worls well with ssh and I also use print.

import digitalocean, ssh, print

Then you need to get your API token from your DigitalOcean account: https://cloud.digitalocean.com/account/api/tokens

setToken(token)

Create a new Droplet

I created this wrapper to manage servers based on demand. I use this to spin up servers when they are needed and spin them down when they are not.

var droplet = await createDroplet(
 name = "example server",
 region = "sfo2",
 size = "s-1vcpu-1gb",
 image = 100001, # use getUserImages to get id
 ssh_keys = @[10000], # use getSSHKeys to get id
 backups = false,
 ipv6 = false,
 private_networking = false,
 user_data = "",
 monitoring = false,
 volumes = @[],
 tags = @["test"],
)

Wait for the droplet to become active:

while droplet.status == "new":
 print droplet.status
 droplet = await getDroplet(d.id)
 sleep(1000)
print dropletd.status

After a droplet is active it is ready to start doing things. I is use my ssh library to log into the computer to set it up. Setup is some thing like this:

import ssh
var server = newSSH(user & "@" & droplet.publicIp)
server.command("apk install ...")
server.writeFile("/etc/someconfig", "{...}")
server.exit()

Then delete the droplet when I am done:

await deleteDroplet(droplet.id)

Get SSH Keys

I highly recommend using SSH keys for everything, never use server passwords. You can list the keys and the IDs you need for droplet creation with this:

  for key in waitFor getSSHKeys():
    echo (key.name, key.id)

Get Images

I create an image that is a base setup for all my server. You can use the images you have from here. You need the image.id and image.regions to match when creating a droplet.

  for image in waitFor getUserImages():
    echo (image.name, image.id, image.slug, image.regions)

You can also list public images which there are many of:

  for image in waitFor getAllImages():
    echo (image.name, image.id, image.slug)

Get Droplets

You can see all the droplets you have here:

  for droplet in waitFor getAllDroplets():
    echo droplet.name

But I think it’s more useful to tag your droplets and look at the by tag. Once you have many droplets the list becomes cluttered.

  for droplet in waitFor getDropletsByTag("gameserver"):
    echo droplet.name

Get your Account Information

You can get your account information.

  echo (waitFor getAccount()).email

You can also get recent actions that happened like which servers got started or stopped:

  for action in waitFor getAllActions():
    echo action.`type`