JSDoc: Class: Droplet

new Droplet()

Droplet resource

Source:

digitalocean/droplet.js, line 5

Methods

(static) Volume#snapshots(id, page or queryObjectopt, perPageopt, callbackopt)

List of snapshot objects from this volume.

Parameters:

Name	Type	Attributes	Description
`id`	number		ID of Droplet for which to retrieve snapshots
`page or queryObject`	number \| object	<optional>	page number to retrieve or key value pairs of query parameters
`perPage`	number	<optional>	number of result per page to retrieve
`callback`	listRequestCallback	<optional>	callback that handles the response

Source:

digitalocean/volume.js, line 60

action(dropletId, parametersOrType, callbackopt)

Create an action on the identified Droplet.

Parameters:

Name	Type	Attributes	Description
`dropletId`	number		The id of the droplet for which to create the action
`parametersOrType`	string \| object		The name of the action to create or an object with key value pairs of parameters.
`callback`	requestCallback	<optional>	callback that handles the response

Source:

digitalocean/droplet.js, line 177

actionByTag(name, actionType, callbackopt)

Delete the Droplets associated with the tag identified by the name.

Parameters:

Name	Type	Attributes	Description
`name`	string		The name of the tag for which to delete Droplets.
`actionType`	string		The type of action to perform. See the official docs for accepted actions.
`callback`	requestCallback	<optional>	callback that handles the response

Source:

digitalocean/droplet.js, line 198

backups(id, page or queryObjectopt, perPageopt, callbackopt)

List backup objects that are backups of the Droplet.

Parameters:

Name	Type	Attributes	Description
`id`	number		ID of Droplet for which to retrieve backups
`page or queryObject`	number \| object	<optional>	page number to retrieve or key value pairs of query parameters
`perPage`	number	<optional>	number of result per page to retrieve
`callback`	listRequestCallback	<optional>	callback that handles the response

Source:

digitalocean/droplet.js, line 92

changeKernel(dropletId, parametersOrKernelId, callbackopt)

Recreate the Droplet from the identified distribution image.

Parameters:

Name	Type	Attributes	Description
`dropletId`	number		The id of the droplet for which to create the action
`parametersOrKernelId`	number \| object		If a number, the identifier of the kernel to use. Otherwise, an object with required keys of `kernel`. See the official docs for valid attributes.
`callback`	requestCallback	<optional>	callback that handles the response

Source:

digitalocean/droplet.js, line 440

create(attributes, callbackopt)

Create a Droplet object.

Parameters:

Name	Type	Attributes	Description
`attributes`	object		The attributes with which to create the Droplet. See the official docs for valid attributes.
`callback`	requestCallback	<optional>	callback that handles the response

Source:

digitalocean/droplet.js, line 35

delete(id, callbackopt)

Delete the identified Droplet object.

Parameters:

Name	Type	Attributes	Description
`id`	number		The id of the Droplet to retrieve
`callback`	requestCallback	<optional>	callback that handles the response

Source:

digitalocean/droplet.js, line 122

deleteByTag(name, callbackopt)

Delete the Droplets associated with the tag identified by the name.

Parameters:

Name	Type	Attributes	Description
`name`	string		The name of the tag for which to delete Droplets.
`callback`	requestCallback	<optional>	callback that handles the response

Source:

digitalocean/droplet.js, line 134

disableBackups(dropletId, callbackopt)

Disable backups on the identified Droplet.

Parameters:

Name	Type	Attributes	Description
`dropletId`	number		The id of the droplet for which to create the action
`callback`	requestCallback	<optional>	callback that handles the response

Source:

digitalocean/droplet.js, line 280

enableBackups(dropletId, callbackopt)

Enable backups on the identified Droplet.

Parameters:

Name	Type	Attributes	Description
`dropletId`	number		The id of the droplet for which to create the action
`callback`	requestCallback	<optional>	callback that handles the response

Source:

digitalocean/droplet.js, line 269

enableIPv6(dropletId, callbackopt)

Enable IPv6 networking on the identified Droplet.

Parameters:

Name	Type	Attributes	Description
`dropletId`	number		The id of the droplet for which to create the action
`callback`	requestCallback	<optional>	callback that handles the response

Source:

digitalocean/droplet.js, line 302

enablePrivateNetworking(dropletId, callbackopt)

Enable private-to-the-datacenter networking on the identified Droplet.

Parameters:

Name	Type	Attributes	Description
`dropletId`	number		The id of the droplet for which to create the action
`callback`	requestCallback	<optional>	callback that handles the response

Source:

digitalocean/droplet.js, line 313

get(id, callbackopt)

Get the identified Droplet object.

Parameters:

Name	Type	Attributes	Description
`id`	number		The id of the Droplet to retrieve
`callback`	requestCallback	<optional>	callback that handles the response

Source:

digitalocean/droplet.js, line 46

getAction(dropletId, id, callbackopt)

Get the identified action object.

Parameters:

Name	Type	Attributes	Description
`dropletId`	number		The id of the droplet for which to retrieve the action
`id`	number		The id of the action to retrieve
`callback`	requestCallback	<optional>	callback that handles the response

Source:

digitalocean/droplet.js, line 164

kernels(id, page or queryObjectopt, perPageopt, callbackopt)

List kernel objects.

Parameters:

Name	Type	Attributes	Description
`id`	number		ID of Droplet for which to retrieve kernels
`page or queryObject`	number \| object	<optional>	page number to retrieve or key value pairs of query parameters
`perPage`	number	<optional>	number of result per page to retrieve
`callback`	listRequestCallback	<optional>	callback that handles the response

Source:

digitalocean/droplet.js, line 60

list(page or queryObjectopt, perPageopt, callbackopt)

List Droplet objects.

Parameters:

Name	Type	Attributes	Description
`page or queryObject`	number \| object	<optional>	page number to retrieve or key value pairs of query parameters
`perPage`	number	<optional>	number of result per page to retrieve
`callback`	listRequestCallback	<optional>	callback that handles the response

Source:

digitalocean/droplet.js, line 22

listActions(id, page or queryObjectopt, perPageopt, callbackopt)

List of action objects.

Parameters:

Name	Type	Attributes	Description
`id`	number		ID of Droplet for which to retrieve actions
`page or queryObject`	number \| object	<optional>	page number to retrieve or key value pairs of query parameters
`perPage`	number	<optional>	number of result per page to retrieve
`callback`	listRequestCallback	<optional>	callback that handles the response

Source:

digitalocean/droplet.js, line 149

neighbors(id, page or queryObjectopt, perPageopt, callbackopt)

List of Droplet objects that are physically co-located with the Droplet.

Parameters:

Name	Type	Attributes	Description
`id`	number		ID of Droplet for which to retrieve neighbors
`page or queryObject`	number \| object	<optional>	page number to retrieve or key value pairs of query parameters
`perPage`	number	<optional>	number of result per page to retrieve
`callback`	listRequestCallback	<optional>	callback that handles the response

Source:

digitalocean/droplet.js, line 108

passwordReset(dropletId, callbackopt)

Reset the root user's password on the identified Droplet.

Parameters:

Name	Type	Attributes	Description
`dropletId`	number		The id of the droplet for which to create the action
`callback`	requestCallback	<optional>	callback that handles the response

Source:

digitalocean/droplet.js, line 291

powerCycle(dropletId, callbackopt)

Power cycle the identified Droplet.

Parameters:

Name	Type	Attributes	Description
`dropletId`	number		The id of the droplet for which to create the action
`callback`	requestCallback	<optional>	callback that handles the response

Source:

digitalocean/droplet.js, line 247

powerOff(dropletId, callbackopt)

Power off the identified Droplet.

Parameters:

Name	Type	Attributes	Description
`dropletId`	number		The id of the droplet for which to create the action
`callback`	requestCallback	<optional>	callback that handles the response

Source:

digitalocean/droplet.js, line 225

powerOn(dropletId, callbackopt)

Power on the identified Droplet.

Parameters:

Name	Type	Attributes	Description
`dropletId`	number		The id of the droplet for which to create the action
`callback`	requestCallback	<optional>	callback that handles the response

Source:

digitalocean/droplet.js, line 236

reboot(dropletId, callbackopt)

Reboot the identified Droplet.

Parameters:

Name	Type	Attributes	Description
`dropletId`	number		The id of the droplet for which to create the action
`callback`	requestCallback	<optional>	callback that handles the response

Source:

digitalocean/droplet.js, line 258

rebuild(dropletId, parametersOrImage, callbackopt)

Recreate the Droplet from the identified distribution image.

Parameters:

Name	Type	Attributes	Description
`dropletId`	number		The id of the droplet for which to create the action
`parametersOrImage`	string \| number \| object		If a string, the slug of the distribution image to use. If a number, the identifier of the distribution image to use. Otherwise, an object with required keys of `image`. See the official docs for valid attributes.
`callback`	requestCallback	<optional>	callback that handles the response

Source:

digitalocean/droplet.js, line 417

rename(dropletId, parametersOrHostname, callbackopt)

Change the hostname of the identified Droplet.

Parameters:

Name	Type	Attributes	Description
`dropletId`	number		The id of the droplet for which to create the action
`parametersOrHostname`	string \| object		If a string, the hostname to change the Droplet to. Otherwise, an object with required keys of `name`. See the official docs for valid attributes.
`callback`	requestCallback	<optional>	callback that handles the response

Source:

digitalocean/droplet.js, line 348

resize(dropletId, parametersOrSizeSlug, callbackopt)

Change the available resources for the identified Droplet.

Parameters:

Name	Type	Attributes	Description
`dropletId`	number		The id of the droplet for which to create the action
`parametersOrSizeSlug`	string \| object		If a string, the name of the size to change the Droplet to. Otherwise, an object with required keys of `size`. See the official docs for valid attributes.
`callback`	requestCallback	<optional>	callback that handles the response

Source:

digitalocean/droplet.js, line 325

restore(dropletId, parametersOrImageId, callbackopt)

Recreate the Droplet from the identified image snapshot or backup.

Parameters:

Name	Type	Attributes	Description
`dropletId`	number		The id of the droplet for which to create the action
`parametersOrImageId`	number \| object		If a number, identifier of the image to use. Otherwise, an object with required keys of `image`. See the official docs for valid attributes.
`callback`	requestCallback	<optional>	callback that handles the response

Source:

digitalocean/droplet.js, line 394

shutdown(dropletId, callbackopt)

Shutdown the identified Droplet.

Parameters:

Name	Type	Attributes	Description
`dropletId`	number		The id of the droplet for which to create the action
`callback`	requestCallback	<optional>	callback that handles the response

Source:

digitalocean/droplet.js, line 214

snapshot(dropletId, parametersOrName, callbackopt)

Create a snapshot image of the identified Droplet.

Parameters:

Name	Type	Attributes	Description
`dropletId`	number		The id of the droplet for which to create the action
`parametersOrName`	string \| object		If a string, the name of the created image. Otherwise, an object with required keys of `name`. See the official docs for valid attributes.
`callback`	requestCallback	<optional>	callback that handles the response

Source:

digitalocean/droplet.js, line 371

snapshots(id, page or queryObjectopt, perPageopt, callbackopt)

List of image objects that are snapshots of the Droplet.

Parameters:

Name	Type	Attributes	Description
`id`	number		ID of Droplet for which to retrieve snapshots
`page or queryObject`	number \| object	<optional>	page number to retrieve or key value pairs of query parameters
`perPage`	number	<optional>	number of result per page to retrieve
`callback`	listRequestCallback	<optional>	callback that handles the response

Source:

digitalocean/droplet.js, line 76