Skip to main content
POST
/
service
/
{tenant_name}
/
connection
/
connections
Create Connections
curl --request POST \
  --url https://api.example.com/service/{tenant_name}/connection/connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "vi_name": "<string>",
  "internet": true,
  "virtual_interface_type": "routed",
  "ip_addresses": [],
  "mtu": 123,
  "administrative_state": "up",
  "description": "<string>",
  "customer_ports_request": [],
  "azure_ports_request": [],
  "aws_ports_request": [],
  "gcp_ports_request": [],
  "labels": {}
}
'
{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "status": "received",
  "extra_details": {}
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

Body

application/json
vi_name
string
required
internet
boolean
required
virtual_interface_type
enum<string>
default:routed
Available options:
bridged,
routed,
loopback
ip_addresses
string[] | null
mtu
integer | null
administrative_state
enum<string>
default:up
Available options:
up,
down
description
string | null
customer_ports_request
NBCustomerPortRequest · object[]
azure_ports_request
NBAzureRequest · object[]
aws_ports_request
NBAWSRequest · object[]
gcp_ports_request
NBGCPRequest · object[]
labels
Labels · object

Response

Successful Response

id
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
status
enum<string>
required
Available options:
received,
in_progress,
success,
failed,
cancelled
extra_details
Extra Details · object