Skip to main content
POST
/
tenant
/
{tenant_name}
/
virtual_interface
Create a new virtual interface for a tenant
curl --request POST \
  --url https://api.example.com/tenant/{tenant_name}/virtual_interface \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "virtual_interface_type": "routed",
  "ipv4_addresses": [],
  "ipv6_addresses": [],
  "description": "<string>",
  "mtu": 9220,
  "administrative_state": "up",
  "network_segments": [],
  "labels": {},
  "system_name": "<string>"
}
'
{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "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
​
name
string
required
Required string length: 1 - 63
Pattern: ^[a-zA-Z0-9_\-]+$
​
virtual_interface_type
enum<string>
default:routed
Available options:
bridged,
routed,
loopback
​
ipv4_addresses
string[]
​
ipv6_addresses
string[]
​
description
string | null
​
mtu
integer
default:9220
​
administrative_state
enum<string> | null
default:up
Available options:
up,
down
​
network_segments
string[]
​
labels
Labels · object
​
system_name
string | null

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