User

Create User

Create a new user

  • username: 3 to 32 characters, can include a-z, 0-9, and underscores.
  • status: User's status, defaults to active. Special rules if on_hold.
  • expire: UTC datetime for account expiration. Use 0 for unlimited.
  • data_limit: Max data usage in bytes (e.g., 1073741824 for 1GB). 0 means unlimited.
  • data_limit_reset_strategy: Defines how/if data limit resets. no_reset means it never resets.
  • proxy_settings: Dictionary of protocol settings (e.g., vmess, vless) will generate data for all protocol by default.
  • group_ids: List of group IDs to assign to the user.
  • note: Optional text field for additional user information or notes.
  • on_hold_timeout: UTC timestamp when on_hold status should start or end.
  • on_hold_expire_duration: Duration (in seconds) for how long the user should stay in on_hold status.
  • next_plan: Next user plan (resets after use).
post/api/user

Request body

data_limitinteger nullable

data_limit can be 0 or greater

data_limit_reset_strategy'no_reset' | 'day' | 'week' | 'month' | 'year'
notestring nullable
on_hold_expire_durationinteger nullable
group_idsinteger[] nullable
auto_delete_in_daysinteger nullable
hwid_limitinteger nullable
usernamestring required
status'active' | 'disabled' | 'limited' | 'expired' | 'on_hold'

Response

Successful Response

data_limitinteger nullable

data_limit can be 0 or greater

data_limit_reset_strategy'no_reset' | 'day' | 'week' | 'month' | 'year'
notestring nullable
on_hold_expire_durationinteger nullable
group_idsinteger[] nullable
auto_delete_in_daysinteger nullable
hwid_limitinteger nullable
idinteger required
usernamestring required
status'active' | 'disabled' | 'limited' | 'expired' | 'on_hold' required
used_trafficinteger required
lifetime_used_trafficinteger
created_atstring date-time required
edit_atstring date-time nullable
online_atstring date-time nullable
subscription_urlstring

Changes