digitalocean
Version:
nodejs wrapper for digitalocean v2 api
3,788 lines (954 loc) • 82.1 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: Droplet</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: Droplet</h1>
<section>
<header>
<h2>Droplet</h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="Droplet"><span class="type-signature"></span>new Droplet<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Droplet resource
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="digitalocean_droplet.js.html">digitalocean/droplet.js</a>, <a href="digitalocean_droplet.js.html#line5">line 5</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="snapshots"><span class="type-signature">(static) </span>Volume#snapshots<span class="signature">(id, page or queryObject<span class="signature-attributes">opt</span>, perPage<span class="signature-attributes">opt</span>, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
List of snapshot objects from this volume.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last">ID of Droplet for which to retrieve snapshots</td>
</tr>
<tr>
<td class="name"><code>page or queryObject</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">page number to retrieve or key value pairs of query parameters</td>
</tr>
<tr>
<td class="name"><code>perPage</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">number of result per page to retrieve</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#listRequestCallback">listRequestCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">callback that handles the response</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="digitalocean_volume.js.html">digitalocean/volume.js</a>, <a href="digitalocean_volume.js.html#line60">line 60</a>
</li></ul></dd>
</dl>
<h4 class="name" id="action"><span class="type-signature"></span>action<span class="signature">(dropletId, parametersOrType, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
Create an action on the identified Droplet.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>dropletId</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last">The id of the droplet for which to create the action</td>
</tr>
<tr>
<td class="name"><code>parametersOrType</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">object</span>
</td>
<td class="attributes">
</td>
<td class="description last">The name of the action to create or an object with key value pairs of parameters.</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#requestCallback">requestCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">callback that handles the response</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="digitalocean_droplet.js.html">digitalocean/droplet.js</a>, <a href="digitalocean_droplet.js.html#line177">line 177</a>
</li></ul></dd>
</dl>
<h4 class="name" id="actionByTag"><span class="type-signature"></span>actionByTag<span class="signature">(name, actionType, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
Delete the Droplets associated with the tag identified by the name.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last">The name of the tag for which to delete Droplets.</td>
</tr>
<tr>
<td class="name"><code>actionType</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last">The type of action to perform. See the <a href="https://developers.digitalocean.com/documentation/v2/#acting-on-tagged-droplets">official docs</a> for accepted actions.</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#requestCallback">requestCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">callback that handles the response</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="digitalocean_droplet.js.html">digitalocean/droplet.js</a>, <a href="digitalocean_droplet.js.html#line198">line 198</a>
</li></ul></dd>
</dl>
<h4 class="name" id="backups"><span class="type-signature"></span>backups<span class="signature">(id, page or queryObject<span class="signature-attributes">opt</span>, perPage<span class="signature-attributes">opt</span>, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
List backup objects that are backups of the Droplet.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last">ID of Droplet for which to retrieve backups</td>
</tr>
<tr>
<td class="name"><code>page or queryObject</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">page number to retrieve or key value pairs of query parameters</td>
</tr>
<tr>
<td class="name"><code>perPage</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">number of result per page to retrieve</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#listRequestCallback">listRequestCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">callback that handles the response</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="digitalocean_droplet.js.html">digitalocean/droplet.js</a>, <a href="digitalocean_droplet.js.html#line92">line 92</a>
</li></ul></dd>
</dl>
<h4 class="name" id="changeKernel"><span class="type-signature"></span>changeKernel<span class="signature">(dropletId, parametersOrKernelId, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
Recreate the Droplet from the identified distribution image.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>dropletId</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last">The id of the droplet for which to create the action</td>
</tr>
<tr>
<td class="name"><code>parametersOrKernelId</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">object</span>
</td>
<td class="attributes">
</td>
<td class="description last">If a number, the identifier of the kernel to use. Otherwise, an object with required keys of `kernel`. See the <a href="https://developers.digitalocean.com/documentation/v2/#change-the-kernel">official docs</a> for valid attributes.</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#requestCallback">requestCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">callback that handles the response</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="digitalocean_droplet.js.html">digitalocean/droplet.js</a>, <a href="digitalocean_droplet.js.html#line440">line 440</a>
</li></ul></dd>
</dl>
<h4 class="name" id="create"><span class="type-signature"></span>create<span class="signature">(attributes, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
Create a Droplet object.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>attributes</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
</td>
<td class="description last">The attributes with which to create the Droplet. See the <a href="https://developers.digitalocean.com/documentation/v2/#droplets">official docs</a> for valid attributes.</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#requestCallback">requestCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">callback that handles the response</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="digitalocean_droplet.js.html">digitalocean/droplet.js</a>, <a href="digitalocean_droplet.js.html#line35">line 35</a>
</li></ul></dd>
</dl>
<h4 class="name" id="delete"><span class="type-signature"></span>delete<span class="signature">(id, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
Delete the identified Droplet object.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last">The id of the Droplet to retrieve</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#requestCallback">requestCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">callback that handles the response</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="digitalocean_droplet.js.html">digitalocean/droplet.js</a>, <a href="digitalocean_droplet.js.html#line122">line 122</a>
</li></ul></dd>
</dl>
<h4 class="name" id="deleteByTag"><span class="type-signature"></span>deleteByTag<span class="signature">(name, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
Delete the Droplets associated with the tag identified by the name.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last">The name of the tag for which to delete Droplets.</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#requestCallback">requestCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">callback that handles the response</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="digitalocean_droplet.js.html">digitalocean/droplet.js</a>, <a href="digitalocean_droplet.js.html#line134">line 134</a>
</li></ul></dd>
</dl>
<h4 class="name" id="disableBackups"><span class="type-signature"></span>disableBackups<span class="signature">(dropletId, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
Disable backups on the identified Droplet.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>dropletId</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last">The id of the droplet for which to create the action</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#requestCallback">requestCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">callback that handles the response</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="digitalocean_droplet.js.html">digitalocean/droplet.js</a>, <a href="digitalocean_droplet.js.html#line280">line 280</a>
</li></ul></dd>
</dl>
<h4 class="name" id="enableBackups"><span class="type-signature"></span>enableBackups<span class="signature">(dropletId, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
Enable backups on the identified Droplet.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>dropletId</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last">The id of the droplet for which to create the action</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#requestCallback">requestCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">callback that handles the response</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="digitalocean_droplet.js.html">digitalocean/droplet.js</a>, <a href="digitalocean_droplet.js.html#line269">line 269</a>
</li></ul></dd>
</dl>
<h4 class="name" id="enableIPv6"><span class="type-signature"></span>enableIPv6<span class="signature">(dropletId, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
Enable IPv6 networking on the identified Droplet.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>dropletId</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last">The id of the droplet for which to create the action</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#requestCallback">requestCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">callback that handles the response</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="digitalocean_droplet.js.html">digitalocean/droplet.js</a>, <a href="digitalocean_droplet.js.html#line302">line 302</a>
</li></ul></dd>
</dl>
<h4 class="name" id="enablePrivateNetworking"><span class="type-signature"></span>enablePrivateNetworking<span class="signature">(dropletId, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
Enable private-to-the-datacenter networking on the identified Droplet.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>dropletId</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last">The id of the droplet for which to create the action</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#requestCallback">requestCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">callback that handles the response</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="digitalocean_droplet.js.html">digitalocean/droplet.js</a>, <a href="digitalocean_droplet.js.html#line313">line 313</a>
</li></ul></dd>
</dl>
<h4 class="name" id="get"><span class="type-signature"></span>get<span class="signature">(id, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
Get the identified Droplet object.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last">The id of the Droplet to retrieve</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#requestCallback">requestCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">callback that handles the response</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="digitalocean_droplet.js.html">digitalocean/droplet.js</a>, <a href="digitalocean_droplet.js.html#line46">line 46</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getAction"><span class="type-signature"></span>getAction<span class="signature">(dropletId, id, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
Get the identified action object.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>dropletId</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last">The id of the droplet for which to retrieve the action</td>
</tr>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last">The id of the action to retrieve</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#requestCallback">requestCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">callback that handles the response</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="digitalocean_droplet.js.html">digitalocean/droplet.js</a>, <a href="digitalocean_droplet.js.html#line164">line 164</a>
</li></ul></dd>
</dl>
<h4 class="name" id="kernels"><span class="type-signature"></span>kernels<span class="signature">(id, page or queryObject<span class="signature-attributes">opt</span>, perPage<span class="signature-attributes">opt</span>, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
List kernel objects.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last">ID of Droplet for which to retrieve kernels</td>
</tr>
<tr>
<td class="name"><code>page or queryObject</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">page number to retrieve or key value pairs of query parameters</td>
</tr>
<tr>
<td class="name"><code>perPage</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">number of result per page to retrieve</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#listRequestCallback">listRequestCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">callback that handles the response</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="digitalocean_droplet.js.html">digitalocean/droplet.js</a>, <a href="digitalocean_droplet.js.html#line60">line 60</a>
</li></ul></dd>
</dl>
<h4 class="name" id="list"><span class="type-signature"></span>list<span class="signature">(page or queryObject<span class="signature-attributes">opt</span>, perPage<span class="signature-attributes">opt</span>, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
List Droplet objects.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>page or queryObject</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">page number to retrieve or key value pairs of query parameters</td>
</tr>
<tr>
<td class="name"><code>perPage</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">number of result per page to retrieve</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#listRequestCallback">listRequestCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">callback that handles the response</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="digitalocean_droplet.js.html">digitalocean/droplet.js</a>, <a href="digitalocean_droplet.js.html#line22">line 22</a>
</li></ul></dd>
</dl>
<h4 class="name" id="listActions"><span class="type-signature"></span>listActions<span class="signature">(id, page or queryObject<span class="signature-attributes">opt</span>, perPage<span class="signature-attributes">opt</span>, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
List of action objects.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last">ID of Droplet for which to retrieve actions</td>
</tr>
<tr>
<td class="name"><code>page or queryObject</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">page number to retrieve or key value pairs of query parameters</td>
</tr>
<tr>
<td class="name"><code>perPage</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">number of result per page to retrieve</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#listRequestCallback">listRequestCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">callback that handles the response</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="digitalocean_droplet.js.html">digitalocean/droplet.js</a>, <a href="digitalocean_droplet.js.html#line149">line 149</a>
</li></ul></dd>
</dl>
<h4 class="name" id="neighbors"><span class="type-signature"></span>neighbors<span class="signature">(id, page or queryObject<span class="signature-attributes">opt</span>, perPage<span class="signature-attributes">opt</span>, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
List of Droplet objects that are physically co-located with the Droplet.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last">ID of Droplet for which to retrieve neighbors</td>
</tr>
<tr>
<td class="name"><code>page or queryObject</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">page number to retrieve or key value pairs of query parameters</td>
</tr>
<tr>
<td class="name"><code>perPage</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">number of result per page to retrieve</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#listRequestCallback">listRequestCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">callback that handles the response</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="digitalocean_droplet.js.html">digitalocean/droplet.js</a>, <a href="digitalocean_droplet.js.html#line108">line 108</a>
</li></ul></dd>
</dl>
<h4 class="name" id