Skip to content

network

Manage networks

Add_addresses

Path
POST /v7.0/networks/{network_id}/add_addresses
Description
Add IP addresses to a managed network
Authentication required
yes
Scope
network#add_addresses
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
network
ParameterTypeRequiredDetails
count
Count
 Integer yes

Number of added IP addresses

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

Number
  • Must be a number after parameter type conversion.
  • Minimum: 1 (inclusive).

Validation error message: must be at least 1
user
User
 Resource no

Owner of new IP addresses
environment
Environment
 Resource no

Environment to which the addresses are charged

Output parameters

Layout
hash
Namespace
network
ParameterTypeDescription
count
Count
 Integer Number of added IP addresses

Create

Path
POST /v7.0/networks
Description
Add a new network
Authentication required
yes
Scope
network#create
Aliases
new
Blocking
yes

Input parameters

Layout
object
Namespace
network
ParameterTypeRequiredDetails
label
Label
 String no

Default: null
ip_version
Ip_version
 Integer yes

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

Include

Allowed values:

  • 4
  • 6

Validation error message: %{value} cannot be used
address
Address
 String yes

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
prefix
Prefix
 Integer yes

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
role
Role
 String yes

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

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
managed
Managed
 Boolean yes

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

Include

Allowed values:

  • true
  • false

Validation error message: %{value} cannot be used
enabled
Enabled
 Boolean no

Allow new allocations and assignments

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • true
  • false

Validation error message: %{value} cannot be used
split_access
Split_access
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • no_access
  • user_split
  • owner_split

Validation error message: %{value} cannot be used
split_prefix
Split_prefix
 Integer yes

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
purpose
Purpose
 String yes

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • any
  • vps
  • export

Validation error message: %{value} cannot be used

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
add_ip_addresses
Add_ip_addresses
 Boolean no

Add all IP addresses from this network to the database now

Default: false

Output parameters

Layout
object
Namespace
network
ParameterTypeDescription
id
Id
 Integer
primary_location
Primary_location
 Resource
label
Label
 String
ip_version
Ip_version
 Integer
address
Address
 String
prefix
Prefix
 Integer
role
Role
 String Show only datasets of certain role
managed
Managed
 Boolean
enabled
Enabled
 Boolean Allow new allocations and assignments
split_access
Split_access
 String
split_prefix
Split_prefix
 Integer
purpose
Purpose
 String
size
Size
 Integer Number of possible host IP addresses
used
Used
 Integer Number of IP addresses present in vpsAdmin
assigned
Assigned
 Integer Number of IP addresses assigned to VPSes
owned
Owned
 Integer Number of IP addresses owned by some users
taken
Taken
 Integer Number of owned and assigned IP addresses
available_to_users
Available to users
 Integer Registered unowned, unassigned and unreserved addresses or prefixes; zero when the network is disabled
owned_unassigned
Owned, not assigned
 Integer User-owned addresses or prefixes without an interface assignment, including reserved entries and disabled networks

Index

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

Input parameters

Layout
object
Namespace
network
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
location
Location
 Resource no
enabled
Enabled
 Boolean no

Allow new allocations and assignments

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • true
  • false

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

Output parameters

Layout
object_list
Namespace
networks
ParameterTypeDescription
id
Id
 Integer
primary_location
Primary_location
 Resource
label
Label
 String
ip_version
Ip_version
 Integer
address
Address
 String
prefix
Prefix
 Integer
role
Role
 String Show only datasets of certain role
managed
Managed
 Boolean
enabled
Enabled
 Boolean Allow new allocations and assignments
split_access
Split_access
 String
split_prefix
Split_prefix
 Integer
purpose
Purpose
 String
size
Size
 Integer Number of possible host IP addresses
used
Used
 Integer Number of IP addresses present in vpsAdmin
assigned
Assigned
 Integer Number of IP addresses assigned to VPSes
owned
Owned
 Integer Number of IP addresses owned by some users
taken
Taken
 Integer Number of owned and assigned IP addresses
available_to_users
Available to users
 Integer Registered unowned, unassigned and unreserved addresses or prefixes; zero when the network is disabled
owned_unassigned
Owned, not assigned
 Integer User-owned addresses or prefixes without an interface assignment, including reserved entries and disabled networks

Show

Path
GET /v7.0/networks/{network_id}
Description
Show a network
Authentication required
yes
Scope
network#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
network
ParameterTypeDescription
id
Id
 Integer
primary_location
Primary_location
 Resource
label
Label
 String
ip_version
Ip_version
 Integer
address
Address
 String
prefix
Prefix
 Integer
role
Role
 String Show only datasets of certain role
managed
Managed
 Boolean
enabled
Enabled
 Boolean Allow new allocations and assignments
split_access
Split_access
 String
split_prefix
Split_prefix
 Integer
purpose
Purpose
 String
size
Size
 Integer Number of possible host IP addresses
used
Used
 Integer Number of IP addresses present in vpsAdmin
assigned
Assigned
 Integer Number of IP addresses assigned to VPSes
owned
Owned
 Integer Number of IP addresses owned by some users
taken
Taken
 Integer Number of owned and assigned IP addresses
available_to_users
Available to users
 Integer Registered unowned, unassigned and unreserved addresses or prefixes; zero when the network is disabled
owned_unassigned
Owned, not assigned
 Integer User-owned addresses or prefixes without an interface assignment, including reserved entries and disabled networks

Update

Path
PUT /v7.0/networks/{network_id}
Description
Update a network
Authentication required
yes
Scope
network#update
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
network
ParameterTypeRequiredDetails
label
Label
 String no

Default: null
ip_version
Ip_version
 Integer no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • 4
  • 6

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

Default: null
prefix
Prefix
 Integer no

Default: null
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
managed
Managed
 Boolean no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • true
  • false

Validation error message: %{value} cannot be used
enabled
Enabled
 Boolean no

Allow new allocations and assignments

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • true
  • false

Validation error message: %{value} cannot be used
split_access
Split_access
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • no_access
  • user_split
  • owner_split

Validation error message: %{value} cannot be used
split_prefix
Split_prefix
 Integer no

Default: null
purpose
Purpose
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • any
  • vps
  • export

Validation error message: %{value} cannot be used

Output parameters

Layout
object
Namespace
network
ParameterTypeDescription
id
Id
 Integer
primary_location
Primary_location
 Resource
label
Label
 String
ip_version
Ip_version
 Integer
address
Address
 String
prefix
Prefix
 Integer
role
Role
 String Show only datasets of certain role
managed
Managed
 Boolean
enabled
Enabled
 Boolean Allow new allocations and assignments
split_access
Split_access
 String
split_prefix
Split_prefix
 Integer
purpose
Purpose
 String
size
Size
 Integer Number of possible host IP addresses
used
Used
 Integer Number of IP addresses present in vpsAdmin
assigned
Assigned
 Integer Number of IP addresses assigned to VPSes
owned
Owned
 Integer Number of IP addresses owned by some users
taken
Taken
 Integer Number of owned and assigned IP addresses
available_to_users
Available to users
 Integer Registered unowned, unassigned and unreserved addresses or prefixes; zero when the network is disabled
owned_unassigned
Owned, not assigned
 Integer User-owned addresses or prefixes without an interface assignment, including reserved entries and disabled networks