Skip to content

Commit 91bac07

Browse files
authored
Update README.md
1 parent c8a1fef commit 91bac07

1 file changed

Lines changed: 159 additions & 3 deletions

File tree

README.md

Lines changed: 159 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,166 @@ Api.auth('fastuser', 'password').then(async () => {
5858
5959
## Методы
6060
61-
### _get()
61+
### me()
6262
63-
Отправка GET запроса к API
63+
Получить информацию о текущем аккаунте
64+
65+
#### Ввод:
6466
6567
```js
66-
Api._get('api/me')
68+
Api.me();
6769
```
70+
71+
#### Вывод:
72+
73+
```bash
74+
{ data:
75+
{ action: null,
76+
allowed_user_count: 0,
77+
allowed_virtualhost_count: 0,
78+
avail_virtualhost_count: 0,
79+
created_at: '2021-04-11T19:27:02.658153773Z',
80+
enabled: true,
81+
home_dir: '/var/www/fastuser/data',
82+
id: 1,
83+
php_version: null,
84+
profile:
85+
{ cards_order: null,
86+
id: 1,
87+
interface_settings: [Object],
88+
server_name: '10.130.0.19',
89+
show_information: false,
90+
show_statistic: false,
91+
vhost_order: [] },
92+
quota: null,
93+
reseller_creating: false,
94+
restore_email: 'mayer.dev@yahoo.com',
95+
roles: [ 'ROLE_SUPER_ADMIN' ],
96+
sites_allocated: 0,
97+
state:
98+
{ sites: 2,
99+
domain: 1,
100+
email_domain: 0,
101+
db: 2,
102+
task: 1,
103+
ftp_account: 2,
104+
box: 0,
105+
backup_plan: 0,
106+
user: 4 },
107+
user_creating: false,
108+
username: 'fastuser',
109+
virtualhost_count: 2 } }
110+
```
111+
112+
### settings()
113+
114+
Получить настройки
115+
116+
#### Ввод:
117+
118+
```js
119+
Api.settings();
120+
```
121+
122+
#### Вывод:
123+
124+
```bash
125+
ftp: [Object],
126+
git: [Object],
127+
jpegoptim: [Object],
128+
memcached: [Object],
129+
optipng: [Object],
130+
php_version: [Object],
131+
phppgadmin: [Object],
132+
postgresql10: [Object],
133+
postgresql11: [Object],
134+
postgresql12: [Object],
135+
postgresql96: [Object],
136+
quota: [Object],
137+
rainloop: [Object],
138+
redis: [Object],
139+
roundcube: [Object],
140+
sftp: [Object],
141+
shellinabox: [Object],
142+
spamassassin: [Object],
143+
wpcli: [Object] },
144+
database_servers: [ [Object] ],
145+
panel_version: '1.9.227',
146+
single_dns_account: true,
147+
show_statistics: false,
148+
spamassassin: false,
149+
insecure_domain: false,
150+
tos_agreed: true,
151+
time_offset: 0,
152+
os_release: 'cen7',
153+
send_notification_localy: false,
154+
email_notification: { type: 'sendgrid', email: '', host: '', port: 0 },
155+
notifications: [],
156+
accepted_notifications: {} } }
157+
```
158+
159+
### users()
160+
161+
Получить список пользователей
162+
163+
#### Ввод:
164+
165+
```js
166+
Api.users();
167+
```
168+
169+
#### Вывод:
170+
171+
```bash
172+
{ data:
173+
[ { action: null,
174+
allowed_user_count: 0,
175+
allowed_virtualhost_count: 0,
176+
avail_virtualhost_count: 0,
177+
created_at: '2021-04-11T19:27:02.658153773Z',
178+
enabled: true,
179+
home_dir: '/var/www/fastuser/data',
180+
id: 1,
181+
php_version: null,
182+
quota: null,
183+
reseller_creating: false,
184+
restore_email: 'mayer.dev@yahoo.com',
185+
roles: [Array],
186+
sites_allocated: 0,
187+
user_creating: false,
188+
username: 'fastuser',
189+
virtualhost_count: 0 }, ... ] }
190+
```
191+
192+
```bash
193+
{ data:
194+
{ action: null,
195+
allowed_user_count: 0,
196+
allowed_virtualhost_count: 0,
197+
avail_virtualhost_count: 0,
198+
created_at: '2021-04-11T19:27:02.658153773Z',
199+
enabled: true,
200+
home_dir: '/var/www/fastuser/data',
201+
id: 1,
202+
php_version: null,
203+
quota: null,
204+
reseller_creating: false,
205+
restore_email: 'mayer.dev@yahoo.com',
206+
roles: [ 'ROLE_SUPER_ADMIN' ],
207+
sites_allocated: 0,
208+
user_creating: false,
209+
username: 'fastuser',
210+
virtualhost_count: 0 } }
211+
```
212+
213+
### user(id пользователя)
214+
215+
Получить информацию о пользователе
216+
217+
#### Ввод:
218+
219+
```js
220+
Api.user(1);
221+
```
222+
223+
#### Вывод:

0 commit comments

Comments
 (0)