Skip to content

ip_address_assignment

Browse IP address assignments

Index

Path
GET /v7.0/ip_address_assignments
Description
List IP address assignments
Authentication required
yes
Scope
ip_address_assignment#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
ip_address_assignment
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
ip_addr
Ip_addr
 String no

Default: null
ip_prefix
Ip_prefix
 Integer no

Default: null
user
User
 Resource no
vps
VPS
 Resource no
assigned_by_chain
Assigned_by_chain
 Resource no
unassigned_by_chain
Unassigned_by_chain
 Resource no
reconstructed
Reconstructed
 Boolean no

Default: null
location
Location
 Resource no
network
Network
 Resource no
ip_version
Ip_version
 Integer no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • 4
  • 6

Validation error message: %{value} cannot be used
order
Order
 String no

Template order

Default: newest

Validation rules
RuleDetails
Include

Allowed values:

  • newest
  • oldest

Validation error message: %{value} cannot be used
active
Active
 Boolean no

Default: null

Output parameters

Layout
object_list
Namespace
ip_address_assignments
ParameterTypeDescription
id
ID
 Integer
ip_address
IpAddress
 Resource
ip_addr
Ip_addr
 String
ip_prefix
Ip_prefix
 Integer
user
User
 Resource
raw_user_id
Raw_user_id
 Integer
vps
VPS
 Resource
raw_vps_id
Raw_vps_id
 Integer
from_date
From_date
 Datetime Paginate by create/update date
to_date
To_date
 Datetime
assigned_by_chain
Assigned_by_chain
 Resource
unassigned_by_chain
Unassigned_by_chain
 Resource
reconstructed
Reconstructed
 Boolean
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Show

Path
GET /v7.0/ip_address_assignments/{ip_address_assignment_id}
Description
Show IP address assignment
Authentication required
yes
Scope
ip_address_assignment#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
ip_address_assignment
ParameterTypeDescription
id
ID
 Integer
ip_address
IpAddress
 Resource
ip_addr
Ip_addr
 String
ip_prefix
Ip_prefix
 Integer
user
User
 Resource
raw_user_id
Raw_user_id
 Integer
vps
VPS
 Resource
raw_vps_id
Raw_vps_id
 Integer
from_date
From_date
 Datetime Paginate by create/update date
to_date
To_date
 Datetime
assigned_by_chain
Assigned_by_chain
 Resource
unassigned_by_chain
Unassigned_by_chain
 Resource
reconstructed
Reconstructed
 Boolean
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime