Clicky

CLI and Local API

Updated 3 months ago by Annes

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

3 Steps to start using Local API:

1. Predefine the application listening port

2.
Launch Multilogin application manually or with CLI

3.
Use Local API endpoints

1. Multilogin port allocation

You need to predefine the application port in order to utilize Local API endpoints. Here is how you can predefine the Multilogin port:

  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.

2. CLI

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

3. Local API

Local API endpoints are available in Multilogin versions 5.4 or higher.

As soon as you started Multilogin manually or with CLI you can use Local API endpoints. Local API provides programmatic access to read and write data of Multilogin browser profiles. Create a new browser profile, get a list of all browser profiles, add a browser profile to a group and more.

Local API endpoints

Local API endpoints are available in our Swagger documentation (A.k.a OpenAPI Specification).

Test our code example

Code examples of how to open the existing Multilogin browser profile and perform simple Selenium and Puppeteer browser automation:

Plan limits

Local API is only available for users with Automate and Scale subscriptions, with certain endpoints limited to the number of requests per second.

If an API is accessed from a subscription plan, which does not include Local API usage, the server will respond with the following error:

1 {"status":"ERROR","value":"unauthorized"}
Rate limits

Rate limits are applicable to all paid plan subscriptions. They differ by two endpoint types:

  • For requests returning a list (E.g. listProfiles) - 1 requests/minute
  • Create and Update requests - 1 requests/minute
  • All other requests - 10 requests/minute.

Upon reaching the limit, the server will respond with the following error:

1 {"status":"ERROR","value":"rate limit exceeded."}

For further information, please contact our support team.


Was this article helpful?