Manage a Capacity Burst via the API

For more information about bursts and which virtual circuits are eligible, see Capacity Bursts.

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 marketplace connection, you will need the following information:

  • Header row
    • Parameter
    • Required
    • Description
  • Row 1
    • vc_circuit_id
    • Yes (parameter)
    • The ID of the virtual circuit. You can get the circuit ID from
  • Row 1
    • speed
    • Yes
    • Burst speed in Mbps. This bandwidth will be added to the existing circuit speed. Must be a multiple of 100Mbps.

Get your virtual circuit ID

The following GET call will return a list of your ports:

Note the circuit ID of the connection you want to burst.

Apply the burst


Modify the burst

If an existing burst exists, repeat the same request above with a new burst speed. The new speed replaces the previous burst speed.

For example, in the examples above we added a 300Mbps burst. If the circuit was initially 50Mbps, the capacity would be 350Mbps while the burst is in place.

If we want to have a 500Mbps burst, then simply repeat the call above with a speed of 500Mbps (using cURL):

curl -X POST{vc_circuit_id}/burst -d '{"speed":"500Mbps"}' -H "accept: */*" -H "Authorization: Bearer replace_with_api_key"

This would result in a virtual circuit with 550Mbps of capacity (again assuming the virtual circuit was initially only 50Mbps).

Delete the burst

Use the same URL but as a DELETE request:{vc_circuit_id}/burst