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 FAQConnecting the agent Testing a proxy Saving browser data Using Multilogin on macOS Investigating speed issues Can't start Multilogin Can't launch profile or connect to proxy Error: Failed to get profile data Stopping the agent from auto-sending log files Handling ban issues Issue: Profile is locked Troubleshooting FAQ
-
Error: Failed to get IP data: can't connect through proxy Error: Javax.crypto.badpaddingexception: pad block corrupted Status: Update in progress...Loading (1) of 2 components Error: Fingerprint composition failed Connection error due to non-Latin characters in Windows username Error: Mimic/Stealthfox executable is not found Multilogin 6 browser profile shows "Error" in status Can't launch a profile in Multilogin 6 JavaScript error when switching to dark mode in Multilogin 6 Common errors and solutions in Multilogin 6
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 user@example.com -p password123
- Linux/macOS:
./cli.sh -login -u user@example.com -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.