Last modified October 31, 2024

listAccounts

This function returns list of all accounts.
Parameter name Value Description Possible values Example
orphan Boolean Whether to list orphan accounts (account backups with no associated active accounts)   orphan=1
Returns
Parameter name Value Description Possible values Example
accounts[] List Return List of account objects. To view the parameters returned by this function, click on Account Object  
total Integer The total amount of accounts you have.    

Example Call JETAPI

jetbackup5api -F listAccounts -D "orphan=1"
success: 1 message: system: version: 5.3.3 version_panel: 5.3.3 tier: EDGE type: cPanel retry_ms: 0 disableui: dr: agreement_panel: agreement: licenseIssue: data: accounts: 0: _id: 6503d48bfc45b1addf0a9633 uuid: a0e78ee09b83e4d9b4c85a17e00b9150fe492cf7 username: user nickname: created: 2023-09-15T03:50:35+00:00 domain: user.com owner: root owner_id: 6503d48bfc45b1addf0a9632 owner_nickname: root owners: 0: root owners_id: 0: 6503d48bfc45b1addf0a9632 homedir: /home/user ip: package: default packages: root: reseller: suspended: login_only: orphan: active: 1 virtual: email: max_snapshots: -1 backup_quota: backup_stats: 511: 0 1: 0 2: 0 4: 0 128: 0 256: 0 8: 0 16: 0 32: 0 64: 0 tags: backup_type: 0 encryption_key_type: 0 privacy: 0 queue_priority: last_active: secret_key: assignable_accounts: 0 quota: disk_total: -1 disk_usage: 83886080 disk_free: -1 inode_usage: 3834

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listAccounts&orphan=1