An interface for provisioning Layer 2 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
    "circuit_ep_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,
    // 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
}


get

Returns a list of Circuits filtered by the provided parameters.

circuit_id

Identifier of Circuit to filter results by.

name

Name of Circuit to filter results by.

state

State of Circuits to search for. Must be `active` or `decom`.

workgroup_id Required

Identifier of Workgroup to filter results by.



provision

Creates and provisions a new Circuit.

circuit_id

-1 or undefined indicate circuit is to be added.

description Required

The description of the circuit.

endpoint Required

JSON array of endpoints to be used.

external_identifier

External Identifier of the circuit

link

Array of names of links to be used in the primary path.

provision_time Required

Timestamp of when circuit should be created in epoch time format. -1 means now.

remote_requester

The remote requester.

remote_url

The remote URL for the IDC

remove_time Required

The time the circuit should be removed from the network in epoch time format. -1 means never.

skip_cloud_provisioning

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

status

Status of the Circuit (note mostly used for NSI integration)

workgroup_id Required

Identifier of managing Workgroup.



remove

Removes a Circuit from the network.

circuit_id Required

Identifier of Circuit to remove.

skip_cloud_provisioning

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

workgroup_id Required

Identifier of managing Workgroup.