Skip to content

Setting Up Service Keys

A service key is a code that is given by one Megaport ONE account holder to another to connect two separate businesses together. Customers who have separate Megaport ONE accounts can connect their Ports to each other across the Megaport network, enabling business-to-business VXCs.

For example, suppose Company Y wants to establish a connection with Company Z. Company Z wants Company Y to connect to a particular Port on the Megaport network that they have already deployed, and they want the connection at a specific rate limit.

The service key process is:

  1. Company Z creates a service key that is preconfigured with their required settings.
  2. Company Z shares the service key with Company Y.
  3. Company Y accepts the service key and uses it to create a VXC back to Company Z.

Requirements and assumptions

Before you create a service key, ensure that you meet these requirements:

  • Access to the Megaport ONE Portal
  • Both you and your customer have Ports on the Megaport network, with live cross connects on both ends
  • Layer 2/Layer 3 devices are on each end terminating the physical connections
  • Equipment supporting 802.1q trunking is on the two links connecting into Megaport

Creating a service key

You can create either a single use or a multi-use service key. With a multi-use key, the customer that you share the key with can request multiple connections using that key.


Once you create a service key, it cannot be removed.

To create a service key

  1. In the Megaport ONE Portal, choose Networking > Services.
  2. Click the gear icon Gear icon next to the Port you want to use.
  3. Select Service Keys.
  4. Click Add.
  5. Specify the details for the new service key:

    • Label – Enter a name for the key.
    • Type – Select Single Use or Multi-Use.
    • Rate Limit – Assign a speed in Mbps.
    • Default VLAN (Single Use keys only) – Specify a default VLAN ID for the B-End when the service key VXC is deployed.
      Megaport ONE checks that the requested VLAN ID is available. If the VLAN ID is already in use, an error message tells you the VLAN is not available. When a customer uses this service key to create a connection, they can specify a VLAN ID for the A-End.
    • Valid Until – Specify how long the key will be valid.
    • Active – Select Yes or No to specify whether the key is active. If you don’t want the key to be available right away, select No. You can edit the key later to change this setting.
      New Service Key
  6. Click Add to create the key.

  7. Click Close.


After you deploy a service key on a B-End circuit, you cannot reuse the associated B-End VLAN ID if there is already a service key using that same VLAN ID on that Port.

Viewing, copying, and editing a service key

When configured, service keys appear in the Portal. Click the gear icon for a Port and select Service Keys to view the configured keys.


The Service Keys option will display only if the Port is available for new connections, the current user has ordering privileges, and it does not already have an untagged VXC attached.

Click the key to copy it to the clipboard; click Edit to make changes.

Service key details

To disable a service key

  1. In the Megaport ONE Portal, go to the Networking > Services page.
  2. Click the gear icon Gear icon next to the Port and select Service Keys.
  3. Clear the Enabled check box for the service key to disable.
    A red X appears for the key in the Valid column.
  4. Click Close.

Sharing the key

You can share the key however you prefer, such as email or messaging.

When you copy and send the key, recipients can create a VXC to you based on your parameters. Remember, both you and your customers must have active Ports on the Megaport network for key sharing to function correctly.


The end user cannot alter or modify the service key parameters.

Creating a VXC with a service key

Once the service key is created and shared, anybody with the key can create a connection.

To create a VXC with a service key

  1. In the Megaport ONE Portal, choose Networking > Services.
  2. Click the gear icon Gear icon next to the Port you want to use.
  3. Select Add Connection.
    Add Connection
  4. Select Service Key as the Connection Type.
  5. Enter the service key in the Megaport Service Key ID field.
    Megaport ONE validates the key and displays basic information about the key.
    Service key validation

  6. Specify these connection details:

    • Connection Name – The name of your VXC to be shown in the Megaport ONE Portal.
    • Rate Limit (Mbps) – The speed of your connection in Mbps, up to the maximum limit defined by the key.


      Rate limit change requests for existing service key VXCs must be approved by the other party on the VXC configuration page. You can also cancel the request on this page.

    • A-End VLAN (optional) – Specify an unused VLAN ID for this connection. This must be a unique VLAN ID on this Port and can range from 2 to 4093. If you specify a VLAN ID that is already in use, the system displays the next available VLAN number. The VLAN ID must be unique to proceed with the order. If you don’t specify a value, Megaport ONE will assign one.

    • B-End VLAN (optional) – The B-End VLAN for the provider side termination will be automatically populated based on the service key.

      Alternatively, you can click Untag to remove the VLAN tagging for this connection. The untagged option limits you to only one VXC deployed on this Port.

    VXC configuration details

  7. Specify the Billing Details:

    • Service Level Reference (optional) – Specify a unique identifying number for the VXC to be used for billing purposes, such as a cost center number or a unique customer ID. The service level reference number appears for each service under the Product section of the invoice. You can also edit this field for an existing service.
    • Promo Code – If you have a promotional code, enter it and click Add Code.
  8. Click Create Connection.
    A summary page appears that includes the monthly cost. Click Cancel to make changes or click Confirm to order. Once you have finished this configuration, you can configure additional VXCs.
    Service key VXC

After ordering the key, a notification is sent to the company that you are connecting to, and the receiving company can either accept or reject the key. They cannot alter the key but can request modifications to the service key parameters before accepting it.

Last update: 2023-09-19