CLI and Local REST API
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.
Start Multilogin without UI on random port:
Start Multilogin without UI on a predefined port (45000 used as an example):
headless.exe -port 45000
./headless -port 45000
Login to Multilogin account:
cli.exe -login -u firstname.lastname@example.org -p password123
./cli -login -u email@example.com -p password123
Restrict token access:
cli.exe -restrict-access -tag tagname
./cli -restrict-access -tag tagname
This command is required to restrict a visibility of sessions on an individual machine. E.g. machine A logins account firstname.lastname@example.org and should see only sessions tagged with a certain tag.
You should first login into Multilogin account by using “login” command described above and then run “-restrict-access” command with -tag parameter.
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:
- Please go to C:\Users\%username%\.multiloginapp.com directory and open app.properies file
- Add the following string: multiloginapp.port=[PORT_NUMBER]
- 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).