├── .github └── ISSUE_TEMPLATE │ ├── bug_report.md │ └── feature_request.md ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── index.js ├── package.json └── test.js /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **To Reproduce** 14 | Steps to reproduce the behavior: 15 | 1. Go to '...' 16 | 2. Click on '....' 17 | 3. Scroll down to '....' 18 | 4. See error 19 | 20 | **Expected behavior** 21 | A clear and concise description of what you expected to happen. 22 | 23 | **Screenshots** 24 | If applicable, add screenshots to help explain your problem. 25 | 26 | **Desktop (please complete the following information):** 27 | - OS: [e.g. iOS] 28 | - Browser [e.g. chrome, safari] 29 | - Version [e.g. 22] 30 | 31 | **Smartphone (please complete the following information):** 32 | - Device: [e.g. iPhone6] 33 | - OS: [e.g. iOS8.1] 34 | - Browser [e.g. stock browser, safari] 35 | - Version [e.g. 22] 36 | 37 | **Additional context** 38 | Add any other context about the problem here. 39 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | A clear and concise description of what you want to happen. 15 | 16 | **Describe alternatives you've considered** 17 | A clear and concise description of any alternative solutions or features you've considered. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. 21 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | We as members, contributors, and leaders pledge to make participation in our 6 | community a harassment-free experience for everyone, regardless of age, body 7 | size, visible or invisible disability, ethnicity, sex characteristics, gender 8 | identity and expression, level of experience, education, socio-economic status, 9 | nationality, personal appearance, race, religion, or sexual identity 10 | and orientation. 11 | 12 | We pledge to act and interact in ways that contribute to an open, welcoming, 13 | diverse, inclusive, and healthy community. 14 | 15 | ## Our Standards 16 | 17 | Examples of behavior that contributes to a positive environment for our 18 | community include: 19 | 20 | * Demonstrating empathy and kindness toward other people 21 | * Being respectful of differing opinions, viewpoints, and experiences 22 | * Giving and gracefully accepting constructive feedback 23 | * Accepting responsibility and apologizing to those affected by our mistakes, 24 | and learning from the experience 25 | * Focusing on what is best not just for us as individuals, but for the 26 | overall community 27 | 28 | Examples of unacceptable behavior include: 29 | 30 | * The use of sexualized language or imagery, and sexual attention or 31 | advances of any kind 32 | * Trolling, insulting or derogatory comments, and personal or political attacks 33 | * Public or private harassment 34 | * Publishing others' private information, such as a physical or email 35 | address, without their explicit permission 36 | * Other conduct which could reasonably be considered inappropriate in a 37 | professional setting 38 | 39 | ## Enforcement Responsibilities 40 | 41 | Community leaders are responsible for clarifying and enforcing our standards of 42 | acceptable behavior and will take appropriate and fair corrective action in 43 | response to any behavior that they deem inappropriate, threatening, offensive, 44 | or harmful. 45 | 46 | Community leaders have the right and responsibility to remove, edit, or reject 47 | comments, commits, code, wiki edits, issues, and other contributions that are 48 | not aligned to this Code of Conduct, and will communicate reasons for moderation 49 | decisions when appropriate. 50 | 51 | ## Scope 52 | 53 | This Code of Conduct applies within all community spaces, and also applies when 54 | an individual is officially representing the community in public spaces. 55 | Examples of representing our community include using an official e-mail address, 56 | posting via an official social media account, or acting as an appointed 57 | representative at an online or offline event. 58 | 59 | ## Enforcement 60 | 61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 62 | reported to the community leaders responsible for enforcement at 63 | mayer.dev@yahoo.com. 64 | All complaints will be reviewed and investigated promptly and fairly. 65 | 66 | All community leaders are obligated to respect the privacy and security of the 67 | reporter of any incident. 68 | 69 | ## Enforcement Guidelines 70 | 71 | Community leaders will follow these Community Impact Guidelines in determining 72 | the consequences for any action they deem in violation of this Code of Conduct: 73 | 74 | ### 1. Correction 75 | 76 | **Community Impact**: Use of inappropriate language or other behavior deemed 77 | unprofessional or unwelcome in the community. 78 | 79 | **Consequence**: A private, written warning from community leaders, providing 80 | clarity around the nature of the violation and an explanation of why the 81 | behavior was inappropriate. A public apology may be requested. 82 | 83 | ### 2. Warning 84 | 85 | **Community Impact**: A violation through a single incident or series 86 | of actions. 87 | 88 | **Consequence**: A warning with consequences for continued behavior. No 89 | interaction with the people involved, including unsolicited interaction with 90 | those enforcing the Code of Conduct, for a specified period of time. This 91 | includes avoiding interactions in community spaces as well as external channels 92 | like social media. Violating these terms may lead to a temporary or 93 | permanent ban. 94 | 95 | ### 3. Temporary Ban 96 | 97 | **Community Impact**: A serious violation of community standards, including 98 | sustained inappropriate behavior. 99 | 100 | **Consequence**: A temporary ban from any sort of interaction or public 101 | communication with the community for a specified period of time. No public or 102 | private interaction with the people involved, including unsolicited interaction 103 | with those enforcing the Code of Conduct, is allowed during this period. 104 | Violating these terms may lead to a permanent ban. 105 | 106 | ### 4. Permanent Ban 107 | 108 | **Community Impact**: Demonstrating a pattern of violation of community 109 | standards, including sustained inappropriate behavior, harassment of an 110 | individual, or aggression toward or disparagement of classes of individuals. 111 | 112 | **Consequence**: A permanent ban from any sort of public interaction within 113 | the community. 114 | 115 | ## Attribution 116 | 117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 118 | version 2.0, available at 119 | https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. 120 | 121 | Community Impact Guidelines were inspired by [Mozilla's code of conduct 122 | enforcement ladder](https://github.com/mozilla/diversity). 123 | 124 | [homepage]: https://www.contributor-covenant.org 125 | 126 | For answers to common questions about this code of conduct, see the FAQ at 127 | https://www.contributor-covenant.org/faq. Translations are available at 128 | https://www.contributor-covenant.org/translations. 129 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Coming soon 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2021 Artem Lomakin 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # fastpanel-api 2 | # Репозиторий больше неактуален, FastPanel обновили API, а мне лень обновлять клиент. 3 | # Если кто-то это хочет сделать, то Pull Request в помощь. 4 | # Мои контакты, если есть вопросы: https://t.me/notenoughprivacy 5 | NodeJS API client for FastPanel 6 | 7 | ## Установка 8 | 9 | > npm install fastpanel-api -s 10 | 11 | ## Пример 12 | 13 | ```js 14 | const api = require('fastpanel-api'); 15 | 16 | const Api = new api('https://cp.mayerdev.com'); 17 | 18 | Api.auth('fastuser', 'password').then(async () => { 19 | console.log(await Api.me()); 20 | }); 21 | ``` 22 | 23 | ## Пример вывода 24 | 25 | ```bash 26 | [FastPanel API by MayerDev] Got token: 27 | Здесь токен 28 | { data: 29 | { action: null, 30 | allowed_user_count: 0, 31 | allowed_virtualhost_count: 0, 32 | avail_virtualhost_count: 0, 33 | created_at: '2021-04-11T19:27:02.658153773Z', 34 | enabled: true, 35 | home_dir: '/var/www/fastuser/data', 36 | id: 1, 37 | php_version: null, 38 | profile: 39 | { cards_order: null, 40 | id: 1, 41 | interface_settings: [Object], 42 | server_name: '10.130.0.19', 43 | show_information: false, 44 | show_statistic: false, 45 | vhost_order: [] }, 46 | quota: null, 47 | reseller_creating: false, 48 | restore_email: 'mayer.dev@yahoo.com', 49 | roles: [ 'ROLE_SUPER_ADMIN' ], 50 | sites_allocated: 0, 51 | state: 52 | { sites: 2, 53 | domain: 1, 54 | email_domain: 0, 55 | db: 2, 56 | task: 1, 57 | ftp_account: 2, 58 | box: 0, 59 | backup_plan: 0, 60 | user: 4 }, 61 | user_creating: false, 62 | username: 'fastuser', 63 | virtualhost_count: 2 } } 64 | ``` 65 | 66 | ## Методы 67 | 68 | ### me() 69 | 70 | Получить информацию о текущем аккаунте 71 | 72 | #### Использование: 73 | 74 | ```js 75 | Api.me(); 76 | ``` 77 | 78 | ### settings() 79 | 80 | Получить настройки 81 | 82 | #### Использование: 83 | 84 | ```js 85 | Api.settings(); 86 | ``` 87 | 88 | ### users() 89 | 90 | Получить список пользователей 91 | 92 | #### Использование: 93 | 94 | ```js 95 | Api.users(); 96 | ``` 97 | 98 | ### user(id пользователя) 99 | 100 | Получить информацию о пользователе 101 | 102 | #### Использование: 103 | 104 | ```js 105 | Api.user(1); 106 | ``` 107 | 108 | ### domains() 109 | 110 | Получить список DNS-доменов 111 | 112 | #### Использование: 113 | 114 | ```js 115 | Api.domains(); 116 | ``` 117 | 118 | ### domain(id домена) 119 | 120 | Получить список DNS-записей домена 121 | 122 | #### Использование: 123 | 124 | ```js 125 | Api.domain(1); 126 | ``` 127 | 128 | ### sites(максимальное количество, по умолчанию 30) 129 | 130 | Получить список сайтов 131 | 132 | #### Использование: 133 | 134 | ```js 135 | Api.sites(1); 136 | ``` 137 | 138 | ### site(id сайта) 139 | 140 | Получить информацию о сайте 141 | 142 | #### Использование: 143 | 144 | ```js 145 | Api.site(1); 146 | ``` 147 | 148 | ### createUser(Данные пользователя) 149 | 150 | Создать пользователя 151 | 152 | #### Создание пользователя: 153 | 154 | ```js 155 | Api.createUser({ 156 | username: 'test', // логин 157 | password: 'qwer12345', // пароль 158 | role: 'user', // группа пользователя 159 | sites: 1 // количество разрешённых сайтов 160 | }); 161 | ``` 162 | 163 | #### Создание реселлера: 164 | 165 | ```js 166 | Api.createUser({ 167 | username: 'test', // логин 168 | password: 'qwer12345', // пароль 169 | role: 'reseller', // группа пользователя 170 | sites: 1, // количество разрешённых сайтов 171 | users: 1, // количество разрешённых пользователей 172 | create: true // может ли создавать пользователей 173 | }); 174 | ``` 175 | 176 | ### deleteUser(id пользователя) 177 | 178 | Удаляет пользователя 179 | 180 | #### Использование: 181 | 182 | ```js 183 | Api.deleteUser(16); 184 | ``` 185 | 186 | ### pauseUser(id пользователя) 187 | 188 | Заблокировать аккаунт пользователя 189 | 190 | #### Использование: 191 | 192 | ```js 193 | Api.pauseUser(16); 194 | ``` 195 | 196 | ### unpauseUser(id пользователя) 197 | 198 | Разблокировать аккаунт пользователя 199 | 200 | #### Использование: 201 | 202 | ```js 203 | Api.unpauseUser(16); 204 | ``` 205 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | const axios = require('axios'); 2 | 3 | class FastPanel { 4 | roles = { 5 | user: 'ROLE_USER', 6 | reseller: 'ROLE_RESELLER_ADMIN', 7 | admin: 'ROLE_SUPER_ADMIN' 8 | } 9 | 10 | constructor(url) { 11 | this.url = url; 12 | } 13 | 14 | async auth(username, password) { 15 | try { 16 | const res = await axios.post(`${this.url}/login`, { username, password }); 17 | this.token = res.data.token; 18 | console.log('[FastPanel API by MayerDev] Got token:'); 19 | console.log(this.token); 20 | return true; 21 | } catch (error) { 22 | console.log('[FastPanel API by MayerDev] Username or password incorrect'); 23 | throw error; 24 | } 25 | } 26 | 27 | async _request(method, route, data) { 28 | try { 29 | const res = await axios({ 30 | method, 31 | url: `${this.url}/${route}`, 32 | data, 33 | headers: { 34 | Authorization: `Bearer ${this.token}` 35 | } 36 | }); 37 | return res.data; 38 | } catch (error) { 39 | throw error; 40 | } 41 | } 42 | 43 | async me() { 44 | return this._request('get', 'api/me'); 45 | } 46 | 47 | async settings() { 48 | return this._request('get', 'api/settings'); 49 | } 50 | 51 | async users() { 52 | return this._request('get', 'api/users'); 53 | } 54 | 55 | async user(id) { 56 | return this._request('get', `api/users/${id}`); 57 | } 58 | 59 | async domains() { 60 | return this._request('get', 'api/dns/domains'); 61 | } 62 | 63 | async domain(id) { 64 | return this._request('get', `api/dns/domain/${id}/records`); 65 | } 66 | 67 | async sites(limit = 30) { 68 | return this._request('get', `api/sites/list?filter[limit]=${limit}&filter[type]=all&filter[offset]=0`); 69 | } 70 | 71 | async site(id) { 72 | return this._request('get', `api/sites/${id}`); 73 | } 74 | 75 | async createUser(data) { 76 | const payload = data.role === 'user' ? { 77 | fpuser: { 78 | username: data.username, 79 | password: data.password, 80 | roles: this.roles[data.role], 81 | allowed_virtualhost_count: data.sites, 82 | } 83 | } : { 84 | fpuser: { 85 | username: data.username, 86 | password: data.password, 87 | roles: this.roles[data.role], 88 | allowed_virtualhost_count: data.sites, 89 | allowed_user_count: data.create ? data.users : 0, 90 | user_creating: data.create 91 | } 92 | }; 93 | 94 | return this._request('post', 'api/users', payload); 95 | } 96 | 97 | async deleteUser(id) { 98 | return this._request('delete', `api/users/${id}`); 99 | } 100 | 101 | async pauseUser(id) { 102 | return this._request('post', `api/users/${id}/status`, { 103 | fpuser: { 104 | enabled: false 105 | } 106 | }); 107 | } 108 | 109 | async unpauseUser(id) { 110 | return this._request('post', `api/users/${id}/status`, { 111 | fpuser: { 112 | enabled: true 113 | } 114 | }); 115 | } 116 | } 117 | 118 | module.exports = FastPanel; 119 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "fastpanel-api", 3 | "version": "0.0.7", 4 | "description": "FastPanel API by MayerDev", 5 | "main": "index.js", 6 | "scripts": { 7 | "test": "echo \"Error: no test specified\" && exit 1" 8 | }, 9 | "author": "Artem Lomakin ", 10 | "homepage": "https://mayerdev.com", 11 | "repository": "https://github.com/mayerdev/fastpanel-api", 12 | "license": "MIT", 13 | "dependencies": { 14 | "axios": "^0.21.1" 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /test.js: -------------------------------------------------------------------------------- 1 | const api = require('./index'); 2 | 3 | const Api = new api('https://cp.mayerdev.com'); 4 | 5 | Api.auth('fastuser', 'password').then(async () => { 6 | Api.me(); 7 | }); --------------------------------------------------------------------------------