Clicky

CLI and Local REST API

Updated 2 weeks ago by Daniel

Since version 2.1.4, Multilogin supports Command Line Interface (CLI) commands and Local REST API. This guide will introduce the basic CLI commands, Local REST API endpoints and provide usage examples.

Before entering the following commands in Command prompt please make sure your Cmd/Terminal is opened in the main Multilogin directory (for Windows it's usually "C:\Program Files (x86)\Multilogin").
If you are using UNIX system, please make sure that you added execution permissions to .sh file. You can add execution permissions to a file by using chmod +x command (for ex. ‘chmod +x multilogin.sh’).

Start Multilogin with UI on random port: 

Windows

multilogin.exe

Linux/MacOS

./multilogin.sh

Start Multilogin without UI on a predefined port (45000 used as an example):

Windows

headless.exe -port 45000

Linux/MacOS

./headless.sh -port 45000

Please keep in mind that although our app can be launched in headless mode, the browser profiles can not. You still need to have a system with a graphical user interface in order to use them.

Login to Multilogin account:

Windows

cli.exe -login -u user@example.com -p password123

Linux/MacOS

./cli.sh -login -u user@example.com -p password123

Local REST API

As soon as you started Multilogin with CLI you can use Local REST API endpoints in order to start/stop, share, clone browser profile and check if a profile is running. 

Multilogin port allocation

On 3.x versions of Multilogin, you need to predefine the application port in order to utilize Local REST API endpoints. Here is how you can predefine Multilogin port in 3.X:

  1. Please go to C:\Users\%username%\.multiloginapp.com directory and open app.properies file
  2. Add the following string: multiloginapp.port=[PORT_NUMBER]
  3. Save the app.properties file

Thereafter, you will be able to refer to the Multiogin application through this port.

All Local REST API endpoints are described in our swagger documentation (A.k.a OpenAPI Specification).


Was this article helpful?