An interface for provisioning Layer 3 network connections.

Endpoint JSON

The provision method of this CGI requires at least one endpoint to be specified. An endpoint is a JSON string describing the network endpoint to be provisioned.

{
    // Required when editing an existing endpoint
    "vrf_endpoint_id":   123,
    // Optional if both node and interface are provided
    "entity":           "customer a - network lab",
    // Optional if entity is provided. Only respected if both node and
    // interface provided
    "node":             "router.example.com",
    // Optional if entity is provided. Only respected if both node and
    // interface provided
    "interface":        "xe-7/0/1",
    // Required
    "tag":              300,
    // Optional. Only provided for QinQ tagged endpoints
    "inner_tag":        null,
    // Required. Specified in Mbps. Indicates how much bandwith shall be
    // reserved for this endpoint. Zero indicates no bandwidth restrictions
    "bandwidth":        0,
    // Required. Zero or One. Indicates MTU setting
    "jumbo":            1,
    // Include only for endpoints terminating at cloud provider. Value provided
    // is the:
    // - Service Key for an Azure ExpressRoute
    // - Pairing Key for a GCP Partner Interconnect
    // - Cloud Account ID for a AWS Hosted Connection
    // - OCID for an Oracle FastConnect
    "cloud_account_id": null,
    // Required. At least one peer must be provided per endpoint
    "peers":            [
        {
            // Required. ipv4 or ipv6
            "ip_version": "ipv4",
            // Required
            "local_ip":   "192.168.1.3/31",
            // Required
            "peer_asn":   65650,
            // Required
            "peer_ip":    "192.168.1.2/31",
            // Required. Null if BGP auth is disabled
            "md5_key":    null,
            // Zero or One. Indicates BFD state
            "bfd":        0
        }
    ]
}


get_vrf_details

Returns the Layer3 Connection identified by vrf_id.

vrf_id Required

Identifier Layer3 Connection to return.

workgroup_id Required

Identifier of Workgroup used to fetch Layer3 Connections.



get_vrf_history

returns a list of network events that have affected this vrf connection

vrf_id Required

The id of the conneciton to fetch network events for.

workgroup_id Required

The workgroup the user is a part of.



get_vrfs

Returns a list of Layer3 Connections.

name

Name of VRF to filter results by.

workgroup_id Required

Identifier of Workgroup to filter results by.



provision

provision a new vrf on the network

description Required

The description of the circuit.

endpoint Required

The JSON blob describing all of the endpoints

local_asn Required

The JSON blob describing all of the endpoints

name Required

The workgroup_id with permission to build the vrf, the user must be a member of this workgroup.

prefix_limit

Maximum prefix limit size for BGP peer routes

skip_cloud_provisioning

If editing an existing VRF specify the ID otherwise leave blank for new VRF.

vrf_id

If editing an existing VRF specify the ID otherwise leave blank for new VRF.

workgroup_id Required

The workgroup_id with permission to build the vrf, the user must be a member of this workgroup.



remove

removes a vrf that is on the network

skip_cloud_provisioning

If set to 1 cloud provider configurations will not be performed.

vrf_id Required

the ID of the VRF to remove from the network

workgroup_id Required

The workgroup_id with permission to build the vrf, the user must be a member of this workgroup.