## Marzban Marzban **Kind**: global class * [Marzban](#Marzban) * [new Marzban(url)](#new_Marzban_new) * [.admin](#Marzban+admin) : [Admin](#Admin) * [.token(username, password, parameters)](#Marzban+admin+token) ⇒ Promise.<\*> * [.get()](#Marzban+admin+get) ⇒ Promise.<\*> * [.edit(username, data)](#Marzban+admin+edit) ⇒ Promise.<\*> * [.delete(username)](#Marzban+admin+delete) ⇒ Promise.<\*> * [.getAdmins(parameters)](#Marzban+admin+getAdmins) ⇒ Promise.<\*> * [.core](#Marzban+core) : [Core](#Core) * [.get()](#Marzban+core+get) ⇒ Promise.<\*> * [.restart()](#Marzban+core+restart) ⇒ Promise.<\*> * [.getConfig()](#Marzban+core+getConfig) ⇒ Promise.<\*> * [.editConfig(data)](#Marzban+core+editConfig) ⇒ Promise.<\*> * [.node](#Marzban+node) : [Node](#Node) * [.getSettings()](#Marzban+node+getSettings) ⇒ Promise.<\*> * [.add(data)](#Marzban+node+add) ⇒ Promise.<\*> * [.get(node_id)](#Marzban+node+get) ⇒ Promise.<\*> * [.edit(node_id, data)](#Marzban+node+edit) ⇒ Promise.<\*> * [.delete(node_id)](#Marzban+node+delete) ⇒ Promise.<\*> * [.reconnect(node_id)](#Marzban+node+reconnect) ⇒ Promise.<\*> * [.getNodes()](#Marzban+node+getNodes) ⇒ Promise.<\*> * [.getUsage(parameters)](#Marzban+node+getUsage) ⇒ Promise.<\*> * [.sub](#Marzban+sub) : [Sub](#Sub) * [.get(token)](#Marzban+sub+get) ⇒ Promise.<\*> * [.getInfo(token)](#Marzban+sub+getInfo) ⇒ Promise.<\*> * [.getUsage(token, parameters)](#Marzban+sub+getUsage) ⇒ Promise.<\*> * [.getByClientType(token, client_type)](#Marzban+sub+getByClientType) ⇒ Promise.<\*> * [.system](#Marzban+system) : [System](#System) * [.get()](#Marzban+system+get) ⇒ Promise.<\*> * [.getInbounds()](#Marzban+system+getInbounds) ⇒ Promise.<\*> * [.getHosts()](#Marzban+system+getHosts) ⇒ Promise.<\*> * [.editHost(data)](#Marzban+system+editHost) ⇒ Promise.<\*> * [.user](#Marzban+user) : [User](#User) * [.add(data)](#Marzban+user+add) ⇒ Promise.<\*> * [.get(username)](#Marzban+user+get) ⇒ Promise.<\*> * [.edit(username, data)](#Marzban+user+edit) ⇒ Promise.<\*> * [.delete(username)](#Marzban+user+delete) ⇒ Promise.<\*> * [.resetDataUsage(username)](#Marzban+user+resetDataUsage) ⇒ Promise.<\*> * [.revokeSub(username)](#Marzban+user+revokeSub) ⇒ Promise.<\*> * [.getUsage(username, parameters)](#Marzban+user+getUsage) ⇒ Promise.<\*> * [.setOwner(username, admin_username)](#Marzban+user+setOwner) ⇒ Promise.<\*> * [.list(parameters)](#Marzban+user+list) ⇒ Promise.<\*> * [.resetUsersUsage()](#Marzban+user+resetUsersUsage) ⇒ Promise.<\*> * [.getExpired(parameters)](#Marzban+user+getExpired) ⇒ Promise.<\*> * [.deleteExpired(parameters)](#Marzban+user+deleteExpired) ⇒ Promise.<\*> * [.userTemplate](#Marzban+userTemplate) : [UserTemplate](#UserTemplate) * [.list(parameters)](#Marzban+userTemplate+list) ⇒ Promise.<\*> * [.get(id)](#Marzban+userTemplate+get) ⇒ Promise.<\*> * [.add(data)](#Marzban+userTemplate+add) ⇒ Promise.<\*> * [.edit(id, data)](#Marzban+userTemplate+edit) ⇒ Promise.<\*> * [.delete(id)](#Marzban+userTemplate+delete) ⇒ Promise.<\*> * [.auth(username, password)](#Marzban+auth) ⇒ Promise.<boolean> ### new Marzban(url) | Param | Type | Description | | --- | --- | --- | | url | String | Marzban API URL | ### marzban.admin : [Admin](#Admin) Admin **Kind**: instance class of [Marzban](#Marzban) * [.admin](#Marzban+admin) : [Admin](#Admin) * [.token(username, password, parameters)](#Marzban+admin+token) ⇒ Promise.<\*> * [.get()](#Marzban+admin+get) ⇒ Promise.<\*> * [.edit(username, data)](#Marzban+admin+edit) ⇒ Promise.<\*> * [.delete(username)](#Marzban+admin+delete) ⇒ Promise.<\*> * [.getAdmins(parameters)](#Marzban+admin+getAdmins) ⇒ Promise.<\*> #### admin.token(username, password, parameters) ⇒ Promise.<\*> **Kind**: instance method of [admin](#Marzban+admin) | Param | Type | | --- | --- | | username | String | | password | String | | parameters | Object | #### admin.get() ⇒ Promise.<\*> Get Current Admin **Kind**: instance method of [admin](#Marzban+admin) #### admin.edit(username, data) ⇒ Promise.<\*> Modify Admin **Kind**: instance method of [admin](#Marzban+admin) | Param | Type | | --- | --- | | username | String | | data | Object | #### admin.delete(username) ⇒ Promise.<\*> Remove Admin **Kind**: instance method of [admin](#Marzban+admin) | Param | Type | | --- | --- | | username | String | #### admin.getAdmins(parameters) ⇒ Promise.<\*> Get Admins **Kind**: instance method of [admin](#Marzban+admin) | Param | Type | | --- | --- | | parameters | Object | ### marzban.core : [Core](#Core) Core **Kind**: instance class of [Marzban](#Marzban) * [.core](#Marzban+core) : [Core](#Core) * [.get()](#Marzban+core+get) ⇒ Promise.<\*> * [.restart()](#Marzban+core+restart) ⇒ Promise.<\*> * [.getConfig()](#Marzban+core+getConfig) ⇒ Promise.<\*> * [.editConfig(data)](#Marzban+core+editConfig) ⇒ Promise.<\*> #### core.get() ⇒ Promise.<\*> Get Core Stats **Kind**: instance method of [core](#Marzban+core) #### core.restart() ⇒ Promise.<\*> Restart Core **Kind**: instance method of [core](#Marzban+core) #### core.getConfig() ⇒ Promise.<\*> Get Core Config **Kind**: instance method of [core](#Marzban+core) #### core.editConfig(data) ⇒ Promise.<\*> Modify Core Config **Kind**: instance method of [core](#Marzban+core) | Param | Type | | --- | --- | | data | Object | ### marzban.node : [Node](#Node) Node **Kind**: instance class of [Marzban](#Marzban) * [.node](#Marzban+node) : [Node](#Node) * [.getSettings()](#Marzban+node+getSettings) ⇒ Promise.<\*> * [.add(data)](#Marzban+node+add) ⇒ Promise.<\*> * [.get(node_id)](#Marzban+node+get) ⇒ Promise.<\*> * [.edit(node_id, data)](#Marzban+node+edit) ⇒ Promise.<\*> * [.delete(node_id)](#Marzban+node+delete) ⇒ Promise.<\*> * [.reconnect(node_id)](#Marzban+node+reconnect) ⇒ Promise.<\*> * [.getNodes()](#Marzban+node+getNodes) ⇒ Promise.<\*> * [.getUsage(parameters)](#Marzban+node+getUsage) ⇒ Promise.<\*> #### node.getSettings() ⇒ Promise.<\*> Get Node Settings **Kind**: instance method of [node](#Marzban+node) #### node.add(data) ⇒ Promise.<\*> Add Node **Kind**: instance method of [node](#Marzban+node) | Param | Type | | --- | --- | | data | Object | #### node.get(node_id) ⇒ Promise.<\*> Get Node **Kind**: instance method of [node](#Marzban+node) | Param | Type | | --- | --- | | node_id | Number | #### node.edit(node_id, data) ⇒ Promise.<\*> Modify Node **Kind**: instance method of [node](#Marzban+node) | Param | Type | | --- | --- | | node_id | Number | | data | Object | #### node.delete(node_id) ⇒ Promise.<\*> Remove Node **Kind**: instance method of [node](#Marzban+node) | Param | Type | | --- | --- | | node_id | Number | #### node.reconnect(node_id) ⇒ Promise.<\*> Reconnect Node **Kind**: instance method of [node](#Marzban+node) | Param | Type | | --- | --- | | node_id | Number | #### node.getNodes() ⇒ Promise.<\*> Get Nodes **Kind**: instance method of [node](#Marzban+node) #### node.getUsage(parameters) ⇒ Promise.<\*> Get Usage **Kind**: instance method of [node](#Marzban+node) | Param | Type | | --- | --- | | parameters | Object | ### marzban.sub : [Sub](#Sub) Sub **Kind**: instance class of [Marzban](#Marzban) * [.sub](#Marzban+sub) : [Sub](#Sub) * [.get(token)](#Marzban+sub+get) ⇒ Promise.<\*> * [.getInfo(token)](#Marzban+sub+getInfo) ⇒ Promise.<\*> * [.getUsage(token, parameters)](#Marzban+sub+getUsage) ⇒ Promise.<\*> * [.getByClientType(token, client_type)](#Marzban+sub+getByClientType) ⇒ Promise.<\*> #### sub.get(token) ⇒ Promise.<\*> User Subscription **Kind**: instance method of [sub](#Marzban+sub) | Param | Type | | --- | --- | | token | String | #### sub.getInfo(token) ⇒ Promise.<\*> User Subscription Info **Kind**: instance method of [sub](#Marzban+sub) | Param | Type | | --- | --- | | token | String | #### sub.getUsage(token, parameters) ⇒ Promise.<\*> User get usage **Kind**: instance method of [sub](#Marzban+sub) | Param | Type | | --- | --- | | token | String | | parameters | Object | #### sub.getByClientType(token, client_type) ⇒ Promise.<\*> User Subscription With Client Type **Kind**: instance method of [sub](#Marzban+sub) | Param | Type | | --- | --- | | token | String | | client_type | String | ### marzban.system : [System](#System) System **Kind**: instance class of [Marzban](#Marzban) * [.system](#Marzban+system) : [System](#System) * [.get()](#Marzban+system+get) ⇒ Promise.<\*> * [.getInbounds()](#Marzban+system+getInbounds) ⇒ Promise.<\*> * [.getHosts()](#Marzban+system+getHosts) ⇒ Promise.<\*> * [.editHost(data)](#Marzban+system+editHost) ⇒ Promise.<\*> #### system.get() ⇒ Promise.<\*> Get System Stats **Kind**: instance method of [system](#Marzban+system) #### system.getInbounds() ⇒ Promise.<\*> Get Inbounds **Kind**: instance method of [system](#Marzban+system) #### system.getHosts() ⇒ Promise.<\*> Get Hosts **Kind**: instance method of [system](#Marzban+system) #### system.editHost(data) ⇒ Promise.<\*> Modify Hosts **Kind**: instance method of [system](#Marzban+system) | Param | | --- | | data | ### marzban.user : [User](#User) User **Kind**: instance class of [Marzban](#Marzban) * [.user](#Marzban+user) : [User](#User) * [.add(data)](#Marzban+user+add) ⇒ Promise.<\*> * [.get(username)](#Marzban+user+get) ⇒ Promise.<\*> * [.edit(username, data)](#Marzban+user+edit) ⇒ Promise.<\*> * [.delete(username)](#Marzban+user+delete) ⇒ Promise.<\*> * [.resetDataUsage(username)](#Marzban+user+resetDataUsage) ⇒ Promise.<\*> * [.revokeSub(username)](#Marzban+user+revokeSub) ⇒ Promise.<\*> * [.getUsage(username, parameters)](#Marzban+user+getUsage) ⇒ Promise.<\*> * [.setOwner(username, admin_username)](#Marzban+user+setOwner) ⇒ Promise.<\*> * [.list(parameters)](#Marzban+user+list) ⇒ Promise.<\*> * [.resetUsersUsage()](#Marzban+user+resetUsersUsage) ⇒ Promise.<\*> * [.getExpired(parameters)](#Marzban+user+getExpired) ⇒ Promise.<\*> * [.deleteExpired(parameters)](#Marzban+user+deleteExpired) ⇒ Promise.<\*> #### user.add(data) ⇒ Promise.<\*> Add User **Kind**: instance method of [user](#Marzban+user) | Param | Type | | --- | --- | | data | Object | #### user.get(username) ⇒ Promise.<\*> Get User **Kind**: instance method of [user](#Marzban+user) | Param | Type | | --- | --- | | username | String | #### user.edit(username, data) ⇒ Promise.<\*> Modify User **Kind**: instance method of [user](#Marzban+user) | Param | Type | | --- | --- | | username | String | | data | Object | #### user.delete(username) ⇒ Promise.<\*> Remove User **Kind**: instance method of [user](#Marzban+user) | Param | Type | | --- | --- | | username | String | #### user.resetDataUsage(username) ⇒ Promise.<\*> Renew User Data Usage **Kind**: instance method of [user](#Marzban+user) | Param | Type | | --- | --- | | username | String | #### user.revokeSub(username) ⇒ Promise.<\*> Revoke users subscription (Subscription link and proxies) **Kind**: instance method of [user](#Marzban+user) | Param | Type | | --- | --- | | username | String | #### user.getUsage(username, parameters) ⇒ Promise.<\*> Get User Usage **Kind**: instance method of [user](#Marzban+user) | Param | Type | | --- | --- | | username | String | | parameters | Object | #### user.setOwner(username, admin_username) ⇒ Promise.<\*> Set Owner **Kind**: instance method of [user](#Marzban+user) | Param | Type | | --- | --- | | username | String | | admin_username | String | #### user.list(parameters) ⇒ Promise.<\*> Get all users **Kind**: instance method of [user](#Marzban+user) | Param | Type | | --- | --- | | parameters | Object | #### user.resetUsersUsage() ⇒ Promise.<\*> Reset all users data usage **Kind**: instance method of [user](#Marzban+user) #### user.getExpired(parameters) ⇒ Promise.<\*> Get users who has expired **Kind**: instance method of [user](#Marzban+user) | Param | Type | | --- | --- | | parameters | Object | #### user.deleteExpired(parameters) ⇒ Promise.<\*> Delete users who has expired **Kind**: instance method of [user](#Marzban+user) | Param | Type | | --- | --- | | parameters | Object | ### marzban.userTemplate : [UserTemplate](#UserTemplate) UserTemplate **Kind**: instance class of [Marzban](#Marzban) * [.userTemplate](#Marzban+userTemplate) : [UserTemplate](#UserTemplate) * [.list(parameters)](#Marzban+userTemplate+list) ⇒ Promise.<\*> * [.get(id)](#Marzban+userTemplate+get) ⇒ Promise.<\*> * [.add(data)](#Marzban+userTemplate+add) ⇒ Promise.<\*> * [.edit(id, data)](#Marzban+userTemplate+edit) ⇒ Promise.<\*> * [.delete(id)](#Marzban+userTemplate+delete) ⇒ Promise.<\*> #### userTemplate.list(parameters) ⇒ Promise.<\*> Get User Templates **Kind**: instance method of [userTemplate](#Marzban+userTemplate) | Param | Type | | --- | --- | | parameters | Object | #### userTemplate.get(id) ⇒ Promise.<\*> Get User Template **Kind**: instance method of [userTemplate](#Marzban+userTemplate) | Param | Type | | --- | --- | | id | Number | #### userTemplate.add(data) ⇒ Promise.<\*> Add User Template **Kind**: instance method of [userTemplate](#Marzban+userTemplate) | Param | Type | | --- | --- | | data | Object | #### userTemplate.edit(id, data) ⇒ Promise.<\*> Modify User Template **Kind**: instance method of [userTemplate](#Marzban+userTemplate) | Param | Type | | --- | --- | | id | Number | | data | Object | #### userTemplate.delete(id) ⇒ Promise.<\*> Remove User Template **Kind**: instance method of [userTemplate](#Marzban+userTemplate) | Param | Type | | --- | --- | | id | Number | ### marzban.auth(username, password) ⇒ Promise.<boolean> Authenticate to the Marzban API **Kind**: instance method of [Marzban](#Marzban) | Param | Type | | --- | --- | | username | String | | password | String |