Digital Ocean API v2
Base URI
This is not official version of Digital Ocean REST API.
Link to Official documentation
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.
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. |
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.
EXAMPLE ERROR RESPONSE
HTTP/1.1 403 Forbidden
{
"id": "forbidden",
"message": "You do not have access for the attempted action."
}
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.
RESPONSE FOR A SINGLE OBJECT
{
"droplet": {
"name": "example.com"
. . .
}
}
RESPONSE FOR AN OBJECT COLLECTION
{
"droplets": [
{
"name": "example.com"
. . .
},
{
"name": "second.com"
. . .
}
]
}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).
SAMPLE META OBJECT
{
. . .
"meta": {
"total": 43
}
. . .
}The links object is returned as part of the response body when pagination is enabled. By default, 25 objects are returned per page. If the response contains 25 objects or fewer, no links object will be returned. If the response contains more than 25 objects, the first 25 will be returned along with the links object.
You can request a different pagination limit or force pagination by appending ?per_page= to the request with the number of items you would like per page. For instance, to show only two results per page, you could add ?per_page=2 to the end of your query.
The links object contains a pages object. The pages object, in turn, contains keys indicating the relationship of additional pages. The values of these are the URLs of the associated pages. The keys will be one of the following:
- first: The URI of the first page of results.
- prev: The URI of the previous sequential page of results.
- next: The URI of the next sequential page of results.
- last: The URI of the last page of results.
The pages object will only include the links that make sense. So for the first page of results, no first or prev links will ever be set. This convention holds true in other situations where a link would not make sense.
SAMPLE LINKS OBJECT
{
. . .
"links": {
"pages": {
"last": "https://api.digitalocean.com/v2/images?page=2",
"next": "https://api.digitalocean.com/v2/images?page=2"
}
}
. . .
}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.
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."
}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.
SET AND EXPORT YOUR OAUTH TOKEN
export TOKEN=your_token_here
SET AND EXPORT A VARIABLE
export DROPLET_ID=1111111
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.
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"
There are two different ways to pass parameters in a request with the API.
The best way to pass parameters is 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.
Another way of passing parameters is using standard query attributes.
Using this format, you would pass the attributes within the URI itself. Tools like curl can take parameters and value as arguments to create the appropriate URI.
With curl this is 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.
You could also use a standard query string if that would be easier in our application. 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 &.
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 PARAMETERS AS URI COMPONENTS
curl -H "Authorization: Bearer $TOKEN" \
-F "name=example.com" -F "ip_address=127.0.0.1" \
-X POST "https://api.digitalocean.com/v2/domains"
PASS PARAMETERS AS A QUERY STRING
curl -H "Authorization: Bearer $TOKEN" \
-X POST \
"https://api.digitalocean.com/v2/domains?name=example.com&ip_address=127.0.0.1"
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.
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
. . .
Get User Information.
Request headers
Responses
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
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.
Body
The total number of droplets the user may have
The email the user has registered for Digital Ocean with
The universal identifier for this user
If true, the user has verified their account via email. False otherwise.
curl -X GET -H 'Content-Type: application/json' \
-H 'Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582' \
"https://api.digitalocean.com/v2/account"GET https://api.digitalocean.com/v2/account HTTP/1.1
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
Content-Type: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"account": {
"droplet_limit": 25,
"email": "web@digitalocean.com",
"uuid": "b6fc48dbf6d9906cace5f3c78dc9851e757381ef",
"email_verified": true
}
}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.
{ACTION_ID}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:
Request headers
Responses
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
GET https://api.digitalocean.com/v2/actions?page=1&per_page=1 HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
HTTP/1.1 200 OK
content-type: application/json
ratelimit-limit: 1200
ratelimit-remaining: 1124
ratelimit-reset: 1415984218
{
"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
}
}{ACTION_ID}To retrieve a specific action object, send a GET request to /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
Path variables
Request headers
Responses
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
GET https://api.digitalocean.com/v2/actions/36804636 HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
HTTP/1.1 200 OK
content-type: application/json
ratelimit-limit: 1200
ratelimit-remaining: 1123
ratelimit-reset: 1415984218
{
"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"
}
}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.
{DOMAIN_NAME}{DOMAIN_NAME}To retrieve a list of all of the domains in your account, send a GET request to /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
Request headers
Responses
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
GET https://api.digitalocean.com/v2/domains HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
HTTP/1.1 200 OK
content-type: application/json
ratelimit-limit: 1200
ratelimit-remaining: 1124
ratelimit-reset: 1415984218
{
"domains": [
{
"name": "digitaloceanisthebombdiggity.com",
"ttl": 1800,
"zone_file": "$ORIGIN digitaloceanisthebombdiggity.com.\n$TTL 1800\ndigitaloceanisthebombdiggity.com. IN SOA ns1.digitalocean.com. hostmaster.digitaloceanisthebombdiggity.com. 1415982609 10800 3600 604800 1800\ndigitaloceanisthebombdiggity.com. 1800 IN NS ns1.digitalocean.com.\ndigitaloceanisthebombdiggity.com. 1800 IN NS ns2.digitalocean.com.\ndigitaloceanisthebombdiggity.com. 1800 IN NS ns3.digitalocean.com.\ndigitaloceanisthebombdiggity.com. 1800 IN A 1.2.3.4\n"
}
],
"links": {
},
"meta": {
"total": 1
}
}To create a new domain, send a POST request to /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.
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.
Request parameters
To create a new domain, send a POST request to /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.
Request headers
To create a new domain, send a POST request to /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.
Request body
The 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.
This attribute contains the IP address you want the domain to point to.
Responses
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
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
curl -X POST "https://api.digitalocean.com/v2/domains" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582" \
-d '{
"name": "digitaloceanisthebombdiggity.com",
"ip_address": "1.2.3.4"
}'POST https://api.digitalocean.com/v2/domains HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
{
"name": "digitaloceanisthebombdiggity.com",
"ip_address": "1.2.3.4"
}
HTTP/1.1 201 Created
content-type: application/json
ratelimit-limit: 1200
ratelimit-remaining: 1124
ratelimit-reset: 1415984218
{
"domain": {
"name": "digitaloceanisthebombdiggity.com",
"ttl": 1800,
"zone_file": null
}
}{DOMAIN_NAME}To get details about a specific domain, send a GET request to /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
Path variables
Request headers
Responses
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
GET https://api.digitalocean.com/v2/domains/digitaloceanisthebombdiggity.com HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
HTTP/1.1 200 OK
content-type: application/json
ratelimit-limit: 1200
ratelimit-remaining: 1124
ratelimit-reset: 1415984218
{
"domain": {
"name": "digitaloceanisthebombdiggity.com",
"ttl": 1800,
"zone_file": "$ORIGIN digitaloceanisthebombdiggity.com.\n$TTL 1800\ndigitaloceanisthebombdiggity.com. IN SOA ns1.digitalocean.com. hostmaster.digitaloceanisthebombdiggity.com. 1415982611 10800 3600 604800 1800\ndigitaloceanisthebombdiggity.com. 1800 IN NS ns1.digitalocean.com.\ndigitaloceanisthebombdiggity.com. 1800 IN NS ns2.digitalocean.com.\ndigitaloceanisthebombdiggity.com. 1800 IN NS ns3.digitalocean.com.\ndigitaloceanisthebombdiggity.com. 1800 IN A 1.2.3.4\n"
}
}{DOMAIN_NAME}To delete a domain, send a DELETE request to /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.
Path variables
Request headers
DELETE https://api.digitalocean.com/v2/domains/digitaloceanisthebombdiggity.com HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
HTTP/1.1 204 No Content
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.
{DOMAIN_NAME}/records{DOMAIN_NAME}/records{DOMAIN_NAME}/records/{RECORD_ID}{DOMAIN_NAME}/records/{RECORD_ID}{DOMAIN_NAME}/records/{RECORD_ID}{DOMAIN_NAME}/recordsTo get a listing of all records configured for a domain, send a GET request to /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.
Path variables
Request headers
Responses
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
GET https://api.digitalocean.com/v2/domains/digitaloceanisthebombdiggity.com/records HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
HTTP/1.1 200 OK
content-type: application/json
ratelimit-limit: 1200
ratelimit-remaining: 1124
ratelimit-reset: 1415984218
{
"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
}
}{DOMAIN_NAME}/recordsTo create a new record to a domain, send a POST request to /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.
Path variables
Request headers
Request body
Responses
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.
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
POST https://api.digitalocean.com/v2/domains/digitaloceanisthebombdiggity.com/records HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
{
"type": "A",
"name": "customdomainrecord.com",
"data": "162.10.66.0",
"priority": null,
"port": null,
"weight": null
}
HTTP/1.1 201 Created
content-type: application/json; charset=utf-8
ratelimit-limit: 1200
ratelimit-remaining: 1120
ratelimit-reset: 1415984218
{
"domain_record": {
"id": 3352896,
"type": "A",
"name": "customdomainrecord.com",
"data": "162.10.66.0",
"priority": null,
"port": null,
"weight": null
}
}{DOMAIN_NAME}/records/{RECORD_ID}To retrieve a specific domain record, send a GET request to /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
Path variables
Request headers
Responses
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
GET https://api.digitalocean.com/v2/domains/digitaloceanisthebombdiggity.com/records/3352896 HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
HTTP/1.1 200 OK
content-type: application/json
ratelimit-limit: 1200
ratelimit-remaining: 1124
ratelimit-reset: 1415984218
{
"domain_record": {
"id": 3352896,
"type": "A",
"name": "customdomainrecord.com",
"data": "162.10.66.0",
"priority": null,
"port": null,
"weight": null
}
}{DOMAIN_NAME}/records/{RECORD_ID}To update an existing record, send a PUT request to /domains/{DOMAIN_NAME}/records/{RECORD_ID}. Any attribute valid for the record type can be set to a new value for the record.
Path variables
Request headers
Request body
Responses
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
PUT https://api.digitalocean.com/v2/domains/digitaloceanisthebombdiggity.com/records/3352896 HTTP/1.1
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
Content-Type: application/json
{
"name": "updated-record-name.com"
}
HTTP/1.1 200 OK
content-type: content-type: application/json; charset=utf-8
ratelimit-limit: 1200
ratelimit-remaining: 1118
ratelimit-reset: 1415984218
{
"domain_record": {
"id": 3352896,
"type": "A",
"name": "updated-record-name.com",
"data": "162.10.66.0",
"priority": null,
"port": null,
"weight": null
}
}{DOMAIN_NAME}/records/{RECORD_ID}To delete a record for a domain, send a DELETE request to /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.
Path variables
Request headers
DELETE https://api.digitalocean.com/v2/domains/digitaloceanisthebombdiggity.com/records/3352896 HTTP/1.1
HTTP/1.1 204 No Content
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.
{DROPLET_ID}{DROPLET_ID}/kernels{DROPLET_ID}/snapshots{DROPLET_ID}/backups{DROPLET_ID}/actions{DROPLET_ID}{id}/neighborsTo create a new Droplet, send a POST request to /droplets.
Request headers
Request body
The 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.
The unique slug identifier for the region that you wish to deploy in.
The unique slug identifier for the size that you wish to select for this Droplet.
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.
An array containing the IDs or fingerprints of the SSH keys that you wish to embed in the Droplet’s root account upon creation.
A boolean indicating whether automated backups should be enabled for the Droplet. Automated backups can only be enabled when the Droplet is created.
A boolean indicating whether IPv6 is enabled on the Droplet.
A boolean indicating whether private networking is enabled for the Droplet. Private networking is currently only available in certain regions.
A string of the desired User Data for the Droplet. User Data is currently only available in regions with metadata listed in their features.
Responses
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
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
POST https://api.digitalocean.com/v2/droplets HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
{
"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
}
HTTP/1.1 201 Created
content-type: application/json; charset=utf-8
ratelimit-limit: 1200
ratelimit-remaining: 965
ratelimit-reset: 1415984218
{
"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": {
},
"size": {
},
"size_slug": "512mb",
"networks": {
},
"region": {
}
},
"links": {
"actions": [
{
"id": 36805096,
"rel": "create",
"href": "https://api.digitalocean.com/v2/actions/36805096"
}
]
}
}{DROPLET_ID}To show an individual droplet, send a GET request to /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
Path variables
Request headers
Responses
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
GET https://api.digitalocean.com/v2/droplets/3164494 HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
ratelimit-limit: 1200
ratelimit-remaining: 902
ratelimit-reset: 1415984218
{
"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": {
},
"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
}
}
}To list all Droplets in your account, send a GET request to /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
Request headers
Responses
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
GET https://api.digitalocean.com/v2/droplets?page=1&per_page=1 HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
HTTP/1.1 200 OK
content-type: application/json
ratelimit-limit: 1200
ratelimit-remaining: 1124
ratelimit-reset: 1415984218
{
"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": {
},
"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
}
}
],
"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
}
}{DROPLET_ID}/kernelsTo retrieve a list of all kernels available to a Dropet, send a GET request to /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
Path variables
Request headers
Responses
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
GET https://api.digitalocean.com/v2/droplets/3164494/kernels HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
ratelimit-limit: 1200
ratelimit-remaining: 946
ratelimit-reset: 1415984218
{
"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
}
}{DROPLET_ID}/snapshotsTo retrieve the snapshots that have been created from a Droplet, sent a GET request to /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
Path variables
Request headers
Responses
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
GET https://api.digitalocean.com/v2/droplets/3164494/snapshots HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
HTTP/1.1 200 OK
content-type: application/json
ratelimit-limit: 1200
ratelimit-remaining: 1124
ratelimit-reset: 1415984218
{
"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
}
],
"links": {
},
"meta": {
"total": 1
}
}{DROPLET_ID}/backupsTo retrieve any backups associated with a Droplet, sent a GET request to /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.
Path variables
Request headers
Responses
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
“Type” in snapshot object will be “backup”
GET https://api.digitalocean.com/v2/droplets/3067509/backups HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
HTTP/1.1 200 OK
content-type: application/json
ratelimit-limit: 1200
ratelimit-remaining: 1124
ratelimit-reset: 1415984218
{
"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
}
],
"meta": {
"total": 1
}
}{DROPLET_ID}/actionsTo retrieve all actions that have been executed on a Droplet, send a GET request to /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 attribute
Path variables
Request headers
Responses
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
GET https://api.digitalocean.com/v2/droplets/3164494/actions?page=1&per_page=1 HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
HTTP/1.1 200 OK
content-type: application/json
ratelimit-limit: 1200
ratelimit-remaining: 1124
ratelimit-reset: 1415984218
{
"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
}
}{DROPLET_ID}To delete a Droplet, send a DELETE request to /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.
Path variables
Request headers
DELETE https://api.digitalocean.com/v2/droplets/3164494 HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
HTTP/1.1 204 No Content
{id}/neighborsTo retrieve a list of droplets that are running on the same physical server, send a GET request to /droplets/{id}/neighbors
The results will be returned as a JSON array containing any other droplets that share the samp physical hardware.
Path variables
3164494
Request headers
Responses
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
GET https://api.digitalocean.com/v2/droplets/3164444/neighbors HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
ratelimit-limit: 1200
ratelimit-remaining: 903
ratelimit-reset: 1415984218
{
"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": {
},
"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
}
}
]
}To retrieve a list of any droplets that are running on the same physical hardware, send a GET request to /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.
Request headers
Responses
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
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.
Body
GET https://api.digitalocean.com/v2/reports/droplet_neighbors HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
HTTP/1.1 200 OK
ratelimit-limit: 1200
ratelimit-remaining: 1124
ratelimit-reset: 1415984218
content-type: application/json
[
{
"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": {
},
"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
}
}
]
]
}
]To retrieve a list of droplets that are scheduled to be upgraded, send a GET request to /droplet_upgrades
The results will be returned as a JSON array containing details about the schedule and droplet id.
Request headers
Responses
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
The affected droplet’s ID
A time value given in ISO8601 combined date and time format that represents when the migration will occur for the droplet.
A URL pointing to the Droplet’s API endpoint. This is the endpoint to be used if you want to retrieve information about the droplet.
GET https://api.digitalocean.com/v2/droplet_upgrades HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
HTTP/1.1 200 OK
content-type: application/json
ratelimit-limit: 1200
ratelimit-remaining: 1124
ratelimit-reset: 1415984218
[
{
"droplet_id": 123,
"date_of_migration": "2014-12-01T12:00:00Z",
"url": "https://api.digitalocean.com/v2/droplets/123"
}
]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.
{DROPLET_ID}/actions{DROPLET_ID}/actions{DROPLET_ID}/actions{DROPLET_ID}/actions{DROPLET_ID}/actions{DROPLET_ID}/actions{DROPLET_ID}/actions{DROPLET_ID}/actions{DROPLET_ID}/actions{DROPLET_ID}/actions{DROPLET_ID}/actions{DROPLET_ID}/actions{DROPLET_ID}/actions{DROPLET_ID}/actions{DROPLET_ID}/actions{DROPLET_ID}/actions{DROPLET_ID}/actions/{ACTION_ID}{DROPLET_ID}/actionsTo disable backups on an existing Droplet send a POST request to /droplets/{DROPLET_ID}/actions. Set the “type” attribute to disable_backups.
Path variables
Request headers
Request body
Must be disable_backups
Responses
The response will be a JSON object with a key called action. The value will be a Droplet actions object
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
POST https://api.digitalocean.com/v2/droplets/3164450/actions HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
{
"type": "disable_backups"
}
HTTP/1.1 201 Created
content-type: application/json
ratelimit-limit: 1200
ratelimit-remaining: 1124
ratelimit-reset: 1415984218
{
"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"
}
}{DROPLET_ID}/actionsTo reboot a Droplet, send a POST request to /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.
Path variables
Request headers
Request body
Must be reboot
Responses
The response will be a JSON object with a key called action. The value will be a Droplet actions object
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
The response will be a JSON object with a key called action. The value will be a Droplet actions object
POST https://api.digitalocean.com/v2/droplets/3164450/actions HTTP/1.1
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
Content-Type: application/json
{
"type": "reboot"
}
HTTP/1.1 201 Created
content-type: application/json; charset=utf-8
ratelimit-limit: 1200
ratelimit-remaining: 1097
ratelimit-reset: 1415984218
{
"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"
}
}{DROPLET_ID}/actionsTo power cycle a Droplet (power off and then back on), send a POST request to /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.
Path variables
Request headers
Request body
Must be power_cycle
Responses
The response will be a JSON object with a key called action. The value will be a Droplet actions object
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
POST https://api.digitalocean.com/v2/droplets/3164450/actions HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
{
"type": "power_cycle"
}
HTTP/1.1 201 Created
content-type: application/json
ratelimit-limit: 1200
ratelimit-remaining: 1124
ratelimit-reset: 1415984218
{
"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"
}
}{DROPLET_ID}/actionsTo shutdown a Droplet, send a POST request to /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. This is the preferred way to turn off a Droplet.
Path variables
Request headers
Request body
Must be shutdown
Responses
The response will be a JSON object with a key called action. The value will be a Droplet actions object
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
POST https://api.digitalocean.com/v2/droplets/3067649/actions HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
{
"type": "shutdown"
}
HTTP/1.1 201 Created
content-type: application/json; charset=utf-8
ratelimit-limit: 1200
ratelimit-remaining: 1124
ratelimit-reset: 1415984218
{
"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"
}
}{DROPLET_ID}/actionsTo power off a Droplet, send a POST request to /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.
Path variables
Request headers
Request body
Must be power_off
Responses
The response will be a JSON object with a key called action. The value will be a Droplet actions object.
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
POST https://api.digitalocean.com/v2/droplets/3164450/actions HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
{
"type": "power_off"
}
HTTP/1.1 201 Created
content-type: application/json; charset=utf-8
ratelimit-limit: 1200
ratelimit-remaining: 1095
ratelimit-reset: 1415984218
{
"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"
}
}{DROPLET_ID}/actionsTo power on a Droplet, send a POST request to /droplets/$DROPLET_ID/actions. Set the “type” attribute to power_on.
Path variables
Request headers
Request body
Must be power_on
Responses
The response will be a JSON object with a key called action. The value will be a Droplet actions object.
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
POST https://api.digitalocean.com/v2/droplets/3164450/actions HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
{
"type": "power_on"
}
HTTP/1.1 201 Created
content-type: application/json; charset=utf-8
ratelimit-limit: 1200
ratelimit-remaining: 1088
ratelimit-reset: 1415984218
{
"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"
}
}{DROPLET_ID}/actionsTo restore a Droplet, send a POST request to /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.
Path variables
Request headers
Request body
Must be restore
An image slug or ID. This represents the image that the Droplet will use as a base.
Responses
The response will be a JSON object with a key called action. The value will be a Droplet actions object
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
POST https://api.digitalocean.com/v2/droplets/3067649/actions HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
{
"type": "restore",
"image": "12389723"
}
HTTP/1.1 201 Created
content-type: application/json; charset=utf-8
ratelimit-limit: 1200
ratelimit-remaining: 1088
ratelimit-reset: 1415984218
{
"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"
}
}{DROPLET_ID}/actionsTo reset the password for a Droplet, send a POST request to /droplets/{DROPLET_ID}/actions. Set the “type” attribute to password_reset.
Path variables
Request headers
Request body
Must be password_reset
Responses
The response will be a JSON object with a key called action. The value will be a Droplet actions object
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
POST https://api.digitalocean.com/v2/droplets/3164450/actions HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
{
"type": "password_reset"
}
HTTP/1.1 201 Created
content-type: application/json
ratelimit-limit: 1200
ratelimit-remaining: 1124
ratelimit-reset: 1415984218
{
"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"
}
}{DROPLET_ID}/actionsTo resize a Droplet, send a POST request to /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.
Path variables
Request headers
Request body
Must be resize
Whether to increase disk size
The size slug that you want to resize to.
Responses
The response will be a JSON object with a key called action. The value will be a Droplet actions object
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
POST https://api.digitalocean.com/v2/droplets/3164450/actions HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
{
"type": "resuze",
"disk": "true",
"size": "1gb"
}
HTTP/1.1 201 Created
content-type: application/json; charset=utf-8
ratelimit-limit: 1200
ratelimit-remaining: 1046
ratelimit-reset: 1415984218
{
"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"
}
}{DROPLET_ID}/actionsTo rebuild a Droplet, send a POST request to /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.
Path variables
Request headers
Request body
Must be rebuild
An image slug or ID. This represents the image that the Droplet will use as a base.
Responses
The response will be a JSON object with a key called action. The value will be a Droplet actions object
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
POST https://api.digitalocean.com/v2/droplets/3164450/actions HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
{
"type": "rebuild",
"image": "ubuntu-14-04-x64"
}
HTTP/1.1 201 Created
content-type: application/json; charset=utf-8
ratelimit-limit: 1200
ratelimit-remaining: 1124
ratelimit-reset: 1415984218
{
"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"
}
}{DROPLET_ID}/actionsTo rename a Droplet, send a POST request to /droplets/{DROPLET_ID}/actions. Set the “type” attribute to rename and the “name” attribute to the new name for the droplet.
Path variables
Request headers
Request body
Must be rename
The new name for the Droplet.
Responses
The response will be a JSON object with a key called action. The value will be a Droplet actions object
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
POST https://api.digitalocean.com/v2/droplets/3164450/actions HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
{
"type": "rename",
"name": "nifty-new-name"
}
HTTP/1.1 201 Created
content-type: application/json; charset=utf-8
ratelimit-limit: 1200
ratelimit-remaining: 1025
ratelimit-reset: 1415984218
{
"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"
}
}{DROPLET_ID}/actionsTo change the kernel of a Droplet, send a POST request to /droplets/{DROPLET_ID}/actions. Set the “type” attribute to change_kernel and the “kernel” attribute to the new kernel’s ID.
Path variables
Request headers
Request body
Must be change_kernel
A unique number used to identify and reference a specific kernel.
Responses
The response will be a JSON object with a key called action. The value will be a Droplet actions object
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
POST https://api.digitalocean.com/v2/droplets/3164450/actions HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
{
"type": "change_kernel",
"kernel": 991
}
HTTP/1.1 201 Created
content-type: application/json; charset=utf-8
ratelimit-limit: 1200
ratelimit-remaining: 1124
ratelimit-reset: 1415984218
{
"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"
}
}{DROPLET_ID}/actionsTo enable IPv6 networking on an existing Droplet (within a region that has IPv6 available), send a POST request to /droplets/{DROPLET_ID}/actions. Set the “type” attribute to enable_ipv6.
Path variables
Request headers
Request body
Must be enable_ipv6
Responses
The response will be a JSON object with a key called action. The value will be a Droplet actions object
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
POST https://api.digitalocean.com/v2/droplets/3164450/actions HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
{
"type": "enable_ipv6"
}
HTTP/1.1 201 Created
content-type: application/json; charset=utf-8
ratelimit-limit: 1200
ratelimit-remaining: 1124
ratelimit-reset: 1415984218
{
"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"
}
}{DROPLET_ID}/actionso enable private networking on an existing Droplet (within a region that has private networking available), send a POST request to /droplets/{DROPLET_ID}/actions. Set the “type” attribute to enable_private_networking.
Path variables
Request headers
Request body
Must be enable_private_networking
Responses
The response will be a JSON object with a key called action. The value will be a Droplet actions object
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
POST https://api.digitalocean.com/v2/droplets/3164450/actions HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
{
"type": "enable_private_networking"
}
HTTP/1.1 201 Created
content-type: application/json
ratelimit-limit: 1200
ratelimit-remaining: 1124
ratelimit-reset: 1415984218
{
"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"
}
}{DROPLET_ID}/actionsTo snapshot a Droplet, send a POST request to /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.
Path variables
Request headers
Request body
Must be snapshot
Responses
The response will be a JSON object with a key called action. The value will be a Droplet actions object
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
POST https://api.digitalocean.com/v2/droplets/3164450/actions HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
{
"type": "snapshot",
"name": "Nifty New Snapshot"
}
HTTP/1.1 201 Created
content-type: application/json
ratelimit-limit: 1200
ratelimit-remaining: 1124
ratelimit-reset: 1415984218
{
"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"
}
}{DROPLET_ID}/actionsTo upgrade a Droplet, send a POST request to /droplets/{DROPLET_ID}/actions. Set the “type” attribute to upgrade
Path variables
Request headers
Request body
Must be upgrade
Responses
The response will be a JSON object with a key called action. The value will be a Droplet actions object
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
The response will be a JSON object with a key called action. The value will be a Droplet actions object
POST https://api.digitalocean.com/v2/droplets/3164450/actions HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
{
"type": "upgrade"
}
HTTP/1.1 201 Created
content-type: application/json
ratelimit-limit: 1200
ratelimit-remaining: 1124
ratelimit-reset: 1415984218
{
"action": {
"id": 36805022,
"status": "in-progress",
"type": "upgrade",
"started_at": "2014-11-14T16:34:39Z",
"completed_at": null,
"resource_id": 3164450,
"resource_type": "droplet",
"region": "nyc1",
"region_slug": "nyc1"
}
}{DROPLET_ID}/actions/{ACTION_ID}To retrieve a Droplet action, send a GET request to /droplets/{DROPLET_ID}/actions/{ACTION_ID}.
Path variables
Request headers
Responses
The response will be a JSON object with a key called action. The value will be a Droplet actions object
Headers
The number of requests that can be made per hour per OAuth token.
The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
Body
The response will be a JSON object with a key called action. The value will be a Droplet actions object
GET https://api.digitalocean.com/v2/droplets/3164444/actions/36804807 HTTP/1.1
Content-Type: application/json
Authorization: Bearer b7d03a6947b217efb6f3ec3bd3504582
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
ratelimit-limit: 1200
ratelimit-remaining: 1124
ratelimit-reset: 1415984218
{
"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 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.
{IMAGE_ID}/actions{IMAGE_ID}{IMAGE_SLUG}{IMAGE_ID}{IMAGE_ID}To list all of the images available on your account, send a GET request to /images
Request headers
Responses
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