Provision a Port 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 port, you will need the following information:

  • Header row
    • Parameter
    • Required
    • Description
  • Row 1
    • account_uuid
      string
    • Yes
    • Billing account ID (see below).
  • Row 1
  • Row 1

    • speed
      string

    • Yes

    • Speed of the port: “1Gbps” “10Gbps” “40Gbps” “100Gbps”.

      Use /v2/locations/{pop}/port-availability to verify that the appropriate speed is available in the POP.

  • Row 1

    • media
      string

    • Yes

    • Optic media type: “LX” “EX” “ZX” “LR” “ER” “ER DWDM” “ZR” “ZR DWDM” “LR4” “ER4” “CWDM4” “LR4” “ER4 Lite”.

      Use /v2/locations/{pop}/port-availability to verify what optic types are available for your chosen speed and location.

  • Row 1
    • subscription_term
      integer
    • Yes
    • Duration of the contract in months: 1, 12, 24, or 36.
  • Row 1

    • zone
      string

    • No

    • Availabilty zone of the port.

      Use /v2/locations/{pop}/port-availability to verify the availability zones in the POP.

  • Row 1
    • autoneg
      boolean
    • No
    • Only applicable to 1Gbps ports. Controls whether auto negotiation is on (true) or off (false).
  • Row 1
    • description
      string
    • No
    • Brief description of the port.
  • Row 1

    • nni
      boolean

    • No

    • Set this to true to provision an ENNI port.

      NOTE: By default, ENNI ports are not available to all users. If you want to create an ENNI port, contact [email protected].

Find the billing account ID

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

Gather location information

When you provision a port, you will be required to provide the point of presence (POP) in which you want your port. You may also want to specify the availability zone in which to provision the port.

The following GET call will return all PacketFabric locations: https://api.packetfabric.com/v2.1/locations

However, this list is extensive, so you should add one or more location filters: pop, city, state, market, region. For example, to see all POPs in the the New York City metro area, you could use https://api.packetfabric.com/v2.1/locations?market=nyc.

TIP: You can also browse locations from the portal or from our website.

If you would prefer to only use the API, you can use /v2/locations/markets and /v2/locations/regions to get lists of our markets and regions.

View port availability for a POP

Once you have decided on a POP, check port availability using the following GET call:

https://api.packetfabric.com/v2/locations/{pop}/port-availability

This will return the remaining information that you will need when provisioning your port, for example:

    {
        "speed": "100Gbps",
        "media": "LR4",
        "zone": "Y",
        "partial": false,
        "enni": true,
        "count": 14
    },
    {
        "speed": "100Gbps",
        "media": "CWDM4",
        "zone": "Y",
        "partial": false,
        "enni": true,
        "count": 2
    },

Note speed and media, as those will be required when you provision the port.

You can also note the available zones and whether the port is an ENNI port (note that most customers will not need ENNI ports, and ENNI ports come with an additional cost).

NOTE: The {pop} parameter is case sensitive.

For example, https://api.packetfabric.com/v2/locations/DAL1/port-availability returns information about the DAL1 pop, but https://api.packetfabric.com/v2/locations/dal1/port-availability returns an error stating the location can’t be found.

Provision the port

Postman
cURL
Requests

Updated on 14 Jul 2022