Provision a Virtual Circuit via the API

Before you begin

Ensure you have a bearer token authorizing all your API calls. For information on authorizing calls, see one of the following pages:

API reference

Parameters and attributes

To provision a backbone virtual circuit, you will need the following information:

  • Header row
    • Parameter
    • Required
    • Description
  • Row 1

    • epl
      boolean

    • Yes

    • In most cases this should be false.

      If true, the circuit will be an Ethernet Private Line connection. If false, the circuit will be an Ethernet Virtual Private Line. For information on the differences between the two, see Ethernet Service Specification.

  • Row 1
    • bandwidth
      object
    • Yes
    • An object defining speed, billing account, and connection type. (See below)
  • Row 1
    • interfaces
      array of objects
    • Yes
    • Specify the A and Z sides of the connection. (See below)
  • Row 1
    • description
      string
    • No
    • Brief description of the connection.
  • Row 1
    • rate_limit_in
      integer
    • No
    • The upper bound, in Mbps, to limit incoming data by.
  • Row 1
    • rate_limit_out
      integer
    • No
    • The lower bound, in Mbps, to limit incoming data by.
  • Row 1
    • published_quote_line_uuid
      string
    • No
    • The UUID of the published quote line with which this connection should be associated.
Bandwidth
  • Header row
    • Parameter
    • Required
    • Description
  • Row 1
    • account_uuid
      string
    • Yes
    • Billing account ID (see below).
  • Row 1

    • longhaul_type
      string

    • Yes

    • This can be “dedicated” “usage” or “hourly.”

      • Dedicated (no limits or additional charges) requires a subscription term.
      • Usage-based charges per transferred GB and does not require a subscription term or a speed.
      • Hourly billing does not require a subscription term, but does require a speed.
  • Row 1

    • subscription_term
      integer

    • Maybe

    • Duration of the contract in months: 1, 12, 24, or 36.

      Only applicable if longhaul_type is “dedicated.”

  • Row 1

    • speed
      string

    • Maybe

    • Link speed. Values for hourly (burst) billing accepts multiples of 100Mbps.

      For dedicated connections, you can enter “50Mbps” “100Mbps” “200Mbps” “300Mbps” “400Mbps” “500Mbps” “1Gbps” “2Gbps” “5Gbps” “10Gbps” “20Gbps” “30Gbps” “40Gbps” “50Gbps” “60Gbps” “80Gbps” “100Gbps.”

      Only applicable if longhaul_type is “dedicated” or “hourly.”

Interfaces

Enter the following information for both the A and Z side.

  • Header row
    • Parameter
    • Required
    • Description
  • Row 1
    • port_circuit_id
      string
    • Yes
    • The circuit ID of the port. You can find this in the portal or you can use https://api.packetfabric.com/v2/ports to get a list of your ports.
  • Row 1
    • vlan
      string
    • Yes, unless untagged
    • Valid VLAN range is from 4-4094, inclusive. You must provide a VLAN unless untagged is set to true.
  • Row 1
    • svlan
      string
    • Maybe
    • Valid S-VLAN range is from 4-4094, inclusive. This is only applicable to virtual circuits provisioned on ENNI ports.
  • Row 1
    • untagged
      boolean
    • No
    • Whether the interface should be untagged. The default is false. For information on untagged VLAN scenarios, see VLAN Tagging.

Find the billing account ID

For information on finding your billing account ID, see Get the Account UUID.

Get your port circuit IDs

The following GET call will return a list of your ports: https://api.packetfabric.com/v2.1/ports

From this list, you want to copy the port_circuit_id of your A and Z sides.

Provision the virtual circuit

Postman
cURL
Requests

Updated on 13 Jul 2022