API v2 Introduction

Welcome to the DigitalOcean API documentation.

The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. The endpoints are intuitive and powerful, allowing you to easily make calls to retrieve information or to execute actions.

All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires.

The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints.

Requests

Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required.

Method Usage
GET

For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object.

The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.

DELETE

To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found.

This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.

PUT

To update the information about a resource in your account, the PUT method is available.

Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.

POST

To create a new object, your request should specify the POST method.

The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.

HEAD

Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request.

Response headers contain some useful information about your API access and the results that are available for your request.

For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.

HTTP Statuses

Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes.

In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered.

In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered.

Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed.

If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having an issue on our end and cannot fulfill your request currently.

HTTP Statuses

EXAMPLE ERROR RESPONSE


HTTP/1.1 403 Forbidden
{
  "id":       "forbidden",
  "message":  "You do not have access for the attempted action."
}

Responses

When a request is successful, a response body will typically be sent back in the form of a JSON object. An exception to this is when a DELETE request is processed, which will result in a successful HTTP 204 status and an empty response body.

Inside of this JSON object, the resource root that was the target of the request will be set as the key. This will be the singular form of the word if the request operated on a single object, and the plural form of the word if a collection was processed.

For example, if you send a GET request to /v2/droplets/$DROPLET_ID you will get back an object with a key called "droplet". However, if you send the GET request to the general collection at /v2/droplets, you will get back an object with a key called "droplets".

The value of these keys will generally be a JSON object for a request on a single object and an array of objects for a request on a collection of objects.

Responses

Response for a Single Object

{
    "droplet": {
        "name": "example.com"
        . . .
    }
}

Response for an Object Collection

{
    "droplets": [
        {
            "name": "example.com"
            . . .
        },
        {
            "name": "second.com"
            . . .
        }
    ]
}

Meta

In addition to the main resource root, the response may also contain a meta object. This object contains information about the response itself.

The meta object contains a total key that is set to the total number of objects returned by the request. This has implications on the links object and pagination.

The meta object will only be displayed when it has a value. Currently, the meta object will have a value when a request is made on a collection (like droplets or domains).

Meta

Sample Meta Object

{
    . . .
    "meta": {
        "total": 43
    }
    . . .
}

Rate Limit

The number of requests that can be made through the API is currently limited to 5,000 per hour per OAuth token.

The rate limiting information is contained within the response headers of each request. The relevant headers are:

  • RateLimit-Limit: The number of requests that can be made per hour.
  • RateLimit-Remaining: The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
  • RateLimit-Reset: This represents the time when the oldest request will expire. The value is given in Unix epoch time. See below for more information about how request limits expire.

As long as the RateLimit-Remaining count is above zero, you will be able to make additional requests.

The way that a request expires and is removed from the current limit count is important to understand. Rather than counting all of the requests for an hour and resetting the RateLimit-Remaining value at the end of the hour, each request instead has its own timer.

This means that each request contributes toward the RateLimit-Remaining count for one complete hour after the request is made. When that request's timer runs out, it is no longer counted towards the request limit.

This has implications on the meaning of the RateLimit-Reset header as well. Because the entire rate limit is not reset at one time, the value of this header is set to the time when the oldest request will expire.

Keep this in mind if you see your RateLimit-Reset value change, but not move an entire hour into the future.

If the RateLimit-Remaining reaches zero, subsequent requests will receive a 429 error code until the request reset has been reached. You can see the format of the response in the examples.

Rate Limit

Sample Rate Limit Headers

. . .
RateLimit-Limit: 1200
RateLimit-Remaining: 1193
RateLimit-Reset: 1402425459
. . .

Sample Rate Exceeded Response

429 Too Many Requests
{
        id: "too_many_requests",
        message: "API Rate limit exceeded."
}

Curl Examples

Throughout this document, some example API requests will be given using the curl command. This will allow us to demonstrate the various endpoints in a simple, textual format.

The names of account-specific references (like Droplet IDs, for instance) will be represented by variables. For instance, a Droplet ID may be represented by a variable called $DROPLET_ID. You can set the associated variables in your environment if you wish to use the examples without modification.

The first variable that you should set to get started is your OAuth authorization token. The next section will go over the details of this, but you can set an environmental variable for it now.

Generate a token by going to the Apps & API section of the DigitalOcean control panel. Use an existing token if you have saved one, or generate a new token with the "Generate new token" button. Copy the generated token and use it to set and export the TOKEN variable in your environment as the example shows.

You may also wish to set some other variables now or as you go along. For example, you may wish to set the DROPLET_ID variable to one of your droplet IDs since this will be used frequently in the API.

If you are following along, make sure you use a Droplet ID that you control for so that your commands will execute correctly.

If you need access to the headers of a response through curl, you can pass the -i flag to display the header information along with the body. If you are only interested in the header, you can instead pass the -I flag, which will exclude the response body entirely.

Curl Examples

Set and Export your OAuth Token

export TOKEN=your_token_here

Set and Export a Variable

export DROPLET_ID=1111111

OAuth Authentication

In order to interact with the DigitalOcean API, you or your application must authenticate.

The DigitalOcean API handles this through OAuth, an open standard for authorization. OAuth allows you to delegate access to your account in full or in read-only mode.

You can generate an OAuth token by visiting the Apps & API section of the DigitalOcean control panel for your account.

An OAuth token functions as a complete authentication request. In effect, it acts as a substitute for a username and password pair.

Because of this, it is absolutely essential that you keep your OAuth tokens secure. In fact, upon generation, the web interface will only display each token a single time in order to prevent the token from being compromised.

How to Authenticate with OAuth

There are two separate ways to authenticate using OAuth.

The first option is to send a bearer authorization header with your request. This is the preferred method of authenticating because it completes the authorization request in the header portion, away from the actual request.

You can also authenticate using basic authentication. The normal way to do this with a tool like curl is to use the -u flag which is used for passing authentication information.

You then send the username and password combination delimited by a colon character. We only have an OAuth token, so use the OAuth token as the username and leave the password field blank (make sure to include the colon character though).

This is effectively the same as embedding the authentication information within the URI itself.

OAuth Authentication

Authenticate with a Bearer Authorization Header

curl -X $HTTP_METHOD -H "Authorization: Bearer $TOKEN" "https://api.digitalocean.com/v2/$OBJECT"

Authenticate with Basic Authentication

curl -X $HTTP_METHOD -u "$TOKEN:" "https://api.digitalocean.com/v2/$OBJECT"

Parameters

There are two different ways to pass parameters in a request with the API.

When passing parameters to create or update an object, parameters should be passed as a JSON object containing the appropriate attribute names and values as key-value pairs. When you use this format, you should specify that you are sending a JSON object in the header. This is done by setting the Content-Type header to application/json. This ensures that your request is interpreted correctly.

When passing parameters to filter a response on GET requests, parameters can be passed using standard query attributes. In this case, the parameters would be embedded into the URI itself by appending a ? to the end of the URI and then setting each attribute with an equal sign. Attributes can be separated with a &. Tools like curl can create the appropriate URI when given parameters and values; this can also be done using the -F flag and then passing the key and value as an argument. The argument should take the form of a quoted string with the attribute being set to a value with an equal sign.

Parameters

Pass Parameters as a JSON Object

curl -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"name": "example.com", "ip_address": "127.0.0.1"}' \
    -X POST "https://api.digitalocean.com/v2/domains"

Pass Filter Parameters as a Query String

 curl -H "Authorization: Bearer $TOKEN" \
     -X GET \
     "https://api.digitalocean.com/v2/images?type=snapshot"
        

Cross Origin Resource Sharing

In order to make requests to the API from other domains, the API implements Cross Origin Resource Sharing (CORS) support.

CORS support is generally used to create AJAX requests outside of the domain that the request originated from. This is necessary to implement projects like control panels utilizing the API. This tells the browser that it can send requests to an outside domain.

The procedure that the browser initiates in order to perform these actions (other than GET requests) begins by sending a "preflight" request. This sets the Origin header and uses the OPTIONS method. The server will reply back with the methods it allows and some of the limits it imposes. The client then sends the actual request if it falls within the allowed constraints.

This process is usually done in the background by the browser, but you can use curl to emulate this process using the example provided. The headers that will be set to show the constraints are:

  • Access-Control-Allow-Origin: This is the domain that is sent by the client or browser as the origin of the request. It is set through an Origin header.
  • Access-Control-Allow-Methods: This specifies the allowed options for requests from that domain. This will generally be all available methods.
  • Access-Control-Expose-Headers: This will contain the headers that will be available to requests from the origin domain.
  • Access-Control-Max-Age: This is the length of time that the access is considered valid. After this expires, a new preflight should be sent.
  • Access-Control-Allow-Credentials: This will be set to true. It basically allows you to send your OAuth token for authentication.

You should not need to be concerned with the details of these headers, because the browser will typically do all of the work for you.

Cross Origin Resource Sharing

Example Preflight Request

curl -I -H "Origin: https://example.com" -X OPTIONS "https://api.digitalocean.com/v2/droplets"

Example Preflight Response

. . .
Access-Control-Allow-Origin: https://example.com
Access-Control-Allow-Methods: GET, POST, PUT, PATCH, DELETE, OPTIONS
Access-Control-Expose-Headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset, Total, Link
Access-Control-Max-Age: 86400
Access-Control-Allow-Credentials: true
. . .

Account

NameTypeDescription
droplet_limitnumberThe total number of droplets the user may have
floating_ip_limitnumberThe total number of floating IPs the user may have
emailstringThe email the user has registered for Digital Ocean with
uuidstring (alphanumeric)The universal identifier for this user
email_verifiedbooleanIf true, the user has verified their account via email. False otherwise.
statusstringThis value is one of "active", "warning" or "locked".
status_messagestringA human-readable message giving more details about the status of the account.

Get User Information

Get User Information

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/account"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.account.info

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

account, _, err := client.Account.Get(ctx)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 1137
ratelimit-reset: 1415984218

Response Body

{
  "account": {
    "droplet_limit": 25,
    "floating_ip_limit": 5,
    "email": "sammy@digitalocean.com",
    "uuid": "b6fr89dbf6d9156cace5f3c78dc9851d957381ef",
    "email_verified": true,
    "status": "active",
    "status_message": ""
  }
}

Actions

Actions are records of events that have occurred on the resources in your account. These can be things like rebooting a Droplet, or transferring an image to a new region.

An action object is created every time one of these actions is initiated. The action object contains information about the current status of the action, start and complete timestamps, and the associated resource type and ID.

Every action that creates an action object is available through this endpoint. Completed actions are not removed from this list and are always available for querying.

NameTypeDescription
idnumberA unique numeric ID that can be used to identify and reference an action.
statusstringThe current status of the action. This can be "in-progress", "completed", or "errored".
typestringThis is the type of action that the object represents. For example, this could be "transfer" to represent the state of an image transfer action.
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

List all Actions

To list all of the actions that have been executed on the current account, send a GET request to /v2/actions.

This will be the entire list of actions taken on your account, so it will be quite large. As with any large collection returned by the API, the results will be paginated with only 25 on each page by default.

The results will be returned as a JSON object with an actions key. This will be set to an array filled with action objects containing the standard action attributes:

NameTypeDescription
idnumberA unique numeric ID that can be used to identify and reference an action.
statusstringThe current status of the action. This can be "in-progress", "completed", or "errored".
typestringThis is the type of action that the object represents. For example, this could be "transfer" to represent the state of an image transfer action.
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

List all Actions

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/actions?page=1&per_page=1"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

actions = client.actions.all
actions.each

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

opt := &godo.ListOptions{
    Page:    1,
    PerPage: 200,
}
actions, _, err := client.Actions.List(ctx, opt)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 1124
ratelimit-reset: 1415984218

Response Body

{
  "actions": [
    {
      "id": 36804636,
      "status": "completed",
      "type": "create",
      "started_at": "2014-11-14T16:29:21Z",
      "completed_at": "2014-11-14T16:30:06Z",
      "resource_id": 3164444,
      "resource_type": "droplet",
      "region": "nyc3",
      "region_slug": "nyc3"
    }
  ],
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/actions?page=159&per_page=1",
      "next": "https://api.digitalocean.com/v2/actions?page=2&per_page=1"
    }
  },
  "meta": {
    "total": 159
  }
}

Retrieve an existing Action

To retrieve a specific action object, send a GET request to /v2/actions/$ACTION_ID.

The result will be a JSON object with an action key. This will be set to an action object containing the standard action attributes:

NameTypeDescription
idnumberA unique numeric ID that can be used to identify and reference an action.
statusstringThe current status of the action. This can be "in-progress", "completed", or "errored".
typestringThis is the type of action that the object represents. For example, this could be "transfer" to represent the state of an image transfer action.
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

Retrieve an existing Action

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/actions/36804636"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.actions.find(id: 36804636)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

action, _, err := client.Actions.Get(ctx, 36804636)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 1123
ratelimit-reset: 1415984218

Response Body

{
  "action": {
    "id": 36804636,
    "status": "completed",
    "type": "create",
    "started_at": "2014-11-14T16:29:21Z",
    "completed_at": "2014-11-14T16:30:06Z",
    "resource_id": 3164444,
    "resource_type": "droplet",
    "region": "nyc3",
    "region_slug": "nyc3"
  }
}

Block Storage

Block Storage volumes provide expanded storage capacity for your Droplets and can be moved between Droplets within a specific region. Volumes function as raw block devices, meaning they appear to the operating system as locally attached storage which can be formatted using any file system supported by the OS. They may be created in sizes from 1GiB to 16TiB.

By sending requests to the /v2/volumes endpoint, you can list, create, or delete volumes as well as attach and detach them from Droplets.

NameTypeDescription
idstringThe unique identifier for the Block Storage volume.
regionobjectThe region that the Block Storage volume is located in. When setting a region, the value should be the slug identifier for the region. When you query a Block Storage volume, the entire region object will be returned.
droplet_idsarrayAn array containing the IDs of the Droplets the volume is attached to. Note that at this time, a volume can only be attached to a single Droplet.
namestringA human-readable name for the Block Storage volume. Must be lowercase and be composed only of numbers, letters and "-", up to a limit of 64 characters.
descriptionstringAn optional free-form text field to describe a Block Storage volume.
size_gigabytesnumberThe size of the Block Storage volume in GiB (1024^3).
created_atstringA time value given in ISO8601 combined date and time format that represents when the Block Storage volume was created.
droplet_idsarrayThis attribute is an array of the Droplets that the volume is attached to.

List all Block Storage volumes

To list all of the Block Storage volumes available on your account, send a GET request to /v2/volumes.

The response will be a JSON object with a key called volumes. This will be set to an array of volume objects, each of which will contain the standard volume attributes.

The region may be provided as query paramater in order to restrict results to volumes available in a specific region. For exmple: /v2/volumes?region=nyc1

NameTypeDescription
idstringThe unique identifier for the Block Storage volume.
regionobjectThe region that the Block Storage volume is located in. When setting a region, the value should be the slug identifier for the region. When you query a Block Storage volume, the entire region object will be returned.
droplet_idsarrayAn array containing the IDs of the Droplets the volume is attached to. Note that at this time, a volume can only be attached to a single Droplet.
namestringA human-readable name for the Block Storage volume. Must be lowercase and be composed only of numbers, letters and "-", up to a limit of 64 characters.
descriptionstringAn optional free-form text field to describe a Block Storage volume.
size_gigabytesnumberThe size of the Block Storage volume in GiB (1024^3).
created_atstringA time value given in ISO8601 combined date and time format that represents when the Block Storage volume was created.
droplet_idsarrayThis attribute is an array of the Droplets that the volume is attached to.

List all Block Storage volumes

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/volumes?region=nyc1"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

volumes = client.volumes.all
volumes.each

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

opt := &godo.ListOptions{
    Page:    1,
    PerPage: 200,
}

volumes, _, err := client.Storage.ListVolumes(ctx, opt)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 5000
ratelimit-remaining: 4823
ratelimit-reset: 1444931833

Response Body

{
  "volumes": [
    {
      "id": "506f78a4-e098-11e5-ad9f-000f53306ae1",
      "region": {
        "name": "New York 1",
        "slug": "nyc1",
        "sizes": [
          "512mb",
          "1gb",
          "2gb",
          "4gb",
          "8gb",
          "16gb",
          "32gb",
          "48gb",
          "64gb"
        ],
        "features": [
          "private_networking",
          "backups",
          "ipv6",
          "metadata"
        ],
        "available": true
      },
      "droplet_ids": [

      ],
      "name": "example",
      "description": "Block store for examples",
      "size_gigabytes": 10,
      "created_at": "2016-03-02T17:00:49Z"
    }
  ],
  "links": {
  },
  "meta": {
    "total": 1
  }
}

Create a new Block Storage volume

To create a new volume, send a POST request to /v2/volumes. The attribute values that must be set to successfully create a volume are:

NameTypeDescriptionRequired
size_gigabytesnumberThe size of the Block Storage volume in GiB (1024^3).true
namestringA human-readable name for the Block Storage volume. Must be lowercase and be composed only of numbers, letters and "-", up to a limit of 64 characters.true
descriptionstringAn optional free-form text field to describe a Block Storage volume.
regionstringThe region where the Block Storage volume will be created. When setting a region, the value should be the slug identifier for the region. When you query a Block Storage volume, the entire region object will be returned. Should not be specified with a snapshot_id.
snapshot_idstringThe unique identifier for the volume snapshot from which to create the volume. Should not be specified with a region_id.

The response will be a array called volumes containing an object with the standard attributes associated with a volume:

NameTypeDescription
idstringThe unique identifier for the Block Storage volume.
regionobjectThe region that the Block Storage volume is located in. When setting a region, the value should be the slug identifier for the region. When you query a Block Storage volume, the entire region object will be returned.
droplet_idsarrayAn array containing the IDs of the Droplets the volume is attached to. Note that at this time, a volume can only be attached to a single Droplet.
namestringA human-readable name for the Block Storage volume. Must be lowercase and be composed only of numbers, letters and "-", up to a limit of 64 characters.
descriptionstringAn optional free-form text field to describe a Block Storage volume.
size_gigabytesnumberThe size of the Block Storage volume in GiB (1024^3).
created_atstringA time value given in ISO8601 combined date and time format that represents when the Block Storage volume was created.
droplet_idsarrayThis attribute is an array of the Droplets that the volume is attached to.

Create a new Block Storage volume

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"size_gigabytes":10, "name": "example", "description": "Block store for examples", "region": "nyc1"}' "https://api.digitalocean.com/v2/volumes"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

volume = DropletKit::Volume.new(
  size_gigabytes: 10,
  name: 'Example',
  description: 'Block store for examples',
  region: 'nyc1'
)
client.volumes.create(volume)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

createRequest := &VolumeCreateRequest{
    Region:        "nyc1",
    Name:          "example",
    Description:   "Block store for examples",
    SizeGigaBytes: 10,
}

volume, _, err := client.Storage.CreateVolume(ctx, createRequest)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "size_gigabytes": 10,
  "name": "example",
  "description": "Block store for examples",
  "region": "nyc1"
}

Response Headers

content-type: application/json; charset=utf-8
status: 201 Created
ratelimit-limit: 5000
ratelimit-remaining: 4821
ratelimit-reset: 1444931833

Response Body

{
  "volume": {
    "id": "506f78a4-e098-11e5-ad9f-000f53306ae1",
    "region": {
      "name": "New York 1",
      "slug": "nyc1",
      "sizes": [
        "512mb",
        "1gb",
        "2gb",
        "4gb",
        "8gb",
        "16gb",
        "32gb",
        "48gb",
        "64gb"
      ],
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata"
      ],
      "available": true
    },
    "droplet_ids": [

    ],
    "name": "example",
    "description": "Block store for examples",
    "size_gigabytes": 10,
    "created_at": "2016-03-02T17:00:49Z"
  }
}

Retrieve an existing Block Storage volume

To show information about a Block Storage volume, send a GET request to /v2/volumes/$VOLUME_ID.

The response will be a JSON object with a key called volume. The value of this will be an object that contains the standard attributes associated with a volume:

NameTypeDescription
idstringThe unique identifier for the Block Storage volume.
regionobjectThe region that the Block Storage volume is located in. When setting a region, the value should be the slug identifier for the region. When you query a Block Storage volume, the entire region object will be returned.
droplet_idsarrayAn array containing the IDs of the Droplets the volume is attached to. Note that at this time, a volume can only be attached to a single Droplet.
namestringA human-readable name for the Block Storage volume. Must be lowercase and be composed only of numbers, letters and "-", up to a limit of 64 characters.
descriptionstringAn optional free-form text field to describe a Block Storage volume.
size_gigabytesnumberThe size of the Block Storage volume in GiB (1024^3).
created_atstringA time value given in ISO8601 combined date and time format that represents when the Block Storage volume was created.
droplet_idsarrayThis attribute is an array of the Droplets that the volume is attached to.

Retrieve an existing Block Storage volume

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/volumes/7724db7c-e098-11e5-b522-000f53304e51"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.volumes.find(id: '7724db7c-e098-11e5-b522-000f53304e51')

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

volume, _, err := client.Storage.GetVolume(ctx, "7724db7c-e098-11e5-b522-000f53304e51")

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 5000
ratelimit-remaining: 4820
ratelimit-reset: 1444931833

Response Body

{
  "volume": {
    "id": "506f78a4-e098-11e5-ad9f-000f53306ae1",
    "region": {
      "name": "New York 1",
      "slug": "nyc1",
      "sizes": [
        "512mb",
        "1gb",
        "2gb",
        "4gb",
        "8gb",
        "16gb",
        "32gb",
        "48gb",
        "64gb"
      ],
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata"
      ],
      "available": true
    },
    "droplet_ids": [

    ],
    "name": "example",
    "description": "Block store for examples",
    "size_gigabytes": 10,
    "created_at": "2016-03-02T17:00:49Z"
  }
}

Retrieve an existing Block Storage volume by name

It is also possible to retrieve information about a Block Storage volume by name. To do so, send a GET request with the volume's name and the region slug for the region it is located in as query parameters to /v2/volumes?name=$DRIVE_NAME&region=nyc1.

The response will be a JSON object with a key called volumes. This will be set to an array containing a volume object with the standard volume attributes:

NameTypeDescription
idstringThe unique identifier for the Block Storage volume.
regionobjectThe region that the Block Storage volume is located in. When setting a region, the value should be the slug identifier for the region. When you query a Block Storage volume, the entire region object will be returned.
droplet_idsarrayAn array containing the IDs of the Droplets the volume is attached to. Note that at this time, a volume can only be attached to a single Droplet.
namestringA human-readable name for the Block Storage volume. Must be lowercase and be composed only of numbers, letters and "-", up to a limit of 64 characters.
descriptionstringAn optional free-form text field to describe a Block Storage volume.
size_gigabytesnumberThe size of the Block Storage volume in GiB (1024^3).
created_atstringA time value given in ISO8601 combined date and time format that represents when the Block Storage volume was created.
droplet_idsarrayThis attribute is an array of the Droplets that the volume is attached to.

Retrieve an existing Block Storage volume by name

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/volumes?name=example&region=nyc1"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 5000
ratelimit-remaining: 4820
ratelimit-reset: 1444931833

Response Body

{
  "volumes": [
    {
      "id": "506f78a4-e098-11e5-ad9f-000f53306ae1",
      "region": {
        "name": "New York 1",
        "slug": "nyc1",
        "sizes": [
          "512mb",
          "1gb",
          "2gb",
          "4gb",
          "8gb",
          "16gb",
          "32gb",
          "48gb",
          "64gb"
        ],
        "features": [
          "private_networking",
          "backups",
          "ipv6",
          "metadata"
        ],
        "available": true
      },
      "droplet_ids": [

      ],
      "name": "example",
      "description": "Block store for examples",
      "size_gigabytes": 10,
      "created_at": "2016-03-02T17:00:49Z"
    }
  ],
  "links": {
  },
  "meta": {
    "total": 1
  }
}

List snapshots for a volume

To retrieve the snapshots that have been created from a volume, send a GET request to /v2/volumes/$VOLUME_ID/snapshots.

You will get back a JSON object that has a snapshots key. This will be set to an array of snapshot objects, each of which contain the standard snapshot attributes:

NameTypeDescription
idstringThe unique identifier for the snapshot.
namestringA human-readable name for the snapshot.
created_atstringA time value given in ISO8601 combined date and time format that represents when the snapshot was created.
regionsarrayAn array of the regions that the image is available in. The regions are represented by their identifying slug values.
resource_idstringA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
min_disk_sizenumberThe minimum size in GB required for a volume or Droplet to use this snapshot.
size_gigabytesnumberThe billable size of the snapshot in gigabytes.

List snapshots for a volume

cURL Example

curl -X GET -H 'Content-Type: application/json' -H 'Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582' "https://api.digitalocean.com/v2/volumes/82a48a18-873f-11e6-96bf-000f53315a41/snapshots?page=1&per_page=1"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 5000
ratelimit-remaining: 4982
ratelimit-reset: 1475263694

Response Body

{
  "snapshots": [
    {
      "id": "8eb4d51a-873f-11e6-96bf-000f53315a41",
      "name": "big-data-snapshot1475261752",
      "regions": [
        "nyc1"
      ],
      "created_at": "2016-09-30T18:56:12Z",
      "resource_id": "82a48a18-873f-11e6-96bf-000f53315a41",
      "resource_type": "volume",
      "min_disk_size": 10,
      "size_gigabytes": 0
    }
  ],
  "links": {
  },
  "meta": {
    "total": 1
  }
}

Create snapshot from a volume

To create a snapshot from a volume, sent a POST request to /v2/volumes/$VOLUME_ID/snapshots.

NameTypeDescription
namestringA human-readable name for the volume snapshot.

You will get back a JSON object that has a snapshot key. This will contain the standard snapshot attributes:

NameTypeDescription
idstringThe unique identifier for the snapshot.
namestringA human-readable name for the snapshot.
created_atstringA time value given in ISO8601 combined date and time format that represents when the snapshot was created.
regionsarrayAn array of the regions that the image is available in. The regions are represented by their identifying slug values.
resource_idstringA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
min_disk_sizenumberThe minimum size in GB required for a volume or Droplet to use this snapshot.
size_gigabytesnumberThe billable size of the snapshot in gigabytes.

Create snapshot from a volume

cURL Example

curl -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582' -d '{"name":"big-data-snapshot1475261774"}' "https://api.digitalocean.com/v2/volumes/82a48a18-873f-11e6-96bf-000f53315a41/snapshots"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "name": "big-data-snapshot1475261774"
}

Response Headers

content-type: application/json; charset=utf-8
status: 201 Created
ratelimit-limit: 5000
ratelimit-remaining: 4981
ratelimit-reset: 1475263694

Response Body

{
  "snapshot": {
    "id": "8fa70202-873f-11e6-8b68-000f533176b1",
    "name": "big-data-snapshot1475261774",
    "regions": [
      "nyc1"
    ],
    "created_at": "2016-09-30T18:56:14Z",
    "resource_id": "82a48a18-873f-11e6-96bf-000f53315a41",
    "resource_type": "volume",
    "min_disk_size": 10,
    "size_gigabytes": 0
  }
}

Delete a Block Storage volume

To delete a Block Storage volume, destroying all data and removing it from your account, send a DELETE request to /v2/volumes/$VOLUME_ID.

No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.

Delete a Block Storage volume

cURL Example

curl -X DELETE -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/volumes/7724db7c-e098-11e5-b522-000f53304e51"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.volumes.delete(id: '7724db7c-e098-11e5-b522-000f53304e51')

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

_, err := client.Storage.DeleteVolume(ctx, "7724db7c-e098-11e5-b522-000f53304e51")

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

status: 204 No Content
ratelimit-limit: 5000
ratelimit-remaining: 4815
ratelimit-reset: 1444931833

Delete a Block Storage volume by name

Block Storage volumes may also be deleted by name by sending a DELETE request with the volume's name and the region slug for the region it is located in as query parameters to /v2/volumes?name=$DRIVE_NAME&region=nyc1.

No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.

Delete a Block Storage volume by name

cURL Example

curl -X DELETE -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/volumes?name=example&region=nyc1"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

status: 204 No Content
ratelimit-limit: 5000
ratelimit-remaining: 4815
ratelimit-reset: 1444931833

Block Storage Actions

Block Storage actions are commands that can be given to a DigitalOcean Block Storage volume. An example would be detaching or attaching a volume from a Droplet. These requests are made on the /v2/volumes/$VOLUME_ID/actions endpoint.

An action object is returned. These objects hold the current status of the requested action.

NameTypeDescription
idintA unique numeric ID that can be used to identify and reference an action.
statusstringThe current status of the action. This can be "in-progress", "completed", or "errored".
typestringThis is the type of action that the object represents. For example, this could be "attach_volume" to represent the state of a volume attach action.
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnullable intA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionobjectThe region where the resources acted upon are located.
region_slugnullable stringA slug representing the region where the action occurred.

Attach a Block Storage volume to a Droplet

To attach a Block Storage volume to a Droplet, send a POST request to /v2/volumes/$VOLUME_ID/actions. In the body, set the "type" attribute to attach and the "droplet_id" attribute to the Droplet's ID.

Each volume may only be attached to a single Droplet. However, up to five volumes may be attached to a Droplet at a time.

NameTypeDescriptionRequired
typestringThis must be "attach"true
droplet_idintThe unique identifier for the Droplet the volume will be attached or detached from.true
regionstringThe slug identifier for the region the volume is located in.

The response will be a JSON object with a key called action. The value of this will be an object that contains the standard attributes associated with an action:

NameTypeDescription
idintA unique numeric ID that can be used to identify and reference an action.
statusstringThe current status of the action. This can be "in-progress", "completed", or "errored".
typestringThis is the type of action that the object represents. For example, this could be "attach_volume" to represent the state of a volume attach action.
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnullable intA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionobjectThe region where the resources acted upon are located.
region_slugnullable stringA slug representing the region where the action occurred.

Attach a Block Storage volume to a Droplet

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"type": "attach", "droplet_id": 11612190, "region": "nyc1"}' "https://api.digitalocean.com/v2/volumes/7724db7c-e098-11e5-b522-000f53304e51/actions"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.volume_actions.attach(volume_id:'7724db7c-e098-11e5-b522-000f53304e51', droplet_id: 11612190, region: 'nyc1'

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

action, _, err := client.StorageActions.Attach(ctx, "7724db7c-e098-11e5-b522-000f53304e51", 11612190)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "type": "attach",
  "droplet_id": 11612190,
  "region": "nyc1"
}

Response Headers

content-type: application/json; charset=utf-8
status: 202 Accepted
ratelimit-limit: 5000
ratelimit-remaining: 4823
ratelimit-reset: 1444931833

Response Body

{
  "action": {
    "id": 72531856,
    "status": "completed",
    "type": "attach_volume",
    "started_at": "2015-11-12T17:51:03Z",
    "completed_at": "2015-11-12T17:51:14Z",
    "resource_id": null,
    "resource_type": "volume",
    "region": {
      "name": "New York 1",
      "slug": "nyc1",
      "sizes": [
        "1gb",
        "2gb",
        "4gb",
        "8gb",
        "32gb",
        "64gb",
        "512mb",
        "48gb",
        "16gb"
      ],
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata"
      ],
      "available": true
    },
    "region_slug": "nyc1"
  }
}

Attach a Block Storage volume to a Droplet by name

To attach a Block Storage volume to a Droplet using its name, send a POST request to /v2/volumes/actions. Each volume may only be attached to a single Droplet. However, up to 5 volumes may be attached to a Droplet at a time.

In the body, set the "type" attribute to attach, the "droplet_id" attribute to the Droplet's ID, and the "volume_name" attribute to the volume's name.

NameTypeDescriptionRequired
typestringThis must be "attach"true
droplet_idintThe unique identifier for the Droplet the volume will be attached or detached from.true
volume_namestringThe name of the Block Storage volume.true
regionstringThe slug identifier for the region the volume is located in.

The response will be a JSON object with a key called action. The value of this will be an object that contains the standard attributes associated with an action:

NameTypeDescription
idintA unique numeric ID that can be used to identify and reference an action.
statusstringThe current status of the action. This can be "in-progress", "completed", or "errored".
typestringThis is the type of action that the object represents. For example, this could be "attach_volume" to represent the state of a volume attach action.
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnullable intA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionobjectThe region where the resources acted upon are located.
region_slugnullable stringA slug representing the region where the action occurred.

Attach a Block Storage volume to a Droplet by name

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"type": "attach", "volume_name": "example", "region": "nyc1", "droplet_id": "11612190"}' "https://api.digitalocean.com/v2/volumes/actions"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "type": "attach",
  "volume_name": "example",
  "region": "nyc1",
  "droplet_id": "11612190"
}

Response Headers

content-type: application/json; charset=utf-8
status: 202 Accepted
ratelimit-limit: 5000
ratelimit-remaining: 4823
ratelimit-reset: 1444931833

Response Body

{
  "action": {
    "id": 72531856,
    "status": "completed",
    "type": "attach_volume",
    "started_at": "2015-11-12T17:51:03Z",
    "completed_at": "2015-11-12T17:51:14Z",
    "resource_id": null,
    "resource_type": "volume",
    "region": {
      "name": "New York 1",
      "slug": "nyc1",
      "sizes": [
        "1gb",
        "2gb",
        "4gb",
        "8gb",
        "32gb",
        "64gb",
        "512mb",
        "48gb",
        "16gb"
      ],
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata"
      ],
      "available": true
    },
    "region_slug": "nyc1"
  }
}

Remove a Block Storage volume from a Droplet

To detach a Block Storage volume from a Droplet, send a POST request to /v2/volumes/$VOLUME_ID/actions. In the body, set the "type" attribute to detach and the "droplet_id" attribute to the Droplet's ID.

NameTypeDescriptionRequired
typestringThis must be "detach"true
droplet_idintThe unique identifier for the Droplet the volume will be attached or detached from.true
regionstringThe slug identifier for the region the volume is located in.

The response will be a JSON object with a key called action. The value of this will be an object that contains the standard attributes associated with an action:

NameTypeDescription
idintA unique numeric ID that can be used to identify and reference an action.
statusstringThe current status of the action. This can be "in-progress", "completed", or "errored".
typestringThis is the type of action that the object represents. For example, this could be "attach_volume" to represent the state of a volume attach action.
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnullable intA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionobjectThe region where the resources acted upon are located.
region_slugnullable stringA slug representing the region where the action occurred.

Remove a Block Storage volume from a Droplet

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"type": "detach", "droplet_id": "11612190", "region": "nyc1"}' "https://api.digitalocean.com/v2/volumes/7724db7c-e098-11e5-b522-000f53304e51/actions"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.volume_actions.detach(volume_id:'7724db7c-e098-11e5-b522-000f53304e51', droplet_id: 11612190, region: 'nyc1'

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

action, _, err := client.StorageActions.Detach(ctx, "7724db7c-e098-11e5-b522-000f53304e51")

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "type": "detach",
  "droplet_id": "11612190",
  "region": "nyc1"
}

Response Headers

content-type: application/json; charset=utf-8
status: 202 Accepted
ratelimit-limit: 5000
ratelimit-remaining: 4816
ratelimit-reset: 1444931833

Response Body

{
  "action": {
    "id": 68212773,
    "status": "in-progress",
    "type": "detach_volume",
    "started_at": "2015-10-15T17:46:15Z",
    "completed_at": null,
    "resource_id": null,
    "resource_type": "backend",
    "region": {
      "name": "New York 1",
      "slug": "nyc1",
      "sizes": [
        "512mb",
        "1gb",
        "2gb",
        "4gb",
        "8gb",
        "16gb",
        "32gb",
        "48gb",
        "64gb"
      ],
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata"
      ],
      "available": true
    },
    "region_slug": "nyc1"
  }
}

Remove a Block Storage volume from a Droplet by name

To detach a Block Storage volume from a Droplet using its name, send a POST request to /v2/volumes/actions. In the body, set the "type" attribute to detach, the "droplet_id" attribute to the Droplet's ID, and the "volume_name" attribute to the volume's name.

NameTypeDescriptionRequired
typestringThis must be "detach"true
droplet_idintThe unique identifier for the Droplet the volume will be attached or detached from.true
volume_namestringThe name of the Block Storage volume.true
regionstringThe slug identifier for the region the volume is located in.

The response will be a JSON object with a key called action. The value of this will be an object that contains the standard attributes associated with an action:

NameTypeDescription
idintA unique numeric ID that can be used to identify and reference an action.
statusstringThe current status of the action. This can be "in-progress", "completed", or "errored".
typestringThis is the type of action that the object represents. For example, this could be "attach_volume" to represent the state of a volume attach action.
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnullable intA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionobjectThe region where the resources acted upon are located.
region_slugnullable stringA slug representing the region where the action occurred.

Remove a Block Storage volume from a Droplet by name

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"type": "detach", "droplet_id": "11612190", "volume_name": "example", "region": "nyc1"}' "https://api.digitalocean.com/v2/volumes/actions"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "type": "detach",
  "droplet_id": "11612190",
  "volume_name": "example",
  "region": "nyc1"
}

Response Headers

content-type: application/json; charset=utf-8
status: 202 Accepted
ratelimit-limit: 5000
ratelimit-remaining: 4816
ratelimit-reset: 1444931833

Resize a volume

To resize a Block Storage volume, send a POST request to /v2/volumes/$VOLUME_ID/actions. Set the "type" attribute to resize, the "size_gigabytes" attribute to the new size of the volume in GiB (1024^3), and the "region" attribute to the slug representing the region where the volume is located. Volumes may only be resized upwards. The maximum size for a volume is 16TiB.

NameTypeDescriptionRequired
typestringThis must be "resize"true
size_gigabytesintThe new size of the Block Storage volume in GiB (1024^3).true
regionstringThe slug identifier for the region the volume is located in.

The response will be an object with a key called action. The value of this will be an object that contains the standard volume action attributes:

NameTypeDescription
idintA unique numeric ID that can be used to identify and reference an action.
statusstringThe current status of the action. This can be "in-progress", "completed", or "errored".
typestringThis is the type of action that the object represents. For example, this could be "attach_volume" to represent the state of a volume attach action.
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnullable intA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionobjectThe region where the resources acted upon are located.
region_slugnullable stringA slug representing the region where the action occurred.

Resize a volume

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"type":"resize","size_gigabytes": 100, "region":"nyc1"}' "https://api.digitalocean.com/v2/volumes/7724db7c-e098-11e5-b522-000f53304e51/actions"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

action, _, err := client.StorageActions.Resize(ctx, "7724db7c-e098-11e5-b522-000f53304e51", 100, "nyc1")

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "type": "resize",
  "size_gigabytes": 100,
  "region": "nyc1"
}

Response Headers

content-type: application/json; charset=utf-8
status: 202 Accepted
ratelimit-limit: 1200
ratelimit-remaining: 1046
ratelimit-reset: 1415984218

Response Body

{
  "action": {
    "id": 72531856,
    "status": "in-progress",
    "type": "resize",
    "started_at": "2015-11-12T17:51:03Z",
    "completed_at": "2015-11-12T17:51:14Z",
    "resource_id": null,
    "resource_type": "volume",
    "region": {
      "name": "New York 1",
      "slug": "nyc1",
      "sizes": [
        "1gb",
        "2gb",
        "4gb",
        "8gb",
        "32gb",
        "64gb",
        "512mb",
        "48gb",
        "16gb"
      ],
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata"
      ],
      "available": true
    },
    "region_slug": "nyc1"
  }
}

List all actions for a volume

To retrieve all actions that have been executed on a volume, send a GET request to /v2/volumes/$VOLUME_ID/actions.

The results will be returned as a JSON object with an actions key. This will be set to an array filled with action objects containing the standard volume action attributes:

NameTypeDescription
idintA unique numeric ID that can be used to identify and reference an action.
statusstringThe current status of the action. This can be "in-progress", "completed", or "errored".
typestringThis is the type of action that the object represents. For example, this could be "attach_volume" to represent the state of a volume attach action.
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnullable intA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionobjectThe region where the resources acted upon are located.
region_slugnullable stringA slug representing the region where the action occurred.

List all actions for a volume

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/volumes/7724db7c-e098-11e5-b522-000f53304e51/actions?page=1&per_page=1"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

actions = client.volume.actions(id: '7724db7c-e098-11e5-b522-000f53304e51')
actions.each

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

opt := &godo.ListOptions{
    Page:    1,
    PerPage: 200,
}

actions, _, err := client.StorageActions(ctx, "7724db7c-e098-11e5-b522-000f53304e51", opt)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 903
ratelimit-reset: 1415984218

Response Body

{
  "actions": [
    {
      "id": 72531856,
      "status": "completed",
      "type": "attach_volume",
      "started_at": "2015-11-21T21:51:09Z",
      "completed_at": "2015-11-21T21:51:09Z",
      "resource_id": null,
      "resource_type": "volume",
      "region": {
        "name": "New York 1",
        "slug": "nyc1",
        "sizes": [
          "512mb",
          "1gb",
          "2gb",
          "4gb",
          "8gb",
          "16gb",
          "32gb",
          "48gb",
          "64gb"
        ],
        "features": [
          "private_networking",
          "backups",
          "ipv6",
          "metadata"
        ],
        "available": true
      },
      "region_slug": "nyc1"
    }
  ],
  "links": {
  },
  "meta": {
    "total": 1
  }
}

Retrieve an existing volume action

To retrieve the status of a volume action, send a GET request to /v2/volumes/$VOLUME_ID/actions/$ACTION_ID.

The response will be an object with a key called action. The value of this will be an object that contains the standard volume action attributes:

NameTypeDescription
idintA unique numeric ID that can be used to identify and reference an action.
statusstringThe current status of the action. This can be "in-progress", "completed", or "errored".
typestringThis is the type of action that the object represents. For example, this could be "attach_volume" to represent the state of a volume attach action.
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnullable intA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionobjectThe region where the resources acted upon are located.
region_slugnullable stringA slug representing the region where the action occurred.

Retrieve an existing volume action

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/volumes/7724db7c-e098-11e5-b522-000f53304e51/actions/72531856"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.volume.actions.find(volume_id: '7724db7c-e098-11e5-b522-000f53304e51', id: 72531856)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

action, _, err := client.StorageActions.Get(ctx, "7724db7c-e098-11e5-b522-000f53304e51", 72531856)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 837
ratelimit-reset: 1415984218

Response Body

{
  "action": {
    "id": 72531856,
    "status": "completed",
    "type": "attach_volume",
    "started_at": "2015-11-12T17:51:03Z",
    "completed_at": "2015-11-12T17:51:14Z",
    "resource_id": null,
    "resource_type": "volume",
    "region": {
      "name": "New York 1",
      "slug": "nyc1",
      "sizes": [
        "1gb",
        "2gb",
        "4gb",
        "8gb",
        "32gb",
        "64gb",
        "512mb",
        "48gb",
        "16gb"
      ],
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata"
      ],
      "available": true
    },
    "region_slug": "nyc1"
  }
}

Certificates

SSL certificates may be uploaded to DigitalOcean where they will be placed in a fully encrypted and isolated storage system. They may then be used to perform SSL termination on Load Balancers.

NameTypeDescription
idstringA unique ID that can be used to identify and reference a certificate.
namestringA unique human-readable name referring to a certificate.
not_afterstringA time value given in ISO8601 combined date and time format that represents the certificate's expiration date.
sha1_fingerprintstringA unique identifier generated from the SHA-1 fingerprint of the certificate.
created_atstringA time value given in ISO8601 combined date and time format that represents when the certificate was created.

Create a new certificate

To upload a new SSL certificate, send a POST request to /v2/certificates. The attribute values that must be set to successfully create a certificate are:

NameTypeDescriptionRequired
namestringA unique human-readable name referring to a certificate.true
private_keystringThe contents of a PEM-formatted private-key corresponding to the SSL certificate.true
leaf_certificatestringThe contents of a PEM-formatted public SSL certificate.true
certificate_chainstringThe full PEM-formatted trust chain between the certificate authority's certificate and your domain's SSL certificate.true

Create a new certificate

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"name":"web-cert-01","private_key": "'"$(</path/to/privkey1.pem)"'","leaf_certificate": "'"$(</path/to/cert1.pem)"'","certificate_chain": "'"$(</path/to/fullchain1.pem)"'"}' "https://api.digitalocean.com/v2/certificates"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

key, err := ioutil.ReadFile("/path/to/privkey1.pem")
if err != nil {
    fmt.Print(err)
}

cert, err := ioutil.ReadFile("/path/to/cert1.pem")
if err != nil {
    fmt.Print(err)
}

chain, err := ioutil.ReadFile("/path/to/fullchain1.pem")
if err != nil {
    fmt.Print(err)
}

createRequest := &godo.CertificateRequest{
    Name:             "web-cert-01",
    PrivateKey:       string(key),
    LeafCertificate:  string(cert),
    CertificateChain: string(chain),
}

certObj, _, err := client.Certificates.Create(ctx, createRequest)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "name": "web-cert-01",
  "private_key": "-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDBIZMz8pnK6V52\nSVf+CYssOfCQHAx5f0Ou5rYbq3xNh8VHAIYJCQ1QxQIxKSP6+uODSYrb2KWyurP1\nDwGb8OYm0J3syEDtCUQik1cpCzpeNlAZ2f8FzXyYQAqPopxdRpsFz8DtZnVvu86X\nwrE4oFPl9MReICmZfBNWylpV5qgFPoXyJ70ZAsTm3cEe3n+LBXEnY4YrVDRWxA3w\nZ2mzZ03HZ1hHrxK9CMnS829U+8sK+UneZpCO7yLRPuxwhmps0wpK/YuZZfRAKF1F\nZRnak/SIQ28rnWufmdg16YqqHgl5JOgnb3aslKRvL4dI2Gwnkd2IHtpZnTR0gxFX\nfqqbQwuRAgMBAAECggEBAILLmkW0JzOkmLTDNzR0giyRkLoIROqDpfLtjKdwm95l\n9NUBJcU4vCvXQITKt/NhtnNTexcowg8pInb0ksJpg3UGE+4oMNBXVi2UW5MQZ5cm\ncVkQqgXkBF2YAY8FMaB6EML+0En2+dGR/3gIAr221xsFiXe1kHbB8Nb2c/d5HpFt\neRpLVJnK+TxSr78PcZA8DDGlSgwvgimdAaFUNO2OqB9/0E9UPyKk2ycdff/Z6ldF\n0hkCLtdYTTl8Kf/OwjcuTgmA2O3Y8/CoQX/L+oP9Rvt9pWCEfuebiOmHJVPO6Y6xgtQVEXwmF1pDHH4Qtz/e6UZTdYeMl9G4aNO2CawwcaYECgYEA57imgSOG4XsJLRhK\nGGncV9R/xhy4AbDWLtAMzQRX4ktvKCaHWyQV2XK2we/cu29NLv2Y89WmerTNPOU+\nP8+pB31uty2ELySVn15QhKpQClVEAlxCnnNjXYrii5LOM80+lVmxvQwxVd8Yz8nj\nIntyioXNBEnYS7V2RxxFGgFun1cCgYEA1V3W+Uyamhq8JS5EY0FhyGcXdHd70K49\nW1ou7McIpncf9tM9acLS1hkI98rd2T69Zo8mKoV1V2hjFaKUYfNys6tTkYWeZCcJ\n3rW44j9DTD+FmmjcX6b8DzfybGLehfNbCw6n67/r45DXIV/fk6XZfkx6IEGO4ODt\nNfnvx4TuI1cCgYBACDiKqwSUvmkUuweOo4IuCxyb5Ee8v98P5JIE/VRDxlCbKbpx\npxEam6aBBQVcDi+n8o0H3WjjlKc6UqbW/01YMoMrvzotxNBLz8Y0QtQHZvR6KoCG\nRKCKstxTcWflzKuknbqN4RapAhNbKBDJ8PMSWfyDWNyaXzSmBdvaidbF1QKBgDI0\no4oD0Xkjg1QIYAUu9FBQmb9JAjRnW36saNBEQS/SZg4RRKknM683MtoDvVIKJk0E\nsAlfX+4SXQZRPDMUMtA+Jyrd0xhj6zmhbwClvDMr20crF3fWdgcqtft1BEFmsuyW\nJUMe5OWmRkjPI2+9ncDPRAllA7a8lnSV/Crph5N/AoGBAIK249temKrGe9pmsmAo\nQbNuYSmwpnMoAqdHTrl70HEmK7ob6SIVmsR8QFAkH7xkYZc4Bxbx4h1bdpozGB+/\nAangbiaYJcAOD1QyfiFbflvI1RFeHgrk7VIafeSeQv6qu0LLMi2zUbpgVzxt78Wg\neTuK2xNR0PIM8OI7pRpgyj1I\n-----END PRIVATE KEY-----",
  "leaf_certificate": "-----BEGIN CERTIFICATE-----\nMIIFFjCCA/6gAwIBAgISA0AznUJmXhu08/89ZuSPC/kRMA0GCSqGSIb3DQEBCwUA\nMEoxCzAJBgNVBAYTAlVTMRYwFAYDVQQKEw1MZXQncyBFbmNyeXB0MSMwIQYDVQQD\nExpMZXQncyBFbmNyeXB0IEF1dGhvcml0eSBYMzAeFw0xNjExMjQwMDIzMDBaFw0x\nNzAyMjIwMDIzMDBaMCQxIjAgBgNVBAMTGWNsb3VkLmFuZHJld3NvbWV0aGluZy5j\nb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDBIZMz8pnK6V52SVf+\nCYssOfCQHAx5f0Ou5rYbq3xNh8VWHIYJCQ1QxQIxKSP6+uODSYrb2KWyurP1DwGb\n8OYm0J3syEDtCUQik1cpCzpeNlAZ2f8FzXyYQAqPopxdRpsFz8DtZnVvu86XwrE4\noFPl9MReICmZfBNWylpV5qgFPoXyJ70ZAsTm3cEe3n+LBXEnY4YrVDRWxA3wZ2mz\nZ03HZ1hHrxK9CMnS829U+8sK+UneZpCO7yLRPuxwhmps0wpK/YuZZfRAKF1FZRna\nk/SIQ28rnWufmdg16YqqHgl5JOgnb3aslKRvL4dI2Gwnkd2IHtpZnTR0gxFXfqqb\nQwuRAgMBAAGjggIaMIICFjAOBgNVHQ8BAf8EBAMCBaAwHQYDVR0lBBYwFAYIKwYB\nBQUHAwEGCCsGAQUFBwMCMAwGA1UdEwEB/wQCMAAwHQYDVR0OBBYEFLsAFcxAhFX1\nMbCnzr9hEO5rL4jqMB8GA1UdIwQYMBaAFKhKamMEfd265tE5t6ZFZe/zqOyhMHAG\nCCsGAQUFBwEBBGQwYjAvBggrBgEFBQcwAYYjaHR0cDovL29jc3AuaW50LXgzLmxl\ndHNlbmNyeXB0Lm9yZy8wLwYIKwYBBQUHMAKGI2h0dHA6Ly9jZXJ0LmludC14My5s\nZXRzZW5jcnlwdC5vcmcvMCQGA1UdEQQdMBuCGWNsb3VkLmFuZHJld3NvbWV0aGlu\nZy5jb20wgf4GA1UdIASB9jCB8zAIBgZngQwBAgWrgeYGCysGAQQBgt8TAQEBMIHW\nMCYGCCsGAQUFBwIBFhpodHRwOi8vY3BzLmxldHNlbmNyeXB0Lm9yZzCBqwYIKwYB\nBQUHAgIwgZ4MgZtUaGlzIENlcnRpZmljYXRlIG1heSBvbmx5IGJlIHJlbGllZCB1\ncG9uIGJ5IFJlbHlpbmcgUGFydGllcyBhbmQgb25seSQ2ziBhY2NvcmRhbmNlIHdp\ndGggdGhlIENlcnRpZmljYXRlIFBvbGljeSBmb3VuZCBhdCBodHRwczovL2xldHNl\nbmNyeXB0Lm9yZy9yZXBvc2l0b3J5LzANBgkqhkiG9w0BAQsFAAOCAQEAOZVQvrjM\nPKXLARTjB5XsgfyDN3/qwLl7SmwGkPe+B+9FJpfScYG1JzVuCj/SoaPaK34G4x/e\niXwlwOXtMOtqjQYzNu2Pr2C+I+rVmaxIrCUXFmC205IMuUBEeWXG9Y/HvXQLPabD\nD3Gdl5+Feink9SDRP7G0HaAwq13hI7ARxkL9p+UIY39X0dV3WOboW2Re8nrkFXJ7\nq9Z6shK5QgpBfsLjtjNsQzaGV3ve1gOg25aTJGearBWOvEjJNA1wGMoKVXOtYwm/\nWyWoVdCQ8HmconcbJB6xc0UZ1EjvzRr5ZIvSa5uHZD0L3m7/kpPWlAlFJ7hHASPu\nUlF1zblDmg2Iaw==\n-----END CERTIFICATE-----",
  "certificate_chain": "-----BEGIN CERTIFICATE-----\nMIIFFjCCA/6gAwIBAgISA0AznUJmXhu08/89ZuSPC/kRMA0GCSqGSIb3DQEBCwUA\nMEoxCzAJBgNVBAYTAlVTMRYwFAYDVQQKEw1MZXQncyBFbmNyeXB0MSMwIQYDVQQD\nExpMZXQncyBFbmNyeXB0IEF1dGhvcml0eSBYMzAeFw0xNjExMjQwMDIzMDBaFw0x\nNzAyMjIwMDIzMDBaMCQxIjAgBgNVBAMTGWNsb3VkLmFuZHJld3NvbWV0aGluZy5j\nb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDBIZMz7tnK6V52SVf+\nCYssOfCQHAx5f0Ou5rYbq3xNh8VHAIYJCQ1QxQIxKSP6+uODSYrb2KWyurP1DwGb\n8OYm0J3syEDtCUQik1cpCzpeNlAZ2f8FzXyYQAqPopxdRpsFz8DtZnVvu86XwrE4\noFPl9MReICmZfBNWylpV5qgFPoXyJ70ZAsTm3cEe3n+LBXEnY4YrVDRWxA3wZ2mz\nZ03HZ1hHrxK9CMnS829U+8sK+UneZpCO7yLRPuxwhmps0wpK/YuZZfRAKF1FZRna\nk/SIQ28rnWufmdg16YqqHgl5JOgnb3aslKRvL4dI2Gwnkd2IHtpZnTR0gxFXfqqb\nQwuRAgMBAAGjggIaMIICFjAOBgNVHQ8BAf8EBAMCBaAwHQYDVR0lBBYwFAYIKwYB\nBQUHAwEGCCsGAQUFBwMCMAwGA1UdEwEB/wQCMAAwHQYDVR0OBBYEFLsAFcxAhFX1\nMbCnzr9hEO5rL4jqMB8GA1UdIwQYMBaAFKhKamMEfd265tE5t6ZFZe/zqOyhMHAG\nCCsGAQUFBwEBBGQwYjAvBggrBgEFBQcwAYYjaHR0cDovL29jc3AuaW50LXgzLmxl\ndHNlbmNyeXB0Lm9yZy8wLwYIKwYBBQUHMAKGI2h0dHA6Ly9jZXJ0LmludC14My5s\nZXRzZW5jcnlwdC5vcmcvMCQGA1UdEQQdMBuCGWNsb3VkLmFuZHJld3NvbWV0aGlu\nZy5jb20wgf4GA1UdIASB9jCB8zAIBgZngQwBAgEwgeWECysGAQQBgt8TAQEBMIHW\nMCYGCCsGAQUFBwIBFhpodHRwOi8vY3BzLmxldHNlbmNyeXB0Lm9yZzCBqwYIKwYB\nBQUHAgIwgZ4MgZtUaGlzIENlcnRpZmljYXRlIG1heSBvbmx5IGJlIHJlbGllZCB1\ncG9uIGJ5IFJlbHlpbmcgUGFydGllcyBhbmQgb25seSQ2ziBhY2NvcmRhbmNlIHdp\ndGggdGhlIENlcnRpZmljYXRlIFBvbGljeSBmb3VuZCBhdCBsdHRwczovL2xldHNl\nbmNyeXB0Lm9yZy9yZXBvc2l0b3J5LzANBgkqhkiG9w0BAQsFAAOCAQEAOZVQvrjM\nPKXLARTjB5XsgfyDN3/qwLl7SmwGkPe+B+9FJpfScYG1JzVuCj/SoaPaK34G4x/e\niXwlwOXtMOtqjQYzNu2Pr2C+I+rVmaxIrCUXFmC205IMuUBEeWXG9Y/HvXQLPabD\nD3Gdl5+Feink9SDRP7G0HaAwq13hI7ARxkL3o+UIY39X0dV3WOboW2Re8nrkFXJ7\nq9Z6shK5QgpBfsLjtjNsQzaGV3ve1gOg25aTJGearBWOvEjJNA1wGMoKVXOtYwm/\nWyWoVdCQ8HmconcbJB6xc0UZ1EjvzRr5ZIvSa5uHZD0L3m7/kpPWlAlFJ7hHASPu\nUlF1zblDmg2Iaw==\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIEkjCCA3qgAwIBAgIQCgFBQgAAAVOFc2oLheynCDANBgkqhkiG9w0BAQsFADA/\nMSQwIgYDVQQKExtEaWdpdGFsIFNpZ25hdHVyZSBUcnVzdCBDby4xFzAVBgNVBAMT\nDkRTVCBSb290IENBIFgzMB4XDTE2MDMxNzE2NDA0NloXDTIxMDMxNzE2NDA0Nlow\nSjELMAkGA1UEBhMCVVMxFjAUBgNVBAoTDUxldCdzIEVuY3J5cHQxIzAhBgNVBAMT\nGkxldCdzIEVuY3J5cHQgQXV0aG9yaXR5IFgzMIIBIjANBgkqhkiG9w0BAQEFAAOC\nAQ8AMIIBCgKCAQEAnNMM8FrlLsd3cl03g7NoYzDq1zUmGSXhvb418XCSL7e4S0EF\nq6meNQhY7LEqxGiHC6PjdeTm86dicbp5gWAf15Gan/PQeGdxyGkOlZHP/uaZ6WA8\nSMx+yk13EiSdRxta67nsHjcAHJyse6cF6s5K671B5TaYucv9bTyWaN8jKkKQDIZ0\nZ8h/pZq4UmEUEz9l6YKHy9v6Dlb2honzhT+Xhq+w3Brvaw2VFn3EK6BlspkENnWA\na6xK8xuQSXgvopZPKiAlKQTGdMDQMc2PMTiVFrqoM7hD8bEfwzB/onkxEz0tNvjj\n/PIzark5McWvxI0NHWQWM6r6hCm21AvA2H3DkwIPOIUo4IBfTCCAXkwEgYDVR0T\nAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwfwYIKwYBBQUHAQEEczBxMDIG\nCCsGAQUFBzABhiZodHRwOi8vaXNyZy50cnVzdGlkLm9jc3AuaWRlbnRydXN0LmNv\nbTA7BggrBgEFBQcwAoYvaHR0cDovL2FwcHMuaWRlbnRydXN0LmNvbS9yb290cy9k\nc3Ryb290Y2F4My5wN2MwHwYDVR0jBBgwFoAUxKexpHsscfrb4UuQdf/EFWCFiRAw\nVAYDVR0gBE0wSzAIBgZngQwBAgEwPwYLKwYBBAGC3xMBAQEwMDAuBggrBgEFBQcC\nARYiaHR0cDovL2Nwcy5yb290LXgxLmxldHNlbmNyeXB0Lm9yZzA8BgNVHR8ENTAz\nMDGgL6AthitodHRwOi8vY3JsLmlkZW50cnVzdC5jb20vRFNUUk9PVENBWDNDUkwu\nY3JsMB0GA1UdDgQWBBSoSmpjBH3duubRObemRWXv86jsoTANBgkqhkiG9w0BAQsF\nAAOCAQEA3TPXEfNjWDjdGBX7CVW+dla5cEilaUcne8IkCJLxWh9KEik3JHRRHGJo\nuM2VcGfl96S8TihRzZvoroed6ti6WqEBmtzw3Wodatg+VyOeph4EYpr/1wXKtx8/\nwApIvJSwtmVi4MFU5aMqrSDE6ea73Mj2tcMyo5jMd6jmeWUHK8so/joWUoHOUgwu\nX4Po1QYz+3dszkDqMp4fklxBwXRsW10KXzPMTZ+sOPAveyxindmjkW8lGy+QsRlG\nPfZ+G6Z6h7mjem0Y+iWlkYcV4PIWL1iwBi8saCbGS5jN2p8M+X+Q7UNKEkROb3N6\nKOqkqm57TH2H3eDJAkSnh6/DNFu0Qg==\n-----END CERTIFICATE-----"
}

Response Headers

content-type: application/json; charset=utf-8
status: 201 Created
ratelimit-limit: 5000
ratelimit-remaining: 4823
ratelimit-reset: 1444931833

Response Body

{
  "certificate": {
    "id": "892071a0-bb95-49bc-8021-3afd67a210bf",
    "name": "web-cert-01",
    "not_after": "2017-02-22T00:23:00Z",
    "sha1_fingerprint": "dfcc9f57d86bf58e321c2c6c31c7a971be244ac7",
    "created_at": "2017-02-08T16:02:37Z"
  }
}

Retrieve an existing certificate

To show information about an existing certificate, send a GET request to /v2/certificates/$CERTIFICATE_ID.

The response will be a JSON object with a certificate key. This will be set to an object containing the standard certificate attributes:

NameTypeDescription
idstringA unique ID that can be used to identify and reference a certificate.
namestringA unique human-readable name referring to a certificate.
not_afterstringA time value given in ISO8601 combined date and time format that represents the certificate's expiration date.
sha1_fingerprintstringA unique identifier generated from the SHA-1 fingerprint of the certificate.
created_atstringA time value given in ISO8601 combined date and time format that represents when the certificate was created.

Retrieve an existing certificate

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/certificates/892071a0-bb95-49bc-8021-3afd67a210bf"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

cert, _, err := client.Certificates.Get(ctx, "892071a0-bb95-49bc-8021-3afd67a210bf")

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 1123
ratelimit-reset: 1415984218

Response Body

{
  "certificate": {
    "id": "892071a0-bb95-49bc-8021-3afd67a210bf",
    "name": "web-cert-01",
    "not_after": "2017-02-22T00:23:00Z",
    "sha1_fingerprint": "dfcc9f57d86bf58e321c2c6c31c7a971be244ac7",
    "created_at": "2017-02-08T16:02:37Z"
  }
}

List all certificates

To list all of the certificates available on your account, send a GET request to /v2/certificates.

The result will be a JSON object with a certificates key. This will be set to an array of certificate objects, each of which will contain the standard certificate attributes:

NameTypeDescription
idstringA unique ID that can be used to identify and reference a certificate.
namestringA unique human-readable name referring to a certificate.
not_afterstringA time value given in ISO8601 combined date and time format that represents the certificate's expiration date.
sha1_fingerprintstringA unique identifier generated from the SHA-1 fingerprint of the certificate.
created_atstringA time value given in ISO8601 combined date and time format that represents when the certificate was created.

List all certificates

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/certificates"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

opt := &godo.ListOptions{
    Page:    1,
    PerPage: 200,
}

certs, _, err := client.Certificates.List(ctx, opt)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 5000
ratelimit-remaining: 4816
ratelimit-reset: 1444931833

Response Body

{
  "certificates": [
    {
      "id": "892071a0-bb95-49bc-8021-3afd67a210bf",
      "name": "web-cert-01",
      "not_after": "2017-02-22T00:23:00Z",
      "sha1_fingerprint": "dfcc9f57d86bf58e321c2c6c31c7a971be244ac7",
      "created_at": "2017-02-08T16:02:37Z"
    }
  ],
  "links": {
  },
  "meta": {
    "total": 1
  }
}

Delete a certificate

To delete a specific certificate, send a DELETE request to /v2/certificates/$CERTIFICATE_ID.

A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.

Delete a certificate

cURL Example

curl -X DELETE -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/certificates/892071a0-bb95-49bc-8021-3afd67a210bf"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

_, err := client.Certificates.Delete(ctx, "892071a0-bb95-49bc-8021-3afd67a210bf")

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 204 No Content
ratelimit-limit: 5000
ratelimit-remaining: 4823
ratelimit-reset: 1444931833

Domains

Domain resources are domain names that you have purchased from a domain name registrar that you are managing through the DigitalOcean DNS interface.

This resource establishes top-level control over each domain. Actions that affect individual domain records should be taken on the [Domain Records] resource.

NameTypeDescription
namestringThe name of the domain itself. This should follow the standard domain format of domain.TLD. For instance, example.com is a valid domain name.
ttlnumberThis value is the time to live for the records on this domain, in seconds. This defines the time frame that clients can cache queried information before a refresh should be requested.
zone_filestringThis attribute contains the complete contents of the zone file for the selected domain. Individual domain record resources should be used to get more granular control over records. However, this attribute can also be used to get information about the SOA record, which is created automatically and is not accessible as an individual record resource.

List all Domains

To retrieve a list of all of the domains in your account, send a GET request to /v2/domains.

The response will be a JSON object with a key called domains. The value of this will be an array of Domain objects, each of which contain the standard domain attributes:

NameTypeDescription
namestringThe name of the domain itself. This should follow the standard domain format of domain.TLD. For instance, example.com is a valid domain name.
ttlnumberThis value is the time to live for the records on this domain, in seconds. This defines the time frame that clients can cache queried information before a refresh should be requested.
zone_filestringThis attribute contains the complete contents of the zone file for the selected domain. Individual domain record resources should be used to get more granular control over records. However, this attribute can also be used to get information about the SOA record, which is created automatically and is not accessible as an individual record resource.

List all Domains

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/domains"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

domains = client.domains.all
domains.each

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

opt := &godo.ListOptions{
    Page:    1,
    PerPage: 200,
}

domains, _, err := client.Domains.List(ctx, opt)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 1115
ratelimit-reset: 1415984218

Response Body

{
  "domains": [
    {
      "name": "example.com",
      "ttl": 1800,
      "zone_file": "$ORIGIN example.com.\n$TTL 1800\nexample.com. IN SOA ns1.digitalocean.com. hostmaster.example.com. 1415982609 10800 3600 604800 1800\nexample.com. 1800 IN NS ns1.digitalocean.com.\nexample.com. 1800 IN NS ns2.digitalocean.com.\nexample.com. 1800 IN NS ns3.digitalocean.com.\nexample.com. 1800 IN A 1.2.3.4\n"
    }
  ],
  "links": {
  },
  "meta": {
    "total": 1
  }
}

Create a new Domain

To create a new domain, send a POST request to /v2/domains. Set the "name" attribute to the domain name you are adding. Set the "ip_address" attribute to the IP address you want to point the domain to.

NameTypeDescriptionRequired
namestringThe domain name to add to the DigitalOcean DNS management interface. The name must be unique in DigitalOcean's DNS system. The request will fail if the name has already been taken.true
ip_addressstringThis attribute contains the IP address you want the domain to point to.true

The response will be a JSON object with a key called domain. The value of this will be an object that contains the standard attributes associated with a domain:

NameTypeDescription
namestringThe name of the domain itself. This should follow the standard domain format of domain.TLD. For instance, example.com is a valid domain name.
ttlnumberThis value is the time to live for the records on this domain, in seconds. This defines the time frame that clients can cache queried information before a refresh should be requested.
zone_filestringThis attribute contains the complete contents of the zone file for the selected domain. Individual domain record resources should be used to get more granular control over records. However, this attribute can also be used to get information about the SOA record, which is created automatically and is not accessible as an individual record resource.

Keep in mind that, upon creation, the zone_file field will have a value of null until a zone file is generated and propagated through an automatic process on the DigitalOcean servers.

Create a new Domain

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"name":"example.com","ip_address":"1.2.3.4"}' "https://api.digitalocean.com/v2/domains"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

domain = DropletKit::Domain.new(
  name: 'example.com',
  ip_address: '1.2.3.4'
)
client.domains.create(domain)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

createRequest := &godo.DomainCreateRequest{
    Name:      "example.com",
    IPAddress: "1.2.3.4",
}

domain, _, err := client.Domains.Create(ctx, createRequest)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "name": "example.com",
  "ip_address": "1.2.3.4"
}

Response Headers

content-type: application/json; charset=utf-8
status: 201 Created
ratelimit-limit: 1200
ratelimit-remaining: 1113
ratelimit-reset: 1415984218

Response Body

{
  "domain": {
    "name": "example.com",
    "ttl": 1800,
    "zone_file": null
  }
}

Retrieve an existing Domain

To get details about a specific domain, send a GET request to /v2/domains/$DOMAIN_NAME.

The response will be a JSON object with a key called domain. The value of this will be an object that contains the standard attributes defined for a domain:

NameTypeDescription
namestringThe name of the domain itself. This should follow the standard domain format of domain.TLD. For instance, example.com is a valid domain name.
ttlnumberThis value is the time to live for the records on this domain, in seconds. This defines the time frame that clients can cache queried information before a refresh should be requested.
zone_filestringThis attribute contains the complete contents of the zone file for the selected domain. Individual domain record resources should be used to get more granular control over records. However, this attribute can also be used to get information about the SOA record, which is created automatically and is not accessible as an individual record resource.

Retrieve an existing Domain

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/domains/example.com"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.domains.find(name: 'example.com')

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

domain, _, err := client.Domains.Get(ctx, "example.com")

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 1112
ratelimit-reset: 1415984218

Response Body

{
  "domain": {
    "name": "example.com",
    "ttl": 1800,
    "zone_file": "$ORIGIN example.com.\n$TTL 1800\nexample.com. IN SOA ns1.digitalocean.com. hostmaster.example.com. 1415982611 10800 3600 604800 1800\nexample.com. 1800 IN NS ns1.digitalocean.com.\nexample.com. 1800 IN NS ns2.digitalocean.com.\nexample.com. 1800 IN NS ns3.digitalocean.com.\nexample.com. 1800 IN A 1.2.3.4\n"
  }
}

Delete a Domain

To delete a domain, send a DELETE request to /v2/domains/$DOMAIN_NAME.

The domain will be removed from your account and a response status of 204 will be returned. This indicates a successful request with no response body.

Delete a Domain

cURL Example

curl -X DELETE -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/domains/example.com"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.domains.delete(name: 'example.com')

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

_, err := client.Domains.Delete(ctx, "example.com")

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

status: 204 No Content
ratelimit-limit: 1200
ratelimit-remaining: 1111
ratelimit-reset: 1415984218

Domain Records

Domain record resources are used to set or retrieve information about the individual DNS records configured for a domain. This allows you to build and manage DNS zone files by adding and modifying individual records for a domain.

The DigitalOcean DNS management interface allows you to configure the following DNS records:

There is also an additional field called id that is auto-assigned for each record and used as a unique identifier for requests. Each record contains all of these attribute types. For record types that do not utilize all fields, a value of null will be set for that record.

NameTypeDescription
idnumberA unique identifier for each domain record.
typestringThe type of the DNS record (ex: A, CNAME, TXT, ...).
namestringThe name to use for the DNS record.
datastringThe value to use for the DNS record.
prioritynullable numberThe priority for SRV and MX records.
portnullable numberThe port for SRV records.
weightnullable numberThe weight for SRV records.

List all Domain Records

To get a listing of all records configured for a domain, send a GET request to /v2/domains/$DOMAIN_NAME/records.

The response will be a JSON object with a key called domain_records. The value of this will be an array of domain record objects, each of which contains the standard domain record attributes:

For attributes that are not used by a specific record type, a value of null will be returned. For instance, all records other than SRV will have null for the weight and port attributes.

NameTypeDescription
idnumberA unique identifier for each domain record.
typestringThe type of the DNS record (ex: A, CNAME, TXT, ...).
namestringThe name to use for the DNS record.
datastringThe value to use for the DNS record.
prioritynullable numberThe priority for SRV and MX records.
portnullable numberThe port for SRV records.
weightnullable numberThe weight for SRV records.

List all Domain Records

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/domains/example.com/records"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

records = client.domain_records.all(for_domain: 'example.com')
records.each

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

opt := &godo.ListOptions{
    Page:    1,
    PerPage: 1,
}

records, _, err := client.Domains.Records(ctx, "example.com", opt)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 1121
ratelimit-reset: 1415984218

Response Body

{
  "domain_records": [
    {
      "id": 3352892,
      "type": "NS",
      "name": "@",
      "data": "ns1.digitalocean.com",
      "priority": null,
      "port": null,
      "weight": null
    },
    {
      "id": 3352893,
      "type": "NS",
      "name": "@",
      "data": "ns2.digitalocean.com",
      "priority": null,
      "port": null,
      "weight": null
    },
    {
      "id": 3352894,
      "type": "NS",
      "name": "@",
      "data": "ns3.digitalocean.com",
      "priority": null,
      "port": null,
      "weight": null
    },
    {
      "id": 3352895,
      "type": "A",
      "name": "@",
      "data": "1.2.3.4",
      "priority": null,
      "port": null,
      "weight": null
    }
  ],
  "links": {
  },
  "meta": {
    "total": 4
  }
}

Create a new Domain Record

To create a new record to a domain, send a POST request to /v2/domains/$DOMAIN_NAME/records.

The request must include all of the required fields for the domain record type being added. The required attributes per domain record type:

NameTypeDescriptionRequired
typestringThe record type (A, MX, CNAME, etc).All Records
namestringThe host name, alias, or service being defined by the record.A, AAAA, CNAME, TXT, SRV
datastringVariable data depending on record type. See the [Domain Records]() section for more detail on each record type.A, AAAA, CNAME, MX, TXT, SRV, NS
prioritynullable numberThe priority of the host (for SRV and MX records. null otherwise).MX, SRV
portnullable numberThe port that the service is accessible on (for SRV records only. null otherwise).SRV
weightnullable numberThe weight of records with the same priority (for SRV records only. null otherwise).SRV

The response body will be a JSON object with a key called domain_record. The value of this will be an object representing the new record. Attributes that are not applicable for the record type will be set to null. An id attribute is generated for each record as part of the object.

NameTypeDescription
idnumberA unique identifier for each domain record.
typestringThe type of the DNS record (ex: A, CNAME, TXT, ...).
namestringThe name to use for the DNS record.
datastringThe value to use for the DNS record.
prioritynullable numberThe priority for SRV and MX records.
portnullable numberThe port for SRV records.
weightnullable numberThe weight for SRV records.

Create a new Domain Record

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"type":"A","name":"www","data":"162.10.66.0","priority":null,"port":null,"weight":null}' "https://api.digitalocean.com/v2/domains/example.com/records"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

record = DropletKit::DomainRecord.new(
  type: 'A',
  name: 'www',
  data: '162.10.66.0'
)
client.domain_records.create(record, for_domain: 'example.com')

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

createRequest := &godo.DomainRecordEditRequest{
    Type: "A",
    Name: "www",
    Data: "1.2.3.4",
}

domainRecord, _, err := client.Domains.CreateRecord(ctx, "example.com", createRequest)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "type": "A",
  "name": "www",
  "data": "162.10.66.0",
  "priority": null,
  "port": null,
  "weight": null
}

Response Headers

content-type: application/json; charset=utf-8
status: 201 Created
ratelimit-limit: 1200
ratelimit-remaining: 1120
ratelimit-reset: 1415984218

Response Body

{
  "domain_record": {
    "id": 3352896,
    "type": "A",
    "name": "www",
    "data": "162.10.66.0",
    "priority": null,
    "port": null,
    "weight": null
  }
}

Retrieve an existing Domain Record

To retrieve a specific domain record, send a GET request to /v2/domains/$DOMAIN_NAME/records/$RECORD_ID.

The response will be a JSON object with a key called domain_record. The value of this will be an object that contains all of the standard domain record attributes:

NameTypeDescription
idnumberA unique identifier for each domain record.
typestringThe type of the DNS record (ex: A, CNAME, TXT, ...).
namestringThe name to use for the DNS record.
datastringThe value to use for the DNS record.
prioritynullable numberThe priority for SRV and MX records.
portnullable numberThe port for SRV records.
weightnullable numberThe weight for SRV records.

Retrieve an existing Domain Record

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/domains/example.com/records/3352896"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.domain_records.find(for_domain: 'example.com', id: 3352896)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

record, _, err := client.Domains.Record(ctx, "example.com", 3352896)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 1119
ratelimit-reset: 1415984218

Response Body

{
  "domain_record": {
    "id": 3352896,
    "type": "A",
    "name": "www",
    "data": "162.10.66.0",
    "priority": null,
    "port": null,
    "weight": null
  }
}

Update a Domain Record

To update an existing record, send a PUT request to /v2/domains/$DOMAIN_NAME/records/$RECORD_ID. Any attribute valid for the record type can be set to a new value for the record.

NameTypeDescriptionRequired
typestringThe record type (A, MX, CNAME, etc).All Records
namestringThe host name, alias, or service being defined by the record.A, AAAA, CNAME, TXT, SRV
datastringVariable data depending on record type. See the [Domain Records]() section for more detail on each record type.A, AAAA, CNAME, MX, TXT, SRV, NS
prioritynullable numberThe priority of the host (for SRV and MX records. null otherwise).MX, SRV
portnullable numberThe port that the service is accessible on (for SRV records only. null otherwise).SRV
weightnullable numberThe weight of records with the same priority (for SRV records only. null otherwise).SRV

The response will be a JSON object with a key called domain_record. The value of this will be a domain record object which contains the standard domain record attributes:

NameTypeDescription
idnumberA unique identifier for each domain record.
typestringThe type of the DNS record (ex: A, CNAME, TXT, ...).
namestringThe name to use for the DNS record.
datastringThe value to use for the DNS record.
prioritynullable numberThe priority for SRV and MX records.
portnullable numberThe port for SRV records.
weightnullable numberThe weight for SRV records.

Update a Domain Record

cURL Example

curl -X PUT -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"name":"blog"}' "https://api.digitalocean.com/v2/domains/example.com/records/3352896"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

record = DropletKit::DomainRecord.new(name: 'blog')
client.domain_records.update(record, for_domain: 'example.com', id: 3352896)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

editRequest := &godo.DomainRecordEditRequest{
    Type: "A",
    Name: "blog",
}

domainRecord, _, err := client.Domains.EditRecord(ctx, "example.com", 3352896, editRequest)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "name": "blog"
}

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 1118
ratelimit-reset: 1415984218

Response Body

{
  "domain_record": {
    "id": 3352896,
    "type": "A",
    "name": "blog",
    "data": "162.10.66.0",
    "priority": null,
    "port": null,
    "weight": null
  }
}

Delete a Domain Record

To delete a record for a domain, send a DELETE request to /v2/domains/$DOMAIN_NAME/records/$RECORD_ID.

The record will be deleted and the response status will be a 204. This indicates a successful request with no body returned.

Delete a Domain Record

cURL Example

curl -X DELETE -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/domains/example.com/records/3352896"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.domain_records.delete(for_domain: 'example.com', id: 3352896)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

_, err := client.Domains.DeleteRecord(ctx, "example.com", 3352896)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/octet-stream
status: 204 No Content
ratelimit-limit: 1200
ratelimit-remaining: 1117
ratelimit-reset: 1415984218

Droplets

A Droplet is a DigitalOcean virtual machine. By sending requests to the Droplet endpoint, you can list, create, or delete Droplets.

Some of the attributes will have an object value. The region and image objects will all contain the standard attributes of their associated types. Find more information about each of these objects in their respective sections.

NameTypeDescription
idnumberA unique identifier for each Droplet instance. This is automatically generated upon Droplet creation.
namestringThe human-readable name set for the Droplet instance.
memorynumberMemory of the Droplet in megabytes.
vcpusnumberThe number of virtual CPUs.
disknumberThe size of the Droplet's disk in gigabytes.
lockedbooleanA boolean value indicating whether the Droplet has been locked, preventing actions by users.
created_atstringA time value given in ISO8601 combined date and time format that represents when the Droplet was created.
statusstringA status string indicating the state of the Droplet instance. This may be "new", "active", "off", or "archive".
backup_idsarrayAn array of backup IDs of any backups that have been taken of the Droplet instance. Droplet backups are enabled at the time of the instance creation.
snapshot_idsarrayAn array of snapshot IDs of any snapshots created from the Droplet instance.
featuresarrayAn array of features enabled on this Droplet.
regionobjectThe region that the Droplet instance is deployed in. When setting a region, the value should be the slug identifier for the region. When you query a Droplet, the entire region object will be returned.
imageobjectThe base image used to create the Droplet instance. When setting an image, the value is set to the image id or slug. When querying the Droplet, the entire image object will be returned.
sizeobjectThe current size object describing the Droplet. When setting a size, the value is set to the size slug. When querying the Droplet, the entire size object will be returned. Note that the disk volume of a droplet may not match the size's disk due to Droplet resize actions. The disk attribute on the Droplet should always be referenced.
size_slugstringThe unique slug identifier for the size of this Droplet.
networksobjectThe details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is.
kernelnullable objectThe current kernel. This will initially be set to the kernel of the base image when the Droplet is created.
next_backup_windownullable objectThe details of the Droplet's backups feature, if backups are configured for the Droplet. This object contains keys for the start and end times of the window during which the backup will start.
tagsarrayAn array of Tags the Droplet has been tagged with.
volume_idsarrayA flat array including the unique identifier for each Block Storage volume attached to the Droplet.

Create a new Droplet

To create a new Droplet, send a POST request to /v2/droplets.

The attribute values that must be set to successfully create a Droplet are:

NameTypeDescriptionRequired
nameStringThe human-readable string you wish to use when displaying the Droplet name. The name, if set to a domain name managed in the DigitalOcean DNS management system, will configure a PTR record for the Droplet. The name set during creation will also determine the hostname for the Droplet in its internal configuration.true
regionStringThe unique slug identifier for the region that you wish to deploy in.true
sizeStringThe unique slug identifier for the size that you wish to select for this Droplet.true
imagenumber (if using an image ID), or String (if using a public image slug)The image ID of a public or private image, or the unique slug identifier for a public image. This image will be the base image for your Droplet.true
ssh_keysArrayAn array containing the IDs or fingerprints of the SSH keys that you wish to embed in the Droplet's root account upon creation.
backupsBooleanA boolean indicating whether automated backups should be enabled for the Droplet. Automated backups can only be enabled when the Droplet is created.
ipv6BooleanA boolean indicating whether IPv6 is enabled on the Droplet.
private_networkingBooleanA boolean indicating whether private networking is enabled for the Droplet. Private networking is currently only available in certain regions.
user_dataStringA string containing 'user data' which may be used to configure the Droplet on first boot, often a 'cloud-config' file or Bash script. It must be plain text and may not exceed 64 KiB in size.
monitoringBooleanA boolean indicating whether to install the DigitalOcean agent for monitoring.
volumesArrayA flat array including the unique string identifier for each Block Storage volume to be attached to the Droplet. At the moment a volume can only be attached to a single Droplet.
tagsArrayA flat array of tag names as strings to apply to the Droplet after it is created. Tag names can either be existing or new tags.

A Droplet will be created using the provided information. The response body will contain a JSON object with a key called droplet. The value will be an object containing the standard attributes for your new Droplet:

NameTypeDescription
idnumberA unique identifier for each Droplet instance. This is automatically generated upon Droplet creation.
namestringThe human-readable name set for the Droplet instance.
memorynumberMemory of the Droplet in megabytes.
vcpusnumberThe number of virtual CPUs.
disknumberThe size of the Droplet's disk in gigabytes.
lockedbooleanA boolean value indicating whether the Droplet has been locked, preventing actions by users.
created_atstringA time value given in ISO8601 combined date and time format that represents when the Droplet was created.
statusstringA status string indicating the state of the Droplet instance. This may be "new", "active", "off", or "archive".
backup_idsarrayAn array of backup IDs of any backups that have been taken of the Droplet instance. Droplet backups are enabled at the time of the instance creation.
snapshot_idsarrayAn array of snapshot IDs of any snapshots created from the Droplet instance.
featuresarrayAn array of features enabled on this Droplet.
regionobjectThe region that the Droplet instance is deployed in. When setting a region, the value should be the slug identifier for the region. When you query a Droplet, the entire region object will be returned.
imageobjectThe base image used to create the Droplet instance. When setting an image, the value is set to the image id or slug. When querying the Droplet, the entire image object will be returned.
sizeobjectThe current size object describing the Droplet. When setting a size, the value is set to the size slug. When querying the Droplet, the entire size object will be returned. Note that the disk volume of a droplet may not match the size's disk due to Droplet resize actions. The disk attribute on the Droplet should always be referenced.
size_slugstringThe unique slug identifier for the size of this Droplet.
networksobjectThe details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is.
kernelnullable objectThe current kernel. This will initially be set to the kernel of the base image when the Droplet is created.
next_backup_windownullable objectThe details of the Droplet's backups feature, if backups are configured for the Droplet. This object contains keys for the start and end times of the window during which the backup will start.
tagsarrayAn array of Tags the Droplet has been tagged with.
volume_idsarrayA flat array including the unique identifier for each Block Storage volume attached to the Droplet.

Create a new Droplet

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"name":"example.com","region":"nyc3","size":"512mb","image":"ubuntu-14-04-x64","ssh_keys":null,"backups":false,"ipv6":true,"user_data":null,"private_networking":null,"volumes": null,"tags":["web"]}' "https://api.digitalocean.com/v2/droplets"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

droplet = DropletKit::Droplet.new(
  name: 'example.com',
  region: 'nyc3',
  size: '512mb',
  image: 'ubuntu-14-04-x64',
  ipv6: true,
  tags: ["web"]
)
client.droplets.create(droplet)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

createRequest := &godo.DropletCreateRequest{
    Name:   "example.com",
    Region: "nyc3",
    Size:   "512mb",
    Image: godo.DropletCreateImage{
        Slug: "ubuntu-14-04-x64",
    },
    IPv6: true,
    Tags: []string{"web"},
}

droplet, _, err := client.Droplets.Create(ctx, createRequest)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "name": "example.com",
  "region": "nyc3",
  "size": "512mb",
  "image": "ubuntu-14-04-x64",
  "ssh_keys": null,
  "backups": false,
  "ipv6": true,
  "user_data": null,
  "private_networking": null,
  "volumes": null,
  "tags": [
    "web"
  ]
}

Response Headers

content-type: application/json; charset=utf-8
status: 202 Accepted
ratelimit-limit: 1200
ratelimit-remaining: 965
ratelimit-reset: 1415984218

Response Body

{
  "droplet": {
    "id": 3164494,
    "name": "example.com",
    "memory": 512,
    "vcpus": 1,
    "disk": 20,
    "locked": true,
    "status": "new",
    "kernel": {
      "id": 2233,
      "name": "Ubuntu 14.04 x64 vmlinuz-3.13.0-37-generic",
      "version": "3.13.0-37-generic"
    },
    "created_at": "2014-11-14T16:36:31Z",
    "features": [
      "virtio"
    ],
    "backup_ids": [

    ],
    "snapshot_ids": [

    ],
    "image": {
    },
    "volume_ids": [

    ],
    "size": {
    },
    "size_slug": "512mb",
    "networks": {
    },
    "region": {
    },
    "tags": [
      "web"
    ]
  },
  "links": {
    "actions": [
      {
        "id": 36805096,
        "rel": "create",
        "href": "https://api.digitalocean.com/v2/actions/36805096"
      }
    ]
  }
}

Create multiple Droplets

To create multiple Droplets, send a POST request to /v2/droplets.

Creating multiple Droplets is very similar to creating a single Droplet, but instead of sending name as a string, send names as an array. Up to ten Droplets may be created at a time. The possible fields are:

NameTypeDescriptionRequired
namesArrayAn array of human human-readable strings you wish to use when displaying the Droplet name. Each name, if set to a domain name managed in the DigitalOcean DNS management system, will configure a PTR record for the Droplet. Each name set during creation will also determine the hostname for the Droplet in its internal configuration.true
regionStringThe unique slug identifier for the region that you wish to deploy in.true
sizeStringThe unique slug identifier for the size that you wish to select for this Droplet.true
imagenumber (if using an image ID), or String (if using a public image slug)The image ID of a public or private image, or the unique slug identifier for a public image. This image will be the base image for your Droplet.true
ssh_keysArrayAn array containing the IDs or fingerprints of the SSH keys that you wish to embed in the Droplet's root account upon creation.
backupsBooleanA boolean indicating whether automated backups should be enabled for the Droplet. Automated backups can only be enabled when the Droplet is created.
ipv6BooleanA boolean indicating whether IPv6 is enabled on the Droplet.
private_networkingBooleanA boolean indicating whether private networking is enabled for the Droplet. Private networking is currently only available in certain regions.
user_dataStringA string containing 'user data' which may be used to configure the Droplet on first boot, often a 'cloud-config' file or Bash script. It must be plain text and may not exceed 64 KiB in size.
monitoringBooleanA boolean indicating whether to install the DigitalOcean agent for monitoring.
tagsArrayA flat array of tag names as strings to apply to the Droplet after it is created. Tag names can either be existing or new tags.

A Droplet will be created for every name you send, using the associated information. The response body will contain a JSON array with a key called droplets. The array will contain JSON objects with standard attributes for your new Droplets:

NameTypeDescription
idnumberA unique identifier for each Droplet instance. This is automatically generated upon Droplet creation.
namestringThe human-readable name set for the Droplet instance.
memorynumberMemory of the Droplet in megabytes.
vcpusnumberThe number of virtual CPUs.
disknumberThe size of the Droplet's disk in gigabytes.
lockedbooleanA boolean value indicating whether the Droplet has been locked, preventing actions by users.
created_atstringA time value given in ISO8601 combined date and time format that represents when the Droplet was created.
statusstringA status string indicating the state of the Droplet instance. This may be "new", "active", "off", or "archive".
backup_idsarrayAn array of backup IDs of any backups that have been taken of the Droplet instance. Droplet backups are enabled at the time of the instance creation.
snapshot_idsarrayAn array of snapshot IDs of any snapshots created from the Droplet instance.
featuresarrayAn array of features enabled on this Droplet.
regionobjectThe region that the Droplet instance is deployed in. When setting a region, the value should be the slug identifier for the region. When you query a Droplet, the entire region object will be returned.
imageobjectThe base image used to create the Droplet instance. When setting an image, the value is set to the image id or slug. When querying the Droplet, the entire image object will be returned.
sizeobjectThe current size object describing the Droplet. When setting a size, the value is set to the size slug. When querying the Droplet, the entire size object will be returned. Note that the disk volume of a droplet may not match the size's disk due to Droplet resize actions. The disk attribute on the Droplet should always be referenced.
size_slugstringThe unique slug identifier for the size of this Droplet.
networksobjectThe details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is.
kernelnullable objectThe current kernel. This will initially be set to the kernel of the base image when the Droplet is created.
next_backup_windownullable objectThe details of the Droplet's backups feature, if backups are configured for the Droplet. This object contains keys for the start and end times of the window during which the backup will start.
tagsarrayAn array of Tags the Droplet has been tagged with.
volume_idsarrayA flat array including the unique identifier for each Block Storage volume attached to the Droplet.

Create multiple Droplets

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"names":["sub-01.example.com","sub-02.example.com"],"region":"nyc3","size":"512mb","image":"ubuntu-14-04-x64","ssh_keys":null,"backups":false,"ipv6":true,"user_data":null,"private_networking":null,"tags":["web"]}' "https://api.digitalocean.com/v2/droplets"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

droplet = DropletKit::Droplet.new(
  names: ['sub-01.example.com', 'sub-02.example.com'],
  region: 'nyc3',
  size: '512mb',
  image: 'ubuntu-14-04-x64',
  ipv6: true,
  tags: ["web"]
)
client.droplets.create_multiple(droplet)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

createRequest := &godo.DropletMultiCreateRequest{
    Names:   []string{"sub-01.example.com","sub-02.example.com"},
    Region: "nyc3",
    Size:   "512mb",
    Image: godo.DropletCreateImage{
       Slug: "ubuntu-14-04-x64",
     },
    IPv6: true,
    Tags: []string{"web"},
}

droplet, _, err := client.Droplets.CreateMultiple(ctx, createRequest)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "names": [
    "sub-01.example.com",
    "sub-02.example.com"
  ],
  "region": "nyc3",
  "size": "512mb",
  "image": "ubuntu-14-04-x64",
  "ssh_keys": null,
  "backups": false,
  "ipv6": true,
  "user_data": null,
  "private_networking": null,
  "tags": [
    "web"
  ]
}

Response Headers

content-type: application/json; charset=utf-8
status: 202 Accepted
ratelimit-limit: 1200
ratelimit-remaining: 965
ratelimit-reset: 1415984218

Response Body

{
  "droplets": [
    {
      "id": 3164494,
      "name": "sub-01.example.com",
      "memory": 512,
      "vcpus": 1,
      "disk": 20,
      "locked": false,
      "status": "new",
      "kernel": {
        "id": 2233,
        "name": "Ubuntu 14.04 x64 vmlinuz-3.13.0-37-generic",
        "version": "3.13.0-37-generic"
      },
      "created_at": "2014-11-14T16:36:31Z",
      "features": [
        "virtio"
      ],
      "backup_ids": [

      ],
      "snapshot_ids": [

      ],
      "image": {
      },
      "volume_ids": [

      ],
      "size": {
      },
      "size_slug": "512mb",
      "networks": {
      },
      "region": {
      },
      "tags": [
        "web"
      ]
    },
    {
      "id": 3164495,
      "name": "sub-02.example.com",
      "memory": 512,
      "vcpus": 1,
      "disk": 20,
      "locked": false,
      "status": "new",
      "kernel": {
        "id": 2233,
        "name": "Ubuntu 14.04 x64 vmlinuz-3.13.0-37-generic",
        "version": "3.13.0-37-generic"
      },
      "created_at": "2014-11-14T16:36:31Z",
      "features": [
        "virtio"
      ],
      "backup_ids": [

      ],
      "snapshot_ids": [

      ],
      "image": {
      },
      "volume_ids": [

      ],
      "size": {
      },
      "size_slug": "512mb",
      "networks": {
      },
      "region": {
      },
      "tags": [
        "web"
      ]
    }
  ],
  "links": {
    "actions": [
      {
        "id": 36805096,
        "rel": "create_multiple",
        "href": "https://api.digitalocean.com/v2/actions/36805096"
      }
    ]
  }
}

Retrieve an existing Droplet by id

To show an individual droplet, send a GET request to /v2/droplets/$DROPLET_ID.

The response will be a JSON object with a key called droplet. This will be set to a JSON object that contains the Droplet's attributes:

NameTypeDescription
idnumberA unique identifier for each Droplet instance. This is automatically generated upon Droplet creation.
namestringThe human-readable name set for the Droplet instance.
memorynumberMemory of the Droplet in megabytes.
vcpusnumberThe number of virtual CPUs.
disknumberThe size of the Droplet's disk in gigabytes.
lockedbooleanA boolean value indicating whether the Droplet has been locked, preventing actions by users.
created_atstringA time value given in ISO8601 combined date and time format that represents when the Droplet was created.
statusstringA status string indicating the state of the Droplet instance. This may be "new", "active", "off", or "archive".
backup_idsarrayAn array of backup IDs of any backups that have been taken of the Droplet instance. Droplet backups are enabled at the time of the instance creation.
snapshot_idsarrayAn array of snapshot IDs of any snapshots created from the Droplet instance.
featuresarrayAn array of features enabled on this Droplet.
regionobjectThe region that the Droplet instance is deployed in. When setting a region, the value should be the slug identifier for the region. When you query a Droplet, the entire region object will be returned.
imageobjectThe base image used to create the Droplet instance. When setting an image, the value is set to the image id or slug. When querying the Droplet, the entire image object will be returned.
sizeobjectThe current size object describing the Droplet. When setting a size, the value is set to the size slug. When querying the Droplet, the entire size object will be returned. Note that the disk volume of a droplet may not match the size's disk due to Droplet resize actions. The disk attribute on the Droplet should always be referenced.
size_slugstringThe unique slug identifier for the size of this Droplet.
networksobjectThe details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is.
kernelnullable objectThe current kernel. This will initially be set to the kernel of the base image when the Droplet is created.
next_backup_windownullable objectThe details of the Droplet's backups feature, if backups are configured for the Droplet. This object contains keys for the start and end times of the window during which the backup will start.
tagsarrayAn array of Tags the Droplet has been tagged with.
volume_idsarrayA flat array including the unique identifier for each Block Storage volume attached to the Droplet.

Retrieve an existing Droplet by id

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/droplets/3164494"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.droplets.find(id: 3164494)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

droplet, _, err := client.Droplets.Get(ctx, 3164494)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 902
ratelimit-reset: 1415984218

Response Body

{
  "droplet": {
    "id": 3164494,
    "name": "example.com",
    "memory": 512,
    "vcpus": 1,
    "disk": 20,
    "locked": false,
    "status": "active",
    "kernel": {
      "id": 2233,
      "name": "Ubuntu 14.04 x64 vmlinuz-3.13.0-37-generic",
      "version": "3.13.0-37-generic"
    },
    "created_at": "2014-11-14T16:36:31Z",
    "features": [
      "ipv6",
      "virtio"
    ],
    "backup_ids": [

    ],
    "snapshot_ids": [
      7938206
    ],
    "image": {
      "id": 6918990,
      "name": "14.04 x64",
      "distribution": "Ubuntu",
      "slug": "ubuntu-14-04-x64",
      "public": true,
      "regions": [
        "nyc1",
        "ams1",
        "sfo1",
        "nyc2",
        "ams2",
        "sgp1",
        "lon1",
        "nyc3",
        "ams3",
        "nyc3"
      ],
      "created_at": "2014-10-17T20:24:33Z",
      "type": "snapshot",
      "min_disk_size": 20,
      "size_gigabytes": 2.34
    },
    "volume_ids": [

    ],
    "size": {
    },
    "size_slug": "512mb",
    "networks": {
      "v4": [
        {
          "ip_address": "104.131.186.241",
          "netmask": "255.255.240.0",
          "gateway": "104.131.176.1",
          "type": "public"
        }
      ],
      "v6": [
        {
          "ip_address": "2604:A880:0800:0010:0000:0000:031D:2001",
          "netmask": 64,
          "gateway": "2604:A880:0800:0010:0000:0000:0000:0001",
          "type": "public"
        }
      ]
    },
    "region": {
      "name": "New York 3",
      "slug": "nyc3",
      "sizes": [
        "32gb",
        "16gb",
        "2gb",
        "1gb",
        "4gb",
        "8gb",
        "512mb",
        "64gb",
        "48gb"
      ],
      "features": [
        "virtio",
        "private_networking",
        "backups",
        "ipv6",
        "metadata"
      ],
      "available": true
    },
    "tags": [

    ]
  }
}

List All Droplets

To list all Droplets in your account, send a GET request to /v2/droplets.

The response body will be a JSON object with a key of droplets. This will be set to an array containing objects representing each Droplet. These will contain the standard Droplet attributes:

NameTypeDescription
idnumberA unique identifier for each Droplet instance. This is automatically generated upon Droplet creation.
namestringThe human-readable name set for the Droplet instance.
memorynumberMemory of the Droplet in megabytes.
vcpusnumberThe number of virtual CPUs.
disknumberThe size of the Droplet's disk in gigabytes.
lockedbooleanA boolean value indicating whether the Droplet has been locked, preventing actions by users.
created_atstringA time value given in ISO8601 combined date and time format that represents when the Droplet was created.
statusstringA status string indicating the state of the Droplet instance. This may be "new", "active", "off", or "archive".
backup_idsarrayAn array of backup IDs of any backups that have been taken of the Droplet instance. Droplet backups are enabled at the time of the instance creation.
snapshot_idsarrayAn array of snapshot IDs of any snapshots created from the Droplet instance.
featuresarrayAn array of features enabled on this Droplet.
regionobjectThe region that the Droplet instance is deployed in. When setting a region, the value should be the slug identifier for the region. When you query a Droplet, the entire region object will be returned.
imageobjectThe base image used to create the Droplet instance. When setting an image, the value is set to the image id or slug. When querying the Droplet, the entire image object will be returned.
sizeobjectThe current size object describing the Droplet. When setting a size, the value is set to the size slug. When querying the Droplet, the entire size object will be returned. Note that the disk volume of a droplet may not match the size's disk due to Droplet resize actions. The disk attribute on the Droplet should always be referenced.
size_slugstringThe unique slug identifier for the size of this Droplet.
networksobjectThe details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is.
kernelnullable objectThe current kernel. This will initially be set to the kernel of the base image when the Droplet is created.
next_backup_windownullable objectThe details of the Droplet's backups feature, if backups are configured for the Droplet. This object contains keys for the start and end times of the window during which the backup will start.
tagsarrayAn array of Tags the Droplet has been tagged with.
volume_idsarrayA flat array including the unique identifier for each Block Storage volume attached to the Droplet.

List All Droplets

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/droplets?page=1&per_page=1"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

droplets = client.droplets.all
droplets.each

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

opt := &godo.ListOptions{
    Page:    1,
    PerPage: 200,
}

droplets, _, err := client.Droplets.List(ctx, opt)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 947
ratelimit-reset: 1415984218

Response Body

{
  "droplets": [
    {
      "id": 3164444,
      "name": "example.com",
      "memory": 512,
      "vcpus": 1,
      "disk": 20,
      "locked": false,
      "status": "active",
      "kernel": {
        "id": 2233,
        "name": "Ubuntu 14.04 x64 vmlinuz-3.13.0-37-generic",
        "version": "3.13.0-37-generic"
      },
      "created_at": "2014-11-14T16:29:21Z",
      "features": [
        "backups",
        "ipv6",
        "virtio"
      ],
      "backup_ids": [
        7938002
      ],
      "snapshot_ids": [

      ],
      "image": {
        "id": 6918990,
        "name": "14.04 x64",
        "distribution": "Ubuntu",
        "slug": "ubuntu-14-04-x64",
        "public": true,
        "regions": [
          "nyc1",
          "ams1",
          "sfo1",
          "nyc2",
          "ams2",
          "sgp1",
          "lon1",
          "nyc3",
          "ams3",
          "nyc3"
        ],
        "created_at": "2014-10-17T20:24:33Z",
        "type": "snapshot",
        "min_disk_size": 20,
        "size_gigabytes": 2.34
      },
      "volume_ids": [

      ],
      "size": {
      },
      "size_slug": "512mb",
      "networks": {
        "v4": [
          {
            "ip_address": "104.236.32.182",
            "netmask": "255.255.192.0",
            "gateway": "104.236.0.1",
            "type": "public"
          }
        ],
        "v6": [
          {
            "ip_address": "2604:A880:0800:0010:0000:0000:02DD:4001",
            "netmask": 64,
            "gateway": "2604:A880:0800:0010:0000:0000:0000:0001",
            "type": "public"
          }
        ]
      },
      "region": {
        "name": "New York 3",
        "slug": "nyc3",
        "sizes": [

        ],
        "features": [
          "virtio",
          "private_networking",
          "backups",
          "ipv6",
          "metadata"
        ],
        "available": null
      },
      "tags": [

      ]
    }
  ],
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/droplets?page=3&per_page=1",
      "next": "https://api.digitalocean.com/v2/droplets?page=2&per_page=1"
    }
  },
  "meta": {
    "total": 3
  }
}

Listing Droplets by Tag

To list Droplets by a tag, send a GET request to /v2/droplets?tag_name=$TAG_NAME.

The response will match that of regular droplet listing request but will be filtered to only include the tagged Droplets.

Listing Droplets by Tag

cURL Example

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

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

droplets = client.droplets.all(tag: awesome)
droplets.each

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

opt := &godo.ListOptions{
    Page:    1,
    PerPage: 200,
}

droplets, _, err := client.Droplets.ListByTag(ctx, "awesome"opt)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/octet-stream
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 901
ratelimit-reset: 1415984218

Response Body

{
  "droplets": [
    {
      "id": 3164444,
      "name": "example.com",
      "memory": 512,
      "vcpus": 1,
      "disk": 20,
      "locked": false,
      "status": "active",
      "kernel": {
        "id": 2233,
        "name": "Ubuntu 14.04 x64 vmlinuz-3.13.0-37-generic",
        "version": "3.13.0-37-generic"
      },
      "created_at": "2014-11-14T16:29:21Z",
      "features": [
        "backups",
        "ipv6",
        "virtio"
      ],
      "backup_ids": [
        7938002
      ],
      "snapshot_ids": [

      ],
      "image": {
        "id": 6918990,
        "name": "14.04 x64",
        "distribution": "Ubuntu",
        "slug": "ubuntu-14-04-x64",
        "public": true,
        "regions": [
          "nyc1",
          "ams1",
          "sfo1",
          "nyc2",
          "ams2",
          "sgp1",
          "lon1",
          "nyc3",
          "ams3",
          "nyc3"
        ],
        "created_at": "2014-10-17T20:24:33Z",
        "type": "snapshot",
        "min_disk_size": 20,
        "size_gigabytes": 2.34
      },
      "volume_ids": [

      ],
      "size": {
      },
      "size_slug": "512mb",
      "networks": {
        "v4": [
          {
            "ip_address": "104.236.32.182",
            "netmask": "255.255.192.0",
            "gateway": "104.236.0.1",
            "type": "public"
          }
        ],
        "v6": [
          {
            "ip_address": "2604:A880:0800:0010:0000:0000:02DD:4001",
            "netmask": 64,
            "gateway": "2604:A880:0800:0010:0000:0000:0000:0001",
            "type": "public"
          }
        ]
      },
      "region": {
        "name": "New York 3",
        "slug": "nyc3",
        "sizes": [

        ],
        "features": [
          "virtio",
          "private_networking",
          "backups",
          "ipv6",
          "metadata"
        ],
        "available": null
      },
      "tags": [
        "awesome"
      ]
    }
  ],
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/droplets?page=3&per_page=1",
      "next": "https://api.digitalocean.com/v2/droplets?page=2&per_page=1"
    }
  },
  "meta": {
    "total": 3
  }
}

List all available Kernels for a Droplet

To retrieve a list of all kernels available to a Dropet, send a GET request to /v2/droplets/$DROPLET_ID/kernels.

The response will be a JSON object that has a key called kernels. This will be set to an array of kernel objects, each of which contain the standard kernel attributes:

NameTypeDescription
idnumberA unique number used to identify and reference a specific kernel.
namestringThe display name of the kernel. This is shown in the web UI and is generally a descriptive title for the kernel in question.
versionstringA standard kernel version string representing the version, patch, and release information.

List all available Kernels for a Droplet

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/droplets/3164494/kernels?page=1&per_page=1"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

kernels = client.droplets.kernels(id: 3164494)
kernels.each

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

opt := &godo.ListOptions{
    Page:    1,
    PerPage: 200,
}

kernels, _, err := client.Droplets.Kernels(ctx, 3164494, opt)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 946
ratelimit-reset: 1415984218

Response Body

{
  "kernels": [
    {
      "id": 231,
      "name": "DO-recovery-static-fsck",
      "version": "3.8.0-25-generic"
    }
  ],
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/droplets/3164494/kernels?page=124&per_page=1",
      "next": "https://api.digitalocean.com/v2/droplets/3164494/kernels?page=2&per_page=1"
    }
  },
  "meta": {
    "total": 124
  }
}

List snapshots for a Droplet

To retrieve the snapshots that have been created from a Droplet, send a GET request to /v2/droplets/$DROPLET_ID/snapshots.

You will get back a JSON object that has a snapshots key. This will be set to an array of snapshot objects, each of which contain the standard image attributes:

NameTypeDescription
idnumberA unique number used to identify and reference a specific image.
namestringThe display name of the image. This is shown in the web UI and is generally a descriptive title for the image in question.
typestringThe kind of image, describing the duration of how long the image is stored. This is either "snapshot" or "backup".
distributionstringThe base distribution used for this image.
slugnullable stringA uniquely identifying string that is associated with each of the DigitalOcean-provided public images. These can be used to reference a public image as an alternative to the numeric id.
publicbooleanA boolean value that indicates whether the image in question is public. An image that is public is available to all accounts. A non-public image is only accessible from your account.
regionsarrayAn array of the regions that the image is available in. The regions are represented by their identifying slug values.
min_disk_sizenumberThe minimum 'disk' required for a size to use this image.
created_atstringA time value given in ISO8601 combined date and time format that represents when the Image was created.

List snapshots for a Droplet

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/droplets/3164494/snapshots?page=1&per_page=1"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

snapshots = client.droplets.snapshots(id: 3164494)
snapshots.each

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

opt := &godo.ListOptions{
    Page:    1,
    PerPage: 200,
}

snapshots, _, err := client.Droplets.Snapshots(ctx, 3164494, opt)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 904
ratelimit-reset: 1415984218

Response Body

{
  "snapshots": [
    {
      "id": 7938206,
      "name": "nginx-fresh",
      "distribution": "Ubuntu",
      "slug": null,
      "public": false,
      "regions": [
        "nyc3",
        "nyc3"
      ],
      "created_at": "2014-11-14T16:37:34Z",
      "type": "snapshot",
      "min_disk_size": 20,
      "size_gigabytes": 2.34
    }
  ],
  "links": {
  },
  "meta": {
    "total": 1
  }
}

List backups for a Droplet

To retrieve any backups associated with a Droplet, send a GET request to /v2/droplets/$DROPLET_ID/backups.

You will get back a JSON object that has a backups key. This will be set to an array of backup objects, each of which contain the standard image attributes:

NameTypeDescription
idnumberA unique number used to identify and reference a specific image.
namestringThe display name of the image. This is shown in the web UI and is generally a descriptive title for the image in question.
typestringThe kind of image, describing the duration of how long the image is stored. This is either "snapshot" or "backup".
distributionstringThe base distribution used for this image.
slugnullable stringA uniquely identifying string that is associated with each of the DigitalOcean-provided public images. These can be used to reference a public image as an alternative to the numeric id.
publicbooleanA boolean value that indicates whether the image in question is public. An image that is public is available to all accounts. A non-public image is only accessible from your account.
regionsarrayAn array of the regions that the image is available in. The regions are represented by their identifying slug values.
min_disk_sizenumberThe minimum 'disk' required for a size to use this image.
created_atstringA time value given in ISO8601 combined date and time format that represents when the Image was created.

List backups for a Droplet

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/droplets/3067509/backups"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

backups = client.droplets.backups(id: 3164494)
backups.each

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

opt := &godo.ListOptions{
    Page:    1,
    PerPage: 200,
}

backups, _, err := client.Droplets.Backups(ctx, 3164494, opt)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK

Response Body

{
  "backups": [
    {
      "id": 7622989,
      "name": "example.com 2014-11-14",
      "distribution": "Ubuntu",
      "slug": null,
      "public": false,
      "regions": [
        "nyc3"
      ],
      "created_at": "2014-11-14T16:07:38Z",
      "type": "snapshot",
      "min_disk_size": 20,
      "size_gigabytes": 2.34
    }
  ],
  "meta": {
    "total": 1
  }
}

List actions for a Droplet

To retrieve all actions that have been executed on a Droplet, send a GET request to /v2/droplets/$DROPLET_ID/actions.

The results will be returned as a JSON object with an actions key. This will be set to an array filled with action objects containing the standard action attributes:

NameTypeDescription
idnumberA unique numeric ID that can be used to identify and reference an action.
statusstringThe current status of the action. This can be "in-progress", "completed", or "errored".
typestringThis is the type of action that the object represents. For example, this could be "transfer" to represent the state of an image transfer action.
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

List actions for a Droplet

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/droplets/3164494/actions?page=1&per_page=1"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

actions = client.droplets.actions(id: 3164494)
actions.each

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

opt := &godo.ListOptions{
    Page:    1,
    PerPage: 200,
}

actions, _, err := client.Droplets.Actions(ctx, 3164494, opt)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 903
ratelimit-reset: 1415984218

Response Body

{
  "actions": [
    {
      "id": 36805187,
      "status": "completed",
      "type": "snapshot",
      "started_at": "2014-11-14T16:37:34Z",
      "completed_at": "2014-11-14T16:39:32Z",
      "resource_id": 3164494,
      "resource_type": "droplet",
      "region": "nyc3",
      "region_slug": "nyc3"
    }
  ],
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/droplets/3164494/actions?page=3&per_page=1",
      "next": "https://api.digitalocean.com/v2/droplets/3164494/actions?page=2&per_page=1"
    }
  },
  "meta": {
    "total": 3
  }
}

Delete a Droplet

To delete a Droplet, send a DELETE request to /v2/droplets/$DROPLET_ID.

No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.

Delete a Droplet

cURL Example

curl -X DELETE -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/droplets/3164494"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.droplets.delete(id: 3164494)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

_, err := client.Droplets.Delete(ctx, 3164494)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/octet-stream
status: 204 No Content
ratelimit-limit: 1200
ratelimit-remaining: 901
ratelimit-reset: 1415984218

Deleting Droplets by Tag

To delete Droplets by a tag (for example awesome), send a DELETE request to /v2/droplets?tag_name=$TAG_NAME.

No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.

Deleting Droplets by Tag

cURL Example

curl -X DELETE -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/droplets?tag_name=awesome"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.droplets.delete_for_tag(tag: awesome)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

client.Droplets.DeleteByTag(ctx, "awesome")

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/octet-stream
status: 204 No Content
ratelimit-limit: 1200
ratelimit-remaining: 901
ratelimit-reset: 1415984218

List Neighbors for a Droplet

To retrieve a list of droplets that are running on the same physical server, send a GET request to /v2/droplets/:id/neighbors

The results will be returned as a JSON array containing any other droplets that share the same physical hardware.

List Neighbors for a Droplet

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/droplets/3164494/neighbors"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 903
ratelimit-reset: 1415984218

Response Body

{
  "droplets": [
    {
      "id": 3164444,
      "name": "example.com",
      "memory": 512,
      "vcpus": 1,
      "disk": 20,
      "locked": false,
      "status": "active",
      "kernel": {
        "id": 2233,
        "name": "Ubuntu 14.04 x64 vmlinuz-3.13.0-37-generic",
        "version": "3.13.0-37-generic"
      },
      "created_at": "2014-11-14T16:29:21Z",
      "features": [
        "backups",
        "ipv6",
        "virtio"
      ],
      "backup_ids": [
        7938002
      ],
      "snapshot_ids": [

      ],
      "image": {
        "id": 6918990,
        "name": "14.04 x64",
        "distribution": "Ubuntu",
        "slug": "ubuntu-14-04-x64",
        "public": true,
        "regions": [
          "nyc1",
          "ams1",
          "sfo1",
          "nyc2",
          "ams2",
          "sgp1",
          "lon1",
          "nyc3",
          "ams3",
          "nyc3"
        ],
        "created_at": "2014-10-17T20:24:33Z",
        "type": "snapshot",
        "min_disk_size": 20,
        "size_gigabytes": 2.34
      },
      "volume_ids": [

      ],
      "size": {
      },
      "size_slug": "512mb",
      "networks": {
        "v4": [
          {
            "ip_address": "104.236.32.182",
            "netmask": "255.255.192.0",
            "gateway": "104.236.0.1",
            "type": "public"
          }
        ],
        "v6": [
          {
            "ip_address": "2604:A880:0800:0010:0000:0000:02DD:4001",
            "netmask": 64,
            "gateway": "2604:A880:0800:0010:0000:0000:0000:0001",
            "type": "public"
          }
        ]
      },
      "region": {
        "name": "New York 3",
        "slug": "nyc3",
        "sizes": [

        ],
        "features": [
          "virtio",
          "private_networking",
          "backups",
          "ipv6",
          "metadata"
        ],
        "available": null
      }
    }
  ]
}

List all Droplet Neighbors

To retrieve a list of any droplets that are running on the same physical hardware, send a GET request to /v2/reports/droplet_neighbors

The results will be returned as a JSON array containing more arrays, one for each set of droplets that share a physical server.

List all Droplet Neighbors

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/reports/droplet_neighbors"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 903
ratelimit-reset: 1415984218

Response Body

[
  {
    "neighbors": [
      [
        {
          "id": 3164444,
          "name": "example.com",
          "memory": 512,
          "vcpus": 1,
          "disk": 20,
          "locked": false,
          "status": "active",
          "kernel": {
            "id": 2233,
            "name": "Ubuntu 14.04 x64 vmlinuz-3.13.0-37-generic",
            "version": "3.13.0-37-generic"
          },
          "created_at": "2014-11-14T16:29:21Z",
          "features": [
            "backups",
            "ipv6",
            "virtio"
          ],
          "backup_ids": [
            7938002
          ],
          "snapshot_ids": [

          ],
          "image": {
            "id": 6918990,
            "name": "14.04 x64",
            "distribution": "Ubuntu",
            "slug": "ubuntu-14-04-x64",
            "public": true,
            "regions": [
              "nyc1",
              "ams1",
              "sfo1",
              "nyc2",
              "ams2",
              "sgp1",
              "lon1",
              "nyc3",
              "ams3",
              "nyc3"
            ],
            "created_at": "2014-10-17T20:24:33Z",
            "type": "snapshot",
            "min_disk_size": 20,
            "size_gigabytes": 2.34
          },
          "volume_ids": [

          ],
          "size": {
          },
          "size_slug": "512mb",
          "networks": {
            "v4": [
              {
                "ip_address": "104.236.32.182",
                "netmask": "255.255.192.0",
                "gateway": "104.236.0.1",
                "type": "public"
              }
            ],
            "v6": [
              {
                "ip_address": "2604:A880:0800:0010:0000:0000:02DD:4001",
                "netmask": 64,
                "gateway": "2604:A880:0800:0010:0000:0000:0000:0001",
                "type": "public"
              }
            ]
          },
          "region": {
            "name": "New York 3",
            "slug": "nyc3",
            "sizes": [

            ],
            "features": [
              "virtio",
              "private_networking",
              "backups",
              "ipv6",
              "metadata"
            ],
            "available": null
          }
        }
      ]
    ]
  }
]

Droplet Actions

Droplet actions are tasks that can be executed on a Droplet. These can be things like rebooting, resizing, snapshotting, etc.

Droplet action requests are generally targeted at one of the "actions" endpoints for a specific Droplet. The specific actions are usually initiated by sending a POST request with the action and arguments as parameters.

Droplet action requests create a Droplet actions object, which can be used to get information about the status of an action. Creating a Droplet action is asynchronous: the HTTP call will return the action object before the action has finished processing on the Droplet. The current status of an action can be retrieved from either the Droplet actions endpoint or the global actions endpoint. If a Droplet action is uncompleted it may block the creation of a subsequent action for that Droplet, the locked attribute of the Droplet will be true and attempts to create a Droplet action will fail with a status of 422.

NameTypeDescription
idnumberA unique identifier for each Droplet action event. This is used to reference a specific action that was requested.
statusstringThe current status of the action. The value of this attribute will be "in-progress", "completed", or "errored".
typestringThe type of action that the event is executing (reboot, power_off, etc.).
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

Enable Backups

To enable backups on an existing Droplet send a POST request to /v2/droplets/$DROPLET_ID/actions. Set the "type" attribute to enable_backups.

NameTypeDescriptionRequired
typestringMust be enable_backupstrue

The response will be a JSON object with a key called action. The value will be a Droplet actions object:

NameTypeDescription
idnumberA unique identifier for each Droplet action event. This is used to reference a specific action that was requested.
statusstringThe current status of the action. The value of this attribute will be "in-progress", "completed", or "errored".
typestringThe type of action that the event is executing (reboot, power_off, etc.).
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

Enable Backups

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"type":"enable_backups"}' "https://api.digitalocean.com/v2/droplets/3164450/actions"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.droplet_actions.enable_backups(droplet_id: 3164450)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

action, _, err := client.DropletActions.EnableBackups(ctx, 3164450)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "type": "enable_backups"
}

Response Headers

content-type: application/json; charset=utf-8
status: 201 Created
ratelimit-limit: 1200
ratelimit-remaining: 1099
ratelimit-reset: 1415984218

Response Body

{
  "action": {
    "id": 36804745,
    "status": "in-progress",
    "type": "enable_backups",
    "started_at": "2014-11-14T16:30:56Z",
    "completed_at": null,
    "resource_id": 3164450,
    "resource_type": "droplet",
    "region": "nyc3",
    "region_slug": "nyc3"
  }
}

Disable Backups

To disable backups on an existing Droplet send a POST request to /v2/droplets/$DROPLET_ID/actions. Set the "type" attribute to disable_backups.

NameTypeDescriptionRequired
typestringMust be disable_backupstrue

The response will be a JSON object with a key called action. The value will be a Droplet actions object:

NameTypeDescription
idnumberA unique identifier for each Droplet action event. This is used to reference a specific action that was requested.
statusstringThe current status of the action. The value of this attribute will be "in-progress", "completed", or "errored".
typestringThe type of action that the event is executing (reboot, power_off, etc.).
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

Disable Backups

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"type":"disable_backups"}' "https://api.digitalocean.com/v2/droplets/3164450/actions"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.droplet_actions.disable_backups(droplet_id: 3164450)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

action, _, err := client.DropletActions.DisableBackups(ctx, 3164450)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "type": "disable_backups"
}

Response Headers

content-type: application/json; charset=utf-8
status: 201 Created
ratelimit-limit: 1200
ratelimit-remaining: 1099
ratelimit-reset: 1415984218

Response Body

{
  "action": {
    "id": 36804745,
    "status": "in-progress",
    "type": "disable_backups",
    "started_at": "2014-11-14T16:30:56Z",
    "completed_at": null,
    "resource_id": 3164450,
    "resource_type": "droplet",
    "region": "nyc3",
    "region_slug": "nyc3"
  }
}

Reboot a Droplet

To reboot a Droplet, send a POST request to /v2/droplets/$DROPLET_ID/actions. Set the "type" attribute to reboot.

A reboot action is an attempt to reboot the Droplet in a graceful way, similar to using the reboot command from the console.

NameTypeDescriptionRequired
typestringMust be reboottrue

The response will be a JSON object with a key called action. The value will be a Droplet actions object:

NameTypeDescription
idnumberA unique identifier for each Droplet action event. This is used to reference a specific action that was requested.
statusstringThe current status of the action. The value of this attribute will be "in-progress", "completed", or "errored".
typestringThe type of action that the event is executing (reboot, power_off, etc.).
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

Reboot a Droplet

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"type":"reboot"}' "https://api.digitalocean.com/v2/droplets/3164450/actions"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.droplet_actions.reboot(droplet_id: 3164450)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

action, _, err := client.DropletActions.Reboot(ctx, 3164450)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "type": "reboot"
}

Response Headers

content-type: application/json; charset=utf-8
status: 201 Created
ratelimit-limit: 1200
ratelimit-remaining: 1097
ratelimit-reset: 1415984218

Response Body

{
  "action": {
    "id": 36804748,
    "status": "in-progress",
    "type": "reboot",
    "started_at": "2014-11-14T16:31:00Z",
    "completed_at": null,
    "resource_id": 3164450,
    "resource_type": "droplet",
    "region": "nyc3",
    "region_slug": "nyc3"
  }
}

Power Cycle a Droplet

To power cycle a Droplet (power off and then back on), send a POST request to /v2/droplets/$DROPLET_ID/actions. Set the "type" attribute to power_cycle.

A powercycle action is similar to pushing the reset button on a physical machine, it's similar to booting from scratch.

NameTypeDescriptionRequired
typestringMust be power_cycletrue

The response will be a JSON object with a key called action. The value will be a Droplet actions object:

NameTypeDescription
idnumberA unique identifier for each Droplet action event. This is used to reference a specific action that was requested.
statusstringThe current status of the action. The value of this attribute will be "in-progress", "completed", or "errored".
typestringThe type of action that the event is executing (reboot, power_off, etc.).
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

Power Cycle a Droplet

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"type":"power_cycle"}' "https://api.digitalocean.com/v2/droplets/3164450/actions"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.droplet_actions.power_cycle(droplet_id: 3164450)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

action, _, err := client.DropletActions.PowerCycle(ctx, 3164450)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "type": "power_cycle"
}

Response Headers

content-type: application/json; charset=utf-8
status: 201 Created
ratelimit-limit: 1200
ratelimit-remaining: 1095
ratelimit-reset: 1415984218

Response Body

{
  "action": {
    "id": 36804749,
    "status": "in-progress",
    "type": "power_cycle",
    "started_at": "2014-11-14T16:31:03Z",
    "completed_at": null,
    "resource_id": 3164450,
    "resource_type": "droplet",
    "region": "nyc3",
    "region_slug": "nyc3"
  }
}

Shutdown A Droplet

To shutdown a Droplet, send a POST request to /v2/droplets/$DROPLET_ID/actions. Set the "type" attribute to shutdown.

A shutdown action is an attempt to shutdown the Droplet in a graceful way, similar to using the shutdown command from the console. Since a shutdown command can fail, this action guarantees that the command is issued, not that it succeeds. The preferred way to turn off a Droplet is to attempt a shutdown, with a reasonable timeout, followed by a power off action to ensure the Droplet is off.

NameTypeDescriptionRequired
typestringMust be shutdowntrue

The response will be a JSON object with a key called action. The value will be a Droplet actions object:

NameTypeDescription
idnumberA unique identifier for each Droplet action event. This is used to reference a specific action that was requested.
statusstringThe current status of the action. The value of this attribute will be "in-progress", "completed", or "errored".
typestringThe type of action that the event is executing (reboot, power_off, etc.).
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

Shutdown A Droplet

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"type":"shutdown"}' "https://api.digitalocean.com/v2/droplets/3067649/actions"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.droplet_actions.shutdown(droplet_id: 3067649)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

action, _, err := client.DropletActions.Shutdown(ctx, 3067649)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "type": "shutdown"
}

Response Headers

content-type: application/json; charset=utf-8
status: 201 Created

Response Body

{
  "action": {
    "id": 36077293,
    "status": "in-progress",
    "type": "shutdown",
    "started_at": "2014-11-04T17:08:03Z",
    "completed_at": null,
    "resource_id": 3067649,
    "resource_type": "droplet",
    "region": "nyc2",
    "region_slug": "nyc2"
  }
}

Power Off a Droplet

To power off a Droplet, send a POST request to /v2/droplets/$DROPLET_ID/actions. Set the "type" attribute to power_off.

A power_off event is a hard shutdown and should only be used if the shutdown action is not successful. It is similar to cutting the power on a server and could lead to complications.

The request should contain the following attributes:

NameTypeDescriptionRequired
typestringMust be power_offtrue

The response will be a JSON object with a key called action. The value will be a Droplet actions object:

NameTypeDescription
idnumberA unique identifier for each Droplet action event. This is used to reference a specific action that was requested.
statusstringThe current status of the action. The value of this attribute will be "in-progress", "completed", or "errored".
typestringThe type of action that the event is executing (reboot, power_off, etc.).
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

Power Off a Droplet

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"type":"power_off"}' "https://api.digitalocean.com/v2/droplets/3164450/actions"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.droplet_actions.power_off(droplet_id: 3164450)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

action, _, err := client.DropletActions.PowerOff(ctx, 3164450)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "type": "power_off"
}

Response Headers

content-type: application/json; charset=utf-8
status: 201 Created
ratelimit-limit: 1200
ratelimit-remaining: 1093
ratelimit-reset: 1415984218

Response Body

{
  "action": {
    "id": 36804751,
    "status": "in-progress",
    "type": "power_off",
    "started_at": "2014-11-14T16:31:07Z",
    "completed_at": null,
    "resource_id": 3164450,
    "resource_type": "droplet",
    "region": "nyc3",
    "region_slug": "nyc3"
  }
}

Power On a Droplet

To power on a Droplet, send a POST request to /v2/droplets/$DROPLET_ID/actions. Set the "type" attribute to power_on.

NameTypeDescriptionRequired
typestringMust be power_ontrue

The response will be a JSON object with a key called action. The value will be a Droplet actions object:

NameTypeDescription
idnumberA unique identifier for each Droplet action event. This is used to reference a specific action that was requested.
statusstringThe current status of the action. The value of this attribute will be "in-progress", "completed", or "errored".
typestringThe type of action that the event is executing (reboot, power_off, etc.).
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

Power On a Droplet

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"type":"power_on"}' "https://api.digitalocean.com/v2/droplets/3164450/actions"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.droplet_actions.power_on(droplet_id: 3164450)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

action, _, err := client.DropletActions.PowerOn(ctx, 3164450)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "type": "power_on"
}

Response Headers

content-type: application/json; charset=utf-8
status: 201 Created
ratelimit-limit: 1200
ratelimit-remaining: 1088
ratelimit-reset: 1415984218

Response Body

{
  "action": {
    "id": 36804758,
    "status": "in-progress",
    "type": "power_on",
    "started_at": "2014-11-14T16:31:19Z",
    "completed_at": null,
    "resource_id": 3164450,
    "resource_type": "droplet",
    "region": "nyc3",
    "region_slug": "nyc3"
  }
}

Restore a Droplet

To restore a Droplet, send a POST request to /v2/droplets/$DROPLET_ID/actions. Set the "type" attribute to restore and the "image" attribute to an image ID.

A Droplet restoration will rebuild an image using a backup image. The image ID that is passed in must be a backup of the current Droplet instance. The operation will leave any embedded SSH keys intact.

NameTypeDescriptionRequired
typestringMust be restoretrue
imagestring if an image slug. number if an image ID.An image slug or ID. This represents the image that the Droplet will use as a base.true

The response will be a JSON object with a key called action. The value will be a Droplet actions object:

NameTypeDescription
idnumberA unique identifier for each Droplet action event. This is used to reference a specific action that was requested.
statusstringThe current status of the action. The value of this attribute will be "in-progress", "completed", or "errored".
typestringThe type of action that the event is executing (reboot, power_off, etc.).
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

Restore a Droplet

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"type":"restore", "image": 12389723 }' "https://api.digitalocean.com/v2/droplets/3067649/actions"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.droplet_actions.restore(droplet_id: 3067649, image: 12389723)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

action, _, err := client.DropletActions.Restore(ctx, 3164449, 12389723)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "type": "restore",
  "image": 12389723
}

Response Headers

content-type: application/json; charset=utf-8
status: 201 Created

Response Body

{
  "action": {
    "id": 36077293,
    "status": "in-progress",
    "type": "restore",
    "started_at": "2014-11-04T17:08:03Z",
    "completed_at": null,
    "resource_id": 3067649,
    "resource_type": "droplet",
    "region": "nyc2",
    "region_slug": "nyc2"
  }
}

Password Reset a Droplet

To reset the password for a Droplet, send a POST request to /v2/droplets/$DROPLET_ID/actions. Set the "type" attribute to password_reset.

NameTypeDescriptionRequired
typestringMust be password_resettrue

The response will be a JSON object with a key called action. The value will be a Droplet actions object:

NameTypeDescription
idnumberA unique identifier for each Droplet action event. This is used to reference a specific action that was requested.
statusstringThe current status of the action. The value of this attribute will be "in-progress", "completed", or "errored".
typestringThe type of action that the event is executing (reboot, power_off, etc.).
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

Password Reset a Droplet

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"type":"password_reset"}' "https://api.digitalocean.com/v2/droplets/3164450/actions"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.droplet_actions.password_reset(droplet_id: 3164450)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

action, _, err := client.DropletActions.PasswordReset(ctx, 3164450)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "type": "password_reset"
}

Response Headers

content-type: application/json; charset=utf-8
status: 201 Created
ratelimit-limit: 1200
ratelimit-remaining: 1085
ratelimit-reset: 1415984218

Response Body

{
  "action": {
    "id": 36804760,
    "status": "in-progress",
    "type": "password_reset",
    "started_at": "2014-11-14T16:31:25Z",
    "completed_at": null,
    "resource_id": 3164450,
    "resource_type": "droplet",
    "region": "nyc3",
    "region_slug": "nyc3"
  }
}

Resize a Droplet

To resize a Droplet, send a POST request to /v2/droplets/$DROPLET_ID/actions. Set the "type" attribute to resize and the "size" attribute to a sizes slug. If a permanent resize, with disk changes included, is desired, set the "disk" attribute to true.

The Droplet must be powered off prior to resizing.

NameTypeDescriptionRequired
typestringMust be resizetrue
diskBooleanWhether to increase disk size
sizestringThe size slug that you want to resize to.true

The response will be a JSON object with a key called action. The value will be a Droplet actions object:

NameTypeDescription
idnumberA unique identifier for each Droplet action event. This is used to reference a specific action that was requested.
statusstringThe current status of the action. The value of this attribute will be "in-progress", "completed", or "errored".
typestringThe type of action that the event is executing (reboot, power_off, etc.).
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

Resize a Droplet

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"type":"resize","size":"1gb"}' "https://api.digitalocean.com/v2/droplets/3164450/actions"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.droplet_actions.resize(droplet_id: 3164450, size: '1gb')

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

action, _, err := client.DropletActions.Resize(ctx, 3164450, "1gb", true)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "type": "resize",
  "disk": true,
  "size": "1gb"
}

Response Headers

content-type: application/json; charset=utf-8
status: 201 Created
ratelimit-limit: 1200
ratelimit-remaining: 1046
ratelimit-reset: 1415984218

Response Body

{
  "action": {
    "id": 36804888,
    "status": "in-progress",
    "type": "resize",
    "started_at": "2014-11-14T16:33:17Z",
    "completed_at": null,
    "resource_id": 3164450,
    "resource_type": "droplet",
    "region": "nyc3",
    "region_slug": "nyc3"
  }
}

Rebuild a Droplet

To rebuild a Droplet, send a POST request to /v2/droplets/$DROPLET_ID/actions. Set the "type" attribute to rebuild and the "image" attribute to an image ID or slug.

A rebuild action functions just like a new create.

NameTypeDescriptionRequired
typestringMust be rebuildtrue
imagestring if an image slug. number if an image ID.An image slug or ID. This represents the image that the Droplet will use as a base.true

The response will be a JSON object with a key called action. The value will be a Droplet actions object:

NameTypeDescription
idnumberA unique identifier for each Droplet action event. This is used to reference a specific action that was requested.
statusstringThe current status of the action. The value of this attribute will be "in-progress", "completed", or "errored".
typestringThe type of action that the event is executing (reboot, power_off, etc.).
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

Rebuild a Droplet

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"type":"rebuild","image":"ubuntu-14-04-x64"}' "https://api.digitalocean.com/v2/droplets/3164450/actions"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.droplet_actions.rebuild(droplet_id: 3164450, image: 'ubuntu-14-04-x64')

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

action, _, err := client.DropletActions.RebuildByImageSlug(ctx, 3164450, "ubuntu-14-04-x64")

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "type": "rebuild",
  "image": "ubuntu-14-04-x64"
}

Response Headers

content-type: application/json; charset=utf-8
status: 201 Created
ratelimit-limit: 1200
ratelimit-remaining: 1043
ratelimit-reset: 1415984218

Response Body

{
  "action": {
    "id": 36804899,
    "status": "in-progress",
    "type": "rebuild",
    "started_at": "2014-11-14T16:33:23Z",
    "completed_at": null,
    "resource_id": 3164450,
    "resource_type": "droplet",
    "region": "nyc3",
    "region_slug": "nyc3"
  }
}

Rename a Droplet

To rename a Droplet, send a POST request to /v2/droplets/$DROPLET_ID/actions. Set the "type" attribute to rename and the "name" attribute to the new name for the droplet.

NameTypeDescriptionRequired
typestringMust be renametrue
namestringThe new name for the Droplet.true

The response will be a JSON object with a key called action. The value will be a Droplet actions object:

NameTypeDescription
idnumberA unique identifier for each Droplet action event. This is used to reference a specific action that was requested.
statusstringThe current status of the action. The value of this attribute will be "in-progress", "completed", or "errored".
typestringThe type of action that the event is executing (reboot, power_off, etc.).
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

Rename a Droplet

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"type":"rename","name":"nifty-new-name"}' "https://api.digitalocean.com/v2/droplets/3164450/actions"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.droplet_actions.rename(droplet_id: 3164450, name: 'nifty-new-name')

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

action, _, err := client.DropletActions.Rename(ctx, 3164450, "nifty-new-name")

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "type": "rename",
  "name": "nifty-new-name"
}

Response Headers

content-type: application/json; charset=utf-8
status: 201 Created
ratelimit-limit: 1200
ratelimit-remaining: 1025
ratelimit-reset: 1415984218

Response Body

{
  "action": {
    "id": 36804946,
    "status": "in-progress",
    "type": "rename",
    "started_at": "2014-11-14T16:34:16Z",
    "completed_at": null,
    "resource_id": 3164450,
    "resource_type": "droplet",
    "region": "nyc3",
    "region_slug": "nyc3"
  }
}

Change the Kernel

To change the kernel of a Droplet, send a POST request to /v2/droplets/$DROPLET_ID/actions. Set the "type" attribute to change_kernel and the "kernel" attribute to the new kernel's ID.

NameTypeDescriptionRequired
typestringMust be change_kerneltrue
kernelnumberA unique number used to identify and reference a specific kernel.true

The response will be a JSON object with a key called action. The value will be a Droplet actions object:

NameTypeDescription
idnumberA unique identifier for each Droplet action event. This is used to reference a specific action that was requested.
statusstringThe current status of the action. The value of this attribute will be "in-progress", "completed", or "errored".
typestringThe type of action that the event is executing (reboot, power_off, etc.).
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

Change the Kernel

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"type":"change_kernel","kernel":991}' "https://api.digitalocean.com/v2/droplets/3164450/actions"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.droplet_actions.change_kernel(droplet_id: 3164450, kernel: 991)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

action, _, err := client.DropletActions.ChangeKernel(ctx, 3164450, 991)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "type": "change_kernel",
  "kernel": 991
}

Response Headers

content-type: application/json; charset=utf-8
status: 201 Created
ratelimit-limit: 1200
ratelimit-remaining: 1016
ratelimit-reset: 1415984218

Response Body

{
  "action": {
    "id": 36804951,
    "status": "in-progress",
    "type": "change_kernel",
    "started_at": "2014-11-14T16:34:20Z",
    "completed_at": null,
    "resource_id": 3164450,
    "resource_type": "droplet",
    "region": "nyc3",
    "region_slug": "nyc3"
  }
}

Enable IPv6

To enable IPv6 networking on an existing Droplet (within a region that has IPv6 available), send a POST request to /v2/droplets/$DROPLET_ID/actions. Set the "type" attribute to enable_ipv6.

NameTypeDescriptionRequired
typestringMust be enable_ipv6true

The response will be a JSON object with a key called action. The value will be a Droplet actions object:

NameTypeDescription
idnumberA unique identifier for each Droplet action event. This is used to reference a specific action that was requested.
statusstringThe current status of the action. The value of this attribute will be "in-progress", "completed", or "errored".
typestringThe type of action that the event is executing (reboot, power_off, etc.).
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

Enable IPv6

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"type":"enable_ipv6"}' "https://api.digitalocean.com/v2/droplets/3164450/actions"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.droplet_actions.enable_ipv6(droplet_id: 3164450)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

action, _, err := client.DropletActions.EnableIPv6(ctx, 3164450)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "type": "enable_ipv6"
}

Response Headers

content-type: application/json; charset=utf-8
status: 201 Created
ratelimit-limit: 1200
ratelimit-remaining: 1014
ratelimit-reset: 1415984218

Response Body

{
  "action": {
    "id": 36804954,
    "status": "in-progress",
    "type": "enable_ipv6",
    "started_at": "2014-11-14T16:34:24Z",
    "completed_at": null,
    "resource_id": 3164450,
    "resource_type": "droplet",
    "region": "nyc3",
    "region_slug": "nyc3"
  }
}

Enable Private Networking

To enable private networking on an existing Droplet (within a region that has private networking available), send a POST request to /v2/droplets/$DROPLET_ID/actions. Set the "type" attribute to enable_private_networking.

NameTypeDescriptionRequired
typestringMust be enable_private_networkingtrue

The response will be a JSON object with a key called action. The value will be a Droplet actions object:

NameTypeDescription
idnumberA unique identifier for each Droplet action event. This is used to reference a specific action that was requested.
statusstringThe current status of the action. The value of this attribute will be "in-progress", "completed", or "errored".
typestringThe type of action that the event is executing (reboot, power_off, etc.).
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

Enable Private Networking

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"type":"enable_private_networking"}' "https://api.digitalocean.com/v2/droplets/3164450/actions"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.droplet_actions.enable_private_networking(droplet_id: 3164450)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

action, _, err := client.DropletActions.EnablePrivateNetworking(ctx, 3164450)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "type": "enable_private_networking"
}

Response Headers

content-type: application/json; charset=utf-8
status: 201 Created
ratelimit-limit: 1200
ratelimit-remaining: 1008
ratelimit-reset: 1415984218

Response Body

{
  "action": {
    "id": 36805001,
    "status": "in-progress",
    "type": "enable_private_networking",
    "started_at": "2014-11-14T16:34:36Z",
    "completed_at": null,
    "resource_id": 3164450,
    "resource_type": "droplet",
    "region": "nyc3",
    "region_slug": "nyc3"
  }
}

Snapshot a Droplet

To snapshot a Droplet, send a POST request to /v2/droplets/$DROPLET_ID/actions. Set the "type" attribute to snapshot and the "name" attribute to the name you would like to give the created image.

NameTypeDescriptionRequired
typestringMust be snapshottrue
namestringThe name to give the new snapshot

The response will be a JSON object with a key called action. The value will be a Droplet actions object:

NameTypeDescription
idnumberA unique identifier for each Droplet action event. This is used to reference a specific action that was requested.
statusstringThe current status of the action. The value of this attribute will be "in-progress", "completed", or "errored".
typestringThe type of action that the event is executing (reboot, power_off, etc.).
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

Snapshot a Droplet

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"type":"snapshot","name":"Nifty New Snapshot"}' "https://api.digitalocean.com/v2/droplets/3164450/actions"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.droplet_actions.snapshot(droplet_id: 3164450, name: 'Nifty New Snapshot')

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

action, _, err := client.DropletActions.Snapshot(ctx, 3164450, "Nifty New Snapshot")

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "type": "snapshot",
  "name": "Nifty New Snapshot"
}

Response Headers

content-type: application/json; charset=utf-8
status: 201 Created
ratelimit-limit: 1200
ratelimit-remaining: 1006
ratelimit-reset: 1415984218

Response Body

{
  "action": {
    "id": 36805022,
    "status": "in-progress",
    "type": "snapshot",
    "started_at": "2014-11-14T16:34:39Z",
    "completed_at": null,
    "resource_id": 3164450,
    "resource_type": "droplet",
    "region": "nyc3",
    "region_slug": "nyc3"
  }
}

Acting on Tagged Droplets

Some actions can be performed in bulk on tagged droplets. The actions can be initiated by sending a POST to /v2/droplets/actions?tag_name=$TAG_NAME with the action arguments.

The list of supported action types are:

  • power_cycle
  • power_on
  • power_off
  • shutdown
  • enable_private_networking
  • enable_ipv6
  • enable_backups
  • disable_backups
  • snapshot

The response will be a JSON object with a key called actions. The value will be an array of Droplet actions objects:

NameTypeDescription
idnumberA unique identifier for each Droplet action event. This is used to reference a specific action that was requested.
statusstringThe current status of the action. The value of this attribute will be "in-progress", "completed", or "errored".
typestringThe type of action that the event is executing (reboot, power_off, etc.).
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

Acting on Tagged Droplets

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"type":"enable_backups"}' "https://api.digitalocean.com/v2/droplets/actions?tag_name=awesome"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.droplet_actions.power_off_for_tag(tag: 'awesome')

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

action, _, err := client.DropletActions.PowerOffByTag(ctx, "awesome")

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "type": "power_off"
}

Response Headers

content-type: application/json; charset=utf-8
status: 201 Created
ratelimit-limit: 1200
ratelimit-remaining: 1099
ratelimit-reset: 1415984218

Response Body

{
  "actions": [
    {
      "id": 36077293,
      "status": "in-progress",
      "type": "shutdown",
      "started_at": "2014-11-04T17:08:03Z",
      "completed_at": null,
      "resource_id": 3067649,
      "resource_type": "droplet",
      "region": "nyc2",
      "region_slug": "nyc2"
    },
    {
      "id": 36077294,
      "status": "in-progress",
      "type": "shutdown",
      "started_at": "2014-11-04T17:08:03Z",
      "completed_at": null,
      "resource_id": 3067650,
      "resource_type": "droplet",
      "region": "nyc2",
      "region_slug": "nyc2"
    }
  ]
}

Retrieve a Droplet Action

To retrieve a Droplet action, send a GET request to /v2/droplets/$DROPLET_ID/actions/$ACTION_ID.

The response will be a JSON object with a key called action. The value will be a Droplet actions object:

NameTypeDescription
idnumberA unique identifier for each Droplet action event. This is used to reference a specific action that was requested.
statusstringThe current status of the action. The value of this attribute will be "in-progress", "completed", or "errored".
typestringThe type of action that the event is executing (reboot, power_off, etc.).
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

Retrieve a Droplet Action

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/droplets/3164444/actions/36804807"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.droplet_actions.find(droplet_id: 3164444, id: 36804807)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

action, _, err := client.DropletActions.Get(ctx, 3164450, 36804807)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 966
ratelimit-reset: 1415984218

Response Body

{
  "action": {
    "id": 36804807,
    "status": "completed",
    "type": "backup",
    "started_at": "2014-11-14T16:32:24Z",
    "completed_at": "2014-11-14T16:34:15Z",
    "resource_id": 3164444,
    "resource_type": "droplet",
    "region": "nyc3",
    "region_slug": "nyc3"
  }
}

Images

Images in DigitalOcean may refer to one of a few different kinds of objects.

An image may refer to a snapshot that has been taken of a Droplet instance. It may also mean an image representing an automatic backup of a Droplet. The third category that it can represent is a public Linux distribution or application image that is used as a base to create Droplets.

To interact with images, you will generally send requests to the images endpoint at /v2/images.

NameTypeDescription
idnumberA unique number that can be used to identify and reference a specific image.
namestringThe display name that has been given to an image. This is what is shown in the control panel and is generally a descriptive title for the image in question.
typestringThe kind of image, describing the duration of how long the image is stored. This is either "snapshot" or "backup".
distributionstringThis attribute describes the base distribution used for this image.
slugnullable stringA uniquely identifying string that is associated with each of the DigitalOcean-provided public images. These can be used to reference a public image as an alternative to the numeric id.
publicbooleanThis is a boolean value that indicates whether the image in question is public or not. An image that is public is available to all accounts. A non-public image is only accessible from your account.
regionsarrayThis attribute is an array of the regions that the image is available in. The regions are represented by their identifying slug values.
min_disk_sizenumberThe minimum 'disk' required for a size to use this image.
size_gigabytesnumberThe size of the image in gigabytes.
created_atstringA time value given in ISO8601 combined date and time format that represents when the Image was created.

List all Images

To list all of the images available on your account, send a GET request to /v2/images.

The response will be a JSON object with a key called images. This will be set to an array of image objects, each of which will contain the standard image attributes:

NameTypeDescription
idnumberA unique number that can be used to identify and reference a specific image.
namestringThe display name that has been given to an image. This is what is shown in the control panel and is generally a descriptive title for the image in question.
typestringThe kind of image, describing the duration of how long the image is stored. This is either "snapshot" or "backup".
distributionstringThis attribute describes the base distribution used for this image.
slugnullable stringA uniquely identifying string that is associated with each of the DigitalOcean-provided public images. These can be used to reference a public image as an alternative to the numeric id.
publicbooleanThis is a boolean value that indicates whether the image in question is public or not. An image that is public is available to all accounts. A non-public image is only accessible from your account.
regionsarrayThis attribute is an array of the regions that the image is available in. The regions are represented by their identifying slug values.
min_disk_sizenumberThe minimum 'disk' required for a size to use this image.
size_gigabytesnumberThe size of the image in gigabytes.
created_atstringA time value given in ISO8601 combined date and time format that represents when the Image was created.

List all Images

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/images?page=1&per_page=1"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

images = client.images.all
images.each

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

opt := &godo.ListOptions{
    Page:    1,
    PerPage: 200,
}

images, _, err := client.Images.List(ctx, opt)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 777
ratelimit-reset: 1415984218

Response Body

{
  "images": [
    {
      "id": 7555620,
      "name": "Nifty New Snapshot",
      "distribution": "Ubuntu",
      "slug": null,
      "public": false,
      "regions": [
        "nyc2",
        "nyc2"
      ],
      "created_at": "2014-11-04T22:23:02Z",
      "type": "snapshot",
      "min_disk_size": 20,
      "size_gigabytes": 2.34
    }
  ],
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/images?page=56&per_page=1",
      "next": "https://api.digitalocean.com/v2/images?page=2&per_page=1"
    }
  },
  "meta": {
    "total": 56
  }
}

List all Distribution Images

To retrieve only distribution images, include the type query paramter set to distribution, /v2/images?type=distribution.

NameTypeDescription
idnumberA unique number that can be used to identify and reference a specific image.
namestringThe display name that has been given to an image. This is what is shown in the control panel and is generally a descriptive title for the image in question.
typestringThe kind of image, describing the duration of how long the image is stored. This is either "snapshot" or "backup".
distributionstringThis attribute describes the base distribution used for this image.
slugnullable stringA uniquely identifying string that is associated with each of the DigitalOcean-provided public images. These can be used to reference a public image as an alternative to the numeric id.
publicbooleanThis is a boolean value that indicates whether the image in question is public or not. An image that is public is available to all accounts. A non-public image is only accessible from your account.
regionsarrayThis attribute is an array of the regions that the image is available in. The regions are represented by their identifying slug values.
min_disk_sizenumberThe minimum 'disk' required for a size to use this image.
size_gigabytesnumberThe size of the image in gigabytes.
created_atstringA time value given in ISO8601 combined date and time format that represents when the Image was created.

List all Distribution Images

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/images?page=1&per_page=1&type=distribution"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

images = client.images.all(type: 'distribution')
images.each

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

opt := &godo.ListOptions{
    Page:    1,
    PerPage: 200,
}

images, _, err := client.Images.ListDistribution(ctx, opt)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 776
ratelimit-reset: 1415984218

Response Body

{
  "images": [
    {
      "id": 6370882,
      "name": "20 x64",
      "distribution": "Fedora",
      "slug": "fedora-20-x64",
      "public": true,
      "regions": [
        "nyc1",
        "ams1",
        "sfo1",
        "nyc2",
        "ams2",
        "sgp1",
        "lon1",
        "nyc3",
        "ams3",
        "nyc3"
      ],
      "created_at": "2014-09-26T15:29:01Z",
      "min_disk_size": 20,
      "size_gigabytes": 2.34
    }
  ],
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/images?page=24&per_page=1&type=distribution",
      "next": "https://api.digitalocean.com/v2/images?page=2&per_page=1&type=distribution"
    }
  },
  "meta": {
    "total": 24
  }
}

List all Application Images

To retrieve only application images, include the type query paramter set to application, /v2/images?type=application.

NameTypeDescription
idnumberA unique number that can be used to identify and reference a specific image.
namestringThe display name that has been given to an image. This is what is shown in the control panel and is generally a descriptive title for the image in question.
typestringThe kind of image, describing the duration of how long the image is stored. This is either "snapshot" or "backup".
distributionstringThis attribute describes the base distribution used for this image.
slugnullable stringA uniquely identifying string that is associated with each of the DigitalOcean-provided public images. These can be used to reference a public image as an alternative to the numeric id.
publicbooleanThis is a boolean value that indicates whether the image in question is public or not. An image that is public is available to all accounts. A non-public image is only accessible from your account.
regionsarrayThis attribute is an array of the regions that the image is available in. The regions are represented by their identifying slug values.
min_disk_sizenumberThe minimum 'disk' required for a size to use this image.
size_gigabytesnumberThe size of the image in gigabytes.
created_atstringA time value given in ISO8601 combined date and time format that represents when the Image was created.

List all Application Images

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/images?page=1&per_page=1&type=application"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

images = client.images.all(type: 'application')
images.each

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

opt := &godo.ListOptions{
    Page:    1,
    PerPage: 200,
}

images, _, err := client.Images.ListApplication(ctx, opt)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 775
ratelimit-reset: 1415984218

Response Body

{
  "images": [
    {
      "id": 6376601,
      "name": "Ruby on Rails on 14.04 (Nginx + Unicorn)",
      "distribution": "Ubuntu",
      "slug": "ruby-on-rails",
      "public": true,
      "regions": [
        "nyc1",
        "ams1",
        "sfo1",
        "nyc2",
        "ams2",
        "sgp1",
        "lon1",
        "nyc3",
        "ams3",
        "nyc1"
      ],
      "created_at": "2014-09-26T20:20:24Z",
      "min_disk_size": 20,
      "size_gigabytes": 2.34
    }
  ],
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/images?page=14&per_page=1&type=application",
      "next": "https://api.digitalocean.com/v2/images?page=2&per_page=1&type=application"
    }
  },
  "meta": {
    "total": 14
  }
}

List a User's Images

To retrieve only the private images of a user, include the private query paramter set to true, /v2/images?private=true.

NameTypeDescription
idnumberA unique number that can be used to identify and reference a specific image.
namestringThe display name that has been given to an image. This is what is shown in the control panel and is generally a descriptive title for the image in question.
typestringThe kind of image, describing the duration of how long the image is stored. This is either "snapshot" or "backup".
distributionstringThis attribute describes the base distribution used for this image.
slugnullable stringA uniquely identifying string that is associated with each of the DigitalOcean-provided public images. These can be used to reference a public image as an alternative to the numeric id.
publicbooleanThis is a boolean value that indicates whether the image in question is public or not. An image that is public is available to all accounts. A non-public image is only accessible from your account.
regionsarrayThis attribute is an array of the regions that the image is available in. The regions are represented by their identifying slug values.
min_disk_sizenumberThe minimum 'disk' required for a size to use this image.
size_gigabytesnumberThe size of the image in gigabytes.
created_atstringA time value given in ISO8601 combined date and time format that represents when the Image was created.

List a User's Images

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/images?page=1&per_page=1&private=true"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

images = client.images.all(private: true)
images.each

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

opt := &godo.ListOptions{
    Page:    1,
    PerPage: 200,
}

images, _, err := client.Images.ListUser(ctx, opt)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 775
ratelimit-reset: 1415984218

Response Body

{
  "images": [
    {
      "id": 6376601,
      "name": "My application image",
      "distribution": "Ubuntu",
      "public": false,
      "regions": [
        "nyc1",
        "ams1",
        "sfo1",
        "nyc2",
        "ams2",
        "sgp1"
      ],
      "created_at": "2014-09-26T20:20:24Z",
      "min_disk_size": 20,
      "size_gigabytes": 2.34
    }
  ],
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/images?page=14&per_page=1&type=application",
      "next": "https://api.digitalocean.com/v2/images?page=2&per_page=1&type=application"
    }
  },
  "meta": {
    "total": 14
  }
}

List all actions for an image

To retrieve all actions that have been executed on an image, send a GET request to /v2/images/$IMAGE_ID/actions.

The results will be returned as a JSON object with an actions key. This will be set to an array filled with action objects containing the standard action attributes:

NameTypeDescription
idnumberA unique numeric ID that can be used to identify and reference an action.
statusstringThe current status of the action. This can be "in-progress", "completed", or "errored".
typestringThis is the type of action that the object represents. For example, this could be "transfer" to represent the state of an image transfer action.
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

List all actions for an image

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/images/7555620/actions?page=1&per_page=1"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 775
ratelimit-reset: 1415984218

Response Body

{
  "actions": [
    {
      "id": 29410565,
      "status": "completed",
      "type": "transfer",
      "started_at": "2014-07-25T15:04:21Z",
      "completed_at": "2014-07-25T15:10:20Z",
      "resource_id": 7555620,
      "resource_type": "image",
      "region": "nyc2",
      "region_slug": "nyc2"
    }
  ],
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/images/7555620/actions?page=5&per_page=1",
      "next": "https://api.digitalocean.com/v2/images/7555620/actions?page=2&per_page=1"
    }
  },
  "meta": {
    "total": 5
  }
}

Retrieve an existing Image by id

To retrieve information about an image (public or private), send a GET request to /v2/images/$IMAGE_ID.

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

NameTypeDescription
idnumberA unique number that can be used to identify and reference a specific image.
namestringThe display name that has been given to an image. This is what is shown in the control panel and is generally a descriptive title for the image in question.
typestringThe kind of image, describing the duration of how long the image is stored. This is either "snapshot" or "backup".
distributionstringThis attribute describes the base distribution used for this image.
slugnullable stringA uniquely identifying string that is associated with each of the DigitalOcean-provided public images. These can be used to reference a public image as an alternative to the numeric id.
publicbooleanThis is a boolean value that indicates whether the image in question is public or not. An image that is public is available to all accounts. A non-public image is only accessible from your account.
regionsarrayThis attribute is an array of the regions that the image is available in. The regions are represented by their identifying slug values.
min_disk_sizenumberThe minimum 'disk' required for a size to use this image.
size_gigabytesnumberThe size of the image in gigabytes.
created_atstringA time value given in ISO8601 combined date and time format that represents when the Image was created.

Retrieve an existing Image by id

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/images/7555620"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.images.find(id: '7555620')

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

image, _, err := client.Images.GetByID(ctx, 7555620)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 774
ratelimit-reset: 1415984218

Response Body

{
  "image": {
    "id": 7555620,
    "name": "Nifty New Snapshot",
    "distribution": "Ubuntu",
    "slug": null,
    "public": false,
    "regions": [
      "nyc2",
      "nyc2"
    ],
    "created_at": "2014-11-04T22:23:02Z",
    "min_disk_size": 20,
    "size_gigabytes": 2.34
  }
}

Retrieve an existing Image by slug

To retrieve information about a public image, one option is to send a GET request to /v2/images/$IMAGE_SLUG.

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

NameTypeDescription
idnumberA unique number that can be used to identify and reference a specific image.
namestringThe display name that has been given to an image. This is what is shown in the control panel and is generally a descriptive title for the image in question.
typestringThe kind of image, describing the duration of how long the image is stored. This is either "snapshot" or "backup".
distributionstringThis attribute describes the base distribution used for this image.
slugnullable stringA uniquely identifying string that is associated with each of the DigitalOcean-provided public images. These can be used to reference a public image as an alternative to the numeric id.
publicbooleanThis is a boolean value that indicates whether the image in question is public or not. An image that is public is available to all accounts. A non-public image is only accessible from your account.
regionsarrayThis attribute is an array of the regions that the image is available in. The regions are represented by their identifying slug values.
min_disk_sizenumberThe minimum 'disk' required for a size to use this image.
size_gigabytesnumberThe size of the image in gigabytes.
created_atstringA time value given in ISO8601 combined date and time format that represents when the Image was created.

Retrieve an existing Image by slug

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/images/ubuntu-14-04-x64"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.images.find(id: 'ubuntu-14-04-x64')

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

image, _, err := client.Images.GetBySlug(ctx, "ubuntu-14-04-x64")

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 773
ratelimit-reset: 1415984218

Response Body

{
  "image": {
    "id": 6918990,
    "name": "14.04 x64",
    "distribution": "Ubuntu",
    "slug": "ubuntu-14-04-x64",
    "public": true,
    "regions": [
      "nyc1",
      "ams1",
      "sfo1",
      "nyc2",
      "ams2",
      "sgp1",
      "lon1",
      "nyc3",
      "ams3",
      "nyc3"
    ],
    "created_at": "2014-10-17T20:24:33Z",
    "min_disk_size": 20,
    "size_gigabytes": 2.34
  }
}

Update an Image

To update an image, send a PUT request to /v2/images/$IMAGE_ID. Set the "name" attribute to the new value you would like to use.

NameTypeDescriptionRequired
namestringThe new name that you would like to use for the image.true

The response will be a JSON object with a key set to image. The value of this will be an image object containing the standard image attributes:

NameTypeDescription
idnumberA unique number that can be used to identify and reference a specific image.
namestringThe display name that has been given to an image. This is what is shown in the control panel and is generally a descriptive title for the image in question.
typestringThe kind of image, describing the duration of how long the image is stored. This is either "snapshot" or "backup".
distributionstringThis attribute describes the base distribution used for this image.
slugnullable stringA uniquely identifying string that is associated with each of the DigitalOcean-provided public images. These can be used to reference a public image as an alternative to the numeric id.
publicbooleanThis is a boolean value that indicates whether the image in question is public or not. An image that is public is available to all accounts. A non-public image is only accessible from your account.
regionsarrayThis attribute is an array of the regions that the image is available in. The regions are represented by their identifying slug values.
min_disk_sizenumberThe minimum 'disk' required for a size to use this image.
size_gigabytesnumberThe size of the image in gigabytes.
created_atstringA time value given in ISO8601 combined date and time format that represents when the Image was created.

Update an Image

cURL Example

curl -X PUT -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"name":"new-image-name"}' "https://api.digitalocean.com/v2/images/7938391"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

image = DropletKit::Image.new(name: 'new-image-name')
client.images.update(image, id: 7938391)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

updateRequest := &godo.ImageUpdateRequest{
    Name: "new-image-name",
}

image, _, err := client.Images.Update(ctx, id, updateRequest)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "name": "new-image-name"
}

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 772
ratelimit-reset: 1415984218

Response Body

{
  "image": {
    "id": 7938391,
    "name": "new-image-name",
    "distribution": "Ubuntu",
    "slug": null,
    "public": false,
    "regions": [
      "nyc3",
      "nyc3"
    ],
    "created_at": "2014-11-14T16:44:03Z",
    "min_disk_size": 20,
    "size_gigabytes": 2.34
  }
}

Delete an Image

To delete an image, send a DELETE request to /v2/images/$IMAGE_ID.

A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.

Delete an Image

cURL Example

curl -X DELETE -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/images/7938391"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.images.delete(id: 7938391)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

_, err := client.Images.Delete(ctx, 7938391)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/octet-stream
status: 204 No Content
ratelimit-limit: 1200
ratelimit-remaining: 771
ratelimit-reset: 1415984218

Image Actions

Image actions are commands that can be given to a DigitalOcean image. In general, these requests are made on the actions endpoint of a specific image.

An image action object is returned. These objects hold the current status of the requested action.

NameTypeDescription
idnumberA unique numeric ID that can be used to identify and reference an image action.
statusstringThe current status of the image action. This will be either "in-progress", "completed", or "errored".
typestringThis is the type of the image action that the JSON object represents. For example, this could be "transfer" to represent the state of an image transfer action.
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

Transfer an Image

To transfer an image to another region, send a POST request to /v2/images/$IMAGE_ID/actions. Set the "type" attribute to "transfer" and set "region" attribute to the slug identifier of the region you wish to transfer to.

NameTypeDescriptionRequired
typestringMust be transfertrue
regionstringThe region slug that represents the region target.true

The response will be a JSON object with a key called action. The value of this will be an object containing the standard image action attributes:

NameTypeDescription
idnumberA unique numeric ID that can be used to identify and reference an image action.
statusstringThe current status of the image action. This will be either "in-progress", "completed", or "errored".
typestringThis is the type of the image action that the JSON object represents. For example, this could be "transfer" to represent the state of an image transfer action.
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

Transfer an Image

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"type":"transfer","region":"nyc2"}' "https://api.digitalocean.com/v2/images/7938269/actions"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.image_actions.transfer(image_id: 7938269, region: 'nyc2')

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

transferRequest := &godo.ActionRequest{
    "type":   "transfer",
    "region": "nyc2",
}

transfer, _, err := client.ImageActions.Transfer(ctx, 7938269, transferRequest)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "type": "transfer",
  "region": "nyc2"
}

Response Headers

content-type: application/json; charset=utf-8
status: 201 Created
ratelimit-limit: 1200
ratelimit-remaining: 838
ratelimit-reset: 1415984218

Response Body

{
  "action": {
    "id": 36805527,
    "status": "in-progress",
    "type": "transfer",
    "started_at": "2014-11-14T16:42:45Z",
    "completed_at": null,
    "resource_id": 7938269,
    "resource_type": "image",
    "region": "nyc3",
    "region_slug": "nyc3"
  }
}

Convert an Image to a snapshot

To convert an image, for example, a backup to a snapshot, send a POST request to /v2/images/$IMAGE_ID/actions. Set the "type" attribute to "convert".

NameTypeDescriptionRequired
typestringMust be converttrue

The response will be a JSON object with a key called action. The value of this will be an object containing the standard image action attributes:

NameTypeDescription
idnumberA unique numeric ID that can be used to identify and reference an image action.
statusstringThe current status of the image action. This will be either "in-progress", "completed", or "errored".
typestringThis is the type of the image action that the JSON object represents. For example, this could be "transfer" to represent the state of an image transfer action.
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

Convert an Image to a snapshot

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"type":"convert"}' "https://api.digitalocean.com/v2/images/7938291/actions"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.image_actions.convert(image_id: 7938269)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "type": "convert"
}

Response Headers

content-type: application/json; charset=utf-8
status: 201 Created
ratelimit-limit: 1200
ratelimit-remaining: 838
ratelimit-reset: 1415984218

Response Body

{
  "action": {
    "id": 46592838,
    "status": "completed",
    "type": "convert_to_snapshot",
    "started_at": "2015-03-24T19:02:47Z",
    "completed_at": "2015-03-24T19:02:47Z",
    "resource_id": 11060029,
    "resource_type": "image",
    "region": null,
    "region_slug": null
  }
}

Retrieve an existing Image Action

To retrieve the status of an image action, send a GET request to /v2/images/$IMAGE_ID/actions/$IMAGE_ACTION_ID.

The response will be an object with a key called action. The value of this will be an object that contains the standard image action attributes:

NameTypeDescription
idnumberA unique numeric ID that can be used to identify and reference an image action.
statusstringThe current status of the image action. This will be either "in-progress", "completed", or "errored".
typestringThis is the type of the image action that the JSON object represents. For example, this could be "transfer" to represent the state of an image transfer action.
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

Retrieve an existing Image Action

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/images/7938269/actions/36805527"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.image_actions.find(image_id: 7938269, id: 36805527)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

action, _, err := client.ImageActions.Get(ctx, 7938269, 36805527)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 837
ratelimit-reset: 1415984218

Response Body

{
  "action": {
    "id": 36805527,
    "status": "in-progress",
    "type": "transfer",
    "started_at": "2014-11-14T16:42:45Z",
    "completed_at": null,
    "resource_id": 7938269,
    "resource_type": "image",
    "region": "nyc3",
    "region_slug": "nyc3"
  }
}

Load Balancers

Load Balancers provide a way to distribute traffic across multiple Droplets. By sending requests to the /v2/load_balancers endpoint, you can list, create, or delete Load Balancers as well as add or remove Droplets, forwarding rules, and other configuration details.

NameTypeDescription
idstringA unique ID that can be used to identify and reference a Load Balancer.
namestringA human-readable name for a Load Balancer instance.
ipstringAn attribute containing the public-facing IP address of the Load Balancer.
algorithmstringThe load balancing algorithm used to determine which backend Droplet will be selected by a client. It must be either "round_robin" or "least_connections".
statusstringA status string indicating the current state of the Load Balancer. This can be "new", "active", or "errored".
created_atstringA time value given in ISO8601 combined date and time format that represents when the Load Balancer was created.
forwarding_rulesobjectAn object specifying the forwarding rules for a Load Balancer (see table below).
health_checkobjectAn object specifying health check settings for the Load Balancer (see table below).
sticky_sessionsobjectAn object specifying sticky sessions settings for the Load Balancer (see table below).
regionobjectThe region where the Load Balancer instance is located. When setting a region, the value should be the slug identifier for the region. When you query a Load Balancer, an entire region object will be returned.
tagstringThe name of a Droplet tag corresponding to Droplets assigned to the Load Balancer.
droplet_idsarray of integersAn array containing the IDs of the Droplets assigned to the Load Balancer.
redirect_http_to_httpsboolA boolean value indicating whether HTTP requests to the Load Balancer on port 80 will be redirected to HTTPS on port 443.

Some of a Load Balancer's attributes will have an object value. The forwarding_rules, health_check, and sticky_sessions objects will all contain the standard attributes of their associated types. These can be found below.

Forwarding rules determine how traffic will be routed from the Load Balancer to the Droplets assigned to it. They can be used to configure the type of traffic (HTTP, HTTPS, or TCP) and to map ports on the Load Balancer to ports on the Droplets. For SSL encrypted traffic, you may also configure whether to use SSL termination at the Load Balancer (by specifying an SSL certificate) or to pass the encrypted traffic through to the Droplet. Currently, each Load Balancer may have up to 15 forwarding rules.

NameTypeDescription
entry_protocolstringThe protocol used for traffic to the Load Balancer. The possible values are: "http", "https", or "tcp".
entry_portintAn integer representing the port on which the Load Balancer instance will listen.
target_protocolstringThe protocol used for traffic from the Load Balancer to the backend Droplets. The possible values are: "http", "https", or "tcp".
target_portintAn integer representing the port on the backend Droplets to which the Load Balancer will send traffic.
certificate_idstringThe ID of the TLS certificate used for SSL termination if enabled.
tls_passthroughboolA boolean value indicating whether SSL encrypted traffic will be passed through to the backend Droplets.

Health checks are used to tell if a Droplet is responding and should receive traffic. The Load Balancer will automatically stop sending traffic to unresponsive Droplets. You may specify the protocol, port, and path for a health check as well as additional setting such as the check interval and response timeout.

NameTypeDescription
protocolstringThe protocol used for health checks sent to the backend Droplets. The possible values are "http" or "tcp".
portintAn integer representing the port on the backend Droplets on which the health check will attempt a connection.
pathstringThe path on the backend Droplets to which the Load Balancer instance will send a request.
check_interval_secondsintThe number of seconds between between two consecutive health checks.
response_timeout_secondsintThe number of seconds the Load Balancer instance will wait for a response until marking a health check as failed.
unhealthy_thresholdintThe number of times a health check must fail for a backend Droplet to be marked "unhealthy" and be removed from the pool.
healthy_thresholdintThe number of times a health check must pass for a backend Droplet to be marked "healthy" and be re-added to the pool.

When sticky sessions are in use, follow up requests from a client will be sent to the same Droplet as the original request. Both the name of the cookie and the TTL are configurable.

NameTypeDescription
typestringAn attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are "cookies" or "none".
cookie_namestringThe name of the cookie sent to the client. This attribute is only returned when using "cookies" for the sticky sessions type.
cookie_ttl_secondsstringThe number of seconds until the cookie set by the Load Balancer expires. This attribute is only returned when using "cookies" for the sticky sessions type.

Create a new Load Balancer

To create a new Load Balancer instance, send a POST request to /v2/load_balancers. The attribute values that must be set to successfully create a Load Balancer are:

NameTypeDescriptionRequired
namestringA human-readable name for a Load Balancer instance.true
algorithmstringThe load balancing algorithm used to determine which backend Droplet will be selected by a client. It must be either "round_robin" or "least_connections". The default value is "round_robin".
regionstringThe region where the Load Balancer instance will be located. When setting a region, the value should be the slug identifier for the region. When you query a Load Balancer, an entire region object will be returned.true
forwarding_rulesarray of objectsAn array of objects specifying the forwarding rules for a Load Balancer. At least one forwarding rule is required when creating a new Load Balancer instance (see table below).true
health_checkobjectAn object specifying health check settings for the Load Balancer. If omitted, default values will be provided (see table below).
sticky_sessionsobjectAn object specifying sticky sessions settings for the Load Balancer (see table below).
redirect_http_to_httpsboolA boolean value indicating whether HTTP requests to the Load Balancer on port 80 will be redirected to HTTPS on port 443. Default value is false.
droplet_idsarray of integersAn array containing the IDs of the Droplets to be assigned to the Load Balancer.

The request must contain at least one forwarding rule. A Load Balancer's forwarding_rules attribute is made up of an array of objects with the following attributes:

NameTypeDescriptionRequired
entry_protocolstringThe protocol used for traffic to the Load Balancer. The possible values are: "http", "https", or "tcp". true
entry_portintAn integer representing the port on which the Load Balancer instance will listen.true
target_protocolstringThe protocol used for traffic from the Load Balancer to the backend Droplets. The possible values are: "http", "https", or "tcp". true
target_portintAn integer representing the port on the backend Droplets to which the Load Balancer will send traffic.true
certificate_idstringThe ID of the TLS certificate to be used for SSL termination.
tls_passthroughboolA boolean value indicating whether SSL encrypted traffic will be passed through to the backend Droplets. The defaults value is false.

The request may also contain health check settings. Defaults will be provided if omitted. A Load Balancer's health_check attribute is made up of an object containing:

NameTypeDescriptionRequired
protocolstringThe protocol used for health checks sent to the backend Droplets. The possible values are "http" or "tcp".true
portintAn integer representing the port on the backend Droplets on which the health check will attempt a connection.true
pathstringThe path on the backend Droplets to which the Load Balancer instance will send a request. The default value is "/".
check_interval_secondsintThe number of seconds between between two consecutive health checks. If not specified, the default value is "10".
response_timeout_secondsintThe number of seconds the Load Balancer instance will wait for a response until marking a health check as failed. If not specified, the default value is "5".
unhealthy_thresholdintThe number of times a health check must fail for a backend Droplet to be marked "unhealthy" and be removed from the pool. If not specified, the default value is "3".
healthy_thresholdintThe number of times a health check must pass for a backend Droplet to be marked "healthy" and be re-added to the pool. If not specified, the default value is "5".

The request may also contain sticky session settings. Sticky sessions will not be configured if omitted. A Load Balancer's sticky_sessions attribute is made up of an object containing:

NameTypeDescription
typestringAn attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are "cookies" or "none". If not specified, the default value is "none".
cookie_namestringThe name to be used for the cookie sent to the client. This attribute is required when using "cookies" for the sticky sessions type.
cookie_ttl_secondsstringThe number of seconds until the cookie set by the Load Balancer expires. This attribute is required when using "cookies" for the sticky sessions type.

A Load Balancer instance will be created using the provided information. The response body will contain a JSON object with a key called load_balancer. The value will be an object containing the standard attributes for your new Load Balancer:

NameTypeDescription
idstringA unique ID that can be used to identify and reference a Load Balancer.
namestringA human-readable name for a Load Balancer instance.
ipstringAn attribute containing the public-facing IP address of the Load Balancer.
algorithmstringThe load balancing algorithm used to determine which backend Droplet will be selected by a client. It must be either "round_robin" or "least_connections".
statusstringA status string indicating the current state of the Load Balancer. This can be "new", "active", or "errored".
created_atstringA time value given in ISO8601 combined date and time format that represents when the Load Balancer was created.
forwarding_rulesobjectAn object specifying the forwarding rules for a Load Balancer (see table below).
health_checkobjectAn object specifying health check settings for the Load Balancer (see table below).
sticky_sessionsobjectAn object specifying sticky sessions settings for the Load Balancer (see table below).
regionobjectThe region where the Load Balancer instance is located. When setting a region, the value should be the slug identifier for the region. When you query a Load Balancer, an entire region object will be returned.
tagstringThe name of a Droplet tag corresponding to Droplets assigned to the Load Balancer.
droplet_idsarray of integersAn array containing the IDs of the Droplets assigned to the Load Balancer.
redirect_http_to_httpsboolA boolean value indicating whether HTTP requests to the Load Balancer on port 80 will be redirected to HTTPS on port 443.

Create a new Load Balancer

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"name": "example-lb-01", "region": "nyc3", "forwarding_rules":[{"entry_protocol":"http","entry_port":80,"target_protocol":"http","target_port":80,"certificate_id":"","tls_passthrough":false}, {"entry_protocol": "https","entry_port": 444,"target_protocol": "https","target_port": 443,"tls_passthrough": true}], "health_check":{"protocol":"http","port":80,"path":"/","check_interval_seconds":10,"response_timeout_seconds":5,"healthy_threshold":5,"unhealthy_threshold":3}, "sticky_sessions":{"type":"none"}, "droplet_ids": [3164444, 3164445]}' "https://api.digitalocean.com/v2/load_balancers"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

load_balancer = DropletKit::LoadBalancer.new(
  name: 'example-lb-01',
  algorithm: 'round_robin',
  droplet_ids: [ 3164444, 3164445],
  redirect_http_to_https: true,
  region: 'nyc3',
  forwarding_rules: [
    DropletKit::ForwardingRule.new(
      entry_protocol: 'http',
      entry_port: 80,
      target_protocol: 'http',
      target_port: 80,
      certificate_id: '',
      tls_passthrough: false
    ),
    DropletKit::ForwardingRule.new(
      entry_protocol: 'https',
      entry_port: 443,
      target_protocol: 'https',
      target_port: 443,
      certificate_id: '',
      tls_passthrough: true
    )
  ],
  sticky_sessions: DropletKit::StickySession.new(
    type: 'cookies',
    cookie_name: 'DO-LB',
    cookie_ttl_seconds: 5
  ),
  health_check: DropletKit::HealthCheck.new(
    protocol: 'http',
    port: 80,
    path: '/',
    check_interval_seconds: 10,
    response_timeout_seconds: 5,
    healthy_threshold: 5,
    unhealthy_threshold: 3
  )
)
client.load_balancers.create(load_balancer)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

createRequest := &godo.LoadBalancerRequest{
    Name:      "example-01",
    Algorithm: "round_robin",
    Region:    "nyc3",
    ForwardingRules: []godo.ForwardingRule{
        {
            EntryProtocol:  "http",
            EntryPort:      80,
            TargetProtocol: "http",
            TargetPort:     80,
        },
        {
            EntryProtocol:  "https",
            EntryPort:      443,
            TargetProtocol: "https",
            TargetPort:     443,
            TlsPassthrough: true,
        },
    },
    HealthCheck: &godo.HealthCheck{
        Protocol:               "http",
        Port:                   80,
        Path:                   "/",
        CheckIntervalSeconds:   10,
        ResponseTimeoutSeconds: 5,
        HealthyThreshold:       5,
        UnhealthyThreshold:     3,
    },
    StickySessions: &godo.StickySessions{
        Type: "none",
    },
    DropletIDs:          []int{3164444, 3164445},
    RedirectHttpToHttps: false,
}

lb, _, err := client.LoadBalancers.Create(ctx, createRequest)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "name": "example-lb-01",
  "region": "nyc3",
  "forwarding_rules": [
    {
      "entry_protocol": "http",
      "entry_port": 80,
      "target_protocol": "http",
      "target_port": 80,
      "certificate_id": "",
      "tls_passthrough": false
    },
    {
      "entry_protocol": "https",
      "entry_port": 444,
      "target_protocol": "https",
      "target_port": 443,
      "tls_passthrough": true
    }
  ],
  "health_check": {
    "protocol": "http",
    "port": 80,
    "path": "/",
    "check_interval_seconds": 10,
    "response_timeout_seconds": 5,
    "healthy_threshold": 5,
    "unhealthy_threshold": 3
  },
  "sticky_sessions": {
    "type": "none"
  },
  "droplet_ids": [
    3164444,
    3164445
  ]
}

Response Headers

content-type: application/json; charset=utf-8
status: 202 Accepted
ratelimit-limit: 5000
ratelimit-remaining: 4823
ratelimit-reset: 1444931833

Response Body

{
  "load_balancer": {
    "id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
    "name": "example-lb-01",
    "ip": "",
    "algorithm": "round_robin",
    "status": "new",
    "created_at": "2017-02-01T22:22:58Z",
    "forwarding_rules": [
      {
        "entry_protocol": "http",
        "entry_port": 80,
        "target_protocol": "http",
        "target_port": 80,
        "certificate_id": "",
        "tls_passthrough": false
      },
      {
        "entry_protocol": "https",
        "entry_port": 444,
        "target_protocol": "https",
        "target_port": 443,
        "certificate_id": "",
        "tls_passthrough": true
      }
    ],
    "health_check": {
      "protocol": "http",
      "port": 80,
      "path": "/",
      "check_interval_seconds": 10,
      "response_timeout_seconds": 5,
      "healthy_threshold": 5,
      "unhealthy_threshold": 3
    },
    "sticky_sessions": {
      "type": "none"
    },
    "region": {
      "name": "New York 3",
      "slug": "nyc3",
      "sizes": [
        "512mb",
        "1gb",
        "2gb",
        "4gb",
        "8gb",
        "16gb",
        "m-16gb",
        "32gb",
        "m-32gb",
        "48gb",
        "m-64gb",
        "64gb",
        "m-128gb",
        "m-224gb"
      ],
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata",
        "install_agent"
      ],
      "available": true
    },
    "tag": "",
    "droplet_ids": [
      3164444,
      3164445
    ],
    "redirect_http_to_https": false
  }
}

Create a new Load Balancer with Droplet tag

You may also use a Droplet tag to assign a group of Droplets to Load Balancer in place of a list of Droplet IDs. To create a new Load Balancer instance, send a POST request to /v2/load_balancers with the tag attribute. All Droplets with the tag will be assigned to the Load Balancer. Additional Droplets will be assigned as they are tagged. The other attributes remain the same:

NameTypeDescriptionRequired
namestringA human-readable name for a Load Balancer instance.true
algorithmstringThe load balancing algorithm used to determine which backend Droplet will be selected by a client. It must be either "round_robin" or "least_connections". The default value is "round_robin".
regionstringThe region where the Load Balancer instance will be located. When setting a region, the value should be the slug identifier for the region. When you query a Load Balancer, an entire region object will be returned.true
forwarding_rulesarray of objectsAn array of objects specifying the forwarding rules for a Load Balancer. At least one forwarding rule is required when creating a new Load Balancer instance (see table below).true
health_checkobjectAn object specifying health check settings for the Load Balancer. If omitted, default values will be provided (see table below).
sticky_sessionsobjectAn object specifying sticky sessions settings for the Load Balancer (see table below).
redirect_http_to_httpsboolA boolean value indicating whether HTTP requests to the Load Balancer on port 80 will be redirected to HTTPS on port 443. Default value is false.
tagstringThe name of a Droplet tag corresponding to Droplets to be assigned to the Load Balancer.

The request must contain at least one forwarding rule. A Load Balancer's forwarding_rules attribute is made up of an array of objects with the following attributes:

NameTypeDescriptionRequired
entry_protocolstringThe protocol used for traffic to the Load Balancer. The possible values are: "http", "https", or "tcp". true
entry_portintAn integer representing the port on which the Load Balancer instance will listen.true
target_protocolstringThe protocol used for traffic from the Load Balancer to the backend Droplets. The possible values are: "http", "https", or "tcp". true
target_portintAn integer representing the port on the backend Droplets to which the Load Balancer will send traffic.true
certificate_idstringThe ID of the TLS certificate to be used for SSL termination.
tls_passthroughboolA boolean value indicating whether SSL encrypted traffic will be passed through to the backend Droplets. The defaults value is false.

The request may also contain health check settings. Defaults will be provided if omitted. A Load Balancer's health_check attribute is made up of an object containing:

NameTypeDescriptionRequired
protocolstringThe protocol used for health checks sent to the backend Droplets. The possible values are "http" or "tcp".true
portintAn integer representing the port on the backend Droplets on which the health check will attempt a connection.true
pathstringThe path on the backend Droplets to which the Load Balancer instance will send a request. The default value is "/".
check_interval_secondsintThe number of seconds between between two consecutive health checks. If not specified, the default value is "10".
response_timeout_secondsintThe number of seconds the Load Balancer instance will wait for a response until marking a health check as failed. If not specified, the default value is "5".
unhealthy_thresholdintThe number of times a health check must fail for a backend Droplet to be marked "unhealthy" and be removed from the pool. If not specified, the default value is "3".
healthy_thresholdintThe number of times a health check must pass for a backend Droplet to be marked "healthy" and be re-added to the pool. If not specified, the default value is "5".

The request may also contain sticky session settings. Sticky sessions will not be configured if omitted. A Load Balancer's sticky_sessions attribute is made up of an object containing:

NameTypeDescription
typestringAn attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are "cookies" or "none". If not specified, the default value is "none".
cookie_namestringThe name to be used for the cookie sent to the client. This attribute is required when using "cookies" for the sticky sessions type.
cookie_ttl_secondsstringThe number of seconds until the cookie set by the Load Balancer expires. This attribute is required when using "cookies" for the sticky sessions type.

A Load Balancer instance will be created using the provided information. The response body will contain a JSON object with a key called load_balancer. The value will be an object containing the standard attributes for your new Load Balancer:

NameTypeDescription
idstringA unique ID that can be used to identify and reference a Load Balancer.
namestringA human-readable name for a Load Balancer instance.
ipstringAn attribute containing the public-facing IP address of the Load Balancer.
algorithmstringThe load balancing algorithm used to determine which backend Droplet will be selected by a client. It must be either "round_robin" or "least_connections".
statusstringA status string indicating the current state of the Load Balancer. This can be "new", "active", or "errored".
created_atstringA time value given in ISO8601 combined date and time format that represents when the Load Balancer was created.
forwarding_rulesobjectAn object specifying the forwarding rules for a Load Balancer (see table below).
health_checkobjectAn object specifying health check settings for the Load Balancer (see table below).
sticky_sessionsobjectAn object specifying sticky sessions settings for the Load Balancer (see table below).
regionobjectThe region where the Load Balancer instance is located. When setting a region, the value should be the slug identifier for the region. When you query a Load Balancer, an entire region object will be returned.
tagstringThe name of a Droplet tag corresponding to Droplets assigned to the Load Balancer.
droplet_idsarray of integersAn array containing the IDs of the Droplets assigned to the Load Balancer.
redirect_http_to_httpsboolA boolean value indicating whether HTTP requests to the Load Balancer on port 80 will be redirected to HTTPS on port 443.

Create a new Load Balancer with Droplet tag

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"name": "example-lb-01", "region": "nyc3", "forwarding_rules":[{"entry_protocol":"http","entry_port":80,"target_protocol":"http","target_port":80,"certificate_id":"","tls_passthrough":false}, {"entry_protocol": "https","entry_port": 444,"target_protocol": "https","target_port": 443,"tls_passthrough": true}], "health_check":{"protocol":"http","port":80,"path":"/","check_interval_seconds":10,"response_timeout_seconds":5,"healthy_threshold":5,"unhealthy_threshold":3}, "sticky_sessions":{"type":"none"}, "tag": "web:prod"}' "https://api.digitalocean.com/v2/load_balancers"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

load_balancer = DropletKit::LoadBalancer.new(
  name: 'example-lb-01',
  algorithm: 'round_robin',
  tag: 'web:prod',
  redirect_http_to_https: true,
  region: 'nyc3',
  forwarding_rules: [
    DropletKit::ForwardingRule.new(
      entry_protocol: 'http',
      entry_port: 80,
      target_protocol: 'http',
      target_port: 80,
      certificate_id: '',
      tls_passthrough: false
    ),
    DropletKit::ForwardingRule.new(
      entry_protocol: 'https',
      entry_port: 443,
      target_protocol: 'https',
      target_port: 443,
      certificate_id: '',
      tls_passthrough: true
    )
  ],
  sticky_sessions: DropletKit::StickySession.new(
    type: 'cookies',
    cookie_name: 'DO-LB',
    cookie_ttl_seconds: 5
  ),
  health_check: DropletKit::HealthCheck.new(
    protocol: 'http',
    port: 80,
    path: '/',
    check_interval_seconds: 10,
    response_timeout_seconds: 5,
    healthy_threshold: 5,
    unhealthy_threshold: 3
  )
)
client.load_balancers.create(load_balancer)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

createRequest := &godo.LoadBalancerRequest{
    Name:      "example-01",
    Algorithm: "round_robin",
    Region:    "nyc3",
    ForwardingRules: []godo.ForwardingRule{
        {
            EntryProtocol:  "http",
            EntryPort:      80,
            TargetProtocol: "http",
            TargetPort:     80,
        },
        {
            EntryProtocol:  "https",
            EntryPort:      443,
            TargetProtocol: "https",
            TargetPort:     443,
            TlsPassthrough: true,
        },
    },
    HealthCheck: &godo.HealthCheck{
        Protocol:               "http",
        Port:                   80,
        Path:                   "/",
        CheckIntervalSeconds:   10,
        ResponseTimeoutSeconds: 5,
        HealthyThreshold:       5,
        UnhealthyThreshold:     3,
    },
    StickySessions: &godo.StickySessions{
        Type: "none",
    },
    Tag:                 "web:prod",
    RedirectHttpToHttps: false,
}

lb, _, err := c.LoadBalancers.Create(ctx, createRequest)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "name": "example-lb-01",
  "region": "nyc3",
  "forwarding_rules": [
    {
      "entry_protocol": "http",
      "entry_port": 80,
      "target_protocol": "http",
      "target_port": 80,
      "certificate_id": "",
      "tls_passthrough": false
    },
    {
      "entry_protocol": "https",
      "entry_port": 444,
      "target_protocol": "https",
      "target_port": 443,
      "tls_passthrough": true
    }
  ],
  "health_check": {
    "protocol": "http",
    "port": 80,
    "path": "/",
    "check_interval_seconds": 10,
    "response_timeout_seconds": 5,
    "healthy_threshold": 5,
    "unhealthy_threshold": 3
  },
  "sticky_sessions": {
    "type": "none"
  },
  "tag": "web:prod"
}

Response Headers

content-type: application/json; charset=utf-8
status: 202 Accepted
ratelimit-limit: 5000
ratelimit-remaining: 4823
ratelimit-reset: 1444931833

Response Body

{
  "load_balancer": {
    "id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
    "name": "example-lb-01",
    "ip": "",
    "algorithm": "round_robin",
    "status": "new",
    "created_at": "2017-02-01T22:22:58Z",
    "forwarding_rules": [
      {
        "entry_protocol": "http",
        "entry_port": 80,
        "target_protocol": "http",
        "target_port": 80,
        "certificate_id": "",
        "tls_passthrough": false
      },
      {
        "entry_protocol": "https",
        "entry_port": 444,
        "target_protocol": "https",
        "target_port": 443,
        "certificate_id": "",
        "tls_passthrough": true
      }
    ],
    "health_check": {
      "protocol": "http",
      "port": 80,
      "path": "/",
      "check_interval_seconds": 10,
      "response_timeout_seconds": 5,
      "healthy_threshold": 5,
      "unhealthy_threshold": 3
    },
    "sticky_sessions": {
      "type": "none"
    },
    "region": {
      "name": "New York 3",
      "slug": "nyc3",
      "sizes": [
        "512mb",
        "1gb",
        "2gb",
        "4gb",
        "8gb",
        "16gb",
        "m-16gb",
        "32gb",
        "m-32gb",
        "48gb",
        "m-64gb",
        "64gb",
        "m-128gb",
        "m-224gb"
      ],
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata",
        "install_agent"
      ],
      "available": true
    },
    "droplet_ids": [
      3164444,
      3164445
    ],
    "tag": "web:prod",
    "redirect_http_to_https": false
  }
}

Retrieve an existing Load Balancer

To show information about a Load Balancer instance, send a GET request to /v2/load_balancers/$LOAD_BALANCER_ID.

The response will be a JSON object with a key called load_balancer. The value of this will be an object that contains the standard attributes associated with a Load Balancer:

NameTypeDescription
idstringA unique ID that can be used to identify and reference a Load Balancer.
namestringA human-readable name for a Load Balancer instance.
ipstringAn attribute containing the public-facing IP address of the Load Balancer.
algorithmstringThe load balancing algorithm used to determine which backend Droplet will be selected by a client. It must be either "round_robin" or "least_connections".
statusstringA status string indicating the current state of the Load Balancer. This can be "new", "active", or "errored".
created_atstringA time value given in ISO8601 combined date and time format that represents when the Load Balancer was created.
forwarding_rulesobjectAn object specifying the forwarding rules for a Load Balancer (see table below).
health_checkobjectAn object specifying health check settings for the Load Balancer (see table below).
sticky_sessionsobjectAn object specifying sticky sessions settings for the Load Balancer (see table below).
regionobjectThe region where the Load Balancer instance is located. When setting a region, the value should be the slug identifier for the region. When you query a Load Balancer, an entire region object will be returned.
tagstringThe name of a Droplet tag corresponding to Droplets assigned to the Load Balancer.
droplet_idsarray of integersAn array containing the IDs of the Droplets assigned to the Load Balancer.
redirect_http_to_httpsboolA boolean value indicating whether HTTP requests to the Load Balancer on port 80 will be redirected to HTTPS on port 443.

The forwarding_rules attribute will contain an array of objects with the following attributes:

NameTypeDescription
entry_protocolstringThe protocol used for traffic to the Load Balancer. The possible values are: "http", "https", or "tcp".
entry_portintAn integer representing the port on which the Load Balancer instance will listen.
target_protocolstringThe protocol used for traffic from the Load Balancer to the backend Droplets. The possible values are: "http", "https", or "tcp".
target_portintAn integer representing the port on the backend Droplets to which the Load Balancer will send traffic.
certificate_idstringThe ID of the TLS certificate used for SSL termination if enabled.
tls_passthroughboolA boolean value indicating whether SSL encrypted traffic will be passed through to the backend Droplets.

The embedded health_check object will contain:

NameTypeDescription
protocolstringThe protocol used for health checks sent to the backend Droplets. The possible values are "http" or "tcp".
portintAn integer representing the port on the backend Droplets on which the health check will attempt a connection.
pathstringThe path on the backend Droplets to which the Load Balancer instance will send a request.
check_interval_secondsintThe number of seconds between between two consecutive health checks.
response_timeout_secondsintThe number of seconds the Load Balancer instance will wait for a response until marking a health check as failed.
unhealthy_thresholdintThe number of times a health check must fail for a backend Droplet to be marked "unhealthy" and be removed from the pool.
healthy_thresholdintThe number of times a health check must pass for a backend Droplet to be marked "healthy" and be re-added to the pool.

The embedded sticky_sessions object will contain:

NameTypeDescription
typestringAn attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are "cookies" or "none".
cookie_namestringThe name of the cookie sent to the client. This attribute is only returned when using "cookies" for the sticky sessions type.
cookie_ttl_secondsstringThe number of seconds until the cookie set by the Load Balancer expires. This attribute is only returned when using "cookies" for the sticky sessions type.

Retrieve an existing Load Balancer

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/load_balancers/4de7ac8b-495b-4884-9a69-1050c6793cd6"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.load_balancers.find(id: '4de7ac8b-495b-4884-9a69-1050c6793cd6')

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

lb, _, err := client.LoadBalancers.Get(ctx, "4de7ac8b-495b-4884-9a69-1050c6793cd6")

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 5000
ratelimit-remaining: 4823
ratelimit-reset: 1444931833

Response Body

{
  "load_balancer": {
    "id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
    "name": "example-lb-01",
    "ip": "104.131.186.241",
    "algorithm": "round_robin",
    "status": "new",
    "created_at": "2017-02-01T22:22:58Z",
    "forwarding_rules": [
      {
        "entry_protocol": "http",
        "entry_port": 80,
        "target_protocol": "http",
        "target_port": 80,
        "certificate_id": "",
        "tls_passthrough": false
      },
      {
        "entry_protocol": "https",
        "entry_port": 444,
        "target_protocol": "https",
        "target_port": 443,
        "certificate_id": "",
        "tls_passthrough": true
      }
    ],
    "health_check": {
      "protocol": "http",
      "port": 80,
      "path": "/",
      "check_interval_seconds": 10,
      "response_timeout_seconds": 5,
      "healthy_threshold": 5,
      "unhealthy_threshold": 3
    },
    "sticky_sessions": {
      "type": "none"
    },
    "region": {
      "name": "New York 3",
      "slug": "nyc3",
      "sizes": [
        "512mb",
        "1gb",
        "2gb",
        "4gb",
        "8gb",
        "16gb",
        "m-16gb",
        "32gb",
        "m-32gb",
        "48gb",
        "m-64gb",
        "64gb",
        "m-128gb",
        "m-224gb"
      ],
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata",
        "install_agent"
      ],
      "available": true
    },
    "tag": "",
    "droplet_ids": [
      3164444,
      3164445
    ],
    "redirect_http_to_https": false
  }
}

List all Load Balancers

To list all of the Load Balancer instances on your account, send a GET request to /v2/load_balancers.

The response will be a JSON object with a key called load_balancers. This will be set to an array of objects, each of which will contain the standard Load Balancer attributes.

NameTypeDescription
idstringA unique ID that can be used to identify and reference a Load Balancer.
namestringA human-readable name for a Load Balancer instance.
ipstringAn attribute containing the public-facing IP address of the Load Balancer.
algorithmstringThe load balancing algorithm used to determine which backend Droplet will be selected by a client. It must be either "round_robin" or "least_connections".
statusstringA status string indicating the current state of the Load Balancer. This can be "new", "active", or "errored".
created_atstringA time value given in ISO8601 combined date and time format that represents when the Load Balancer was created.
forwarding_rulesobjectAn object specifying the forwarding rules for a Load Balancer (see table below).
health_checkobjectAn object specifying health check settings for the Load Balancer (see table below).
sticky_sessionsobjectAn object specifying sticky sessions settings for the Load Balancer (see table below).
regionobjectThe region where the Load Balancer instance is located. When setting a region, the value should be the slug identifier for the region. When you query a Load Balancer, an entire region object will be returned.
tagstringThe name of a Droplet tag corresponding to Droplets assigned to the Load Balancer.
droplet_idsarray of integersAn array containing the IDs of the Droplets assigned to the Load Balancer.
redirect_http_to_httpsboolA boolean value indicating whether HTTP requests to the Load Balancer on port 80 will be redirected to HTTPS on port 443.

The forwarding_rules attribute will contain an array of objects with the following attributes:

NameTypeDescription
entry_protocolstringThe protocol used for traffic to the Load Balancer. The possible values are: "http", "https", or "tcp".
entry_portintAn integer representing the port on which the Load Balancer instance will listen.
target_protocolstringThe protocol used for traffic from the Load Balancer to the backend Droplets. The possible values are: "http", "https", or "tcp".
target_portintAn integer representing the port on the backend Droplets to which the Load Balancer will send traffic.
certificate_idstringThe ID of the TLS certificate used for SSL termination if enabled.
tls_passthroughboolA boolean value indicating whether SSL encrypted traffic will be passed through to the backend Droplets.

The embedded health_check object will contain:

NameTypeDescription
protocolstringThe protocol used for health checks sent to the backend Droplets. The possible values are "http" or "tcp".
portintAn integer representing the port on the backend Droplets on which the health check will attempt a connection.
pathstringThe path on the backend Droplets to which the Load Balancer instance will send a request.
check_interval_secondsintThe number of seconds between between two consecutive health checks.
response_timeout_secondsintThe number of seconds the Load Balancer instance will wait for a response until marking a health check as failed.
unhealthy_thresholdintThe number of times a health check must fail for a backend Droplet to be marked "unhealthy" and be removed from the pool.
healthy_thresholdintThe number of times a health check must pass for a backend Droplet to be marked "healthy" and be re-added to the pool.

The embedded sticky_sessions object will contain:

NameTypeDescription
typestringAn attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are "cookies" or "none".
cookie_namestringThe name of the cookie sent to the client. This attribute is only returned when using "cookies" for the sticky sessions type.
cookie_ttl_secondsstringThe number of seconds until the cookie set by the Load Balancer expires. This attribute is only returned when using "cookies" for the sticky sessions type.

List all Load Balancers

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/load_balancers"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

load_balancers = client.load_balancers.all
load_balancers.each

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

opt := &godo.ListOptions{
    Page:    1,
    PerPage: 200,
}

lbs, _, err := c.LoadBalancers.List(ctx, opt)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 5000
ratelimit-remaining: 4816
ratelimit-reset: 1444931833

Response Body

{
  "load_balancers": [
    {
      "id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
      "name": "example-lb-01",
      "ip": "104.131.186.241",
      "algorithm": "round_robin",
      "status": "new",
      "created_at": "2017-02-01T22:22:58Z",
      "forwarding_rules": [
        {
          "entry_protocol": "http",
          "entry_port": 80,
          "target_protocol": "http",
          "target_port": 80,
          "certificate_id": "",
          "tls_passthrough": false
        },
        {
          "entry_protocol": "https",
          "entry_port": 444,
          "target_protocol": "https",
          "target_port": 443,
          "certificate_id": "",
          "tls_passthrough": true
        }
      ],
      "health_check": {
        "protocol": "http",
        "port": 80,
        "path": "/",
        "check_interval_seconds": 10,
        "response_timeout_seconds": 5,
        "healthy_threshold": 5,
        "unhealthy_threshold": 3
      },
      "sticky_sessions": {
        "type": "none"
      },
      "region": {
        "name": "New York 3",
        "slug": "nyc3",
        "sizes": [
          "512mb",
          "1gb",
          "2gb",
          "4gb",
          "8gb",
          "16gb",
          "m-16gb",
          "32gb",
          "m-32gb",
          "48gb",
          "m-64gb",
          "64gb",
          "m-128gb",
          "m-224gb"
        ],
        "features": [
          "private_networking",
          "backups",
          "ipv6",
          "metadata",
          "install_agent"
        ],
        "available": true
      },
      "tag": "",
      "droplet_ids": [
        3164444,
        3164445
      ],
      "redirect_http_to_https": false
    }
  ],
  "links": {
  },
  "meta": {
    "total": 1
  }
}

Update a Load Balancer

To update a Load Balancer's settings, send a PUT request to /v2/load_balancers. The request should contain a full representation of the Load Balancer including existing attributes. It may contain one of the droplets_ids or tag attributes as they are mutually exclusive. Note that any attribute that is not provided will be reset to its default value.

NameTypeDescriptionRequired
namestringA human-readable name for a Load Balancer instance.true
algorithmstringThe load balancing algorithm used to determine which backend Droplet will be selected by a client. It must be either "round_robin" or "least_connections". The default value is "round_robin".
regionstringThe region where the Load Balancer instance will be located. When setting a region, the value should be the slug identifier for the region. When you query a Load Balancer, an entire region object will be returned.true
forwarding_rulesarray of objectsAn array of objects specifying the forwarding rules for a Load Balancer. At least one forwarding rule is required when creating a new Load Balancer instance (see table below).true
health_checkobjectAn object specifying health check settings for the Load Balancer. If omitted, default values will be provided (see table below).
sticky_sessionsobjectAn object specifying sticky sessions settings for the Load Balancer (see table below).
redirect_http_to_httpsboolA boolean value indicating whether HTTP requests to the Load Balancer on port 80 will be redirected to HTTPS on port 443. Default value is false.
droplet_idsarray of integersAn array containing the IDs of the Droplets to be assigned to the Load Balancer. This attribute and the "tag" attribute are mutually exclusive.
tagstringThe name of a Droplet tag corresponding to Droplets to be assigned to the Load Balancer. This attribute and the "droplet_ids" attribute are mutually exclusive.

A Load Balancer's forwarding_rules attribute is made up of an array of objects with the following attributes:

NameTypeDescriptionRequired
entry_protocolstringThe protocol used for traffic to the Load Balancer. The possible values are: "http", "https", or "tcp". true
entry_portintAn integer representing the port on which the Load Balancer instance will listen.true
target_protocolstringThe protocol used for traffic from the Load Balancer to the backend Droplets. The possible values are: "http", "https", or "tcp". true
target_portintAn integer representing the port on the backend Droplets to which the Load Balancer will send traffic.true
certificate_idstringThe ID of the TLS certificate to be used for SSL termination.
tls_passthroughboolA boolean value indicating whether SSL encrypted traffic will be passed through to the backend Droplets. The defaults value is false.

A Load Balancer's health_check attribute is made up of an object containing:

NameTypeDescriptionRequired
protocolstringThe protocol used for health checks sent to the backend Droplets. The possible values are "http" or "tcp".true
portintAn integer representing the port on the backend Droplets on which the health check will attempt a connection.true
pathstringThe path on the backend Droplets to which the Load Balancer instance will send a request. The default value is "/".
check_interval_secondsintThe number of seconds between between two consecutive health checks. If not specified, the default value is "10".
response_timeout_secondsintThe number of seconds the Load Balancer instance will wait for a response until marking a health check as failed. If not specified, the default value is "5".
unhealthy_thresholdintThe number of times a health check must fail for a backend Droplet to be marked "unhealthy" and be removed from the pool. If not specified, the default value is "3".
healthy_thresholdintThe number of times a health check must pass for a backend Droplet to be marked "healthy" and be re-added to the pool. If not specified, the default value is "5".

A Load Balancer's sticky_sessions attribute is made up of an object containing:

NameTypeDescription
typestringAn attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are "cookies" or "none". If not specified, the default value is "none".
cookie_namestringThe name to be used for the cookie sent to the client. This attribute is required when using "cookies" for the sticky sessions type.
cookie_ttl_secondsstringThe number of seconds until the cookie set by the Load Balancer expires. This attribute is required when using "cookies" for the sticky sessions type.

The Load Balancer instance will be updated using the provided information. The response body will contain a JSON object with a key called load_balancer. The value will be an object containing the standard attributes for your new Load Balancer:

NameTypeDescription
idstringA unique ID that can be used to identify and reference a Load Balancer.
namestringA human-readable name for a Load Balancer instance.
ipstringAn attribute containing the public-facing IP address of the Load Balancer.
algorithmstringThe load balancing algorithm used to determine which backend Droplet will be selected by a client. It must be either "round_robin" or "least_connections".
statusstringA status string indicating the current state of the Load Balancer. This can be "new", "active", or "errored".
created_atstringA time value given in ISO8601 combined date and time format that represents when the Load Balancer was created.
forwarding_rulesobjectAn object specifying the forwarding rules for a Load Balancer (see table below).
health_checkobjectAn object specifying health check settings for the Load Balancer (see table below).
sticky_sessionsobjectAn object specifying sticky sessions settings for the Load Balancer (see table below).
regionobjectThe region where the Load Balancer instance is located. When setting a region, the value should be the slug identifier for the region. When you query a Load Balancer, an entire region object will be returned.
tagstringThe name of a Droplet tag corresponding to Droplets assigned to the Load Balancer.
droplet_idsarray of integersAn array containing the IDs of the Droplets assigned to the Load Balancer.
redirect_http_to_httpsboolA boolean value indicating whether HTTP requests to the Load Balancer on port 80 will be redirected to HTTPS on port 443.

Update a Load Balancer

cURL Example

curl -X PUT -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"name":"example-lb-01","region":"nyc3","algorithm":"least_connections","forwarding_rules":[{"entry_protocol":"http","entry_port":80,"target_protocol":"http","target_port":80},{"entry_protocol":"https","entry_port":444,"target_protocol":"https","target_port":443,"tls_passthrough":true}],"health_check":{"protocol":"http","port":80,"path":"/","check_interval_seconds":10,"response_timeout_seconds":5,"healthy_threshold":5,"unhealthy_threshold":3},"sticky_sessions":{"type":"cookies", "cookie_name": "DO_LB", "cookie_ttl_seconds": 300}, "droplet_ids": [3164444, 3164445]}' "https://api.digitalocean.com/v2/load_balancers/4de7ac8b-495b-4884-9a69-1050c6793cd6"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

load_balancer = DropletKit::LoadBalancer.new(
  name: 'example-lb-01',
  algorithm: 'round_robin',
  droplet_ids: [ 3164444, 3164445],
  redirect_http_to_https: true,
  region: 'nyc3',
  forwarding_rules: [
    DropletKit::ForwardingRule.new(
      entry_protocol: 'http',
      entry_port: 80,
      target_protocol: 'http',
      target_port: 80,
      certificate_id: '',
      tls_passthrough: false
    ),
    DropletKit::ForwardingRule.new(
      entry_protocol: 'https',
      entry_port: 443,
      target_protocol: 'https',
      target_port: 443,
      certificate_id: '',
      tls_passthrough: true
    )
  ],
  sticky_sessions: DropletKit::StickySession.new(
    type: 'cookies',
    cookie_name: 'DO-LB-COOKIE',
    cookie_ttl_seconds: 5
  ),
  health_check: DropletKit::HealthCheck.new(
    protocol: 'http',
    port: 80,
    path: '/',
    check_interval_seconds: 10,
    response_timeout_seconds: 5,
    healthy_threshold: 5,
    unhealthy_threshold: 3
  )
)
client.load_balancers.update(load_balancer, id: '4de7ac8b-495b-4884-9a69-1050c6793cd6')

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

updateRequest := &godo.LoadBalancerRequest{
    Name:      "example-01",
    Algorithm: "round_robin",
    Region:    "nyc3",
    ForwardingRules: []godo.ForwardingRule{
        {
            EntryProtocol:  "http",
            EntryPort:      80,
            TargetProtocol: "http",
            TargetPort:     80,
        },
        {
            EntryProtocol:  "https",
            EntryPort:      443,
            TargetProtocol: "https",
            TargetPort:     443,
            TlsPassthrough: true,
        },
    },
    HealthCheck: &godo.HealthCheck{
        Protocol:               "http",
        Port:                   80,
        Path:                   "/",
        CheckIntervalSeconds:   10,
        ResponseTimeoutSeconds: 5,
        HealthyThreshold:       5,
        UnhealthyThreshold:     3,
    },
    StickySessions: &godo.StickySessions{
        Type:             "cookies",
        CookieName:       "DO_LB",
        CookieTtlSeconds: 300,
    },
    DropletIDs:          []int{3164444, 3164445},
    RedirectHttpToHttps: false,
}

lb, _, err := c.LoadBalancers.Update(ctx, "c2c97ca7-6f63-4e23-8909-906fd86efb5e", updateRequest)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "name": "example-lb-01",
  "region": "nyc3",
  "algorithm": "least_connections",
  "forwarding_rules": [
    {
      "entry_protocol": "http",
      "entry_port": 80,
      "target_protocol": "http",
      "target_port": 80
    },
    {
      "entry_protocol": "https",
      "entry_port": 444,
      "target_protocol": "https",
      "target_port": 443,
      "tls_passthrough": true
    }
  ],
  "health_check": {
    "protocol": "http",
    "port": 80,
    "path": "/",
    "check_interval_seconds": 10,
    "response_timeout_seconds": 5,
    "healthy_threshold": 5,
    "unhealthy_threshold": 3
  },
  "sticky_sessions": {
    "type": "cookies",
    "cookie_name": "DO_LB",
    "cookie_ttl_seconds": 300
  },
  "droplet_ids": [
    3164444,
    3164445
  ]
}

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 1046
ratelimit-reset: 1415984218

Response Body

{
  "load_balancer": {
    "id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
    "name": "example-lb-01",
    "ip": "138.197.50.73",
    "algorithm": "least_connections",
    "status": "active",
    "created_at": "2017-02-01T22:22:58Z",
    "forwarding_rules": [
      {
        "entry_protocol": "http",
        "entry_port": 80,
        "target_protocol": "http",
        "target_port": 80,
        "certificate_id": "",
        "tls_passthrough": false
      },
      {
        "entry_protocol": "https",
        "entry_port": 444,
        "target_protocol": "https",
        "target_port": 443,
        "certificate_id": "",
        "tls_passthrough": true
      }
    ],
    "health_check": {
      "protocol": "http",
      "port": 80,
      "path": "/",
      "check_interval_seconds": 10,
      "response_timeout_seconds": 5,
      "healthy_threshold": 5,
      "unhealthy_threshold": 3
    },
    "sticky_sessions": {
      "type": "cookies",
      "cookie_name": "DO_LB",
      "cookie_ttl_seconds": 300
    },
    "region": {
      "name": "New York 3",
      "slug": "nyc3",
      "sizes": [
        "512mb",
        "1gb",
        "2gb",
        "4gb",
        "8gb",
        "16gb",
        "m-16gb",
        "32gb",
        "m-32gb",
        "48gb",
        "m-64gb",
        "64gb",
        "m-128gb",
        "m-224gb"
      ],
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata",
        "install_agent"
      ],
      "available": true
    },
    "tag": "",
    "droplet_ids": [
      34153248,
      34153250
    ],
    "redirect_http_to_https": false
  }
}

Delete a Load Balancer

To delete a Load Balancer instance, disassociating any Droplets assigned to it and removing it from your account, send a DELETE request to /v2/load_balancers/$LOAD_BALANCER_ID.

No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.

Delete a Load Balancer

cURL Example

curl -X DELETE -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/load_balancers/4de7ac8b-495b-4884-9a69-1050c6793cd6"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.load_balancers.delete(id: '4de7ac8b-495b-4884-9a69-1050c6793cd6')

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

_, err := client.LoadBalancers.Delete(ctx, "4de7ac8b-495b-4884-9a69-1050c6793cd6")

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 204 No Content
ratelimit-limit: 5000
ratelimit-remaining: 4816
ratelimit-reset: 1444931833

Add Droplets to a Load Balancer

To assign a Droplet to a Load Balancer instance, send a POST request to /v2/load_balancers/$LOAD_BALANCER_ID/droplets. In the body of the request, there should be a "droplet_ids" attribute containing a list of Droplet IDs. Individual Droplets can not be added to a Load Balancer configured with a Droplet tag. Attempting to do so will result in a "422 Unprocessable Entity" response from the API.

No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.

NameTypeDescriptionRequired
droplet_idsarray of integersAn array containing the IDs of the Droplets to be assigned to the Load Balancer instance.true

Add Droplets to a Load Balancer

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"droplet_ids": [3164446, 3164447]}' "https://api.digitalocean.com/v2/load_balancers/4de7ac8b-495b-4884-9a69-1050c6793cd6/droplets"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.load_balancers.add_droplets([3164446, 3164447], id: '4de7ac8b-495b-4884-9a69-1050c6793cd6')

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

droplets := []int{3164446, 3164447}
_, err := client.LoadBalancers.AddDroplets(ctx, "4de7ac8b-495b-4884-9a69-1050c6793cd6", droplets...)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "droplet_ids": [
    3164446,
    3164447
  ]
}

Response Headers

content-type: application/json; charset=utf-8
status: 204 No Content
ratelimit-limit: 1200
ratelimit-remaining: 903
ratelimit-reset: 1415984218

Remove Droplets from a Load Balancer

To remove a Droplet from a Load Balancer instance, send a DELETE request to /v2/load_balancers/$LOAD_BALANCER_ID/droplets. In the body of the request, there should be a "droplet_ids" attribute containing a list of Droplet IDs.

No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.

NameTypeDescriptionRequired
droplet_idsarray of integersAn array containing the IDs of the Droplets to be removed from the Load Balancer instance.true

Remove Droplets from a Load Balancer

cURL Example

curl -X DELETE -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"droplet_ids": [3164446, 3164447]}' "https://api.digitalocean.com/v2/load_balancers/4de7ac8b-495b-4884-9a69-1050c6793cd6/droplets"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.load_balancers.remove_droplets([3164446, 3164447], id: '4de7ac8b-495b-4884-9a69-1050c6793cd6')

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

droplets := []int{3164446, 3164447}
_, err := client.LoadBalancers.RemoveDroplets(ctx, "4de7ac8b-495b-4884-9a69-1050c6793cd6", droplets...)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "droplet_ids": [
    3164446,
    3164447
  ]
}

Response Headers

content-type: application/json; charset=utf-8
status: 204 No Content
ratelimit-limit: 1200
ratelimit-remaining: 903
ratelimit-reset: 1415984218

Add forwarding rules to a Load Balancer

To add an additional forwarding rule to a Load Balancer instance, send a POST request to /v2/load_balancers/$LOAD_BALANCER_ID/forwarding_rules. In the body of the request, there should be a "forwarding_rules" attribute containing an array of rules to be added.

No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.

NameTypeDescriptionRequired
entry_protocolstringThe protocol used for traffic to the Load Balancer. The possible values are: "http", "https", or "tcp". true
entry_portintAn integer representing the port on which the Load Balancer instance will listen.true
target_protocolstringThe protocol used for traffic from the Load Balancer to the backend Droplets. The possible values are: "http", "https", or "tcp". true
target_portintAn integer representing the port on the backend Droplets to which the Load Balancer will send traffic.true
certificate_idstringThe ID of the TLS certificate to be used for SSL termination.
tls_passthroughboolA boolean value indicating whether SSL encrypted traffic will be passed through to the backend Droplets. The defaults value is false.

Add forwarding rules to a Load Balancer

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"forwarding_rules": [{"entry_protocol": "tcp","entry_port": 3306,"target_protocol": "tcp","target_port": 3306}]}' "https://api.digitalocean.com/v2/load_balancers/4de7ac8b-495b-4884-9a69-1050c6793cd6/forwarding_rules"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

rule = DropletKit::ForwardingRule.new(
  entry_protocol: 'tcp',
  entry_port: 3306,
  target_protocol: 'tcp',
  target_port: 3306,
  certificate_id: '',
  tls_passthrough: false
)
client.load_balancers.add_forwarding_rules([rule], id: '4de7ac8b-495b-4884-9a69-1050c6793cd6')

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

forwardingRule := []godo.ForwardingRule{
    {
        EntryProtocol:  "tcp",
        EntryPort:      3306,
        TargetProtocol: "tcp",
        TargetPort:     3306,
    },
}

_, err := client.LoadBalancers.AddForwardingRules(ctx, "4de7ac8b-495b-4884-9a69-1050c6793cd6", forwardingRule...)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "forwarding_rules": [
    {
      "entry_protocol": "tcp",
      "entry_port": 3306,
      "target_protocol": "tcp",
      "target_port": 3306
    }
  ]
}

Response Headers

content-type: application/json; charset=utf-8
status: 204 No Content
ratelimit-limit: 1200
ratelimit-remaining: 837
ratelimit-reset: 1415984218

Remove forwarding rules from a Load Balancer

To remove forwarding rules from a Load Balancer instance, send a DELETE request to /v2/load_balancers/$LOAD_BALANCER_ID/forwarding_rules. In the body of the request, there should be a "forwarding_rules" attribute containing an array of rules to be removed.

No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.

NameTypeDescriptionRequired
entry_protocolstringThe protocol used for traffic to the Load Balancer. The possible values are: "http", "https", or "tcp". true
entry_portintAn integer representing the port on which the Load Balancer instance will listen.true
target_protocolstringThe protocol used for traffic from the Load Balancer to the backend Droplets. The possible values are: "http", "https", or "tcp". true
target_portintAn integer representing the port on the backend Droplets to which the Load Balancer will send traffic.true
certificate_idstringThe ID of the TLS certificate to be used for SSL termination.
tls_passthroughboolA boolean value indicating whether SSL encrypted traffic will be passed through to the backend Droplets. The defaults value is false.

Remove forwarding rules from a Load Balancer

cURL Example

curl -X DELETE -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"forwarding_rules": [{"entry_protocol": "tcp","entry_port": 3306,"target_protocol": "tcp","target_port": 3306}]}' "https://api.digitalocean.com/v2/load_balancers/4de7ac8b-495b-4884-9a69-1050c6793cd6/forwarding_rules"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

rule = DropletKit::ForwardingRule.new(
  entry_protocol: 'tcp',
  entry_port: 3306,
  target_protocol: 'tcp',
  target_port: 3306,
  certificate_id: '',
  tls_passthrough: false
)
client.load_balancers.remove_forwarding_rules([rule], id: '4de7ac8b-495b-4884-9a69-1050c6793cd6')

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

forwardingRule := []godo.ForwardingRule{
    {
        EntryProtocol:  "tcp",
        EntryPort:      3306,
        TargetProtocol: "tcp",
        TargetPort:     3306,
    },
}

_, err := client.LoadBalancers.RemoveForwardingRules(ctx, "4de7ac8b-495b-4884-9a69-1050c6793cd6", forwardingRule...)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "forwarding_rules": [
    {
      "entry_protocol": "tcp",
      "entry_port": 3306,
      "target_protocol": "tcp",
      "target_port": 3306
    }
  ]
}

Response Headers

content-type: application/json; charset=utf-8
status: 204 No Content
ratelimit-limit: 1200
ratelimit-remaining: 837
ratelimit-reset: 1415984218

SSH Keys

DigitalOcean allows you to add SSH public keys to the interface so that you can embed your public key into a Droplet at the time of creation. Only the public key is required to take advantage of this functionality.

NameTypeDescription
idnumberThis is a unique identification number for the key. This can be used to reference a specific SSH key when you wish to embed a key into a Droplet.
fingerprintstringThis attribute contains the fingerprint value that is generated from the public key. This is a unique identifier that will differentiate it from other keys using a format that SSH recognizes.
public_keystringThis attribute contains the entire public key string that was uploaded. This is what is embedded into the root user's authorized_keys file if you choose to include this SSH key during Droplet creation.
namestringThis is the human-readable display name for the given SSH key. This is used to easily identify the SSH keys when they are displayed.

List all Keys

To list all of the keys in your account, send a GET request to /v2/account/keys.

The response will be a JSON object with a key set to ssh_keys. The value of this will be an array of key objects, each of which contain the standard key attributes:

NameTypeDescription
idnumberThis is a unique identification number for the key. This can be used to reference a specific SSH key when you wish to embed a key into a Droplet.
fingerprintstringThis attribute contains the fingerprint value that is generated from the public key. This is a unique identifier that will differentiate it from other keys using a format that SSH recognizes.
public_keystringThis attribute contains the entire public key string that was uploaded. This is what is embedded into the root user's authorized_keys file if you choose to include this SSH key during Droplet creation.
namestringThis is the human-readable display name for the given SSH key. This is used to easily identify the SSH keys when they are displayed.

List all Keys

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/account/keys"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

ssh_keys = client.ssh_keys.all
ssh_keys.each

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

opt := &godo.ListOptions{
    Page:    1,
    PerPage: 200,
}

keys, _, err := client.Keys.List(ctx, opt)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 767
ratelimit-reset: 1415984218

Response Body

{
  "ssh_keys": [
    {
      "id": 512189,
      "fingerprint": "3b:16:bf:e4:8b:00:8b:b8:59:8c:a9:d3:f0:19:45:fa",
      "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAQQDDHr/jh2Jy4yALcK4JyWbVkPRaWmhck3IgCoeOO3z1e2dBowLh64QAM+Qb72pxekALga2oi4GvT+TlWNhzPH4V example",
      "name": "My SSH Public Key"
    }
  ],
  "links": {
  },
  "meta": {
    "total": 1
  }
}

Create a new Key

To add a new SSH public key to your DigitalOcean account, send a POST request to /v2/account/keys. Set the "name" attribute to the name you wish to use and the "public_key" attribute to a string of the full public key you are adding.

NameTypeDescriptionRequired
namestringThe name to give the new SSH key in your account.true
public_keystringA string containing the entire public key.true

The response body will be a JSON object with a key set to ssh_key. The value will be the complete generated key object. This will have the standard key attributes:

NameTypeDescription
idnumberThis is a unique identification number for the key. This can be used to reference a specific SSH key when you wish to embed a key into a Droplet.
fingerprintstringThis attribute contains the fingerprint value that is generated from the public key. This is a unique identifier that will differentiate it from other keys using a format that SSH recognizes.
public_keystringThis attribute contains the entire public key string that was uploaded. This is what is embedded into the root user's authorized_keys file if you choose to include this SSH key during Droplet creation.
namestringThis is the human-readable display name for the given SSH key. This is used to easily identify the SSH keys when they are displayed.

Create a new Key

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"name":"My SSH Public Key","public_key":"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAQQDDHr/jh2Jy4yALcK4JyWbVkPRaWmhck3IgCoeOO3z1e2dBowLh64QAM+Qb72pxekALga2oi4GvT+TlWNhzPH4V example"}' "https://api.digitalocean.com/v2/account/keys"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

ssh_key = DropletKit::SSHKey.new(
  name: 'My SSH Public Key',
  public_key: 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAQQDDHr/jh2Jy4yALcK4JyWbVkPRaWmhck3IgCoeOO3z1e2dBowLh64QAM+Qb72pxekALga2oi4GvT+TlWNhzPH4V example'
)
client.ssh_keys.create(ssh_key)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

createRequest := &godo.KeyCreateRequest{
    Name:      "My SSH Public Key",
    PublicKey: "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAQQDDHr/jh2Jy4yALcK4JyWbVkPRaWmhck3IgCoeOO3z1e2dBowLh64QAM+Qb72pxekALga2oi4GvT+TlWNhzPH4V example",
}

transfer, _, err := client.Keys.Create(ctx, createRequest)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "name": "My SSH Public Key",
  "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAQQDDHr/jh2Jy4yALcK4JyWbVkPRaWmhck3IgCoeOO3z1e2dBowLh64QAM+Qb72pxekALga2oi4GvT+TlWNhzPH4V example"
}

Response Headers

content-type: application/json; charset=utf-8
status: 201 Created
ratelimit-limit: 1200
ratelimit-remaining: 765
ratelimit-reset: 1415984218

Response Body

{
  "ssh_key": {
    "id": 512190,
    "fingerprint": "3b:16:bf:e4:8b:00:8b:b8:59:8c:a9:d3:f0:19:45:fa",
    "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAQQDDHr/jh2Jy4yALcK4JyWbVkPRaWmhck3IgCoeOO3z1e2dBowLh64QAM+Qb72pxekALga2oi4GvT+TlWNhzPH4V example",
    "name": "My SSH Public Key"
  }
}

Retrieve an existing Key

To show information about a key, send a GET request to /v2/account/keys/$KEY_ID or /v2/account/keys/$KEY_FINGERPRINT.

The response will be a JSON object with a key called ssh_key. The value of this will be a key object which contains the standard key attributes:

NameTypeDescription
idnumberThis is a unique identification number for the key. This can be used to reference a specific SSH key when you wish to embed a key into a Droplet.
fingerprintstringThis attribute contains the fingerprint value that is generated from the public key. This is a unique identifier that will differentiate it from other keys using a format that SSH recognizes.
public_keystringThis attribute contains the entire public key string that was uploaded. This is what is embedded into the root user's authorized_keys file if you choose to include this SSH key during Droplet creation.
namestringThis is the human-readable display name for the given SSH key. This is used to easily identify the SSH keys when they are displayed.

Retrieve an existing Key

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/account/keys/512190"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.ssh_keys.find(id: 512190)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

key, _, err := client.Keys.GetByID(ctx, 512190)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 764
ratelimit-reset: 1415984218

Response Body

{
  "ssh_key": {
    "id": 512190,
    "fingerprint": "3b:16:bf:e4:8b:00:8b:b8:59:8c:a9:d3:f0:19:45:fa",
    "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAQQDDHr/jh2Jy4yALcK4JyWbVkPRaWmhck3IgCoeOO3z1e2dBowLh64QAM+Qb72pxekALga2oi4GvT+TlWNhzPH4V example",
    "name": "My SSH Public Key"
  }
}

Update a Key

To update the name of an SSH key, send a PUT request to either /v2/account/keys/$SSH_KEY_ID or /v2/account/keys/$SSH_KEY_FINGERPRINT. Set the "name" attribute to the new name you want to use.

NameTypeDescriptionRequired
namestringThe name to give the new SSH key in your account.true

The response body will be a JSON object with a key set to ssh_key. The value will be an ojbect that contains the standard key attributes:

NameTypeDescription
idnumberThis is a unique identification number for the key. This can be used to reference a specific SSH key when you wish to embed a key into a Droplet.
fingerprintstringThis attribute contains the fingerprint value that is generated from the public key. This is a unique identifier that will differentiate it from other keys using a format that SSH recognizes.
public_keystringThis attribute contains the entire public key string that was uploaded. This is what is embedded into the root user's authorized_keys file if you choose to include this SSH key during Droplet creation.
namestringThis is the human-readable display name for the given SSH key. This is used to easily identify the SSH keys when they are displayed.

Update a Key

cURL Example

curl -X PUT -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"name":"Renamed SSH Key"}' "https://api.digitalocean.com/v2/account/keys/512190"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

ssh_key = DropletKit::SSHKey.new(name: 'Renamed SSH Key')
client.ssh_keys.update(ssh_key, id: 512190)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

updateRequest := &godo.KeyUpdateRequest{
    Name:      "Renamed SSH Key",
}

key, _, err := client.Keys.UpdateByID(ctx, 512190, updateRequest)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "name": "Renamed SSH Key"
}

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 763
ratelimit-reset: 1415984218

Response Body

{
  "ssh_key": {
    "id": 512190,
    "fingerprint": "3b:16:bf:e4:8b:00:8b:b8:59:8c:a9:d3:f0:19:45:fa",
    "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAQQDDHr/jh2Jy4yALcK4JyWbVkPRaWmhck3IgCoeOO3z1e2dBowLh64QAM+Qb72pxekALga2oi4GvT+TlWNhzPH4V example",
    "name": "Renamed SSH Key"
  }
}

Destroy a Key

To destroy a public SSH key that you have in your account, send a DELETE request to /v2/account/keys/$KEY_ID or /v2/account/keys/$KEY_FINGERPRINT.

A 204 status will be returned, indicating that the action was successful and that the response body is empty.

Destroy a Key

cURL Example

curl -X DELETE -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/account/keys/512190"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.ssh_keys.delete(id: 512190)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

_, err := client.Keys.DeleteByID(ctx, 512190)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/octet-stream
status: 204 No Content
ratelimit-limit: 1200
ratelimit-remaining: 762
ratelimit-reset: 1415984218

Regions

A region in DigitalOcean represents a datacenter where Droplets can be deployed and images can be transferred.

Each region represents a specific datacenter in a geographic location. Some geographical locations may have multiple "regions" available. This means that there are multiple datacenters available within that area.

NameTypeDescription
slugstringA human-readable string that is used as a unique identifier for each region.
namestringThe display name of the region. This will be a full name that is used in the control panel and other interfaces.
sizesarrayThis attribute is set to an array which contains the identifying slugs for the sizes available in this region.
availablebooleanThis is a boolean value that represents whether new Droplets can be created in this region.
featuresarrayThis attribute is set to an array which contains features available in this region

List all Regions

To list all of the regions that are available, send a GET request to /v2/regions.

The response will be a JSON object with a key called regions. The value of this will be an array of region objects, each of which will contain the standard region attributes:

NameTypeDescription
slugstringA human-readable string that is used as a unique identifier for each region.
namestringThe display name of the region. This will be a full name that is used in the control panel and other interfaces.
sizesarrayThis attribute is set to an array which contains the identifying slugs for the sizes available in this region.
availablebooleanThis is a boolean value that represents whether new Droplets can be created in this region.
featuresarrayThis attribute is set to an array which contains features available in this region

List all Regions

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/regions"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

regions = client.regions.all
regions.each

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

opt := &godo.ListOptions{
    Page:    1,
    PerPage: 200,
}

regions, _, err := client.Regions.List(ctx, opt)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 770
ratelimit-reset: 1415984218

Response Body

{
  "regions": [
    {
      "name": "New York 1",
      "slug": "nyc1",
      "sizes": [

      ],
      "features": [
        "virtio",
        "backups"
      ],
      "available": false
    },
    {
      "name": "Amsterdam 1",
      "slug": "ams1",
      "sizes": [

      ],
      "features": [
        "virtio",
        "backups"
      ],
      "available": false
    },
    {
      "name": "San Francisco 1",
      "slug": "sfo1",
      "sizes": [
        "32gb",
        "16gb",
        "2gb",
        "1gb",
        "4gb",
        "8gb",
        "512mb",
        "64gb",
        "48gb"
      ],
      "features": [
        "virtio",
        "backups",
        "metadata"
      ],
      "available": true
    },
    {
      "name": "New York 2",
      "slug": "nyc2",
      "sizes": [
        "32gb",
        "16gb",
        "2gb",
        "1gb",
        "4gb",
        "8gb",
        "512mb",
        "64gb",
        "48gb"
      ],
      "features": [
        "virtio",
        "private_networking",
        "backups"
      ],
      "available": true
    },
    {
      "name": "Amsterdam 2",
      "slug": "ams2",
      "sizes": [
        "32gb",
        "16gb",
        "2gb",
        "1gb",
        "4gb",
        "8gb",
        "512mb",
        "64gb",
        "48gb"
      ],
      "features": [
        "virtio",
        "private_networking",
        "backups",
        "metadata"
      ],
      "available": true
    },
    {
      "name": "Singapore 1",
      "slug": "sgp1",
      "sizes": [
        "32gb",
        "16gb",
        "2gb",
        "1gb",
        "4gb",
        "8gb",
        "512mb",
        "64gb",
        "48gb"
      ],
      "features": [
        "virtio",
        "private_networking",
        "backups",
        "ipv6",
        "metadata"
      ],
      "available": true
    },
    {
      "name": "London 1",
      "slug": "lon1",
      "sizes": [
        "32gb",
        "16gb",
        "2gb",
        "1gb",
        "4gb",
        "8gb",
        "512mb",
        "64gb",
        "48gb"
      ],
      "features": [
        "virtio",
        "private_networking",
        "backups",
        "ipv6",
        "metadata"
      ],
      "available": true
    },
    {
      "name": "New York 3",
      "slug": "nyc3",
      "sizes": [
        "32gb",
        "16gb",
        "2gb",
        "1gb",
        "4gb",
        "8gb",
        "512mb",
        "64gb",
        "48gb"
      ],
      "features": [
        "virtio",
        "private_networking",
        "backups",
        "ipv6",
        "metadata"
      ],
      "available": true
    },
    {
      "name": "Amsterdam 3",
      "slug": "ams3",
      "sizes": [
        "32gb",
        "16gb",
        "2gb",
        "1gb",
        "4gb",
        "8gb",
        "512mb",
        "64gb",
        "48gb"
      ],
      "features": [
        "virtio",
        "private_networking",
        "backups",
        "ipv6",
        "metadata"
      ],
      "available": true
    }
  ],
  "links": {
  },
  "meta": {
    "total": 9
  }
}

Sizes

The sizes objects represent different packages of hardware resources that can be used for Droplets. When a Droplet is created, a size must be selected so that the correct resources can be allocated.

Each size represents a plan that bundles together specific sets of resources. This includes the amount of RAM, the number of virtual CPUs, disk space, and transfer. The size object also includes the pricing details and the regions that the size is available in.

NameTypeDescription
slugstringA human-readable string that is used to uniquely identify each size.
availablebooleanThis is a boolean value that represents whether new Droplets can be created with this size.
transfernumberThe amount of transfer bandwidth that is available for Droplets created in this size. This only counts traffic on the public interface. The value is given in terabytes.
price_monthlynumberThis attribute describes the monthly cost of this Droplet size if the Droplet is kept for an entire month. The value is measured in US dollars.
price_hourlynumberThis describes the price of the Droplet size as measured hourly. The value is measured in US dollars.
memorynumberThe amount of RAM allocated to Droplets created of this size. The value is represented in megabytes.
vcpusnumberThe number of virtual CPUs allocated to Droplets of this size.
disknumberThe amount of disk space set aside for Droplets of this size. The value is represented in gigabytes.
regionsarrayAn array containing the region slugs where this size is available for Droplet creates.

List all Sizes

To list all of the sizes, send a GET request to /v2/sizes.

The response will be a JSON object with a key called sizes. The value of this will be an array of size objects each of which contain the standard sizes attributes:

NameTypeDescription
slugstringA human-readable string that is used to uniquely identify each size.
availablebooleanThis is a boolean value that represents whether new Droplets can be created with this size.
transfernumberThe amount of transfer bandwidth that is available for Droplets created in this size. This only counts traffic on the public interface. The value is given in terabytes.
price_monthlynumberThis attribute describes the monthly cost of this Droplet size if the Droplet is kept for an entire month. The value is measured in US dollars.
price_hourlynumberThis describes the price of the Droplet size as measured hourly. The value is measured in US dollars.
memorynumberThe amount of RAM allocated to Droplets created of this size. The value is represented in megabytes.
vcpusnumberThe number of virtual CPUs allocated to Droplets of this size.
disknumberThe amount of disk space set aside for Droplets of this size. The value is represented in gigabytes.
regionsarrayAn array containing the region slugs where this size is available for Droplet creates.

List all Sizes

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/sizes"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

sizes = client.sizes.all
sizes.each

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

opt := &godo.ListOptions{
    Page:    1,
    PerPage: 200,
}

sizes, _, err := client.Sizes.List(ctx, opt)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 769
ratelimit-reset: 1415984218

Response Body

{
  "sizes": [
    {
      "slug": "512mb",
      "memory": 512,
      "vcpus": 1,
      "disk": 20,
      "transfer": 1.0,
      "price_monthly": 5.0,
      "price_hourly": 0.00744,
      "regions": [
        "nyc1",
        "sgp1",
        "ams1",
        "ams2",
        "sfo1",
        "nyc2",
        "lon1",
        "nyc3",
        "ams3"
      ],
      "available": true
    },
    {
      "slug": "1gb",
      "memory": 1024,
      "vcpus": 1,
      "disk": 30,
      "transfer": 2.0,
      "price_monthly": 10.0,
      "price_hourly": 0.01488,
      "regions": [
        "nyc2",
        "sgp1",
        "ams1",
        "sfo1",
        "lon1",
        "nyc3",
        "ams3",
        "ams2",
        "nyc1"
      ],
      "available": true
    },
    {
      "slug": "2gb",
      "memory": 2048,
      "vcpus": 2,
      "disk": 40,
      "transfer": 3.0,
      "price_monthly": 20.0,
      "price_hourly": 0.02976,
      "regions": [
        "nyc2",
        "sfo1",
        "ams1",
        "sgp1",
        "ams2",
        "lon1",
        "nyc3",
        "ams3",
        "nyc1"
      ],
      "available": true
    },
    {
      "slug": "4gb",
      "memory": 4096,
      "vcpus": 2,
      "disk": 60,
      "transfer": 4.0,
      "price_monthly": 40.0,
      "price_hourly": 0.05952,
      "regions": [
        "nyc2",
        "sfo1",
        "ams1",
        "sgp1",
        "ams2",
        "lon1",
        "nyc3",
        "ams3",
        "nyc1"
      ],
      "available": true
    },
    {
      "slug": "8gb",
      "memory": 8192,
      "vcpus": 4,
      "disk": 80,
      "transfer": 5.0,
      "price_monthly": 80.0,
      "price_hourly": 0.11905,
      "regions": [
        "nyc2",
        "sfo1",
        "sgp1",
        "ams1",
        "ams2",
        "nyc1",
        "lon1",
        "nyc3",
        "ams3"
      ],
      "available": true
    },
    {
      "slug": "16gb",
      "memory": 16384,
      "vcpus": 8,
      "disk": 160,
      "transfer": 6.0,
      "price_monthly": 160.0,
      "price_hourly": 0.2381,
      "regions": [
        "sgp1",
        "nyc1",
        "sfo1",
        "ams2",
        "nyc3",
        "lon1",
        "nyc2",
        "ams1",
        "ams3"
      ],
      "available": true
    },
    {
      "slug": "32gb",
      "memory": 32768,
      "vcpus": 12,
      "disk": 320,
      "transfer": 7.0,
      "price_monthly": 320.0,
      "price_hourly": 0.47619,
      "regions": [
        "nyc2",
        "sgp1",
        "ams2",
        "nyc1",
        "sfo1",
        "lon1",
        "ams3",
        "nyc3"
      ],
      "available": true
    },
    {
      "slug": "48gb",
      "memory": 49152,
      "vcpus": 16,
      "disk": 480,
      "transfer": 8.0,
      "price_monthly": 480.0,
      "price_hourly": 0.71429,
      "regions": [
        "sgp1",
        "ams2",
        "sfo1",
        "nyc1",
        "lon1",
        "nyc2",
        "ams3",
        "nyc3"
      ],
      "available": true
    },
    {
      "slug": "64gb",
      "memory": 65536,
      "vcpus": 20,
      "disk": 640,
      "transfer": 9.0,
      "price_monthly": 640.0,
      "price_hourly": 0.95238,
      "regions": [
        "sgp1",
        "nyc1",
        "nyc2",
        "sfo1",
        "lon1",
        "ams3",
        "ams2",
        "nyc3"
      ],
      "available": true
    }
  ],
  "links": {
  },
  "meta": {
    "total": 9
  }
}

Floating IPs

Floating IP objects represent a publicly-accessible static IP addresses that can be mapped to one of your Droplets. They can be used to create highly available setups or other configurations requiring movable addresses.

Floating IPs are bound to a specific region.

NameTypeDescription
ipstringThe public IP address of the Floating IP. It also serves as its identifier.
regionobjectThe region that the Floating IP is reserved to. When you query a Floating IP, the entire region object will be returned.
dropletobjectThe Droplet that the Floating IP has been assigned to. When you query a Floating IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null.

List all Floating IPs

To list all of the Floating IPs available on your account, send a GET request to /v2/floating_ips.

The response will be a JSON object with a key called floating_ips. This will be set to an array of Floating IP objects, each of which will contain the standard Floating IP attributes:

NameTypeDescription
ipstringThe public IP address of the Floating IP. It also serves as its identifier.
regionobjectThe region that the Floating IP is reserved to. When you query a Floating IP, the entire region object will be returned.
dropletobjectThe Droplet that the Floating IP has been assigned to. When you query a Floating IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null.

List all Floating IPs

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/floating_ips?page=1&per_page=20"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

floating_ips = client.floating_ips.all
floating_ips.each

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

opt := &godo.ListOptions{
    Page:    1,
    PerPage: 200,
}

floatingIPs, _, err := client.FloatingIPs.List(ctx, opt)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 5000
ratelimit-remaining: 4823
ratelimit-reset: 1444931833

Response Body

{
  "floating_ips": [
    {
      "ip": "45.55.96.47",
      "droplet": null,
      "region": {
        "name": "New York 3",
        "slug": "nyc3",
        "sizes": [
          "512mb",
          "1gb",
          "2gb",
          "4gb",
          "8gb",
          "16gb",
          "32gb",
          "48gb",
          "64gb"
        ],
        "features": [
          "private_networking",
          "backups",
          "ipv6",
          "metadata"
        ],
        "available": true
      },
      "locked": false
    }
  ],
  "links": {
  },
  "meta": {
    "total": 1
  }
}

Create a new Floating IP assigned to a Droplet

On creation, a Floating IP must be either assigned to a Droplet or reserved to a region. To create a new Floating IP assigned to a Droplet, send a POST request to /v2/floating_ips with the "droplet_id" attribute.

NameTypeDescriptionRequired
droplet_idintThe ID of Droplet that the Floating IP will be assigned to.true

The response will be a JSON object with a key called floating_ip. The value of this will be an object that contains the standard attributes associated with a Floating IP:

NameTypeDescription
ipstringThe public IP address of the Floating IP. It also serves as its identifier.
regionobjectThe region that the Floating IP is reserved to. When you query a Floating IP, the entire region object will be returned.
dropletobjectThe Droplet that the Floating IP has been assigned to. When you query a Floating IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null.

Create a new Floating IP assigned to a Droplet

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"droplet_id": 123456}' "https://api.digitalocean.com/v2/floating_ips"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

floating_ip = DropletKit::FloatingIp.new(droplet_id: 123456)
client.floating_ips.create(floating_ip)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

createRequest := &godo.FloatingIPCreateRequest{
    DropletID: 123456,

}

floatingIP, _, err := client.FloatingIPs.Create(ctx, createRequest)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "droplet_id": 123456
}

Response Headers

content-type: application/json; charset=utf-8
status: 202 Accepted
ratelimit-limit: 5000
ratelimit-remaining: 4821
ratelimit-reset: 1444931833

Response Body

{
  "floating_ip": {
    "ip": "45.55.96.47",
    "droplet": null,
    "region": {
      "name": "New York 3",
      "slug": "nyc3",
      "sizes": [
        "512mb",
        "1gb",
        "2gb",
        "4gb",
        "8gb",
        "16gb",
        "32gb",
        "48gb",
        "64gb"
      ],
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata"
      ],
      "available": true
    },
    "locked": false
  },
  "links": {
  }
}

Create a new Floating IP reserved to a Region

On creation, a Floating IP must be either assigned to a Droplet or reserved to a region. To create a Floating IP reserved to a Region, send a POST request to /v2/floating_ips with the "region" attribute.

NameTypeDescriptionRequired
regionstringThe slug identifier for the region the Floating IP will be reserved to.true

The response will be a JSON object with a key called floating_ip. The value of this will be an object that contains the standard attributes associated with a Floating IP:

NameTypeDescription
ipstringThe public IP address of the Floating IP. It also serves as its identifier.
regionobjectThe region that the Floating IP is reserved to. When you query a Floating IP, the entire region object will be returned.
dropletobjectThe Droplet that the Floating IP has been assigned to. When you query a Floating IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null.

Create a new Floating IP reserved to a Region

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"region":"nyc3"}' "https://api.digitalocean.com/v2/floating_ips"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

floating_ip = DropletKit::FloatingIp.new(region: 'nyc3')
client.floating_ips.create(floating_ip)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

createRequest := &godo.FloatingIPCreateRequest{
    Region: "nyc3",
}

floatingIP, _, err := client.FloatingIPs.Create(ctx, createRequest)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "region": "nyc3"
}

Response Headers

content-type: application/json; charset=utf-8
status: 202 Accepted
ratelimit-limit: 5000
ratelimit-remaining: 4821
ratelimit-reset: 1444931833

Response Body

{
  "floating_ip": {
    "ip": "45.55.96.47",
    "droplet": null,
    "region": {
      "name": "New York 3",
      "slug": "nyc3",
      "sizes": [
        "512mb",
        "1gb",
        "2gb",
        "4gb",
        "8gb",
        "16gb",
        "32gb",
        "48gb",
        "64gb"
      ],
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata"
      ],
      "available": true
    },
    "locked": false
  },
  "links": {
  }
}

Retrieve an existing Floating IP

To show information about a Floating IP, send a GET request to /v2/floating_ips/$FLOATING_IP_ADDR.

The response will be a JSON object with a key called floating_ip. The value of this will be an object that contains the standard attributes associated with a Floating IP:

NameTypeDescription
ipstringThe public IP address of the Floating IP. It also serves as its identifier.
regionobjectThe region that the Floating IP is reserved to. When you query a Floating IP, the entire region object will be returned.
dropletobjectThe Droplet that the Floating IP has been assigned to. When you query a Floating IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null.

Retrieve an existing Floating IP

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/floating_ips/45.55.96.47"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.floating_ips.find(ip: '45.55.96.47')

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

floatingIP, _, err := client.FloatingIPs.Get(ctx, "45.55.96.47")

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 5000
ratelimit-remaining: 4820
ratelimit-reset: 1444931833

Response Body

{
  "floating_ip": {
    "ip": "45.55.96.47",
    "droplet": null,
    "region": {
      "name": "New York 3",
      "slug": "nyc3",
      "sizes": [
        "512mb",
        "1gb",
        "2gb",
        "4gb",
        "8gb",
        "16gb",
        "32gb",
        "48gb",
        "64gb"
      ],
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata"
      ],
      "available": true
    },
    "locked": false
  }
}

Delete a Floating IPs

To delete a Floating IP and remove it from your account, send a DELETE request to /v2/floating_ips/$FLOATING_IP_ADDR.

No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.

Delete a Floating IPs

cURL Example

curl -X DELETE -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/floating_ips/45.55.96.47"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.floating_ips.delete(ip: '45.55.96.47')

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

_, err := client.FloatingIPs.Delete(ctx, "45.55.96.34")

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

status: 204 No Content
ratelimit-limit: 5000
ratelimit-remaining: 4815
ratelimit-reset: 1444931833

Floating IP Actions

Floating IP actions are commands that can be given to a DigitalOcean Floating IP. These requests are made on the actions endpoint of a specific Floating IP.

An action object is returned. These objects hold the current status of the requested action.

NameTypeDescription
idnumberA unique numeric ID that can be used to identify and reference an action.
statusstringThe current status of the action. This can be "in-progress", "completed", or "errored".
typestringThis is the type of action that the object represents. For example, this could be "assign_ip" to represent the state of a Floating IP assign action.
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

Assign a Floating IP to a Droplet

To assign a Floating IP to a Droplet, send a POST request to /v2/floating_ips/$FLOATING_IP_ADDR/actions. Set the "type" attribute to assign and the "droplet_id" attribute to the Droplet's ID.

The response will be a JSON object with a key called action. The value will be an action object:

NameTypeDescription
idnumberA unique numeric ID that can be used to identify and reference an action.
statusstringThe current status of the action. This can be "in-progress", "completed", or "errored".
typestringThis is the type of action that the object represents. For example, this could be "assign_ip" to represent the state of a Floating IP assign action.
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

Assign a Floating IP to a Droplet

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"type":"assign","droplet_id":8219222}' "https://api.digitalocean.com/v2/floating_ips/45.55.96.47/actions"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.floating_ip_actions.assign(ip: '45.55.96.47', droplet_id: 8219222)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

action, _, err := client.FloatingIPActions.Assign(ctx, "45.55.96.47", 8219222)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "type": "assign",
  "droplet_id": 8219222
}

Response Headers

content-type: application/json; charset=utf-8
status: 201 Created
ratelimit-limit: 5000
ratelimit-remaining: 4819
ratelimit-reset: 1444931833

Response Body

{
  "action": {
    "id": 68212728,
    "status": "in-progress",
    "type": "assign_ip",
    "started_at": "2015-10-15T17:45:44Z",
    "completed_at": null,
    "resource_id": 758603823,
    "resource_type": "floating_ip",
    "region": {
      "name": "New York 3",
      "slug": "nyc3",
      "sizes": [
        "512mb",
        "1gb",
        "2gb",
        "4gb",
        "8gb",
        "16gb",
        "32gb",
        "48gb",
        "64gb"
      ],
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata"
      ],
      "available": true
    },
    "region_slug": "nyc3"
  }
}

Unassign a Floating IP

To unassign a Floating IP, send a POST request to /v2/floating_ips/$FLOATING_IP_ADDR/actions. Set the "type" attribute to unassign. The Floating IP will be reserved in the region but not assigned to a Droplet.

The response will be a JSON object with a key called action. The value will be an action object:

NameTypeDescription
idnumberA unique numeric ID that can be used to identify and reference an action.
statusstringThe current status of the action. This can be "in-progress", "completed", or "errored".
typestringThis is the type of action that the object represents. For example, this could be "assign_ip" to represent the state of a Floating IP assign action.
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

Unassign a Floating IP

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"type":"unassign"}' "https://api.digitalocean.com/v2/floating_ips/45.55.96.47/actions"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.floating_ip_actions.unassign(ip: '45.55.96.47')

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

action, _, err := client.FloatingIPActions.Unassign(ctx, "45.55.96.47")

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "type": "unassign"
}

Response Headers

content-type: application/json; charset=utf-8
status: 201 Created
ratelimit-limit: 5000
ratelimit-remaining: 4816
ratelimit-reset: 1444931833

Response Body

{
  "action": {
    "id": 68212773,
    "status": "in-progress",
    "type": "unassign_ip",
    "started_at": "2015-10-15T17:46:15Z",
    "completed_at": null,
    "resource_id": 758603823,
    "resource_type": "floating_ip",
    "region": {
      "name": "New York 3",
      "slug": "nyc3",
      "sizes": [
        "512mb",
        "1gb",
        "2gb",
        "4gb",
        "8gb",
        "16gb",
        "32gb",
        "48gb",
        "64gb"
      ],
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata"
      ],
      "available": true
    },
    "region_slug": "nyc3"
  }
}

List all actions for a Floating IP

To retrieve all actions that have been executed on a Floating IP, send a GET request to /v2/floating_ips/$FLOATING_IP/actions.

The results will be returned as a JSON object with an actions key. This will be set to an array filled with action objects containing the standard Floating IP action attributes:

NameTypeDescription
idnumberA unique numeric ID that can be used to identify and reference an action.
statusstringThe current status of the action. This can be "in-progress", "completed", or "errored".
typestringThis is the type of action that the object represents. For example, this could be "assign_ip" to represent the state of a Floating IP assign action.
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

List all actions for a Floating IP

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/floating_ips/45.55.96.47/actions?page=1&per_page=1"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

actions = client.floating_ip_actions.all(ip: '45.55.96.47')
actions.each

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

opt := &godo.ListOptions{
    Page:    1,
    PerPage: 200,
}

actions, _, err := client.FloatingIPActions.List(ctx, '45.55.96.47', opt)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 903
ratelimit-reset: 1415984218

Response Body

{
  "actions": [
    {
      "id": 72531856,
      "status": "completed",
      "type": "reserve_ip",
      "started_at": "2015-11-21T21:51:09Z",
      "completed_at": "2015-11-21T21:51:09Z",
      "resource_id": 758604197,
      "resource_type": "floating_ip",
      "region": {
        "name": "New York 3",
        "slug": "nyc3",
        "sizes": [
          "512mb",
          "1gb",
          "2gb",
          "4gb",
          "8gb",
          "16gb",
          "32gb",
          "48gb",
          "64gb"
        ],
        "features": [
          "private_networking",
          "backups",
          "ipv6",
          "metadata"
        ],
        "available": true
      },
      "region_slug": "nyc3"
    }
  ],
  "links": {
  },
  "meta": {
    "total": 1
  }
}

Retrieve an existing Floating IP Action

To retrieve the status of a Floating IP action, send a GET request to /v2/floating_ips/$FLOATING_IP/actions/$ACTION_ID.

The response will be an object with a key called action. The value of this will be an object that contains the standard Floating IP action attributes:

NameTypeDescription
idnumberA unique numeric ID that can be used to identify and reference an action.
statusstringThe current status of the action. This can be "in-progress", "completed", or "errored".
typestringThis is the type of action that the object represents. For example, this could be "assign_ip" to represent the state of a Floating IP assign action.
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idnumberA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
regionnullable string(deprecated) A slug representing the region where the action occurred.
region_slugnullable stringA slug representing the region where the action occurred.

Retrieve an existing Floating IP Action

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/floating_ips/45.55.96.47/actions/72531856"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.floating_ip_actions.find(ip: '45.55.96.47', id: 72531856)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

action, _, err := client.FloatingIPActions.Get(ctx, "45.55.96.47", 72531856)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 837
ratelimit-reset: 1415984218

Response Body

{
  "action": {
    "id": 72531856,
    "status": "completed",
    "type": "assign_ip",
    "started_at": "2015-11-12T17:51:03Z",
    "completed_at": "2015-11-12T17:51:14Z",
    "resource_id": 758604968,
    "resource_type": "floating_ip",
    "region": {
      "name": "New York 3",
      "slug": "nyc3",
      "sizes": [
        "1gb",
        "2gb",
        "4gb",
        "8gb",
        "32gb",
        "64gb",
        "512mb",
        "48gb",
        "16gb"
      ],
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata"
      ],
      "available": true
    },
    "region_slug": "nyc3"
  }
}

Tags

A Tag is a label that can be applied to a resource (currently only Droplets) in order to better organize or facilitate the lookups and actions on it.

Tags have two attributes: a user defined name attribute and an embedded resources attribute with information about resources that have been tagged.

NameTypeDescription
namestringTags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag.
resourcesobjectAn embedded object containing key value pairs of resource type and resource statistics.

Tagged Resource Statistics include metadata regarding the resource type that has been tagged.

NameTypeDescription
last_taggedobjectThe last tagged object for this type of resource
countnumberThe number tagged objects for this type of resource

Create a new Tag

To create a Tag you can send a POST request to /v2/tags with a name attribute.

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:

NameTypeDescription
namestringTags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag.
resourcesobjectAn embedded object containing key value pairs of resource type and resource statistics.

Create a new Tag

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"name":"awesome"}' "https://api.digitalocean.com/v2/tags"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

tag = DropletKit::Tag.new(name: 'awesome')
client.tags.create(tag)

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

createRequest := &TagCreateRequest{
    Name: "testing-1",
}
client.Tags.Create(ctx, request)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "name": "awesome"
}

Response Headers

content-type: application/json; charset=utf-8
status: 201 Created
ratelimit-limit: 5000
ratelimit-remaining: 4986
ratelimit-reset: 1450713671

Response Body

{
  "tag": {
    "name": "awesome",
    "resources": {
      "droplets": {
        "count": 0,
        "last_tagged": null
      }
    }
  }
}

Retrieve a Tag

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

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:

NameTypeDescription
namestringTags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag.
resourcesobjectAn embedded object containing key value pairs of resource type and resource statistics.

Retrieve a Tag

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/tags/awesome"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.tags.find(name: 'awesome')

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

tag, _, err := client.Tags.Get(ctx, "awesome")

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 5000
ratelimit-remaining: 4986
ratelimit-reset: 1450713671

Response Body

{
  "tag": {
    "name": "extra-awesome",
    "resources": {
      "droplets": {
        "count": 1,
        "last_tagged": {
          "id": 3164444,
          "name": "example.com",
          "memory": 512,
          "vcpus": 1,
          "disk": 20,
          "locked": false,
          "status": "active",
          "kernel": {
            "id": 2233,
            "name": "Ubuntu 14.04 x64 vmlinuz-3.13.0-37-generic",
            "version": "3.13.0-37-generic"
          },
          "created_at": "2014-11-14T16:29:21Z",
          "features": [
            "backups",
            "ipv6",
            "virtio"
          ],
          "backup_ids": [
            7938002
          ],
          "snapshot_ids": [

          ],
          "image": {
            "id": 6918990,
            "name": "14.04 x64",
            "distribution": "Ubuntu",
            "slug": "ubuntu-14-04-x64",
            "public": true,
            "regions": [
              "nyc1",
              "ams1",
              "sfo1",
              "nyc2",
              "ams2",
              "sgp1",
              "lon1",
              "nyc3",
              "ams3",
              "nyc3"
            ],
            "created_at": "2014-10-17T20:24:33Z",
            "type": "snapshot",
            "min_disk_size": 20,
            "size_gigabytes": 2.34
          },
          "volume_ids": [

          ],
          "size": {
          },
          "size_slug": "512mb",
          "networks": {
            "v4": [
              {
                "ip_address": "104.236.32.182",
                "netmask": "255.255.192.0",
                "gateway": "104.236.0.1",
                "type": "public"
              }
            ],
            "v6": [
              {
                "ip_address": "2604:A880:0800:0010:0000:0000:02DD:4001",
                "netmask": 64,
                "gateway": "2604:A880:0800:0010:0000:0000:0000:0001",
                "type": "public"
              }
            ]
          },
          "region": {
            "name": "New York 3",
            "slug": "nyc3",
            "sizes": [

            ],
            "features": [
              "virtio",
              "private_networking",
              "backups",
              "ipv6",
              "metadata"
            ],
            "available": null
          },
          "tags": [
            "awesome"
          ]
        }
      }
    }
  }
}

List all Tags

To list all of your tags, you can send a GET request to /v2/tags.

The response will be a JSON object with a key called tags. This will be set to an array of tag objects, each of which will contain the standard tag attributes:

NameTypeDescription
namestringTags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag.
resourcesobjectAn embedded object containing key value pairs of resource type and resource statistics.

List all Tags

cURL Example

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/tags"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

tags = client.tags.all
tags.each

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

opt := &godo.ListOptions{
    Page:    1,
    PerPage: 200,
}
tags, _, err := client.Tags.List(ctx, opt)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 5000
ratelimit-remaining: 4986
ratelimit-reset: 1450713671

Response Body

{
  "tags": [
    {
      "name": "extra-awesome",
      "resources": {
        "droplets": {
          "count": 1,
          "last_tagged": {
            "id": 3164444,
            "name": "example.com",
            "memory": 512,
            "vcpus": 1,
            "disk": 20,
            "locked": false,
            "status": "active",
            "kernel": {
              "id": 2233,
              "name": "Ubuntu 14.04 x64 vmlinuz-3.13.0-37-generic",
              "version": "3.13.0-37-generic"
            },
            "created_at": "2014-11-14T16:29:21Z",
            "features": [
              "backups",
              "ipv6",
              "virtio"
            ],
            "backup_ids": [
              7938002
            ],
            "snapshot_ids": [

            ],
            "image": {
              "id": 6918990,
              "name": "14.04 x64",
              "distribution": "Ubuntu",
              "slug": "ubuntu-14-04-x64",
              "public": true,
              "regions": [
                "nyc1",
                "ams1",
                "sfo1",
                "nyc2",
                "ams2",
                "sgp1",
                "lon1",
                "nyc3",
                "ams3",
                "nyc3"
              ],
              "created_at": "2014-10-17T20:24:33Z",
              "type": "snapshot",
              "min_disk_size": 20,
              "size_gigabytes": 2.34
            },
            "volume_ids": [

            ],
            "size": {
            },
            "size_slug": "512mb",
            "networks": {
              "v4": [
                {
                  "ip_address": "104.236.32.182",
                  "netmask": "255.255.192.0",
                  "gateway": "104.236.0.1",
                  "type": "public"
                }
              ],
              "v6": [
                {
                  "ip_address": "2604:A880:0800:0010:0000:0000:02DD:4001",
                  "netmask": 64,
                  "gateway": "2604:A880:0800:0010:0000:0000:0000:0001",
                  "type": "public"
                }
              ]
            },
            "region": {
              "name": "New York 3",
              "slug": "nyc3",
              "sizes": [

              ],
              "features": [
                "virtio",
                "private_networking",
                "backups",
                "ipv6",
                "metadata"
              ],
              "available": null
            },
            "tags": [
              "extra-awesome"
            ]
          }
        }
      }
    }
  ]
}

Update a Tag

Sending a PUT request to /v2/tags/$TAG_NAME allows you to change the name of an existing tag. Set the "name" attribute to the new name you want to use.

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

NameTypeDescription
namestringTags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag.
resourcesobjectAn embedded object containing key value pairs of resource type and resource statistics.

Update a Tag

cURL Example

curl -X PUT -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"name":"extra-awesome"}' "https://api.digitalocean.com/v2/tags/awesome"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

tag.name = 'extra-awesome'
client.tags.update(tag, name: 'awesome')

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

updateRequest := &godo.TagUpdateRequest{
    Name: "extra-awesome",
}
client.Tags.Update(ctx, "awesome", updateRequest)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "name": "extra-awesome"
}

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 5000
ratelimit-remaining: 4985
ratelimit-reset: 1450713671

Response Body

{
  "tag": {
    "name": "extra-awesome",
    "resources": {
      "droplets": {
        "count": 1,
        "last_tagged": {
          "id": 3164444,
          "name": "example.com",
          "memory": 512,
          "vcpus": 1,
          "disk": 20,
          "locked": false,
          "status": "active",
          "kernel": {
            "id": 2233,
            "name": "Ubuntu 14.04 x64 vmlinuz-3.13.0-37-generic",
            "version": "3.13.0-37-generic"
          },
          "created_at": "2014-11-14T16:29:21Z",
          "features": [
            "backups",
            "ipv6",
            "virtio"
          ],
          "backup_ids": [
            7938002
          ],
          "snapshot_ids": [

          ],
          "image": {
            "id": 6918990,
            "name": "14.04 x64",
            "distribution": "Ubuntu",
            "slug": "ubuntu-14-04-x64",
            "public": true,
            "regions": [
              "nyc1",
              "ams1",
              "sfo1",
              "nyc2",
              "ams2",
              "sgp1",
              "lon1",
              "nyc3",
              "ams3",
              "nyc3"
            ],
            "created_at": "2014-10-17T20:24:33Z",
            "type": "snapshot",
            "min_disk_size": 20,
            "size_gigabytes": 2.34
          },
          "volume_ids": [

          ],
          "size": {
          },
          "size_slug": "512mb",
          "networks": {
            "v4": [
              {
                "ip_address": "104.236.32.182",
                "netmask": "255.255.192.0",
                "gateway": "104.236.0.1",
                "type": "public"
              }
            ],
            "v6": [
              {
                "ip_address": "2604:A880:0800:0010:0000:0000:02DD:4001",
                "netmask": 64,
                "gateway": "2604:A880:0800:0010:0000:0000:0000:0001",
                "type": "public"
              }
            ]
          },
          "region": {
            "name": "New York 3",
            "slug": "nyc3",
            "sizes": [

            ],
            "features": [
              "virtio",
              "private_networking",
              "backups",
              "ipv6",
              "metadata"
            ],
            "available": null
          },
          "tags": [
            "extra-awesome"
          ]
        }
      }
    }
  }
}

Tag a Resource

Resources can be tagged by sending a POST request to /v2/tags/$TAG_NAME/resources with an array of json objects containing resource_id and resource_type attributes.

Currently only tagging of droplets is supported. resource_id is expected to be the Droplet's id attribute as a string, and resource_type is expected to be the string droplet.

NameTypeDescription
resourcesarrayAn array of objects containing resource_id and resource_type attributes
NameTypeDescription
resource_idstringThe identifier of a resource
resource_typestringThe type of the resource

Tag a Resource

cURL Example

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"resources":[{"resource_id":"9569411","resource_type":"droplet"}]}' "https://api.digitalocean.com/v2/tags/awesome/resources"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.tags.tag_resources(name: 'awesome', resources: [{ resource_id => '9569411', resource_type: 'droplet' }])

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

tagResourcesRequest := &godo.TagResourcesRequest{
    Resources: []Resource{{ID: "11457573", Type: "droplet"}},
}
client.Tags.TagResources(ctx, "awesome", tagResourcesRequest)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "resources": [
    {
      "resource_id": "9569411",
      "resource_type": "droplet"
    }
  ]
}

Response Headers

status: 204 No Content
ratelimit-limit: 5000
ratelimit-remaining: 4983
ratelimit-reset: 1450713671

Untag a Resource

Resources can be untagged by sending a DELETE request to /v2/tags/$TAG_NAME/resources with an array of json objects containing resource_id and resource_type attributes.

Currently only untagging of droplets is supported. resource_id is expected to be the Droplet's id attribute as a string, and resource_type is expected to be the string droplet.

NameTypeDescription
resourcesarrayAn array of objects containing resource_id and resource_type attributes
NameTypeDescription
resource_idstringThe identifier of a resource
resource_typestringThe type of the resource

Untag a Resource

cURL Example

curl -X DELETE -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" -d '{"resources":[{"resource_id":"9569411","resource_type":"droplet"}]}' "https://api.digitalocean.com/v2/tags/awesome/resources"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.tags.untag_resources(name: 'awesome', resources: [{ resource_id => '9569411', resource_type: 'droplet' }])

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

untagResourcesRequest := &godo.UntagResourcesRequest{
    Resources: []Resource{{ID: "11457573", Type: "droplet"}},
}
client.Tags.UntagResources(ctx, "awesome", untagResourcesRequest)

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Request Body

{
  "resources": [
    {
      "resource_id": "9569411",
      "resource_type": "droplet"
    }
  ]
}

Response Headers

status: 204 No Content
ratelimit-limit: 5000
ratelimit-remaining: 4982
ratelimit-reset: 1450713671

Delete a Tag

A Tag can be deleted by sending a DELETE request to /v2/tags/$TAG_NAME. Deleting a Tag also untags all the resources that have previously been tagged by the Tag.

Delete a Tag

cURL Example

curl -X DELETE -H "Content-Type: application/json" -H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" "https://api.digitalocean.com/v2/tags/awesome"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

client.tags.delete(name: 'awesome')

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

client.Tags.Delete(ctx, "awesome")

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

status: 204 No Content
ratelimit-limit: 5000
ratelimit-remaining: 4981
ratelimit-reset: 1450713671

Snapshots

Snapshots are saved instances of a Droplet or a volume, which is reflected in the resource_type attribute. In order to avoid problems with compressing filesystems, each defines a min_disk_size attribute which is the minimum size of the Droplet or volume disk when creating a new resource from the saved snapshot.

To interact with snapshots, you will generally send requests to the snapshots endpoint at /v2/snapshots.

NameTypeDescription
idstringThe unique identifier for the snapshot.
namestringA human-readable name for the snapshot.
created_atstringA time value given in ISO8601 combined date and time format that represents when the snapshot was created.
regionsarrayAn array of the regions that the image is available in. The regions are represented by their identifying slug values.
resource_idstringA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
min_disk_sizenumberThe minimum size in GB required for a volume or Droplet to use this snapshot.
size_gigabytesnumberThe billable size of the snapshot in gigabytes.

List all snapshots

To list all of the snapshots available on your account, send a GET request to /v2/snapshots.

The response will be a JSON object with a key called snapshots. This will be set to an array of snapshot objects, each of which will contain the standard snapshot attributes:

NameTypeDescription
idstringThe unique identifier for the snapshot.
namestringA human-readable name for the snapshot.
created_atstringA time value given in ISO8601 combined date and time format that represents when the snapshot was created.
regionsarrayAn array of the regions that the image is available in. The regions are represented by their identifying slug values.
resource_idstringA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
min_disk_sizenumberThe minimum size in GB required for a volume or Droplet to use this snapshot.
size_gigabytesnumberThe billable size of the snapshot in gigabytes.

List all snapshots

cURL Example

curl -X GET -H 'Content-Type: application/json' -H 'Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582' "https://api.digitalocean.com/v2/snapshots?page=1&per_page=1"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 5000
ratelimit-remaining: 4989
ratelimit-reset: 1475174402

Response Body

{
  "snapshots": [
    {
      "id": 6372321,
      "name": "5.10 x64",
      "regions": [
        "nyc1",
        "ams1",
        "sfo1",
        "nyc2",
        "ams2",
        "sgp1",
        "lon1",
        "nyc3",
        "ams3",
        "fra1",
        "tor1"
      ],
      "created_at": "2014-09-26T16:40:18Z",
      "resource_id": 2713828,
      "resource_type": "droplet",
      "min_disk_size": 20,
      "size_gigabytes": 1.42
    }
  ],
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/snapshots?page=110&per_page=1",
      "next": "https://api.digitalocean.com/v2/snapshots?page=2&per_page=1"
    }
  },
  "meta": {
    "total": 110
  }
}

List all Droplet snapshots

To retrieve only snapshots based on Droplets, include the resource_type query paramter set to droplet, /v2/snapshots?resource_type=droplet.

NameTypeDescription
idstringThe unique identifier for the snapshot.
namestringA human-readable name for the snapshot.
created_atstringA time value given in ISO8601 combined date and time format that represents when the snapshot was created.
regionsarrayAn array of the regions that the image is available in. The regions are represented by their identifying slug values.
resource_idstringA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
min_disk_sizenumberThe minimum size in GB required for a volume or Droplet to use this snapshot.
size_gigabytesnumberThe billable size of the snapshot in gigabytes.

List all Droplet snapshots

cURL Example

curl -X GET -H 'Content-Type: application/json' -H 'Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582' "https://api.digitalocean.com/v2/snapshots?page=1&per_page=1&resource_type=droplet"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 5000
ratelimit-remaining: 4988
ratelimit-reset: 1475174402

Response Body

{
  "snapshots": [
    {
      "id": 19602538,
      "name": "1153.4.0 (beta)",
      "regions": [
        "nyc1",
        "sfo1",
        "nyc2",
        "ams2",
        "sgp1",
        "lon1",
        "nyc3",
        "ams3",
        "fra1",
        "tor1",
        "sfo2",
        "blr1"
      ],
      "created_at": "2016-09-10T18:06:25Z",
      "resource_id": null,
      "resource_type": "droplet",
      "min_disk_size": 20,
      "size_gigabytes": 0.31
    }
  ],
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/snapshots?page=103&per_page=1&resource_type=droplet",
      "next": "https://api.digitalocean.com/v2/snapshots?page=2&per_page=1&resource_type=droplet"
    }
  },
  "meta": {
    "total": 103
  }
}

List all volume snapshots

To retrieve only snapshots based on volumes, include the resource_type query paramter set to volume, /v2/snapshots?resource_type=volume.

NameTypeDescription
idstringThe unique identifier for the snapshot.
namestringA human-readable name for the snapshot.
created_atstringA time value given in ISO8601 combined date and time format that represents when the snapshot was created.
regionsarrayAn array of the regions that the image is available in. The regions are represented by their identifying slug values.
resource_idstringA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
min_disk_sizenumberThe minimum size in GB required for a volume or Droplet to use this snapshot.
size_gigabytesnumberThe billable size of the snapshot in gigabytes.

List all volume snapshots

cURL Example

curl -X GET -H 'Content-Type: application/json' -H 'Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582' "https://api.digitalocean.com/v2/snapshots?page=1&per_page=1&resource_type=volume"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)

Ruby Example

Go Requirements

import (
    "context" 
    "golang.org/x/oauth2" 
    "github.com/digitalocean/godo" 
)

pat := "mytoken" 

type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}

oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
client := godo.NewClient(oauthClient)

ctx := context.TODO()

Go Example

Request Headers

Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582

Response Headers

content-type: application/json; charset=utf-8
status: 200 OK
ratelimit-limit: 5000
ratelimit-remaining: 4987
ratelimit-reset: 1475174402

Response Body

{
  "snapshots": [
    {
      "id": "4f60fc64-85d1-11e6-a004-000f53315871",
      "name": "big-data-snapshot1",
      "regions": [
        "nyc1"
      ],
      "created_at": "2016-09-28T23:14:30Z",
      "resource_id": "89bcc42f-85cf-11e6-a004-000f53315871",
      "resource_type": "volume",
      "min_disk_size": 10,
      "size_gigabytes": 0
    }
  ],
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/snapshots?page=7&per_page=1&resource_type=volume",
      "next": "https://api.digitalocean.com/v2/snapshots?page=2&per_page=1&resource_type=volume"
    }
  },
  "meta": {
    "total": 7
  }
}

Retrieve an existing snapshot by id

To retrieve information about a snapshot, send a GET request to /v2/snapshots/$SNAPSHOT_ID.

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

NameTypeDescription
idstringThe unique identifier for the snapshot.
namestringA human-readable name for the snapshot.
created_atstringA time value given in ISO8601 combined date and time format that represents when the snapshot was created.
regionsarrayAn array of the regions that the image is available in. The regions are represented by their identifying slug values.
resource_idstringA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
min_disk_sizenumberThe minimum size in GB required for a volume or Droplet to use this snapshot.
size_gigabytesnumberThe billable size of the snapshot in gigabytes.

Retrieve an existing snapshot by id

cURL Example

curl -X GET -H 'Content-Type: application/json' -H 'Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582' "https://api.digitalocean.com/v2/snapshots/fbe805e8-866b-11e6-96bf-000f53315a41"

Ruby Requirements

require 'droplet_kit'
token='16f79fc8cd5adcfe528a0994311fa63cc877737b385b6ff7d12ed6684ba4fef5'
client = DropletKit::Client.new(access_token: token)