new cloudAddresses(domainOrOptionsopt)
Parameters:
| Name |
Type |
Attributes |
Description |
domainOrOptions |
string
|
object
|
<optional>
|
The project domain or options object. If object, see the object's optional properties.
Properties
| Name |
Type |
Attributes |
Description |
domain |
string
|
<optional>
|
The project domain |
token |
object
|
<optional>
|
auth token - object with value property and optional headerOrQueryName and isQuery properties |
|
- Source:
Methods
addAddress(body)
Create a new dynamic IPv4 address
Parameters:
| Name |
Type |
Description |
body |
IpAddressCreate
|
address details |
- Source:
attachAddress(addressId, body)
Attach an address to a server
Parameters:
| Name |
Type |
Description |
addressId |
string
|
Address to attach |
body |
AddressAttach
|
Attachment parameters |
- Source:
destroyAddress(addressId)
Destroy an address
Parameters:
| Name |
Type |
Description |
addressId |
string
|
Id of Address to destroy |
- Source:
detachAddress(addressId)
Detach an address from a server
Parameters:
| Name |
Type |
Description |
addressId |
string
|
Address to detach |
- Source:
getAddressActionById(addressId, addressActionId)
Find AddressAction by id
Parameters:
| Name |
Type |
Description |
addressId |
string
|
Address the action is performed on |
addressActionId |
string
|
Id of AddressAction to be fetched |
- Source:
getAddressActionList(addressId, type, limit, offset)
List actions performed on an Address
Parameters:
| Name |
Type |
Description |
addressId |
string
|
Address to retrieve actions for |
type |
string
|
Action type (exact match) |
limit |
integer
|
Number of results to display |
offset |
integer
|
The starting position of the query |
- Source:
getAddressById(addressId)
Find address by id
Parameters:
| Name |
Type |
Description |
addressId |
string
|
Id of address to be fetched |
- Source:
getAddressList(address, serverId, status, type, limit, offset)
List addresses
Parameters:
| Name |
Type |
Description |
address |
string
|
Numeric address (exact match) |
serverId |
string
|
serverId filter |
status |
string
|
Address status (exact match) |
type |
string
|
Address type (exact match) |
limit |
integer
|
Number of results to display |
offset |
integer
|
The starting position of the query |
- Source:
setToken(value, headerOrQueryName, isQuery)
Set Token
Parameters:
| Name |
Type |
Description |
value |
string
|
token's value |
headerOrQueryName |
string
|
the header or query name to send the token at |
isQuery |
boolean
|
true if send the token as query param, otherwise, send as header param |
- Source: