/api/reseller/info

GET

/api/reseller/info

curl --request GET \
  --url https://dashboard.residential.rayobyte.com/api/reseller/info \
  --header 'Authorization: Bearer <token>'

• Main API host

Endpoint to obtain complete information about the Reseller account and its Sub-users

Provides information about the Reseller account, as well as sub-accounts of Proxy Users belonging to it. Information about the Reseller is available such as ID, account status, login, email, short description, date of creation and last update, traffic balance in kilobytes, traffic balance in human-readable string form. Information about sub-users is provided in the form of multiple JSON arrays containing data of the same type (nested objects). There are 4 separate arrays available: active users (accounts that have access to the proxy service), suspended accounts, blocked accounts, accounts that have used the service in the last 24 hours, and all accounts. Each sub-account entry contains the following information: user ID, login (used to access proxy services), account status, traffic balance in kilobytes, total amount of traffic used in kilobytes, amount of traffic used in the last day, creation and last update dates, and also data on the use of traffic in a human-readable string form.

Authorizations

• bearerAuth

Responses

200

Success

Media typeapplication/json

object

status

string

Allowed values: SUCCESS

date

string

data

object

Examples

ExampleSuccess

Reseller full info

{
  "status": "SUCCESS",
  "date": "Mon, 1 Jan 2022 12:00:00 GMT",
  "data": {
    "id": "1",
    "userStatus": "ACTIVE",
    "accountType": "RESELLER",
    "login": "test-reseller1",
    "email": "my-reseller-email1@example.com",
    "description": "Test reseller account",
    "created": "2022-01-19T17:54:43.000Z",
    "updated": "2022-01-25T19:52:38.000Z",
    "resellerStatus": "ACTIVE",
    "trafficBalanceKb": 2692800,
    "trafficBalanceString": "2.6 GB",
    "proxyUsers": {
      "active": [
        {
          "id": "1",
          "login": "test-user1-users",
          "status": "ACTIVE",
          "trafficBalanceKb": 200000,
          "trafficConsumedKb": 12043,
          "trafficConsumedTodayKb": 2217,
          "created": "2022-01-19T17:54:43.000Z",
          "updated": "2022-01-19T17:54:43.000Z",
          "trafficBalanceString": "195.3 MB",
          "trafficConsumedString": "11 MB",
          "trafficConsumedTodayString": "2.2 MB"
        },
        {
          "id": "2",
          "login": "test-user2-users",
          "status": "ACTIVE",
          "trafficBalanceKb": 5337200,
          "trafficConsumedKb": 27199,
          "trafficConsumedTodayKb": 3901,
          "created": "2022-01-19T17:54:43.000Z",
          "updated": "2022-01-25T20:05:34.000Z",
          "trafficBalanceString": "5.1 GB",
          "trafficConsumedString": "26.2 MB",
          "trafficConsumedTodayString": "3.8 MB"
        }
      ],
      "suspended": [],
      "blocked": [],
      "activeToday": [
        {
          "id": "2",
          "login": "test-user2-users",
          "status": "ACTIVE",
          "trafficBalanceKb": 5337200,
          "trafficConsumedKb": 27199,
          "trafficConsumedTodayKb": 3901,
          "created": "2022-01-19T17:54:43.000Z",
          "updated": "2022-01-25T20:05:34.000Z",
          "trafficBalanceString": "5.1 GB",
          "trafficConsumedString": "26.2 MB",
          "trafficConsumedTodayString": "3.8 MB"
        }
      ],
      "all": [
        {
          "id": "1",
          "login": "test-user1-users",
          "status": "ACTIVE",
          "trafficBalanceKb": 200000,
          "trafficConsumedKb": 12043,
          "trafficConsumedTodayKb": 2217,
          "created": "2022-01-19T17:54:43.000Z",
          "updated": "2022-01-19T17:54:43.000Z",
          "trafficBalanceString": "195.3 MB",
          "trafficConsumedString": "11 MB",
          "trafficConsumedTodayString": "2.2 MB"
        },
        {
          "id": "2",
          "login": "test-user2-users",
          "status": "ACTIVE",
          "trafficBalanceKb": 5337200,
          "trafficConsumedKb": 27199,
          "trafficConsumedTodayKb": 3901,
          "created": "2022-01-19T17:54:43.000Z",
          "updated": "2022-01-25T20:05:34.000Z",
          "trafficBalanceString": "5.1 GB",
          "trafficConsumedString": "26.2 MB",
          "trafficConsumedTodayString": "3.8 MB"
        }
      ]
    }
  }
}

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

ExampleInternal error

Internal server error

{
  "status": "FAIL",
  "date": "Mon, 1 Jan 2022 12:00:00 GMT",
  "error": "Internal server error"
}