/api/reseller/users/{userId}/bandwidth/reduce

GET

/api/reseller/users/{userId}/bandwidth/reduce

curl --request GET \
  --url 'https://dashboard.residential.rayobyte.com/api/reseller/users/9ee3d294-6f1e-489c-9b9b-e25e9a4e37a8/bandwidth/reduce?megabytes=1000' \
  --header 'Authorization: Bearer <token>'

• Main API host

Reduce traffic on the Sub-user account

Allows the Reseller to reduce the traffic available to the Sub-user. The amount of traffic to reduce is transmitted in megabytes. When the Sub-user’s balance decreases, the traffic returns to the Reseller’s balance.

Authorizations

• bearerAuth

Parameters

Path Parameters

userId

required

string

Proxy User ID

Example

9ee3d294-6f1e-489c-9b9b-e25e9a4e37a8

Query Parameters

megabytes

required

number

>= 1 <= 100000

Traffic amount in megabytes

Example

1000

Responses

200

Success

Media typeapplication/json

object

status

string

Allowed values: SUCCESS

date

string

data

object

Examples

ExampleSuccess

Updated traffic balance

{
  "status": "SUCCESS",
  "date": "Mon, 1 Jan 2022 12:00:00 GMT",
  "data": {
    "trafficBalanceKb": 5337200,
    "trafficBalanceString": "5.1 GB"
  }
}

400

API call failed

Media typeapplication/json

object

status

string

Allowed values: FAIL

date

string

error

string

Examples

ExampleNo traffic amount

Amount of traffic to add is not specified

{
  "status": "FAIL",
  "date": "Mon, 1 Jan 2022 12:00:00 GMT",
  "error": "Traffic amount is required"
}

401

Not authorized

Media typetext/html

string

Examples

ExampleNot authorized

Not authorized

Not authorized.

500

API call failed

Media typeapplication/json

object

status

string

Allowed values: FAIL

date

string

error

string

Examples

ExampleProxy User balance too low

Proxy User balance lower than the requested amount

{
  "status": "FAIL",
  "date": "Mon, 1 Jan 2022 12:00:00 GMT",
  "error": "Proxy user balance is to low"
}