With the API v1.5 in Undetectable, you will be able to get a list of profiles, create, launch, update, and close them. Additionally, with the obtained information, you can connect various automation tools such as Puppeteer, Playwright, and others to profiles on the Chromium core.
By default, the local server runs on port 25325. If this port is occupied, it will start on another port. You can check the port in the program settings and change it if necessary.
To access the local server, use the IP 127.0.0.1, localhost, or the local IP within your network, and the port from the settings plus the path you want to execute, for example,
http://localhost:25325/status
.
All API responses look like:
{
"code": `<status code>`,
"status": `<status>`,
"data": `<return object>`,
}
where
<status code>
and
<status>
reflect the status:
<return object>
- various data sent by the API, for example, a list of profiles.
Errors have the following format:
{
"code":1,
"status":"error",
"data":
{"error": "error description"},
}
Requests
Status
Path:
/status
Method:
GET
Description: Returns the status of the local server, whether it is running or not.
Returning Data
{
"code":0,
"status":"success",
"data":{},
}
List of Profiles
Path:
/list
Method:
GET
Description: Returns a list of profiles available in the program on the Chromium browser.
Returning Data
{
"code": 0,
"status": "success",
"data"{
"profile_id1": {
"name": "Profile1", // Profile name in the program
"status": "Available", // Profile status, can be: "Started", "Locked", "Available"
"debug_port": "xxxx", // browser debug port used for automation (empty if the profile is not running). Only for Chromium browser
"websocket_link": "ws://127.0.0.1:xxxx/devtools/browser/xxxxxx", // browser link used for automation (empty if the profile is not running). Only for Chromium browser
"folder": "Name", // Profile folder name
"tags": ["tag1", "tag2", "tag3"], // Profile tags
"cloud_id": "", // Cloud profile ID
"creation_date": 123456789, // Creation date Unix Timestamp
"modify_date": 123456789, // Modification date Unix Timestamp
},
"profile_id2": {
…},
…
},
}
Create Profile
Path:
/profile/create
Method:
POST
Description: Creates a profile with the selected parameters. All parameters are optional and may not be present. The list of browsers for the command: Chrome, Edge, FireFox, IE, Opera, Safari, Yandex. The list of OS for the command: Windows, Windows 7, Windows 8, Windows 8.1, Windows 10, Android, iPhone, iPad, Linux, Mac. If there are no configurations with the selected OS or Browser, a random OS or Browser type will be used.
Format: JSON
Request parameters:
{
"name": "profile with random settings", // Profile name in the program
"os": "Windows", // Configuration with which OS to use
"browser": "Chrome", // Configuration with which browser to use
"cpu": 8, // Number of cores, possible values: 32, 24, 20, 16, 12, 10, 8, 7, 6, 5, 4, 3, 2, 1, 0
"memory": 8, // Amount of memory, possible values: 8, 4, 2, 1, 0
"tags": ["tag1", "tag2"], // Set tags on the profile
"geolocation": "12.44, 13.524", // Set geolocation, if you enter an empty or incorrect value, the default settings will be used
"proxy": "socks5://127.0.0.1:5555:login:pass", // Change the proxy in the profile (proxies can be http, https, socks5, there may be options with and without login/password). You can use proxy ID too.
"notes": "Text", // Change the notes in the profile
"folder": "testFolder", // In which folder the profile will be
"language": "ru-RU, en-US", // You can set 2 languages
"cookies": [{}], // Import cookies into the profile
"type": "cloud", // Profile type: cloud, local
"group": "group_example", // If there is no entered group, it takes from the default settings, if there is and it is incorrect, an error is displayed
"configid": "id", // Config ID, if entered, then the OS and Browser parameters are ignored, other parameters if possible, for example, if the config is for Android, the screen resolution will not change
"accounts": [ // Import accounts from different sites into the profile
"timezone": "Pacific/Niue"("Auto", "System")// set timezone or timezone mode
}
Returning Data:
{
"code": 0,
"status": "success",
"data": {
"profile_id": "xxxxxxxx...", // Unique profile ID
"name": "profile with random settings"// Profile name in the program
}
}
Starting a profile
Path:
/profile/start/<profileID>
Method:
GET
Description: Starts the profile with the selected
<profileID>
. You can add parameters to the link:
chrome_flags and pass any launch flags you want, just encode them in URL encoding, for example: ?chrome_flags=—blink-settings%3DimagesEnabled%3Dfalse%20—disable-webgl2
start-pages and specify the start pages, just encode them in URL encoding, for example: ?start-pages=https%3A%2F%2Fgoogle.com%2Chttps%3A%2F%2Fya.ru
Returning Data
{
"code":0,
"status":"success",
"data":{
"name": "Profile1"// Profile name in the program
"websocket_link":"ws://127.0.0.1:xxxx/devtools/browser/xxxxxx", // link to the browser, used for automation (empty value if the profile is not running). Only for Chromium browser
"debug_port": "xxxx", // Chromium browser debug port, used for automation (empty value if the profile is not running). Only for Chromium browser
"folder": "Name", // Profile folder name
"tags": ["tag1", "tag2", "tag3"] // Profile tags
},
}
Closing a profile
Path:
/profile/stop/<profileID>
Method:
GET
Description: Stops the profile with the selected
<profileID>
Returning Data:
{
"code": 0,
"status": "success",
"data": {}
}
Profile Update
Path:
/profile/update/<profileID>
Method:
POST
Description: Updates the information in the profile with the specified
<profileID>
. All parameters are optional and may not be present.
Format: JSON
Request parameters:
{
"proxy": "socks5://127.0.0.1:5555:login:pass", // Change the proxy in the profile (proxies can be http, https, socks5, with or without login/password). You can use proxy ID too.
"notes": "Text", // Change the notes in the profile
"name": "Profile Name", // Change the profile name
"folder":"TestFolder", // Change the folder in the profile
"tags": ["tag1", "tag2"], // Set tags for the profile, old tags will be overwritten, if the array is empty, all tags will be removed from the profile
"geolocation": "12.44, 13.524", // Set the geolocation, if an empty or incorrect value is entered, the default settings will be used
"cookies":[{}], // Import cookies into the profile
"type": "cloud", // Profile type: cloud, local
"group": "group_example", // If no group is entered, it takes the default settings, if there is a group and it is incorrect, an error is displayed
"accounts": [ // Import accounts from different sites into the profile
"language": "en-US,en;q=0.9,ak-GH;q=0.8,ak;q=0.7", // Profile language
"cpu": 8, // Number of cores
"memory": 4, // Amount of memory
"creation_date": 123456789, // Creation date Unix Timestamp
"modify_date": 123456789, // Modification date Unix Timestamp
},
}
Check IP
Path: /profile/checkconnection/<profileID>
Method: GET
Description: Checks the connection in the profile with the selected , if the check fails, an error is returned
Format: JSON
Returning Data:
{
"code":0,
"status": "success",
"data": {
"ip": "127.0.0.1"// Returns the IP address in this profile
}
}
Get timezones list
Path: /timezoneslist
Method: GET
Description: Returning timezones list
Format: JSON
Returning Data:
{
"code":0,
"status": "success",
"data": {
"Pacific/Niue": "GMT-11:00",
"America/Cambridge_Bay": "GMT-7:00",
...
}
}
Get proxies list
Path: /proxies/list
Method: GET
Description: Returning proxies list
Format: JSON
Returning Data:
{
"code":0,
"status": "success",
"data": {
"proxy_id1":
{
"name": "Proxy1"
"type":"http",
"host": "127.0.0.1",
"port": "2222",
"login": "12345",
"password": "12345",
"ipchangelink": "",
}
"proxy_id2":
{
…
},
…
}
}
Add proxy
Path: /proxies/add
Method: POST
Description: Add a proxy to the proxy manager, the parameters login, password, ipchangelink are optional, the rest are required
Format: JSON
Request parameters:
{
"name": "Proxy1",
"type": "http",
"host": "127.0.0.1",
"port": "2222",
"login": "12345",
"password": "12345",
"ipchangelink": ""
}
Returning Data:
{
"code": 0,
"status": "success",
"data": {
"proxy_id": "12345"
}
}
Delete proxy
Path: /proxies/delete/<ProxyID>
Method: GET
Description: Removes a proxy with the selected ID. Proxy will be deleted for all profiles with that proxy, the same as during normal deletion from the manager
Format: JSON
Returning Data:
{
"code":0,
"status":"success",
"data": {
},
}
Update proxy
Path: /proxies/update/<ProxyID>
Method: POST
Description: Updates the proxy with the selected ID, all parameters are optional
Format: JSON
Request parameters:
{
"name": "Proxy1",
"type": "http",
"host": "127.0.0.1",
"port": "2222",
"login": "12345",
"password": "12345",
"ipchangelink": ""
}
Returning Data:
{
"code": 0,
"status": "success",
"data": {
}
}
Examples
Puppeteer (Node.js)
Node.js Puppeteer Launch a profile with a specific name and open the undetectable.io page in that profile:
const puppeteer = require('puppeteer');
const axios = require('axios');
const port = 25325; // Port
const ip = '127.0.0.1'; // Local IP
const profileName = ‘TestProfile’; // Profile name
