Contact Us
If you still have questions or prefer to get help directly from an agent, please submit a request.
Popular topics: Multilogin X, Multilogin 6,
-
Retrieving the token Using the automation token in a workspace Retrieving profile, folder, and workspace IDs Retrieving the user ID Selenium automation example Playwright automation example Puppeteer automation example Logging in to Multilogin automatically Setting up automatic cookie collection Auto-launching the agent Exporting proxy details from profiles Converting external proxy lists into API-ready JSON files Automation FAQHow to fix agent connection issues How to fix startup issues in Multilogin Account banned: what should I do? How to fix profile launch or proxy connection issues How to fix Mimic launch issues on Linux How to enable web camera in Multilogin profiles My app or profile is slow: how to fix performance issues How to unlock a locked profile How to find missing profiles How to fix website loading issues in Multilogin How to access restricted websites How to fix connection issues in restricted regions How to fix Stealthfox issues on Windows How to fix small Stealthfox window resolution on Windows How to fix Multilogin issues on macOS How to disconnect and reconnect the agent How to reinstall app components How to send logs to support How to fix "Failed to get profile data" error How to fix "Access denied" error How to fix “Some settings were reset” error How to fix “Plan limit reached” error How to fix “Wrong proxy data” error How to fix “ERR_CONNECTION_RESET” error
-
Common errors and solutions in Multilogin 6 How to fix profile launch issues in Multilogin 6 How to fix proxy connection issues in Multilogin 6 How to fix frozen "Update in progress... Loading [3] of 2 components" status How to fix Android profile issues in Multilogin 6 How to fix issues with extension data in Mimic How to fix Stealthfox issues on Windows How to fix "JavaScript error" in Multilogin 6 dark mode How to fix "Javax.crypto […] pad block corrupted" error How to fix "Fingerprint composition failed" error How to fix "Mimic/Stealthfox executable is not found" error How to fix "Downloading Mimic browser" error How to fix "Invalid buffer arguments" error How to fix "Cannot invite existing user" error
CLI and Local API in Multilogin 6
Written by Yana Shcharbina
Updated on July 27th, 2024
Table of contents
Multilogin supports both Command Line Interface (CLI) and Local API. This guide will introduce the basic CLI commands and Local API endpoints, along with usage examples.
To start using the Local API, follow these three steps:
- Predefine the application listening port
- Launch Multilogin manually or with CLI
- Use Local API endpoints
Multilogin port allocation
You need to predefine the application port to use the Local API endpoints. Once set, you can refer to the Multilogin application through this port.
- Find the app.properties file in the .multiloginapp.com directory (depending on your OS settings, it may be hidden in your system):
- Windows: C:\Users\%username%\.multiloginapp.com
- Linux: /home/%username%/.multiloginapp.com
- macOS: /Users/%username%/.multiloginapp.com
To find this folder on a Mac, open Finder and press Cmd + Shift + H
to open a user folder, then press Cmd + Shift + .
(period) to show hidden files. After that, go to the .multiloginapp.com folder.
- Open the app.properties file in any text editor
- Add the following string:
multiloginapp.port=[PORT_NUMBER]
The port number has to be in the range of 10000 to 49151.
- Save the app.properties file
Command Line Interface (CLI)
Before entering the following commands into the Command prompt, make sure your Cmd/Terminal is open in the directory specified below.
Multilogin version 6.0 or higher:
- Windows: C:\Program Files (x86)\Multilogin\headless
- macOS: /Applications/multilogin.app/Contents/MacOS/multilogin.app/Contents/MacOS
- Linux: /opt/Multilogin/headless
Multilogin version 5.19 or lower:
- Windows: C:\Program Files (x86)\Multilogin
- macOS: /Applications/multilogin.app/Contents/MacOS
If you are using a UNIX system, make sure to add execution permissions to the .sh file. You can do it by using the chmod +x
command (for example, chmod +x headless.sh
).
Starting Multilogin in headless mode:
- Windows:
headless.exe
- Linux/macOS:
./headless.sh
Starting Multilogin in headless mode on a predefined port (35000 used as an example):
- Windows:
headless.exe -port 35000
- Linux/macOS:
./headless.sh -port 35000
Keep in mind that while our app can run in headless mode, the browser profiles cannot. You'll need a system with a graphical user interface to use them.
Logging in to your Multilogin account:
- Windows:
cli.exe -login -u [email protected] -p password123
- Linux/macOS:
./cli.sh -login -u [email protected] -p password123
Local API
Local API endpoints are available in Multilogin versions 5.4 or higher: check out our Swagger documentation.
Once you start Multilogin manually or with CLI, you can use Local API endpoints. The Local API lets you programmatically access and modify Multilogin browser profiles. You can create new profiles, get a list of all profiles, add profiles to groups, and more.