Skip to content

host_ip_address

Manage interface IP addresses

Assign

Path
POST /v7.0/host_ip_addresses/{host_ip_address_id}/assign
Description
Assign the address to an interface
Authentication required
yes
Scope
host_ip_address#assign
Aliases
Blocking
yes

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
host_ip_address
ParameterTypeDescription
id
ID
 Integer IP address ID
ip_address
IpAddress
 Resource
addr
Address
 String Address itself
assigned
Assigned
 Boolean Number of IP addresses assigned to VPSes
user_created
User_created
 Boolean
reverse_record_value
Reverse_record_value
 String

Create

Path
POST /v7.0/host_ip_addresses
Description
Add host IP address
Authentication required
yes
Scope
host_ip_address#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
host_ip_address
ParameterTypeRequiredDetails
ip_address
IpAddress
 Resource yes
addr
Network address
 String yes

Address itself

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty
assigned
Assigned
 Boolean no

Number of IP addresses assigned to VPSes

Default: null

Output parameters

Layout
object
Namespace
host_ip_address
ParameterTypeDescription
id
ID
 Integer IP address ID
ip_address
IpAddress
 Resource
addr
Address
 String Address itself
assigned
Assigned
 Boolean Number of IP addresses assigned to VPSes
user_created
User_created
 Boolean
reverse_record_value
Reverse_record_value
 String

Delete

Path
DELETE /v7.0/host_ip_addresses/{host_ip_address_id}
Description
Delete host IP address
Authentication required
yes
Scope
host_ip_address#delete
Aliases
destroy
Blocking
yes

Input parameters

No parameters.

Output parameters

No parameters.

Free

Path
POST /v7.0/host_ip_addresses/{host_ip_address_id}/free
Description
Remove the address from its interface
Authentication required
yes
Scope
host_ip_address#free
Aliases
Blocking
yes

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
host_ip_address
ParameterTypeDescription
id
ID
 Integer IP address ID
ip_address
IpAddress
 Resource
addr
Address
 String Address itself
assigned
Assigned
 Boolean Number of IP addresses assigned to VPSes
user_created
User_created
 Boolean
reverse_record_value
Reverse_record_value
 String

Index

Path
GET /v7.0/host_ip_addresses
Description
List IP addresses
Authentication required
yes
Scope
host_ip_address#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
host_ip_address
ParameterTypeRequiredDetails
from_id
From ID
 Integer no

List objects with IDs greater or lower than this value

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).

Validation error message: must be at least 0
limit
Limit
 Integer no

Number of objects to retrieve

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).
  • Maximum: 1000 (inclusive).

Validation error message: must be between 0 and 1000
ip_address
IpAddress
 Resource no
network_interface
NetworkInterface
 Resource no
vps
VPS
 Resource no

VPS this IP is assigned to, can be null
version
IP version
 Integer no

4 or 6

Default: null
network
Network
 Resource no
location
Location
 Resource no

Location this IP address is available in
user
User
 Resource no

Filter by owner
role
Role
 String no

Show only datasets of certain role

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • public_access
  • private_access

Validation error message: %{value} cannot be used
purpose
Purpose
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • any
  • vps
  • export

Validation error message: %{value} cannot be used
usable_for
Usable for
 String no

Filter by compatible network purpose, including networks with purpose any

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • vps
  • export

Validation error message: %{value} cannot be used
addr
Network address
 String no

Address itself

Default: null
prefix
Prefix
 Integer no

Default: null
size
Size
 Integer no

Default: null
assigned
Assigned
 Boolean no

Number of IP addresses assigned to VPSes

Default: null
routed
Routed
 Boolean no

Default: null
order
Order
 String no

Template order

Default: asc

Validation rules
RuleDetails
Include

Allowed values:

  • asc
  • interface

Validation error message: %{value} cannot be used

Output parameters

Layout
object_list
Namespace
host_ip_addresses
ParameterTypeDescription
id
ID
 Integer IP address ID
ip_address
IpAddress
 Resource
addr
Address
 String Address itself
assigned
Assigned
 Boolean Number of IP addresses assigned to VPSes
user_created
User_created
 Boolean
reverse_record_value
Reverse_record_value
 String

Show

Path
GET /v7.0/host_ip_addresses/{host_ip_address_id}
Description
Show interface IP address
Authentication required
yes
Scope
host_ip_address#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
host_ip_address
ParameterTypeDescription
id
ID
 Integer IP address ID
ip_address
IpAddress
 Resource
addr
Address
 String Address itself
assigned
Assigned
 Boolean Number of IP addresses assigned to VPSes
user_created
User_created
 Boolean
reverse_record_value
Reverse_record_value
 String

Update

Path
PUT /v7.0/host_ip_addresses/{host_ip_address_id}
Description
Update host IP address
Authentication required
yes
Scope
host_ip_address#update
Aliases
Blocking
yes

Input parameters

Layout
object
Namespace
host_ip_address
ParameterTypeRequiredDetails
ip_address
IpAddress
 Resource no
addr
Address
 String no

Address itself

Default: null
assigned
Assigned
 Boolean no

Number of IP addresses assigned to VPSes

Default: null
reverse_record_value
Reverse_record_value
 String no

Default: null

Output parameters

Layout
object
Namespace
host_ip_address
ParameterTypeDescription
id
ID
 Integer IP address ID
ip_address
IpAddress
 Resource
addr
Address
 String Address itself
assigned
Assigned
 Boolean Number of IP addresses assigned to VPSes
user_created
User_created
 Boolean
reverse_record_value
Reverse_record_value
 String