Provision a Hosted AWS Connection 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 an AWS connection, you will need the following information:

  • Header row

    • Parameter
    • Required
    • Description

  • Row 1

    • aws_account_id
      string

    • Yes

    • The AWS account ID to connect with. Must be 12 characters long.

      You can find this by logging in to the AWS management console.

  • Row 1

    • account_uuid
      string
    • Yes
    • Billing account ID (see below).

  • Row 1

    • description
      string
    • Yes
    • Brief description of the connection.

  • Row 1

  • Row 1

    • port
      string
    • Yes
    • The circuit ID of the PacketFabric port that the Hosted connection will land on. 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
    • Valid VLAN range is from 4-4094, inclusive.

  • Row 1

    • src_svlan
      string
    • No
    • Valid S-VLAN range is from 4-4094, inclusive. This is only applicable if your source port is an ENNI port.

  • Row 1

    • speed
      string
    • Yes
    • The connection speed. You have the following options: “50Mbps” “100Mbps” “200Mbps” “300Mbps” “400Mbps” “500Mbps” “1Gbps” “2Gbps” “5Gbps” “10Gbps”

  • Row 1

    • zone
      string
    • No
    • The desired zone for the new connection. This is the zone in the AWS on-ramp location.

  • Row 1

    • published_quote_line_uuid
      string
    • No
    • The UUID of the published quote line with which this connection should be associated.

Find the billing account ID

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

Get your AWS ID

You can get this from the AWS management console by opening the user menu in the upper right:

AWS ID

Get on-ramp locations

You can use the following GET call to filter for AWS Hosted on-ramp locations:

https://api.packetfabric.com/v2/locations/cloud?cloud_provider=aws&cloud_connection_type=hosted

However, the response is lengthy, so you should try to include as many filters as you can. For a full list of the filters, see Get a list of cloud locations filtered by query params.

For example, this will return all AWS on-ramps in the Washington D.C./Ashburn market:

https://api.packetfabric.com/v2/locations/cloud?cloud_provider=aws&cloud_connection_type=hosted&market=WDC

From the list that is returned, note the pop value of the on-ramp you want to use. Optionally, you can also note the availability zone to include in you API request

NOTE: For cURL users, you would format the above GET call as follows:

  • Unix-based: https://api.packetfabric.com/v2/locations/cloud?cloud_provider=aws\&cloud_connection_type=hosted\&market=WDC (escaping the &)
  • Windows: "https://api.packetfabric.com/v2/locations/cloud?cloud_provider=aws&cloud_connection_type=hosted&market=WDC" (enclosed in double quotation marks)

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.

Request the Hosted connection

Postman
cURL
Requests

Updated on 13 Jul 2022