post

post https://some.bqn.net:3443/api/v1/subscribers/{subscriberIp}

Create or update a subscriber. If the subscriber already exists, the subscriber will be updated with the new parameters provided in the request body. Note that the parameters not included in the request body will be reset.

Path Params

subscriberIp

string

required

Subscriber IP address. Both IPv4 and IPv6 addresses are supported.For IPv6 addresses, the global IPv6 prefix length is applied (64-bits by default, e.g. ff80:0123:4567:89ab::). This value can be changed in the UI page Administrator>General Settings.

Body Params

callingStationId

string

Calling Station ID string.

nasId

string

NAS Identifier string.

nasIpAddress

string

NAS IP Address.

nasPort

int64

NAS Port.

policyRate

string

Rate policy name associated with the subscriber.

quota

object

Subscriber volume and/or time quota.

subscriberGroups

array of strings

List of the group names for which this subscriber IP is a member. A subscriber IP can be member of a maximum of 3 groups, plus an all-subscribers group.

subscriberGroups

subscriberId

string

Subscriber identifier. The source of this identifier can be this BQN REST API, RADIUS or supported billing systems.

userName

string

User name.

Responses

200

Existing resource updated successfully (existing fields reset).

201

Resource created successfully.

Language

Credentials

Basic

base64


xxxxxxxxxx
1
curl --request POST \
2
     --url https://some.bqn.net:3443/api/v1/subscribers/subscriberIp \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Choose an example:

application/json

400Bad parameter in request.

401Request received from unauthorized client.

403Forbidden request from restricted user.

500Internal Server Error.