Skip to content

network_interface

Manage VPS network interfaces

Index

Path
GET /v7.0/network_interfaces
Description
List network interfaces
Authentication required
yes
Scope
network_interface#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
network_interface
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
vps
VPS
 Resource no

VPS the interface is assigned to, can be null
location
Location
 Resource no

Location this IP address is available in
user
User
 Resource no

Output parameters

Layout
object_list
Namespace
network_interfaces
ParameterTypeDescription
id
ID
 Integer Interface ID
vps
VPS
 Resource VPS the interface is assigned to, can be null
name
Name
 String
type
Type
 String node, storage or mailer
mac
MAC Address
 String
max_tx
Max outgoing data throughput
 Integer Maximum output throughput
max_rx
Max incoming data throughput
 Integer Maximum input throughput
enable
Enable
 Boolean

Show

Path
GET /v7.0/network_interfaces/{network_interface_id}
Description
Show a network interface
Authentication required
yes
Scope
network_interface#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
network_interface
ParameterTypeDescription
id
ID
 Integer Interface ID
vps
VPS
 Resource VPS the interface is assigned to, can be null
name
Name
 String
type
Type
 String node, storage or mailer
mac
MAC Address
 String
max_tx
Max outgoing data throughput
 Integer Maximum output throughput
max_rx
Max incoming data throughput
 Integer Maximum input throughput
enable
Enable
 Boolean

Update

Path
PUT /v7.0/network_interfaces/{network_interface_id}
Description
Modify a network interface
Authentication required
yes
Scope
network_interface#update
Aliases
Blocking
yes

Input parameters

Layout
object
Namespace
network_interface
ParameterTypeRequiredDetails
name
Name
 String no

Default: null

Validation rules
RuleDetails
Format

Must match this regular expression:

\A[a-zA-Z\-_.0-9]{1,30}\z

null

Validation error message: bad format
max_tx
Max outgoing data throughput
 Integer no

Maximum output throughput

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
max_rx
Max incoming data throughput
 Integer no

Maximum input throughput

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
enable
Enable
 Boolean no

Default: null

Output parameters

Layout
object
Namespace
network_interface
ParameterTypeDescription
id
ID
 Integer Interface ID
vps
VPS
 Resource VPS the interface is assigned to, can be null
name
Name
 String
type
Type
 String node, storage or mailer
mac
MAC Address
 String
max_tx
Max outgoing data throughput
 Integer Maximum output throughput
max_rx
Max incoming data throughput
 Integer Maximum input throughput
enable
Enable
 Boolean