users_create
Creates a new VPN user account in Remnawave panel, auto-generating credentials unless you supply them explicitly.
Instructions
Create a user. Credentials (vlessUuid/ssPassword/trojanPassword/shortUuid) are generated by the panel unless given — pass them explicitly for service users.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tag | No | Optional. User tag for categorization. Max 16 characters, uppercase letters, numbers and underscores only. | |
| No | Optional. User email address. Must be a valid email format. | ||
| status | No | Optional. User account status. Defaults to ACTIVE. | ACTIVE |
| expireAt | Yes | Account expiration date. Required. Format: 2025-01-17T15:38:45.065Z | |
| username | Yes | Unique username for the user. Required. Must be 3-36 characters long and contain only letters, numbers, underscores and dashes. | |
| createdAt | No | Optional. Account creation date. Format: 2025-01-17T15:38:45.065Z | |
| shortUuid | No | Optional. Short UUID identifier for the user. | |
| vlessUuid | No | Optional. UUID for VLESS protocol. Must be a valid UUID format. | |
| ssPassword | No | Optional. Password for Shadowsocks protocol. Must be 8-32 characters. | |
| telegramId | No | Optional. Telegram user ID for notifications. Must be an integer. | |
| description | No | Optional. Additional notes or description for the user account. | |
| trojanPassword | No | Optional. Password for Trojan protocol. Must be 8-32 characters. | |
| hwidDeviceLimit | No | Optional. Maximum number of hardware devices allowed. Must be a positive integer. | |
| externalSquadUuid | No | Optional. External squad UUID. | |
| trafficLimitBytes | No | Optional. Traffic limit in bytes. Set to 0 for unlimited traffic. | |
| lastTrafficResetAt | No | Optional. Date of last traffic reset. Format: 2025-01-17T15:38:45.065Z | |
| activeInternalSquads | No | Optional. Array of UUIDs representing enabled internal squads. | |
| trafficLimitStrategy | No | Available reset periods | NO_RESET |