Jump to Content

v1.0

API Reference

v1.0API Reference

BQN REST API

Introduction

BQN REST API

/policies/rate/{policyName}
/policies/rate
- getget
- deletedelete
/subscribers/{subscriberIp}
/subscribers/{subscriberIp}/bandwidth
- getget
/subscribers/{subscriberIp}/congestion
- getget
/subscribers/{subscriberIp}/dpiDownlink
- getget
/subscribers/{subscriberIp}/dpiUplink
- getget
/subscribers/{subscriberIp}/flows
- getget
/subscribers/{subscriberIp}/latency
- getget
/subscribers/{subscriberIp}/retransmission
- getget
/subscribers/{subscriberIp}/trafficAtMaxSpeed
- getget
/subscribers/{subscriberIp}/volume
- getget
/subscribers
- getget
- deletedelete
/subscriberIds/{subscriberId}/bandwidth
- getget
/subscriberIds/{subscriberId}/congestion
- getget
/subscriberIds/{subscriberId}/dpiDownlink
- getget
/subscriberIds/{subscriberId}/dpiUplink
- getget
/subscriberIds/{subscriberId}/flows
- getget
/subscriberIds/{subscriberId}/latency
- getget
/subscriberIds/{subscriberId}/retransmission
- getget
/subscriberIds/{subscriberId}/trafficAtMaxSpeed
- getget
/subscriberIds/{subscriberId}/volume
- getget
/subscriberIds/{subscriberId}/subscribers
- getget
/node/congestion
- getget
/node/dpiDownlink
- getget
/node/dpiUplink
- getget
/node/flows
- getget
/node/latency
- getget
/node/retransmission
- getget
/node/trafficAtMaxSpeed
- getget
/node/volume
- getget
/subscriberGroups
- getget
/subscriberGroups/{subscriberGroupName}
/subscriberGroups/{subscriberGroupName}/subscriberMembers/{subscriberIp}
- postpost
- deletedelete
/subscriberGroups/{subscriberGroupName}/subscriberIdMembers/{subscriberId}
- postpost
- deletedelete
/subscriberGroups/{subscriberGroupName}/congestion
- getget
/subscriberGroups/{subscriberGroupName}/flows
- getget
/subscriberGroups/{subscriberGroupName}/latency
- getget
/subscriberGroups/{subscriberGroupName}/retransmission
- getget
/subscriberGroups/{subscriberGroupName}/trafficAtMaxSpeed
- getget
/subscriberGroups/{subscriberGroupName}/volume
- getget

Powered by

get

get https://some.bqn.net:3443/api/v1/node/volume

Retrieve total volume usage of the BQN node.

Language

Credentials

Basic

base64

: