Skip to content

location_network

Manage location networks

Create

Path
POST /v7.0/location_networks
Description
Add network to a location
Authentication required
yes
Scope
location_network#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
location_network
ParameterTypeRequiredDetails
location
Location
 Resource no
network
Network
 Resource no
primary
Primary
 Boolean no

Default: null
priority
Priority
 Integer no

Optional priority, used for MX and SRV records

Default: null
autopick
Autopick
 Boolean no

Default: null
userpick
Userpick
 Boolean no

Default: null

Output parameters

Layout
object
Namespace
location_network
ParameterTypeDescription
id
Id
 Integer
location
Location
 Resource
network
Network
 Resource
primary
Primary
 Boolean
priority
Priority
 Integer Optional priority, used for MX and SRV records
autopick
Autopick
 Boolean
userpick
Userpick
 Boolean

Delete

Path
DELETE /v7.0/location_networks/{location_network_id}
Description
Remove network from a location
Authentication required
yes
Scope
location_network#delete
Aliases
destroy
Blocking
no

Input parameters

No parameters.

Output parameters

No parameters.

Index

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

Input parameters

Layout
object
Namespace
location_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
network
Network
 Resource no

Output parameters

Layout
object_list
Namespace
location_networks
ParameterTypeDescription
id
Id
 Integer
location
Location
 Resource
network
Network
 Resource
primary
Primary
 Boolean
priority
Priority
 Integer Optional priority, used for MX and SRV records
autopick
Autopick
 Boolean
userpick
Userpick
 Boolean

Show

Path
GET /v7.0/location_networks/{location_network_id}
Description
Show a location network
Authentication required
yes
Scope
location_network#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
location_network
ParameterTypeDescription
id
Id
 Integer
location
Location
 Resource
network
Network
 Resource
primary
Primary
 Boolean
priority
Priority
 Integer Optional priority, used for MX and SRV records
autopick
Autopick
 Boolean
userpick
Userpick
 Boolean

Update

Path
PUT /v7.0/location_networks/{location_network_id}
Description
Update a location network
Authentication required
yes
Scope
location_network#update
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
location_network
ParameterTypeRequiredDetails
primary
Primary
 Boolean no

Default: null
priority
Priority
 Integer no

Optional priority, used for MX and SRV records

Default: null
autopick
Autopick
 Boolean no

Default: null
userpick
Userpick
 Boolean no

Default: null

Output parameters

Layout
object
Namespace
location_network
ParameterTypeDescription
id
Id
 Integer
location
Location
 Resource
network
Network
 Resource
primary
Primary
 Boolean
priority
Priority
 Integer Optional priority, used for MX and SRV records
autopick
Autopick
 Boolean
userpick
Userpick
 Boolean