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 and Local REST API endpoints and provide usage examples.

Before entering the following commands in Command prompt please make sure your Cmd is opened in the main Multilogin directory (usually "C:\Program Files (x86)\Multilogin").

Start Multilogin without UI on random port:

multilogin.exe -headless

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

headless.exe -port 45000

Login to Multilogin account:

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

Restrict token access:

cli.exe -restrict-access -tag tagname

This command is required to restrict a visibility of sessions on an individual machine. E.g. machine A logins account example@example.com and should see only sessions tagged with a certain tag. You should first open the Multilogin console, then login accounts example@example.com using “login” command, 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:

  1. Please go to C:\Users\%username%\.multiloginapp.com directory and open app.properies file
  2. Add the following string: multiloginapp.port=[PORT_NUMBER] and save the 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?