3CX WebAPI Installation Script Guide (v18, v20)

Created by Anton Zykov, Modified on Tue, 16 Apr 2024 at 08:38 PM by Oleg Agapov

1. Create temp directory for installation script 

mkdir /tmp/webapi_install 

cd /tmp/webapi_install


2. Download installation script 

For 3CX v20

wget https://download.creomate.com/install.sh

For 3CX v18

wget https://download.creomate.com/install_v18.sh

3. Run install script with super user rights (sudo or su root) 

sudo bash install.sh

Installation script will automatically download WebAPI binaries, set up service and change nginx configs. 

4. After installation, you can check the WebAPI service 

systemctl status webapi

5. Activate the WebAPI license 

Open WebAPI admin panel in your browser and use "Activate" button.


Login: TCXWebAPI

Default password: Activate

After the license activation, the license code will become the password. 

The trial activation key is NHQE-QRND-TRIAL

6. Run database setup commands 



Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons

Feedback sent

We appreciate your effort and will try to fix the article