Subpaas

API calls to interact with Subpaases.

Subdealer (Sub PaaS) actions

In Navixy, a Subdealer (Sub PaaS) account is designed for dealers who need to manage multiple accounts that provide services independently. This feature is ideal for dealers who act as larger distributors or service providers. With Sub PaaS accounts, dealers can create and manage additional sub-accounts, each with its own users, devices, and settings.

These sub-accounts function similarly to the main dealer account but allow for more granular control and management. This setup is perfect for servicing other dealers (subdealers) or larger enterprises that require separate PaaS accounts, such as a service run on their own domain. It simplifies operations of multiple independent organizations, while maintaining oversight from the main dealer account.

Subdealer (Sub PaaS) object

The read operation returns the full object. The list operation returns a smaller field set plus per-sub-dealer user and device counts.

API actions

API base path: panel/subpaas.

Every operation here requires the subpaas permission, and is available only to dealers whose contract type and plan permit sub-dealer accounts.

required permissions: subpaas: "create".

A newly created sub-dealer starts in INITIAL_BLOCK status.

Creating a sub-dealer sends email. The platform notifies both the parent dealer and the platform managers.

Passwords must be between 12 and 20 characters in length and include at least one uppercase letter, lowercase letter, digit, and special character. To maintain account security, the system tracks password history, so you can't reuse any of your last 10 passwords. If a previous password is detected, the system will return the error "Password was recently used."

Create sub-dealer

post

/panel/subpaas/create

Create a sub-dealer under the current dealer.

This operation sends email. On success the platform notifies both the parent dealer and the platform managers.

The current dealer must be of the PaaS contract type, must not be blocked, and its plan must permit sub-dealer accounts. Failing any of those returns error code 13.

Authorizations

AuthorizationstringRequired

Enter the panel session hash with the "NVX " prefix, e.g. "NVX fa7bf873fab9333144e171372a321b06". Obtain the hash from the accountAuth operation.

Body

passwordstring · passwordRequired

Sub-dealer's password. Must satisfy the platform password policy.

titlestring · min: 1 · max: 50Required

Sub-dealer display name.

Example: Rus Sub-PaaS

jur_namestring · max: 100Required

Legal company name.

Example: OOO Sub-PaaS

emailstring · emailRequired

Company email address.

Example: sub-dealer@email.com

jur_countrystring · max: 255Required

Sub-dealer's country.

Example: country

link_monitoringstring · max: 255Required

Sub-dealer's monitoring domain. Must be a valid internationalized domain name and must not be empty.

Example: sub.navixy.com

contact_fiostring · max: 100Optional

Optional. Contact person.

Example: fio

contact_poststring · max: 50Optional

Optional. Contact person position.

Example: post

contact_phonestring · max: 255Optional

Optional. Contact person's phone.

Example: phone

Responses

200

Sub-dealer created

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

idintegerRead-onlyOptional

ID of the created sub-dealer.

Example: 18

400

Bad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array.

application/json

403

Operation not permitted, error code 13: the session lacks the required permission, or the dealer is not eligible to have sub-dealers.

application/json

default

Error response object

application/json

post/panel/subpaas/create

POST /v2/panel/subpaas/create HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 228

{
  "password": "password",
  "title": "Rus Sub-PaaS",
  "jur_name": "OOO Sub-PaaS",
  "email": "sub-dealer@email.com",
  "jur_country": "country",
  "link_monitoring": "sub.navixy.com",
  "contact_fio": "fio",
  "contact_post": "post",
  "contact_phone": "phone"
}

{
  "success": true,
  "id": 18
}

Errors

13 – If the dealer:
- is not of the PaaS type.
- has a status other than NOT_BLOCKED.
- has a plan that does not allow SubPaaS accounts.

required permissions: subpaas: "read".

The parent dealer is taken from the session, so only your own sub-dealers are returned.

List sub-dealers

post

/panel/subpaas/list

List the sub-dealers belonging to the current dealer, with per-sub-dealer user and device counts, plus optional text filtering, ordering and pagination.

Every parameter is optional.

Authorizations

AuthorizationstringRequired

Enter the panel session hash with the "NVX " prefix, e.g. "NVX fa7bf873fab9333144e171372a321b06". Obtain the hash from the accountAuth operation.

Body

filterstringOptional

Text filter.

order_bystring · enumOptional

Field to order by.

Default: subpaas_idPossible values:

ascendingbooleanOptional

Order direction. Ascending when true.

Default: true

offsetintegerOptional

Starting offset, for pagination.

Default: 0

limitintegerOptional

Maximum number of records to return.

Responses

200

Sub-dealers

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

countintegerRead-onlyOptional

Total number of matching records, ignoring offset and limit.

Example: 1

400

Bad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array.

application/json

403

Operation not permitted, error code 13: the session lacks the required permission, or the dealer is not eligible to have sub-dealers.

application/json

default

Error response object

application/json

post/panel/subpaas/list

POST /v2/panel/subpaas/list HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "filter": "text",
  "order_by": "subpaas_id",
  "ascending": true,
  "offset": 0,
  "limit": 1
}

{
  "success": true,
  "list": [
    {
      "subpaas_id": 18,
      "title": "SubppaasTitle",
      "jur_name": "SubppaasJurName",
      "login": "subpaaslogin",
      "creation_date": "2018-11-15",
      "block_type": "NOT_BLOCKED",
      "users_count": 2,
      "active_users_count": 1,
      "trackers_count": 0,
      "active_trackers_count": 0
    }
  ],
  "count": 1
}

required permissions: subpaas: "read".

Read sub-dealer

post

/panel/subpaas/read

Read a single sub-dealer belonging to the current dealer.

Authorizations

AuthorizationstringRequired

Enter the panel session hash with the "NVX " prefix, e.g. "NVX fa7bf873fab9333144e171372a321b06". Obtain the hash from the accountAuth operation.

Body

subpaas_idintegerRequired

Sub-dealer ID.

Example: 97834

Responses

200

The sub-dealer

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

400

Bad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array.

application/json

403

Operation not permitted, error code 13: the session lacks the required permission, or the dealer is not eligible to have sub-dealers.

application/json

default

Error response object

application/json

post/panel/subpaas/read

POST /v2/panel/subpaas/read HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "subpaas_id": 97834
}

{
  "success": true,
  "value": {
    "subpaas_id": 18,
    "block_type": "NOT_BLOCKED",
    "creation_date": "2018-11-15",
    "login": "subpaaslogin",
    "title": "Rus Sub-PaaS",
    "jur_name": "OOO Sub-PaaS",
    "email": "sub-dealer@email.com",
    "jur_country": "country",
    "link_monitoring": "link",
    "contact_fio": "fio",
    "contact_post": "post",
    "contact_phone": "phone",
    "users_count": 2,
    "active_users_count": 1,
    "trackers_count": 0,
    "active_trackers_count": 0
  }
}

required permissions: subpaas: "update".

Unlike create, this operation requires subpaas_id and block_type. It does not accept a password: use change password instead.

Both link_monitoring and email must be unique across dealers. A clash returns error code 7 naming the offending parameter, rather than a 409.

Update sub-dealer

post

/panel/subpaas/update

Update an existing sub-dealer.

Unlike create, this operation requires subpaas_id and block_type, and does not accept password. Use the password change operation for that.

Authorizations

AuthorizationstringRequired

Enter the panel session hash with the "NVX " prefix, e.g. "NVX fa7bf873fab9333144e171372a321b06". Obtain the hash from the accountAuth operation.

Body

subpaas_idintegerRequired

ID of the sub-dealer to update.

Example: 97834

block_typestring · enumRequired

Block status of the sub-dealer panel and its users.

Example: NOT_BLOCKEDPossible values:

titlestring · min: 1 · max: 50Required

Sub-dealer display name.

Example: Rus Sub-PaaS

jur_namestring · max: 100Required

Legal company name.

Example: OOO Sub-PaaS

emailstring · emailRequired

Company email address.

Example: sub-dealer@email.com

jur_countrystring · max: 255Required

Sub-dealer's country.

Example: country

link_monitoringstring · max: 255Required

Sub-dealer's monitoring domain. Must be a valid internationalized domain name and must not be empty.

Example: sub.navixy.com

contact_fiostring · max: 100Optional

Optional. Contact person.

Example: fio

contact_poststring · max: 50Optional

Optional. Contact person position.

Example: post

contact_phonestring · max: 255Optional

Optional. Contact person's phone.

Example: phone

Responses

200

Successful response

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

400

Bad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array.

application/json

403

Operation not permitted, error code 13: the session lacks the required permission, or the dealer is not eligible to have sub-dealers.

application/json

default

Error response object

application/json

post/panel/subpaas/update

POST /v2/panel/subpaas/update HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 252

{
  "subpaas_id": 97834,
  "block_type": "NOT_BLOCKED",
  "title": "Rus Sub-PaaS",
  "jur_name": "OOO Sub-PaaS",
  "email": "sub-dealer@email.com",
  "jur_country": "country",
  "link_monitoring": "sub.navixy.com",
  "contact_fio": "fio",
  "contact_post": "post",
  "contact_phone": "phone"
}

{
  "success": true
}

Errors

13 –
- The dealer is not PaaS.
- The dealer has a status other than NOT_BLOCKED.
- SubPaaS accounts are not permitted for the dealer.
- block_type is DELETED.
- The found SubPaaS is in DELETED status.
- The found SubPaaS is not in INITIAL_BLOCK status and block_type is INITIAL_BLOCK.
- The found SubPaaS is in INITIAL_BLOCK status and block_type is not INITIAL_BLOCK.

PreviousService Settings

NextChange password

Last updated 1 month ago

Was this helpful?