POST
Create a sub-user

Authorizations

Authorization
string
header
required

[just text field] Please enter token in following format: Bearer

Body

application/json
dataGb
number
required

Amount of data to allocate to the new sub-user, in GB. Must be a positive number (minimum 0.001).

Example:

5

ips
string[]

Optional list of IP addresses to whitelist for the sub-user. If omitted, no IP restriction is applied.

Example:
idempotency_key
string<uuid>

Optional UUIDv4. Reuse for the same operation to replay saved responses. Processing or uncertain operations return 409. Retained indefinitely (at least 24 hours). Omit for legacy behavior.

Response

User created

username
string
required

Username of the sub-user

Example:

"test124"

userId
string
required

Unique identifier of the sub-user (same value as username)

Example:

"test124"

password
string
required

Current password of the sub-user

dataLimit
number
required

Total data allocated to the sub-user, in GB

Example:

5

dataUsed
number
required

Amount of data used by the sub-user so far, in GB

Example:

1.2

dataRemaining
number
required

Amount of data remaining for the sub-user, in GB (dataLimit minus dataUsed)

Example:

3.8

status
enum<string>
required

Current status of the sub-user

Available options:
active,
inactive
Example:

"active"

dateCreated
string<date-time>
required

Date and time the sub-user was created

whitelistedIps
string[]
required

List of IP addresses whitelisted for the sub-user

Example: