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:

• Using Postman with the PacketFabric API
• Using cURL with the PacketFabric API
• Using Python Requests with the PacketFabric API

API reference

• Add speed burst, billed hourly, to your circuit
• Delete a speed burst
• Get virtual circuit list

Parameters and attributes

To provision a marketplace connection, you will need the following information:

Get your virtual circuit ID

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

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

Apply the burst

Postman

{
  "speed": "300Mbps"
}

cURL

curl -X POST https://api.packetfabric.com/v2/services/{vc_circuit_id}/burst -d '{"speed":"300Mbps"}' -H "accept: */*" -H "Authorization: Bearer replace_with_api_key"

curl -X POST https://api.packetfabric.com/v2/services/{vc_circuit_id}/burst -d "{\"speed\":\"300Mbps\"}" -H "accept: */*" -H "Authorization: Bearer replace_with_api_key"

Requests

import requests
api_key = 'replace_with_api_key'
request_header = {
'Authorization': f'Bearer {api_key}'
}
# Replace {vc_circuit_id} with the string you obtained earlier
post_url = 'placeholder_api.packetfabric.com/v2/services/{vc_circuit_id}/burst'
post_json = {
"speed": "300Mbps"
}
api = requests.post(post_url, json=post_json, headers=request_header)
print(api)

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 https://api.packetfabric.com/v2/services/{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: https://api.packetfabric.com/v2/services/{vc_circuit_id}/burst

Postman

cURL

curl -X DELETE https://api.packetfabric.com/v2/services/{vc_circuit_id}/burst -H "accept: */*" -H "Authorization: Bearer replace_with_api_key"

Requests

import requests
api_key = 'replace_with_api_key'
request_header = {
'Authorization': f'Bearer {api_key}'
}
# Replace {vc_circuit_id} with the string you obtained earlier
delete_url = 'placeholder_api.packetfabric.com/v2/services/{vc_circuit_id}/burst'
api = requests.delete(delete_url, headers=request_header)
print(api)