Skip to content

node_transfer_connection

Manage pairwise transfer-only node interconnects

Create

Path
POST /v7.0/node_transfer_connections
Description
Create node transfer connection
Authentication required
yes
Scope
node_transfer_connection#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
node_transfer_connection
ParameterTypeRequiredDetails
node_a
Node_a
 Resource yes
node_b
Node_b
 Resource yes
node_a_ip_addr
Node_a_ip_addr
 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
node_b_ip_addr
Node_b_ip_addr
 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
enabled
Enabled
 Boolean no

Default: null

Output parameters

Layout
object
Namespace
node_transfer_connection
ParameterTypeDescription
id
Id
 Integer
node_a
Node_a
 Resource
node_b
Node_b
 Resource
node_a_ip_addr
Node_a_ip_addr
 String
node_b_ip_addr
Node_b_ip_addr
 String
enabled
Enabled
 Boolean
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Delete

Path
DELETE /v7.0/node_transfer_connections/{node_transfer_connection_id}
Description
Delete node transfer connection
Authentication required
yes
Scope
node_transfer_connection#delete
Aliases
destroy
Blocking
no

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/node_transfer_connections
Description
List node transfer connections
Authentication required
yes
Scope
node_transfer_connection#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
node_transfer_connection
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
node
Node
 Resource no
enabled
Enabled
 Boolean no

Default: null

Output parameters

Layout
object_list
Namespace
node_transfer_connections
ParameterTypeDescription
id
Id
 Integer
node_a
Node_a
 Resource
node_b
Node_b
 Resource
node_a_ip_addr
Node_a_ip_addr
 String
node_b_ip_addr
Node_b_ip_addr
 String
enabled
Enabled
 Boolean
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Show

Path
GET /v7.0/node_transfer_connections/{node_transfer_connection_id}
Description
Show node transfer connection
Authentication required
yes
Scope
node_transfer_connection#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
node_transfer_connection
ParameterTypeDescription
id
Id
 Integer
node_a
Node_a
 Resource
node_b
Node_b
 Resource
node_a_ip_addr
Node_a_ip_addr
 String
node_b_ip_addr
Node_b_ip_addr
 String
enabled
Enabled
 Boolean
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Update

Path
PUT /v7.0/node_transfer_connections/{node_transfer_connection_id}
Description
Update node transfer connection
Authentication required
yes
Scope
node_transfer_connection#update
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
node_transfer_connection
ParameterTypeRequiredDetails
node_a_ip_addr
Node_a_ip_addr
 String no

Default: null
node_b_ip_addr
Node_b_ip_addr
 String no

Default: null
enabled
Enabled
 Boolean no

Default: null

Output parameters

Layout
object
Namespace
node_transfer_connection
ParameterTypeDescription
id
Id
 Integer
node_a
Node_a
 Resource
node_b
Node_b
 Resource
node_a_ip_addr
Node_a_ip_addr
 String
node_b_ip_addr
Node_b_ip_addr
 String
enabled
Enabled
 Boolean
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime