Methods
action(ip, parametersOrType, callbackopt)
Create an action on the identified floating ip.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
ip |
strint | The IP of the floating ip 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:
assign(ip, parametersOrDropletId, callbackopt)
Assign the identified floating IP to a Droplet.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
ip |
strint | The IP of the floating ip for which to create the action | |
parametersOrDropletId |
number | object | If a number, the identifier of the Droplet. Otherwise, an object with required keys of `droplet_id`. See the official docs for valid attributes. | |
callback |
requestCallback |
<optional> |
callback that handles the response |
- Source:
create(attributes, callbackopt)
Create a floating IP object.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
attributes |
object | The attributes with which to create the floating ip. See the official docs for valid attributes. | |
callback |
requestCallback |
<optional> |
callback that handles the response |
- Source:
delete(ip, callbackopt)
Delete the identified floating ip object.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
ip |
string | The ip of the floating ip to delete | |
callback |
requestCallback |
<optional> |
callback that handles the response |
- Source:
get(ip, callbackopt)
Get the identified floating ip object.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
ip |
string | The IP of the floating ip to retrieve | |
callback |
requestCallback |
<optional> |
callback that handles the response |
- Source:
getAction(ip, id, callbackopt)
Get the identified action object.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
ip |
strint | The IP of the floating ip 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 Floating IP 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(ip, page or queryObjectopt, perPageopt, callbackopt)
List of action objects.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
ip |
string | The IP of the floating ip 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:
unassign(ip, callbackopt)
If the identified floating IP is assigned to a Droplet, unassign it.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
ip |
strint | The IP of the floating ip for which to create the action | |
callback |
requestCallback |
<optional> |
callback that handles the response |
- Source: