Difference between revisions of "API: connection"

From BrainyCP
Jump to: navigation, search
 
Line 31: Line 31:
 
 
 
 
  
{|
+
{| style="width: 1261px;"
 
|-
 
|-
|  
+
| style="width: 320px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]'''
  
|  
+
| style="width: 366px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]'''
  
|  
+
| style="width: 553px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Webserver_status <font><font>API: web server status</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Webserver_status <font><font>API: web server status</font></font>]'''
  
 
|-
 
|-
|  
+
| style="width: 320px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_CMS_Autoinstaller <font><font>API: auto installer CMS</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_CMS_Autoinstaller <font><font>API: auto installer CMS</font></font>]'''
  
|  
+
| style="width: 366px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Configuring_backups <font><font>API: configuring backups</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Configuring_backups <font><font>API: configuring backups</font></font>]'''
  
|  
+
| style="width: 553px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Transfer_between_servers <font><font>API: transfer between servers</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Transfer_between_servers <font><font>API: transfer between servers</font></font>]'''
  
 
|-
 
|-
|  
+
| style="width: 320px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]'''
  
|  
+
| style="width: 366px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Server_configuration <font><font>API: server settings</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Server_configuration <font><font>API: server settings</font></font>]'''
  
|  
+
| style="width: 553px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Manage_webserver <font><font>API: web server management</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Manage_webserver <font><font>API: web server management</font></font>]'''
  
 
|-
 
|-
|  
+
| style="width: 320px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]'''
  
|  
+
| style="width: 366px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_User_Certificates <font><font>API: custom certificates</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_User_Certificates <font><font>API: custom certificates</font></font>]'''
  
|  
+
| style="width: 553px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Managing_mailboxes <font><font>API: mailbox management</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Managing_mailboxes <font><font>API: mailbox management</font></font>]'''
  
 
|-
 
|-
|  
+
| style="width: 320px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Server_info <font><font>API: server information</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Server_info <font><font>API: server information</font></font>]'''
  
|  
+
| style="width: 366px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]'''
  
|  
+
| style="width: 553px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Manage_DNS-zones <font><font>API: DNS zone management</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Manage_DNS-zones <font><font>API: DNS zone management</font></font>]'''
  
 
|-
 
|-
|  
+
| style="width: 320px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Traffic_usage <font><font>API: traffic usage</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Traffic_usage <font><font>API: traffic usage</font></font>]'''
  
|  
+
| style="width: 366px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Client_mail <font><font>API: client mailboxes</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Client_mail <font><font>API: client mailboxes</font></font>]'''
  
|  
+
| style="width: 553px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Webserver_Installation <font><font>API: web server installation</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Webserver_Installation <font><font>API: web server installation</font></font>]'''
  
 
|-
 
|-
|  
+
| style="width: 320px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]'''
  
|  
+
| style="width: 366px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Nameserver <font><font>API: name server</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Nameserver <font><font>API: name server</font></font>]'''
  
|  
+
| style="width: 553px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_host-accounts <font><font>API: host accounts</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_host-accounts <font><font>API: host accounts</font></font>]'''
  
 
|-
 
|-
|  
+
| style="width: 320px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_App_manager <font><font>API: application manager</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_App_manager <font><font>API: application manager</font></font>]'''
  
|  
+
| style="width: 366px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Certificates_of_services <font><font>API: service certificates</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Certificates_of_services <font><font>API: service certificates</font></font>]'''
  
|  
+
| style="width: 553px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]'''
  
 
|-
 
|-
|  
+
| style="width: 320px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Process_manager <font><font>API: process manager</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Process_manager <font><font>API: process manager</font></font>]'''
  
|  
+
| style="width: 366px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Network_tools <font><font>API: network tools</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Network_tools <font><font>API: network tools</font></font>]'''
  
|  
+
| style="width: 553px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_FTP-server <font><font>API: FTP server</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_FTP-server <font><font>API: FTP server</font></font>]'''
  
 
|-
 
|-
|  
+
| style="width: 320px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_IP-address_manager <font><font>API: IP address manager</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_IP-address_manager <font><font>API: IP address manager</font></font>]'''
  
|  
+
| style="width: 366px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Load_average <font><font>API: average load</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Load_average <font><font>API: average load</font></font>]'''
  
|  
+
| style="width: 553px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_MySQL_processlist <font><font>API: MySQL processlist</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_MySQL_processlist <font><font>API: MySQL processlist</font></font>]'''
  
 
|}
 
|}

Latest revision as of 14:41, 17 November 2021

To connect via the API, you need to create a host account in your Brainy dashboard:
go to the "Host Accounts" section → fill in the fields in the "Add Host Account" section:

  • Username;
  • password;
  • IP address;
  • group (if there is no group, create);
  • tariff (if there is no tariff, create);
  • language;
  • shell access;
  • owner.

When creating a group, you must enable the "API access" and / or "Full API access (administrator)" option. The last parameter is responsible for adding administrative functions:

RTENOTITLE

Go back to creating a host account and assign a group to the user who will be given the API connection:

RTENOTITLE

 

To connect via the API, you need to open a new page in your browser and enter http://your-IP:8002/api/api.php?Login=username&pass=password. If done correctly, you will see a blank page:
RTENOTITLE

If you entered an incorrect username or password, an error {"code": 1, "message": "Not perm2"} is displayed:

RTENOTITLE

Other helpful articles:

 

API: connection

API: monitoring

API: web server status

API: auto installer CMS

API: configuring backups

API: transfer between servers

API: antivirus

API: server settings

API: web server management

API: database

API: custom certificates

API: mailbox management

API: server information

API: mail

API: DNS zone management

API: traffic usage

API: client mailboxes

API: web server installation

API: logging

API: name server

API: host accounts

API: application manager

API: service certificates

API: CRON

API: process manager

API: network tools

API: FTP server

API: IP address manager

API: average load

API: MySQL processlist