VMLogin Rest API v1

[ Base URL: https://api.vmlogin.com/v1 ]

User authentication and API token
All requests are authenticated by the user’s access token (per-login basis), which is sent along with the desired endpoint.
The token can be set in the https://m.vmlogin.com/member/account/main/index (Account Management -> My Account)

Important! This authentication token is equivalent to your account password. Keep it secret and do not share it with third parties.

groups

Type Description API
GET Create a group /tag/create
GET Remove a group /tag/remove
GET Rename a group /tag/rename
GET Get a list of all groups available on your account /tag/list
GET Move browser profile to specific group /tag/profile/add
GET Remove the browser profile from a specific group /tag/profile/remove

profiles

Type Description API
POST Create browser profile /profile/create
POST Update browser profile settings /profile/update
GET Detail browser profile /profile/detail
GET Sharing browser profile (batch operation) /profile/share
GET Browser profile unshare (batch operation) /profile/cancelShare)
GET Transfer browser profile’s ownership (batch operation) /profile/transferOwnership)
GET Remove browser profile /profile/remove
GET Get a list of all available browser profiles /profile/list



Create a group(/tag/create)
Name Type Description required
token string Authentication token true
name string Group name true

Request

{
    "token": "66e9f73f3617c6afdc6768f7a61a58ae",
    "name": "test"
}


Remove a group(/tag/remove)
Name Type Description required
token string Authentication token true
tagId string Group ID true

Request

{
    "token": "66e9f73f3617c6afdc6768f7a61a58ae",
    "tagId": "1024"
}


Rename a group(/tag/rename)
Name Type Description required
token string Authentication token true
name string New name of Group true
tagId string Group ID true

Request

{
    "token": "66e9f73f3617c6afdc6768f7a61a58ae",
    "name": "New name",
    "tagId": "1024"
}


Get a list of all groups available on your account(/tag/list)
Name Type Description required
token string Authentication token true

Request

{
    "token": "66e9f73f3617c6afdc6768f7a61a58ae"
}


Move browser profile to specific group(/tag/profile/add)
Name Type Description required
token string Authentication token true
tagId string Group ID true
profileId string Browser profile ID true

Request

{
    "token": "66e9f73f3617c6afdc6768f7a61a58ae",
    "tagId": "1024",
    "profileId": "56795471-8dc0-414c-9d1a-794e4dd8be99"
}


Remove the browser profile from a specific group(/tag/profile/remove)
Name Type Description required
token string Authentication token true
tagId string Group ID true
profileId string Browser profile ID true

Request

{
    "token": "66e9f73f3617c6afdc6768f7a61a58ae",
    "tagId": "1024",
    "profileId": "56795471-8dc0-414c-9d1a-794e4dd8be99"
}


Create browser profile(/profile/create)
Name Type Description required
token string Authentication token true
Body object Request body in application/json type true

Request

{
    "token": "66e9f73f3617c6afdc6768f7a61a58ae",
    "Body": {
                "name": "myProfile",
                "notes": "profile notes",
                "iconId": 0,
                "os": "Windows",
                "proxyServer": {
                    "setProxyServer": true,
                    "type": "HTTP",
                    "host": "127.0.0.1",
                    "port": 1080,
                    "username": "hello",
                    "password": "world"
                },
                "webRtc": {
                    "type": "FAKE",
                    "fillOnStart": true,
                    "publicIp": "5.5.5.5",
                    "localIps": [
                        "192.168.1.10"
                    ],
                    "localIpsRand": false
                },
                "userAgent": "user_agent_value",
                "screenWidth": 1920,
                "screenHeight": 1080,
                "langHdr": "en-US",
                "acceptLanguage": "en-US,en;q=0.9",
                "platform": "platform_value",
                "product": "Gecko",
                "appName": "Netscape",
                "hardwareConcurrency": 4,
                "doNotTrack": false,
                "mobileEmulation": false,
                "deviceType": 1,
                "pixelRatio": "1.0",
                "maskFonts": true,
                "fontSetting": {
                    "dynamicFonts": false,
                    "fontList": [
                        "@Microsoft YaHei UI",
                        "@宋体",
                        "MS Outlook"
                    ],
                    "selectAll": false,
                    "clientRects": true,
                    "rand": false
                },
                "canvasDefType": "NOISE",
                "audio": {
                    "noise": true
                },
                "webgl": {
                    "vendor": "vendor_value",
                    "renderer": "renderer_value"
                },
                "timeZoneFillOnStart": false,
                "timeZone": "Europe/Tallinn",
                "mediaDevices": {
                    "setMediaDevices": false,
                    "videoInputs": 1,
                    "audioInputs": 4,
                    "audioOutputs": 4
                },
                "startUrl": "https://vmlogin.com/",
                "browserSettings": {
                    "pepperFlash": true,
                    "mediaStream": true,
                    "webkitSpeech": true,
                    "fakeUiForMedia": true,
                    "gpuAndPepper3D": true,
                    "ignoreCertErrors": true,
                    "audioMute": true,
                    "disableWebSecurity": true,
                    "disablePdf": true,
                    "touchEvents": true,
                    "hyperlinkAuditing": true
                },
                "localCache": {
                    "deleteCache": true,
                    "deleteCookie": true,
                    "clearCache": true,
                    "clearHistory": true
                },
                "synSettings": {
                    "synCookie": true,
                    "synBookmark": true,
                    "synHistory": true,
                    "synExtension": true,
                    "synKeepKey": true,
                    "synLastTag": true
                },
                "leakProof": {
                    "computerName": "",
                    "macAddress": "",
                    "rand" : [
                        "computerName", 
                        "macAddress"
                    ]
                },
                "browserParams": "",
                "customDns": "",
                "remoteDebug": {
                    "debuggingPort": "",
                    "logLevels": 99
                },
                "pluginFingerprint": {
                    "pluginEnable": true,
                    "list": {
                        "name": [
                            "Chrome PDF Plugin",
                            "Chrome PDF Viewer",
                            "Native Client",
                            "Shockwave Flash"
                        ],
                        "describe": [
                            "Portable Document Format",
                            "-",
                            "-",
                            "Shockwave Flash 32.0 r0"
                        ],
                        "fileName": [
                            "internal-pdf-viewer",
                            "mhjfbmdgcfjbbpaeojofohoefgiehjai",
                            "internal-nacl-plugin",
                            "pepflashplayer.dll"
                        ],
                        "mimeType": [
                            "application/x-google-chrome-pdf",
                            "application/pdf",
                            "application/x-nacl|application/x-pnacl",
                            "application/x-shockwave-flash|application/futuresplash"
                        ],
                        "mimeDescription": [
                            "Portable Document Format",
                            "-",
                            "Native Client Executable|-Portable Native Client Executable",
                            "Shockwave Flash|Shockwave Flash"
                        ],
                        "mimeExtension": [
                            "pdf",
                            "pdf",
                            "|",
                            "swf|spl"
                        ]
                    }
                },
                "unPluginFingerprint": {
                    "list": {
                        "name": [
                            "name"
                        ],
                        "describe": [
                           "describe"
                        ],
                        "fileName": [
                            "fileName"
                        ],
                        "mimeType": [
                            "mimeType"
                        ],
                        "mimeDescription": [
                            "mimeDescription"
                        ],
                        "mimeExtension": [
                            "mimeExtension"
                        ]
                    }
                },
                "browserApi": {
                    "setBatteryStatus": false,
                    "isCharging": true,
                    "chargingTime": "0",
                    "drainsTime": "Infinity",
                    "batteryPercentage": "1",
                    "autoGeoIp": false,
                    "setLatitude": false,
                    "setLongitude": false,
                    "setAccuracy": false,
                    "latitude": "51.482594",
                    "longitude": "-0.007661",
                    "accuracy": "1803.34",
                    "setWebBluetooth": false,
                    "setBluetoothAdapter": false,
                    "speechSynthesis": false,
                    "speechVoicesList": {
                        "voiceURI": [
                            "voiceURI value 1",
                            "voiceURI value 2"
                        ],
                        "name": [
                            "name value 1",
                            "name value 2"
                        ],
                        "lang": [
                            "lang value 1",
                            "lang value 2"
                        ],
                        "localService": [
                            false,
                            true
                        ],
                        "default": [
                            true,
                            false
                        ]
                    },
                    "unSpeechVoicesList": {
                        "voiceURI": [
                            "voiceURI value 3"
                        ],
                        "name": [
                            "name value 3"
                        ],
                        "lang": [
                            "lang value 3"
                        ],
                        "localService": [
                            true
                        ],
                        "default": [
                            true
                        ]
                    },
                    "speechVoicesRestoreDefault": false
                },
                "sslFingerprint":{
                    "enableCustomSSL": true,
                    "versionMin": 0,
                    "versionMax": 1,
                    "cipherSuites": {
                        "TLS_AES_128_GCM_SHA256": true,
                        "TLS_AES_256_GCM_SHA384": true,
                        "TLS_CHACHA20_POLY1305_SHA256": true,
                        "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256": true,
                        "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256": true,
                        "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384": true,
                        "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384": true,
                        "TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256": true,
                        "TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256": true,
                        "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA": true,
                        "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA": true,
                        "TLS_RSA_WITH_AES_128_GCM_SHA256": true,
                        "TLS_RSA_WITH_AES_256_GCM_SHA384": true,
                        "TLS_RSA_WITH_AES_128_CBC_SHA": true,
                        "TLS_RSA_WITH_AES_256_CBC_SHA": true,
                        "TLS_RSA_WITH_3DES_EDE_CBC_SHA": false,
                        "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA": false
                    }
                },
                "tag": "group_name"
            }
}


Update browser profile settings(/profile/update)
Name Type Description required
token string Authentication token true
profileId string Browser profile ID true
Body object Request body in application/json type true

Request

{
    "token": "66e9f73f3617c6afdc6768f7a61a58ae",
    "profileId": "56795471-8dc0-414c-9d1a-794e4dd8be99",
    "Body": {
                "name": "myProfile",
                "notes": "profile notes",
                "iconId": 0,
                "os": "Windows",
                "proxyServer": {
                    "setProxyServer": true,
                    "type": "HTTP",
                    "host": "127.0.0.1",
                    "port": 1080,
                    "username": "hello",
                    "password": "world"
                },
                "webRtc": {
                    "type": "FAKE",
                    "fillOnStart": true,
                    "publicIp": "5.5.5.5",
                    "localIps": [
                        "192.168.1.10"
                    ],
                    "localIpsRand": false
                },
                "userAgent": "user_agent_value",
                "screenWidth": 1920,
                "screenHeight": 1080,
                "langHdr": "en-US",
                "acceptLanguage": "en-US,en;q=0.9",
                "platform": "platform_value",
                "product": "Gecko",
                "appName": "Netscape",
                "hardwareConcurrency": 4,
                "doNotTrack": false,
                "deviceType": 1,
                "mobileEmulation": false,
                "pixelRatio": "1.0",
                "maskFonts": true,
                "fontSetting": {
                    "dynamicFonts": false,
                    "fontList": [
                        "@Microsoft YaHei UI",
                        "@宋体",
                        "MS Outlook"
                    ],
                    "selectAll": false,
                    "clientRects": true,
                    "rand": false
                },
                "canvasDefType": "NOISE",
                "audio": {
                    "noise": true
                },
                "webgl": {
                    "vendor": "vendor_value",
                    "renderer": "renderer_value"
                },
                "timeZoneFillOnStart": false,
                "timeZone": "Europe/Tallinn",
                "mediaDevices": {
                    "setMediaDevices": true,
                    "videoInputs": 1,
                    "audioInputs": 4,
                    "audioOutputs": 4
                },
                "startUrl": "https://vmlogin.com/",
                "browserSettings": {
                    "pepperFlash": true,
                    "mediaStream": true,
                    "webkitSpeech": true,
                    "fakeUiForMedia": true,
                    "gpuAndPepper3D": true,
                    "ignoreCertErrors": true,
                    "audioMute": true,
                    "disableWebSecurity": true,
                    "disablePdf": true,
                    "touchEvents": true,
                    "hyperlinkAuditing": true
                },
                "localCache": {
                    "deleteCache": true,
                    "deleteCookie": true,
                    "clearCache": true,
                    "clearHistory": true
                },
                "synSettings": {
                    "synCookie": true,
                    "synBookmark": true,
                    "synHistory": true,
                    "synExtension": true,
                    "synKeepKey": true,
                    "synLastTag": true
                },
                "leakProof": {
                    "computerName": "",
                    "macAddress": "",
                    "rand" : [
                        "computerName", 
                        "macAddress"
                    ]
                },
                "browserParams": "",
                "customDns": "",
                "remoteDebug": {
                    "debuggingPort": "",
                    "logLevels": 99
                },
                "pluginFingerprint": {
                    "pluginEnable": true,
                    "list": {
                        "name": [
                            "Chrome PDF Plugin",
                            "Chrome PDF Viewer",
                            "Native Client",
                            "Shockwave Flash"
                        ],
                        "describe": [
                            "Portable Document Format",
                            "-",
                            "-",
                            "Shockwave Flash 32.0 r0"
                        ],
                        "fileName": [
                            "internal-pdf-viewer",
                            "mhjfbmdgcfjbbpaeojofohoefgiehjai",
                            "internal-nacl-plugin",
                            "pepflashplayer.dll"
                        ],
                        "mimeType": [
                            "application/x-google-chrome-pdf",
                            "application/pdf",
                            "application/x-nacl|application/x-pnacl",
                            "application/x-shockwave-flash|application/futuresplash"
                        ],
                        "mimeDescription": [
                            "Portable Document Format",
                            "-",
                            "Native Client Executable|-Portable Native Client Executable",
                            "Shockwave Flash|Shockwave Flash"
                        ],
                        "mimeExtension": [
                            "pdf",
                            "pdf",
                            "|",
                            "swf|spl"
                        ]
                    }
                },
                "unPluginFingerprint": {
                    "list": {
                        "name": [
                            "name"
                        ],
                        "describe": [
                           "describe"
                        ],
                        "fileName": [
                            "fileName"
                        ],
                        "mimeType": [
                            "mimeType"
                        ],
                        "mimeDescription": [
                            "mimeDescription"
                        ],
                        "mimeExtension": [
                            "mimeExtension"
                        ]
                    }
                },
                "browserApi": {
                    "setBatteryStatus": false,
                    "isCharging": true,
                    "chargingTime": "0",
                    "drainsTime": "Infinity",
                    "batteryPercentage": "1",
                    "autoGeoIp": false,
                    "setLatitude": false,
                    "setLongitude": false,
                    "setAccuracy": false,
                    "latitude": "51.482594",
                    "longitude": "-0.007661",
                    "accuracy": "1803.34",
                    "setWebBluetooth": false,
                    "setBluetoothAdapter": false,
                    "speechSynthesis": false,
                    "speechVoicesList": {
                        "voiceURI": [
                            "voiceURI value 1",
                            "voiceURI value 2"
                        ],
                        "name": [
                            "name value 1",
                            "name value 2"
                        ],
                        "lang": [
                            "lang value 1",
                            "lang value 2"
                        ],
                        "localService": [
                            false,
                            true
                        ],
                        "default": [
                            true,
                            false
                        ]
                    },
                    "unSpeechVoicesList": {
                        "voiceURI": [
                            "voiceURI value 3"
                        ],
                        "name": [
                            "name value 3"
                        ],
                        "lang": [
                            "lang value 3"
                        ],
                        "localService": [
                            true
                        ],
                        "default": [
                            true
                        ]
                    },
                    "speechVoicesRestoreDefault": true
                },
                "sslFingerprint":{
                    "enableCustomSSL": true,
                    "versionMin": 0,
                    "versionMax": 1,
                    "cipherSuites": {
                        "TLS_AES_128_GCM_SHA256": true,
                        "TLS_AES_256_GCM_SHA384": true,
                        "TLS_CHACHA20_POLY1305_SHA256": true,
                        "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256": true,
                        "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256": true,
                        "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384": true,
                        "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384": true,
                        "TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256": true,
                        "TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256": true,
                        "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA": true,
                        "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA": true,
                        "TLS_RSA_WITH_AES_128_GCM_SHA256": true,
                        "TLS_RSA_WITH_AES_256_GCM_SHA384": true,
                        "TLS_RSA_WITH_AES_128_CBC_SHA": true,
                        "TLS_RSA_WITH_AES_256_CBC_SHA": true,
                        "TLS_RSA_WITH_3DES_EDE_CBC_SHA": false,
                        "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA": false
                    }
                },
                "tag": "group_name"
            }
}


Detail browser profile(/profile/detail)
Name Type Description required
token string Authentication token true
profileId string Browser profile ID true

Response

{
    "name": "myProfile",
    "proxyHost": "127.0.0.1", // Obsolete. Do not use
    "proxyPort": 1080, // Obsolete. Do not use
    "proxyUser": "username", // Obsolete. Do not use
    "proxyPass": "password", // Obsolete. Do not use
    "proxyType": "HTTP", // Obsolete. Do not use
    "proxyServer": {
        "setProxyServer": true,
        "type": "HTTP",
        "password": "password",
        "username": "username",
        "port": 1080,
        "host": "127.0.0.1"
    },
    "tag": "",
    "notes": "profile notes",
    "userAgent": "user_agent_value",
    "canvasDefType": "NOISE",
    "maskFonts": true,
    "platform": "platform_value",
    "langHdr": "en-US",
    "screenHeight": 1080,
    "screenWidth": 1920,
    "timeZoneFillOnStart": false,
    "timeZone": "Europe/Tallinn",
    "startUrl": "https://vmlogin.com/",
    "audio": {
        "noise": true
    },
    "mediaDevices": {
        "setMediaDevices": true,
        "audioInputs": 4,
        "audioOutputs": 4,
        "videoInputs": 1
    },
    "webgl": {
        "noise": true,
        "vendor": "vendor_value",
        "renderer": "renderer_value"
    },
    "webRtc": {
        "type": "FAKE",
        "fillOnStart": true,
        "publicIp": "",
        "localIps": [
            "192.168.1.10"
        ]
    },
    "browserSettings": {
        "pepperFlash": true,
        "mediaStream": true,
        "webkitSpeech": true,
        "fakeUiForMedia": true,
        "gpuAndPepper3D": true,
        "ignoreCertErrors": true,
        "audioMute": true,
        "disableWebSecurity": true,
        "disablePdf": true,
        "touchEvents": true,
        "hyperlinkAuditing": true
    },
    "localCache": {
        "deleteCache": true,
        "deleteCookie": true,
        "clearCache": false,
        "clearHistory": true
    },
    "synSettings": {
        "synCookie": true,
        "synBookmark": true,
        "synHistory": true,
        "synExtension": true,
        "synKeepKey": true,
        "synLastTag": true
    },
    "leakProof": {
        "computerName": "DESKTOP-PPVAJBW",
        "macAddress": "3f:9d:82:8b:d8:a2"
    },
    "browserParams": "",
    "customDns": "",
    "remoteDebug": {
        "debuggingPort": "",
        "logLevels": 99
    },
    "pluginFingerprint": {
        "pluginEnable": false,
        "list": {
            "name": [
                "Chrome PDF Plugin",
                "Chrome PDF Viewer",
                "Native Client",
                "Shockwave Flash"
            ],
            "describe": [
                "Portable Document Format",
                "-",
                "-",
                "Shockwave Flash 32.0 r0"
            ],
            "fileName": [
                "internal-pdf-viewer",
                "mhjfbmdgcfjbbpaeojofohoefgiehjai",
                "internal-nacl-plugin",
                "pepflashplayer.dll"
            ],
            "mimeType": [
                "application/x-google-chrome-pdf",
                "application/pdf",
                "application/x-nacl|application/x-pnacl",
                "application/x-shockwave-flash|application/futuresplash"
            ],
            "mimeDescription": [
                "Portable Document Format",
                "-",
                "Native Client Executable|-Portable Native Client Executable",
                "Shockwave Flash|Shockwave Flash"
            ],
            "mimeExtension": [
                "pdf",
                "pdf",
                "|",
                "swf|spl"
            ]
        }
    },
    "unPluginFingerprint": {
        "list": {
            "name": [
                "name"
            ],
            "describe": [
                "describe"
            ],
            "fileName": [
                "fileName"
            ],
            "mimeType": [
                "mimeType"
            ],
            "mimeDescription": [
                "mimeDescription"
            ],
            "mimeExtension": [
                "mimeExtension"
            ]
        }
    },
    "browserApi": {
        "isCharging": true,
        "setBatteryStatus": false,
        "autoGeoIp": false,
        "setLatitude": false,
        "setLongitude": false,
        "setAccuracy": false,
        "setWebBluetooth": false,
        "setBluetoothAdapter": false,
        "speechSynthesis": false,
        "chargingTime": "0",
        "drainsTime": "Infinity",
        "batteryPercentage": "1",
        "latitude": "51.482594",
        "longitude": "-0.007661",
        "accuracy": "1803.34",
        "speechVoicesList": {
            "voiceURI": [
                "voiceURI value 1",
                "voiceURI value 2"
            ],
            "name": [
                "name value 1",
                "name value 2"
            ],
            "lang": [
                "lang value 1",
                "lang value 2"
            ],
            "localService": [
                false,
                true
            ],
            "default": [
                true,
                false
            ]
        },
        "unSpeechVoicesList": {
            "voiceURI": [
                "voiceURI value 3"
            ],
            "name": [
                "name value 3"
            ],
            "lang": [
                "lang value 3"
            ],
            "localService": [
                true
            ],
            "default": [
                true
            ]
        }
    },
    "sslFingerprint":{
        "enableCustomSSL": true,
        "versionMin": 0,
        "versionMax": 1,
        "cipherSuites": {
            "TLS_AES_128_GCM_SHA256": true,
            "TLS_AES_256_GCM_SHA384": true,
            "TLS_CHACHA20_POLY1305_SHA256": true,
            "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256": true,
            "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256": true,
            "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384": true,
            "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384": true,
            "TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256": true,
            "TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256": true,
            "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA": true,
            "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA": true,
            "TLS_RSA_WITH_AES_128_GCM_SHA256": true,
            "TLS_RSA_WITH_AES_256_GCM_SHA384": true,
            "TLS_RSA_WITH_AES_128_CBC_SHA": true,
            "TLS_RSA_WITH_AES_256_CBC_SHA": true,
            "TLS_RSA_WITH_3DES_EDE_CBC_SHA": false,
            "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA": false
        }
    },
    "acceptLanguage": "en-US,en;q=0.9",
    "hardwareConcurrency": 4,
    "dynamicFonts": false,
    "fontList": [
        "@Microsoft YaHei UI",
        "@宋体",
        "MS Outlook"
    ],
    "clientRects": true,
    "fontSetting": {
        "dynamicFonts": false,
        "fontList": [
            "@Microsoft YaHei UI",
            "@宋体",
            "MS Outlook"
        ],
        "clientRects": true
    },
    "doNotTrack": false,
    "product": "Gecko",
    "appName": "Netscape",
    "iconId": 0,
    "mobileEmulation": false,
    "deviceType": 1,
    "pixelRatio": "1.0",
    "os": "Windows"
}


Sharing browser profile (batch operation) (/profile/share)
Name Type Description required
token string Authentication token true
profileId string Browser profile ID (batch share, parameters splice with a comma ,) true
account string Need the account email which to be shared true

Request

{
    "token": "66e9f73f3617c6afdc6768f7a61a58ae",
    "profileId": "56795471-8dc0-414c-9d1a-794e4dd8be99,5F602D27-DE4C-498E-91DC-C05C8AC024F0",
    "account": "support@vmlogin.com"
}

Response

{
    "status": "OK",
    "value": 200
}


Browser profile unshare (batch operation) (/profile/cancelShare)
Name Type Description required
token string Authentication token true
profileId string Browser profile ID (batch share, parameters splice with a comma ,) true
account string account email true

Request

{
    "token": "66e9f73f3617c6afdc6768f7a61a58ae",
    "profileId": "56795471-8dc0-414c-9d1a-794e4dd8be99,5F602D27-DE4C-498E-91DC-C05C8AC024F0",
    "account": "support@vmlogin.com"
}

Response

{
    "status": "OK",
    "value": 200,
    "data": {
        "rows": 2
    }
}


Transfer browser profile’s ownership (batch operation) (/profile/transferOwnership)
Name Type Description required
token string Authentication token true
profileId string Browser profile ID (batch share, parameters splice with a comma ,) true
account string account email true

Request

{
    "token": "66e9f73f3617c6afdc6768f7a61a58ae",
    "profileId": "56795471-8dc0-414c-9d1a-794e4dd8be99,5F602D27-DE4C-498E-91DC-C05C8AC024F0",
    "account": "support@vmlogin.com"
}

Response

{
    "status": "OK",
    "value": 200
}


Remove browser profile(/profile/remove)
Name Type Description required
token string Authentication token true
profileId string Browser profile ID true

Request

{
    "token": "66e9f73f3617c6afdc6768f7a61a58ae",
    "profileId": "56795471-8dc0-414c-9d1a-794e4dd8be99"
}


Get a list of all available browser profiles(/profile/list)
Name Type Description required
token string Authentication token true
search string Looking for profile name(Similar) false
tag string Gather by group name(Similar) false

Request

{
    "token": "66e9f73f3617c6afdc6768f7a61a58ae"
}


Models

CreateUpdateOkResponse

{
    "status": "OK",
    "value": "56795471-8dc0-414c-9d1a-794e4dd8be99" //example: profile id
}


CreateUpdateErrorResponse

{
    "status": "ERROR",
    "value": "1024"
}


ListGroupsOkResponse

{
    "data": [
        {
            "sid": "1024",
            "name": "test"
        }
    ],
    "paging": {
        "totalCount": 1,
        "currentPage": 1
    }
}


CreateRenameGroupOkResponse

{
    "status": "OK",
    "value": "1024"
}


createProfileRequest

{
    "name": "myProfile", // Basic setup -> Display name
    "notes": "profile notes", // Basic setup -> Note
    "iconId": 0, // Basic setup -> ICON: 0 ~ 30
    "os": "Windows", // Basic setup -> System
    "proxyServer": {
        "setProxyServer": true, // Basic setup -> Setting proxy server -> Enable proxy server
        "type": "HTTP", // Basic setup -> Setting proxy server -> Proxy type (HTTP、SOCKS4、SOCKS5)
        "host": "127.0.0.1", // Basic setup -> Setting proxy server -> IP address
        "port": 1080, // Basic setup -> Setting proxy server -> Port
        "username": "hello", // Basic setup -> Setting proxy server -> Username
        "password": "world" // Basic setup -> Setting proxy server -> Password
    },
    "webRtc": {
        "type": "FAKE", // Basic setup -> WebRTC (OFF:[real mode] enable webrtc plug-in  BLOCK:[disable mode] disable webrtc plug-in  FAKE:[replacement mode] return to the specified IP)
        "fillOnStart": true, // Basic setup -> Auto detect IP
        "publicIp": "5.5.5.5", // Basic setup -> Public IP
        "localIps": [
            "192.168.1.10" // Basic setup -> Lan IP
        ],
        "localIpsRand": false // Basic setup -> Lan IP random
    },
    "userAgent": "user_agent_value", // Navigator parameters -> User-Agent
    "screenWidth": 1920, // Navigator parameters -> Resolution width
    "screenHeight": 1080, // Navigator parameters -> Resolution height
    "langHdr": "en-US", // Navigator parameters -> Language
    "acceptLanguage": "en-US,en;q=0.9", // Navigator parameters -> Accept-Language
    "platform": "platform_value", // Navigator parameters -> Platform
    "product": "Gecko", // Navigator parameters -> Product
    "appName": "Netscape", // Navigator parameters -> appName
    "hardwareConcurrency": 4, // Navigator parameters -> hardwareConcurrency (1 ~ 64)
    "doNotTrack": false, // Navigator parameters -> doNotTrack
    "mobileEmulation": false, // Navigator parameters -> mobileEmulatior
    "deviceType": 1, // Navigator parameters -> Device Type  0: Desktop  1: Mobile
    "pixelRatio": "1.0", // Navigator parameters -> Device pixel Ratio
    "maskFonts": true, // Advanced fingerprint protection settings -> Enable [font] fingerprint protection
    "fontSetting": {
        "dynamicFonts": false, // Advanced fingerprint protection settings -> Set font -> Do not use font list, every time dynamic random (false: use  true: Do not use)
        "fontList": [
            "@Microsoft YaHei UI",
            "@宋体",
            "MS Outlook"
        ],
        "selectAll": false, // Advanced fingerprint protection settings -> Set font -> Select all
        "clientRects": true, // Advanced fingerprint protection settings -> Set font -> ClientRects fingerprint protection
        "rand": false // Advanced fingerprint protection settings -> Set font -> Random font
    },
    "canvasDefType": "NOISE", // Advanced fingerprint protection settings -> [Canvas] fingerprint protection(type):NOISE:Noise mode B (A and C are compatible with the old version and are not recommended); OFF:disable; BLOCK:blocking mode
    "audio": {
        "noise": true // Advanced fingerprint protection settings -> Enable [AudioContext] fingerprint protection (noise mode)
    },
    "webgl": {
        "vendor": "vendor_value", // Advanced fingerprint protection settings -> Enable [WebGL] fingerprint protection -> WebGL vendor
        "renderer": "renderer_value" // Advanced fingerprint protection settings -> Enable [WebGL] fingerprint protection -> WebGL renderer
    },
    "timeZoneFillOnStart": false, // Advanced fingerprint protection settings -> Enable setting time zone based on IP
    "timeZone": "Europe/Tallinn", // Advanced fingerprint protection settings -> Set timezone
    "mediaDevices": {
        "setMediaDevices": false, // Media device fingerprint setting
        "videoInputs": 1, // Media device fingerprint setting -> Video input
        "audioInputs": 2, // Media device fingerprint setting -> Audio input
        "audioOutputs": 2 // Media device fingerprint setting -> Audio output
    },
    "startUrl": "https://vmlogin.com/", // 默认首页
    "browserSettings": {
        "pepperFlash": true, // Other configurations -> Enable Pepper Flash
        "mediaStream": true, // Other configurations -> Enable media (WebRTC audio/video) streaming
        "webkitSpeech": true, // Other configurations -> Enable speech input (x-webkit-speech)
        "fakeUiForMedia": true, // Other configurations -> Bypass the media stream infobar by selecting the default device for media streams
        "gpuAndPepper3D": true, // Other configurations -> Enable the GPU plugin and Pepper 3D rendering
        "ignoreCertErrors": true, // Other configurations -> ignore certificate errors
        "audioMute": true, // Other configurations -> Mutes audio
        "disableWebSecurity": true, // Other configurations -> Don't enforce the same-origin policy
        "disablePdf": true, // Other configurations -> Disable the PDF extension
        "touchEvents": true, // Other configurations -> Enable support for touch event feature detection
        "hyperlinkAuditing": true // Other configurations -> Send hyperlink auditing pings in all browsers.
    },
    "localCache": {
        "deleteCache": true, // Other configurations -> Local cache -> Delete cache file before starting browser every time
        "deleteCookie": true, // Other configurations -> Local cache -> Delete cookies before each browser launch
        "clearCache": true, // Other configurations -> Local cache -> Clean up file cache when browser is closed
        "clearHistory": true // Other configurations -> Local cache -> Delete the history when the browser is closed
    },
    "synSettings": {
        "synCookie": true, // Other configurations -> Synchronization settings -> cookies storage
        "synBookmark": true, // Other configurations -> Synchronization settings -> bookmark saving
        "synHistory": true, // Other configurations -> Synchronization settings -> history saving
        "synExtension": true, // Other configurations -> Synchronization settings -> Extension storage
        "synKeepKey": true, // Other configurations -> Synchronization settings -> password saving
        "synLastTag": true // Other configurations -> Synchronization settings -> Last Tabs saving
    },
    "leakProof": {
        "computerName": "", // Other configurations -> Leak proof setting -> Computer name
        "macAddress": "", // Other configurations -> Leak proof setting -> Mac address
        "rand" : [
            "computerName",  // Other configurations -> Leak proof setting -> Rand(Random key names are required)
            "macAddress"
        ]
    },
    "browserParams": "", // Other configurations -> Custom -> Custom launch browser parameters
    "customDns": "", // Other configurations -> Custom -> Custom DNS
    "remoteDebug": {
        "debuggingPort": "", // Other configurations -> RemoteDebugging -> RemoteDebugging port
        "logLevels": 99 // Other configurations -> RemoteDebugging -> Log Severity:0:DEFAULT 1: VERBOSE 99: DISABLE
    },
    "pluginFingerprint": { // Plugin fingerprint -> Plugin list
        "pluginEnable": true, // Plugin fingerprint -> Enable custom plug-in information
        "list": { // Plugin fingerprint -> Plugin list(selected)
            // Plugin name
            "name": [
                "Chrome PDF Plugin",
                "Chrome PDF Viewer",
                "Native Client",
                "Shockwave Flash"
            ],
            // Describe
            "describe": [
                "Portable Document Format",
                "-",
                "-",
                "Shockwave Flash 32.0 r0"
            ],
            // File name
            "fileName": [
                "internal-pdf-viewer",
                "mhjfbmdgcfjbbpaeojofohoefgiehjai",
                "internal-nacl-plugin",
                "pepflashplayer.dll"
            ],
            // mime type
            "mimeType": [
                "application/x-google-chrome-pdf",
                "application/pdf",
                "application/x-nacl|application/x-pnacl",
                "application/x-shockwave-flash|application/futuresplash"
            ],
            // Mime description
            "mimeDescription": [
                "Portable Document Format",
                "-",
                "Native Client Executable|-Portable Native Client Executable",
                "Shockwave Flash|Shockwave Flash"
            ],
            // Mime extension
            "mimeExtension": [
                "pdf",
                "pdf",
                "|",
                "swf|spl"
            ]
        }
    },
    "unPluginFingerprint": { // Plugin fingerprint -> Plugin list
        "list": { // Plugin fingerprint -> Plugin list(unselected)
            "name": [
                "name"
            ],
            "describe": [
               "describe"
            ],
            "fileName": [
                "fileName"
            ],
            "mimeType": [
                "mimeType"
            ],
            "mimeDescription": [
                "mimeDescription"
            ],
            "mimeExtension": [
                "mimeExtension"
            ]
        }
    },
    "browserApi": { // Navigator API
        "setBatteryStatus": false, // Set Battery Status API
        "isCharging": true, // Battery charging
        "chargingTime": "0", // Battery charging time ("0" "Infinity")
        "drainsTime": "Infinity", // Battery discharging time ("Infinity" "3600" "18000" "10800" "12600")
        "batteryPercentage": "1", // Battery level (0.01 ~ 1)
        "autoGeoIp": false, // Geolocation -> Fill geolocation based on IP
        "setLatitude": false, // Geolocation -> Latitude
        "setLongitude": false, // Geolocation -> Longitude
        "setAccuracy": false, // Geolocation -> Accuracy
        "latitude": "51.482594", // Geolocation -> Latitude value
        "longitude": "-0.007661", // Geolocation -> Longitude value
        "accuracy": "1803.34", // Geolocation -> Accuracy(meter)
        "setWebBluetooth": false, // Set Web Bluetooth API
        "setBluetoothAdapter": false, // Bluetooth Adapter
        "speechSynthesis": false, // Set SpeechSynthesis API
        "speechVoicesList": { // Speech Voices List(Enable)
            "voiceURI": [
                "voiceURI value 1", // string
                "voiceURI value 2"
            ],
            "name": [
                "name value 1", // string
                "name value 2"
            ],
            "lang": [
                "lang value 1", // string
                "lang value 2"
            ],
            "localService": [
                false, // boolean
                true
            ],
            "default": [
                true, // boolean
                false
            ]
        },
        "unSpeechVoicesList": { // Speech Voices List(Disable)
            "voiceURI": [
                "voiceURI value 3"
            ],
            "name": [
                "name value 3"
            ],
            "lang": [
                "lang value 3"
            ],
            "localService": [
                true
            ],
            "default": [
                true
            ]
        },
        "speechVoicesRestoreDefault": true // Speech Voices Restore Default
    },
    "sslFingerprint":{ // SSL fingerprint settings
        "enableCustomSSL": true, // Enable custom SSL fingerprinting
        "versionMin": 0, // SSL Version min  0:TLSv1    1:TLSv1.1    2:TLSv1.2    3:TLSv1.3
        "versionMax": 1, // SSL Version max  0:TLSv1.2  1:TLSv1.3
        "cipherSuites": {
            "TLS_AES_128_GCM_SHA256": true,
            "TLS_AES_256_GCM_SHA384": true,
            "TLS_CHACHA20_POLY1305_SHA256": true,
            "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256": true,
            "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256": true,
            "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384": true,
            "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384": true,
            "TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256": true,
            "TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256": true,
            "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA": true,
            "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA": true,
            "TLS_RSA_WITH_AES_128_GCM_SHA256": true,
            "TLS_RSA_WITH_AES_256_GCM_SHA384": true,
            "TLS_RSA_WITH_AES_128_CBC_SHA": true,
            "TLS_RSA_WITH_AES_256_CBC_SHA": true,
            "TLS_RSA_WITH_3DES_EDE_CBC_SHA": false,
            "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA": false
        }
    },
    "tag": "group_name" // Group Name
}


devicesOS

{
    "os": [
        "Windows",
        "Mac OS",
        "Linux",
        "iPad",
        "iPad Mini",
        "iPad Pro",
        "iPhone 4",
        "iPhone 5",
        "iPhone 5/SE",
        "iPhone SE",
        "iPhone 6",
        "iPhone 6/7/8",
        "iPhone 6 Plus",
        "iPhone 6/7/8 Plus",
        "iPhone 7",
        "iPhone 7 Plus",
        "iPhone 8",
        "iPhone 8 Plus",
        "iPhone X",
        "Laptop with touch",
        "BlackBerry Z30",
        "Blackberry PlayBook",
        "Nexus 4",
        "Nexus 5",
        "Nexus 5X",
        "Nexus 6",
        "Nexus 6P",
        "Nexus 7",
        "Nexus 10",
        "Pixel 2",
        "Pixel 2 XL",
        "Nokia N9",
        "Nokia Lumia 520",
        "Microsoft Lumia 550",
        "Microsoft Lumia 950",
        "Galaxy S5",
        "Galaxy S III",
        "Galaxy Note II",
        "Galaxy Note 3",
        "Kindle Fire HDX",
        "LG Optimus L70"
    ]
}


acceptLanguage

{
    "acceptLanguage": [
        "en-US,en;q=0.9",
        "zh-CN,zh;q=0.9",
        "en-GB,en;q=0.9",
        "zh-HK,zh;q=0.9",
        "zh-TW,zh;q=0.9",
        "zh-MO,zh;q=0.9",
        "zh-SG,zh;q=0.9",
        "ja-JP,ja;q=0.9",
        "ko-KR,ko;q=0.9",
        "fr-FR,fr;q=0.9",
        "ru-RU,ru;q=0.9",
        "en-SG,en;q=0.9",
        "en-JM,en;q=0.9",
        "en-MY,en;q=0.9",
        "en-ZW,en;q=0.9",
        "en-CA,en;q=0.9",
        "en-PH,en;q=0.9",
        "en-BZ,en;q=0.9",
        "en-AU,en;q=0.9",
        "en-IE,en;q=0.9",
        "vi-VN,vi;q=0.9",
        "en-IN,en;q=0.9",
        "de-DE,de;q=0.9",
        "de-LU,de;q=0.9",
        "da-DK,de;q=0.9",
        "fr-BE,fr;q=0.9",
        "fr-CA,fr;q=0.9",
        "fr-LU,fr;q=0.9",
        "fr-MC,fr;q=0.9",
        "fr-CH,fr;q=0.9",
        "fil-PH,fil;q=0.9",
        "id-ID,id;q=0.9",
        "it-CH,it;q=0.9",
        "it-IT,it;q=0.9",
        "el-GR,el;q=0.9",
        "es-CL,es;q=0.9",
        "es-PE,es;q=0.9",
        "es-CO,es;q=0.9",
        "es-PA,es;q=0.9",
        "es-VE,es;q=0.9",
        "es-UY,es;q=0.9",
        "es-ES,es;q=0.9",
        "uk-UA,uk;q=0.9",
        "tr-TR,tr;q=0.9",
        "sv-FI,sv;q=0.9",
        "sv-SE,sv;q=0.9"
    ]
}


fontList

{
    "fontList": [
        "@Fixedsys",
        "@Malgun Gothic",
        "@Malgun Gothic Semilight",
        "@Microsoft JhengHei",
        "@Microsoft JhengHei Light",
        "@Microsoft JhengHei UI",
        "@Microsoft JhengHei UI Light",
        "@Microsoft YaHei UI",
        "@Microsoft YaHei UI Light",
        "@MingLiU_HKSCS-ExtB",
        "@MingLiU-ExtB",
        "@MS Gothic",
        "@MS PGothic",
        "@MS UI Gothic",
        "@PMingLiU-ExtB",
        "@SimSun-ExtB",
        "@System",
        "@Terminal",
        "@Yu Gothic",
        "@Yu Gothic Light",
        "@Yu Gothic Medium",
        "@Yu Gothic UI",
        "@Yu Gothic UI Light",
        "@Yu Gothic UI Semibold",
        "@Yu Gothic UI Semilight",
        "@等线",
        "@等线 Light",
        "@方正舒体",
        "@方正姚体",
        "@仿宋",
        "@黑体",
        "@华文彩云",
        "@华文仿宋",
        "@华文行楷",
        "@华文琥珀",
        "@华文楷体",
        "@华文隶书",
        "@华文宋体",
        "@华文细黑",
        "@华文新魏",
        "@华文中宋",
        "@楷体",
        "@隶书",
        "@宋体",
        "@微软雅黑",
        "@微软雅黑 Light",
        "@新宋体",
        "@幼圆",
        "Agency FB",
        "Algerian",
        "Arial",
        "Arial Black",
        "Arial Narrow",
        "Arial Rounded MT Bold",
        "Bahnschrift",
        "Bahnschrift Condensed",
        "Bahnschrift Light",
        "Bahnschrift Light Condensed",
        "Bahnschrift Light SemiCondensed",
        "Bahnschrift SemiBold",
        "Bahnschrift SemiBold Condensed",
        "Bahnschrift SemiBold SemiConden",
        "Bahnschrift SemiCondensed",
        "Bahnschrift SemiLight",
        "Bahnschrift SemiLight Condensed",
        "Bahnschrift SemiLight SemiConde",
        "Baskerville Old Face",
        "Bauhaus ",
        "Bell MT",
        "Berlin Sans FB",
        "Berlin Sans FB Demi",
        "Bernard MT Condensed",
        "Blackadder ITC",
        "Bodoni MT",
        "Bodoni MT Black",
        "Bodoni MT Condensed",
        "Bodoni MT Poster Compressed",
        "Book Antiqua",
        "Bookman Old Style",
        "Bookshelf Symbol ",
        "Bradley Hand ITC",
        "Britannic Bold",
        "Broadway",
        "Brush Script MT",
        "Calibri",
        "Calibri Light",
        "Californian FB",
        "Calisto MT",
        "Cambria",
        "Cambria Math",
        "Candara",
        "Candara Light",
        "Castellar",
        "Centaur",
        "Century",
        "Century Gothic",
        "Century Schoolbook",
        "Chiller",
        "Colonna MT",
        "Comic Sans MS",
        "Consolas",
        "Constantia",
        "Cooper Black",
        "Copperplate Gothic Bold",
        "Copperplate Gothic Light",
        "Corbel",
        "Corbel Light",
        "Courier",
        "Courier New",
        "Curlz MT",
        "Default",
        "DejaVu Sans Mono",
        "Dubai",
        "Dubai Light",
        "Dubai Medium",
        "Ebrima",
        "Edwardian Script ITC",
        "Elephant",
        "Engravers MT",
        "Eras Bold ITC",
        "Eras Demi ITC",
        "Eras Light ITC",
        "Eras Medium ITC",
        "Felix Titling",
        "Fixedsys",
        "Footlight MT Light",
        "Forte",
        "Franklin Gothic Book",
        "Franklin Gothic Demi",
        "Franklin Gothic Demi Cond",
        "Franklin Gothic Heavy",
        "Franklin Gothic Medium",
        "Franklin Gothic Medium Cond",
        "Freestyle Script",
        "French Script MT",
        "Gabriola",
        "Gadugi",
        "Garamond",
        "Georgia",
        "Gigi",
        "Gill Sans MT",
        "Gill Sans MT Condensed",
        "Gill Sans MT Ext Condensed Bold",
        "Gill Sans Ultra Bold",
        "Gill Sans Ultra Bold Condensed",
        "Gloucester MT Extra Condensed",
        "Goudy Old Style",
        "Goudy Stout",
        "Haettenschweiler",
        "Harlow Solid Italic",
        "Harrington",
        "High Tower Text",
        "HoloLens MDL Assets",
        "HP Simplified",
        "HP Simplified Light",
        "Impact",
        "Imprint MT Shadow",
        "Informal Roman",
        "Ink Free",
        "Javanese Text",
        "jdFontAwesome",
        "jdFontCustom",
        "jdIcoFont",
        "jdIcoMoonFree",
        "jdiconfontA",
        "jdiconfontB",
        "jdiconfontC",
        "jdiconfontD",
        "JdIonicons",
        "Jokerman",
        "Juice ITC",
        "Kristen ITC",
        "Kunstler Script",
        "Leelawadee UI",
        "Leelawadee UI Semilight",
        "Lucida Bright",
        "Lucida Calligraphy",
        "Lucida Console",
        "Lucida Fax",
        "Lucida Handwriting",
        "Lucida Sans",
        "Lucida Sans Typewriter",
        "Lucida Sans Unicode",
        "Magneto",
        "Maiandra GD",
        "Malgun Gothic",
        "Malgun Gothic Semilight",
        "Marlett",
        "Matura MT Script Capitals",
        "Microsoft Himalaya",
        "Microsoft JhengHei",
        "Microsoft JhengHei Light",
        "Microsoft JhengHei UI",
        "Microsoft JhengHei UI Light",
        "Microsoft New Tai Lue",
        "Microsoft PhagsPa",
        "Microsoft Sans Serif",
        "Microsoft Tai Le",
        "Microsoft YaHei UI",
        "Microsoft YaHei UI Light",
        "Microsoft Yi Baiti",
        "MingLiU_HKSCS-ExtB",
        "MingLiU-ExtB",
        "Mistral",
        "Modern",
        "Modern No. ",
        "Monaco",
        "Mongolian Baiti",
        "Monotype Corsiva",
        "MS Gothic",
        "MS Outlook",
        "MS PGothic",
        "MS Reference Sans Serif",
        "MS Reference Specialty",
        "MS Sans Serif",
        "MS Serif",
        "MS UI Gothic",
        "MT Extra",
        "MV Boli",
        "Myanmar Text",
        "Niagara Engraved",
        "Niagara Solid",
        "Nirmala UI",
        "Nirmala UI Semilight",
        "OCR A Extended",
        "Old English Text MT",
        "Onyx",
        "Palace Script MT",
        "Palatino Linotype",
        "Papyrus",
        "Parchment",
        "Perpetua",
        "Perpetua Titling MT",
        "Playbill",
        "PMingLiU-ExtB",
        "Poor Richard",
        "Pristina",
        "Rage Italic",
        "Ravie",
        "Rockwell",
        "Rockwell Condensed",
        "Rockwell Extra Bold",
        "Roman",
        "Script",
        "Script MT Bold",
        "Segoe MDL Assets",
        "Segoe Print",
        "Segoe Script",
        "Segoe UI",
        "Segoe UI Black",
        "Segoe UI Emoji",
        "Segoe UI Historic",
        "Segoe UI Light",
        "Segoe UI Semibold",
        "Segoe UI Semilight",
        "Segoe UI Symbol",
        "Showcard Gothic",
        "SimSun-ExtB",
        "Sitka Banner",
        "Sitka Display",
        "Sitka Heading",
        "Sitka Small",
        "Sitka Subheading",
        "Sitka Text",
        "Small Fonts",
        "Snap ITC",
        "Stencil",
        "Sylfaen",
        "Symbol",
        "System",
        "Tahoma",
        "Tempus Sans ITC",
        "Terminal",
        "Times New Roman",
        "Trebuchet MS",
        "Tw Cen MT",
        "Tw Cen MT Condensed",
        "Tw Cen MT Condensed Extra Bold",
        "Verdana",
        "Viner Hand ITC",
        "Vivaldi",
        "Vladimir Script",
        "Webdings",
        "Wide Latin",
        "Wingdings",
        "Wingdings ",
        "Wingdings ",
        "Yu Gothic",
        "Yu Gothic Light",
        "Yu Gothic Medium",
        "Yu Gothic UI",
        "Yu Gothic UI Light",
        "Yu Gothic UI Semibold",
        "Yu Gothic UI Semilight",
        "等线",
        "等线 Light",
        "方正舒体",
        "方正姚体",
        "仿宋",
        "黑体",
        "华文彩云",
        "华文仿宋",
        "华文行楷",
        "华文琥珀",
        "华文楷体",
        "华文隶书",
        "华文宋体",
        "华文细黑",
        "华文新魏",
        "华文中宋",
        "楷体",
        "隶书",
        "宋体",
        "微软雅黑",
        "微软雅黑 Light",
        "新宋体",
        "幼圆"
    ]
}


acceptLanguage

{
    "hardwareConcurrency": 
}

ListProfilesOkResponse

{
    "data": [
        {
            "sid": "56795471-8dc0-414c-9d1a-794e4dd8be99",
            "name": "testProfile",
            "tag": "Default group"
        }
    ],
    "paging": {
        "totalCount": 1,
        "currentPage": 1
    }
}



VMLogin Local REST API

[ Base URL: http://127.0.0.1:35000/api/v1 ]

You can use Local REST API endpoints in order to start/stop, check if a profile is running,create the browser profile file locally and start.

Type Description API SOLO TEAM SCALE CUSTOM
GET Launch the browser profile /profile/start
GET Stop the browser profile /profile/stop
GET Refresh the profile browser /profile/refresh
GET Open the specified page on the current tabs /profile/openurl
GET Get webpage source code /profile/source
GET Find Element /profile/findElement
GET Get Attribute /profile/getAttribute
GET Send the file to the webpage /profile/sendKeys
GET Check the profile is running correctly /profile/active
GET Get a random profile information /profile/randomProfile
GET Delete a profile of local TEMP folder /profile/delete
POST Create the local profile and launch it /profile/create_start × ×
GET Export the cookies from profile /profile/cookies/export/webext
POST Import cookie to browser profile /profile/cookies/import/webext
POST Execute Script /profile/ExecuteScript
POST Screen Shot /profile/ScreenShot
Launch the browser profile(/profile/start)
Name Type Description required
profileId string Browser profile ID true
skiplock boolean Start the browser by skipping the session lock false

Request

{
    "profileId": "7B4B05BA-8050-4236-B26B-06E4464CA287",
    "skiplock": true
}


Stop the browser profile(/profile/stop)
Name Type Description required
profileId string Browser profile ID true

Request

{
    "profileId": "7B4B05BA-8050-4236-B26B-06E4464CA287"
}


Refresh the browser profile(/profile/refresh)
Name Type Description required
profileId string Browser profile ID true

Body
x-www-form-urlencoded

{
    "profileId": "7B4B05BA-8050-4236-B26B-06E4464CA287"
}

Response

{
    "status": "OK",
    "value": "7B4B05BA-8050-4236-B26B-06E4464CA287"
}


Open the specified page on the current tabs(/profile/openurl)
Name Type Description required
profileId string Browser profile ID true
url string url true

Body
x-www-form-urlencoded

{
    "profileId": "7B4B05BA-8050-4236-B26B-06E4464CA287",
    "url": "www.vmlogin.com"
}

Response

{
    "status": "OK",
    "value": "www.vmlogin.com"
}


Get webpage source code(/profile/source)
Name Type Description required
profileId string Browser profile ID true

Body
x-www-form-urlencoded

{
    "profileId": "7B4B05BA-8050-4236-B26B-06E4464CA287"
}

Response

{
    "status": "OK",
    "value": "<html ...>"
}


Find Element(/profile/findElement)
Name Type Description required
profileId string Browser profile ID true
function string function true
args string args is a parameter of function, example: findElementByID(args) true
click string Whether to click after finding the specified element true:Click false:No Click true
index string When there are multiple elements, specify which element to click. Starting at 0, minus 1 is one of the random elements, Used with ‘click = true’ true

Body
x-www-form-urlencoded

{
    "profileId": "7B4B05BA-8050-4236-B26B-06E4464CA287",
    "function": "findElementByID",
    "args": "kw",
    "click": "false",
    "index": "-1"
}


Get Attribute(/profile/getAttribute)
Name Type Description required
profileId string Browser profile ID true
args string Generally, it is a JSON string formed by combining the Element_ID obtained after finding the element through findElement. example: [{“ELEMENT”: “95365abe-6746-4703-8cfd-6316580f5289”, “element-6066-11e4-a52e-4f735466cecf”: “95365abe-6746-4703-8cfd-6316580f5289”}, “value”] This is the value of 95365abe-6746-4703-8cfd-6316580f5289 element. true

Body
x-www-form-urlencoded

{
    "profileId": "7B4B05BA-8050-4236-B26B-06E4464CA287",
    "args": "[{\"ELEMENT\": \"95365abe-6746-4703-8cfd-6316580f5289\", \"element-6066-11e4-a52e-4f735466cecf\": \"95365abe-6746-4703-8cfd-6316580f5289\"}, \"style\"]"
}


Send the file to the webpage(/profile/sendKeys)
Name Type Description required
profileId string Browser profile ID true
elementId string The elementId obtained by finding the element through findElement true
value string Send a string to this web control true

Body
x-www-form-urlencoded

{
    "profileId": "7B4B05BA-8050-4236-B26B-06E4464CA287",
    "elementId": "95365abe-6746-4703-8cfd-6316580f5289",
    "value": "vmlogin"
}


Check the profile is running correctly(/profile/active)
Name Type Description required
profileId string Browser profile ID true

Request

{
    "profileId": "7B4B05BA-8050-4236-B26B-06E4464CA287"
}


Get a random profile information(/profile/randomProfile)
Name Type Description required
platform string Windows Linux Macintosh Android iPhone Chrome Firefox Edge true
langHdr string en-US false
acceptLanguage string en-US,en;q=0.9 false
timeZone string America/New_York false

Request

{
    "platform": "Windows",
    "langHdr": "en-US",
    "acceptLanguage": "en-US,en;q=0.9",
    "timeZone": "America/New_York"
}


Delete a profile of local TEMP folder(/profile/delete)
Name Type Description required
profileId string Browser profile ID true

Request

{
    "profileId": "7B4B05BA-8050-4236-B26B-06E4464CA287"
}


Create the local profile and launch it(/profile/create_start)

Request (need base64 encode)

base64_encode({
    "proxyHost": "127.0.0.1",
    "proxyPort": 1080,
    "proxyUser": "username",
    "proxyPass": "password",
    "proxyType": "HTTP", // HTTP/SOCKS4/SOCKS5
    "userAgent": "user_agent_value",
    "disablePlugins": true,
    "canvasDefType": "NOISE", // NOISE/OFF/BLOCK
    "maskFonts": true,
    "platform": "platform_value",
    "appVersion": "app_version_value",
    "langHdr": "en-US",
    "screenHeight": 900,
    "screenWidth": 1000,
    "timeZone": "Europe/Tallinn",
    "timeZoneFillOnStart": true,
    "startUrl": "https://vmlogin.com/",
    "acceptLanguage":"en-US,en;q=0.9",
    "autoGeo_ip": false,
    "mobileEmulation": false,
    "deviceType": 1,
    "customdns": "8.8.8.8",
    "audio": {
        "noise": true
    },
    "mediaDevices": {
        "audioInputs": 3,
        "audioOutputs": 2,
        "videoInputs": 1
    },
    "webgl": {
        "noise": true,
        "vendor": "vendor_value",
        "renderer": "renderer_value"
    },
    "webRtc": {
        "type": "FAKE",
        "fillOnStart": true,
        "publicIp": "6.6.6.6",
        "localIps": "192.168.1.100"
    }
})

If you do not need to set up the proxy server, remove proxyType/proxyHost/proxyPort/proxyUser/proxyPass.
All fields are optional and not required. The browser profile file created by this API is temporarily offline and will not be synchronized to the server.

Export the cookies from profile(/profile/cookies/export/webext)
Name Type Description required
profileId string Browser profile ID true

Request

{
    "profileId": "7B4B05BA-8050-4236-B26B-06E4464CA287"
}


Name Type Description required
profileId string Browser profile ID true
body string cookie json (need base64 encode ) true

Request

{
    "profileId": "7B4B05BA-8050-4236-B26B-06E4464CA287",
    "body": [
                {
                    "hostOnly": false,
                    "secure": false,
                    "httpOnly": false,
                    "domain": ".vmlogin.com",
                    "session": false,
                    "expirationDate": 1620743803,
                    "value": "Xrli9YsFVTw.0AAAEC",
                    "path": "\/",
                    "name": "CMID",
                    "storeId": null,
                    "sameSite": "unspecified"
                },
                {
                    "hostOnly": false,
                    "secure": false,
                    "httpOnly": false,
                    "domain": ".vmlogin.com",
                    "session": false,
                    "expirationDate": 1596983803,
                    "value": "9960",
                    "path": "\/",
                    "name": "CMPRO",
                    "storeId": null,
                    "sameSite": "unspecified"
                }
            ]
}


Execute Script(/profile/ExecuteScript)
Name Type Description required
profileId string Browser profile ID true
body string js code (need base64 encode) true

Body
x-www-form-urlencoded

{
    "profileId": "7B4B05BA-8050-4236-B26B-06E4464CA287",
    "body": "js code..."
}


Screen Shot(/profile/ScreenShot)
Name Type Description required
profileId string Browser profile ID true
body string Absolute path address of image resource (need base64 encode) true

Body
x-www-form-urlencoded

{
    "profileId": "7B4B05BA-8050-4236-B26B-06E4464CA287",
    "body": "d:\myscreenshot.png"
}


Models

FindElement

{
    "findElement": [
        "findElementByID",
        "findElementByTag",
        "findElementByClassName",
        "findElementByLinkText",
        "findElementByXPath",
        "findElementsByID",
        "findElementsByTag",
        "findElementsByClassName",
        "findElementsByLinkText",
        "findElementsByXPath"
    ]
}


ExportImportCookiesOkResponse

{
    "status": "OK",
    "value": "base64 encode cookie json"
}


ExportImportCookiesErrorResponse

{
    "status": "ERROR",
    "value": "No profile file cookie found." // example: error details
}


ConfigurationInformationRandomOkResponse

{
    "screenHeight": 1080,
    "clientRects": true,
    "appName": "Netscape",
    "timeZone": "Asia\/Shanghai",
    "product": "Gecko",
    "timeZoneFillOnStart": true,
    "dynamicFonts": true,
    "browserSettings": {
        "hyperlinkAuditing": true,
        "touchEvents": false,
        "gpuAndPepper3D": true,
        "ignoreCertErrors": false,
        "fakeUiForMedia": true,
        "webkitSpeech": true,
        "audioMute": false,
        "disableWebSecurity": false,
        "mediaStream": true,
        "disablePdf": false,
        "pepperFlash": false
    },
    "canvasDefType": "NOISE",
    "mediaDevices": {
        "videoInputs": 1,
        "audioInputs": 2,
        "audioOutputs": 1
    },
    "doNotTrack": false,
    "acceptLanguage": "zh-CN,zh;q=0.9",
    "maskFonts": true,
    "webgl": {
        "renderer": "Microsoft Basic Render Driver",
        "noise": true,
        "vendor": "Microsoft"
    },
    "langHdr": "zh-CN",
    "pluginFingerprint": {
        "pluginEnable": false
    },
    "screenWidth": 1920,
    "userAgent": "Mozilla\/5.0 (Windows NT 6.1; WOW64; Trident\/7.0; rv:11.0) like Gecko",
    "audio": {
        "noise": true
    },
    "platform": "Win64",
    "webRtc": {
        "localIps": [
            "172.16.238.250"
        ],
        "publicIp": "45.121.210.192",
        "type": "BLOCK",
        "fillOnStart": false
    },
    "hardwareConcurrency": 6
}