Methods
(static) Volume#snapshot(id, name, callbackopt)
Create a snapshot from the volume.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
id |
string | The id of the volume to snapshot | |
name |
string | The name with which to create the snapshot. See the official docs for valid attributes. | |
callback |
requestCallback |
<optional> |
callback that handles the response |
- Source:
action(imageId, parametersOrType, callbackopt)
Create an action on the identified image.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
imageId |
number | The id of the image 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:
convert(dropletId, callbackopt)
If the image is a backup, wwitch the identified image from a backup to a snapshot.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
dropletId |
number | The id of the image for which to create the action | |
callback |
requestCallback |
<optional> |
callback that handles the response |
- Source:
delete(id, callbackopt)
Delete the identified image object.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
id |
number | The id of the image to delete | |
callback |
requestCallback |
<optional> |
callback that handles the response |
- Source:
get(id, callbackopt)
Get the identified image object.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
id |
number | The id of the image to retrieve | |
callback |
requestCallback |
<optional> |
callback that handles the response |
- Source:
getAction(imageId, id, callbackopt)
Get the identified action object.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
imageId |
number | The id of the image for which to retrieve the action | |
id |
number | The id of the action to retrieve | |
callback |
requestCallback |
<optional> |
callback that handles the response |
- Source:
list(page or queryObjectopt, perPageopt, callbackopt)
List image 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:
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:
transfer(imageId, parametersOrRegionSlug, callbackopt)
Add the image to an additional region.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
imageId |
number | The id of the image for which to create the action | |
parametersOrRegionSlug |
string | object | If a string, the identifier of the region. Otherwise, an object with required keys of `region`. See the official docs for valid attributes. | |
callback |
requestCallback |
<optional> |
callback that handles the response |
- Source:
update(id, attributes, callbackopt)
Update the identified image object.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
id |
number | The id of the image to update | |
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: