![](\"https://releases.octobrowser.net/doc/05-client-token.png\")
\n\nUp to 100 profiles per request allowed.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"08c74e9e-43d6-46d9-a689-b78e19d29a0c","id":"08c74e9e-43d6-46d9-a689-b78e19d29a0c","name":"Profiles","type":"folder"}},"urlObject":{"path":["api","v2","automation","profiles","import"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"b5c38939-4f5c-46f1-a258-3542554a23d7","name":"Import profiles encoded string","originalRequest":{"method":"POST","header":[{"key":"X-Octo-Api-Token","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"data\": [\r\n \"JGFlc19nY20kJE1mUk9tVS5KUGhrZmZyeGVCcGpzQ1VDa2xOUWRtcGdtVXc2WGdnMldqNWU5bFdHcGFnME5LSzZQa1BZLndsdnZEMWRZdHRudG5GdW5xakk5aUxyRWIycHhWdw==\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"//api/v2/automation/profiles/import"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn/20.0.4"},{"key":"Date","value":"Tue, 28 Nov 2023 13:16:44 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"70"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"Profiles imported successfully\",\n \"data\": {\n \"failed\": []\n }\n}"},{"id":"67f64c25-b1f9-43b3-9984-9a706aa64bc7","name":"Import profiles new file","originalRequest":{"method":"POST","header":[{"key":"X-Octo-Api-Token","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"data\": [\r\n {\r\n\t\t\t\"uuid\": \"761c6c15b2e44545851061555c665319\",\r\n\t\t\t\"title\": \"[Imported] Quick bouncy-reception\",\r\n\t\t\t\"data\": \"JGFlc19nY20kJE1mUk9tVS5KUGhrZmZyeGVCcGpzQ1VDa2xOUWRtcGdtVXc2WGdnMldqNWU5bFdHcGFnME5LSzZQa1BZLndsdnZEMWRZdHRudG5GdW5xakk5aUxyRWIycHhWdw==\"\r\n\t\t}\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"//api/v2/automation/profiles/import"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn/20.0.4"},{"key":"Date","value":"Tue, 28 Nov 2023 13:16:44 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"70"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"Profiles imported successfully\",\n \"data\": {\n \"failed\": []\n }\n}"},{"id":"ddad1824-d8a2-4705-ba7d-7e25e3246384","name":"Import profiles old file","originalRequest":{"method":"POST","header":[{"key":"X-Octo-Api-Token","value":""},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"data\": [\r\n {\r\n\t\t\t\"data\": \"{\\\"title\\\": \\\"[Imported] Quick rosy-chairlift\\\", \\\"exported_at\\\": \\\"2023-12-06 08:58:38\\\", \\\"profile\\\": \\\"gAAAAABlcDhTKzTeRIj2pGHBg-zJggNGMsekvt2DT47uM_iZYua9yoEmov0x3ZQKOu-XSWjgMGLL3CAC8rN92zyj-qOBVw3bnA==\\\"}\",\r\n\t\t\t\"signature\": \"MEUCIQD4ynaphY6R0TjQPz6hb5cmPaN5W+5pguRT65a6KB4r/gIgDOOcLfRvhrmeYHSpRIKSnjaziXM6lrS1OvVm86vxKVk=\"\r\n\t\t}\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"//api/v2/automation/profiles/import"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn/20.0.4"},{"key":"Date","value":"Tue, 28 Nov 2023 13:16:44 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"70"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"Profiles imported successfully\",\n \"data\": {\n \"failed\": []\n }\n}"}],"_postman_id":"d888f029-5c6e-458b-b115-cb75f2c7cb71"},{"name":"Set Profiles Password","id":"0a9bb446-d261-4282-a05c-55d2aa2e7e54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Octo-Api-Token","value":"Set password for profiles by given list of profiles uuids. In case of setting new password it is necessary to provide old password.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"08c74e9e-43d6-46d9-a689-b78e19d29a0c","id":"08c74e9e-43d6-46d9-a689-b78e19d29a0c","name":"Profiles","type":"folder"}},"urlObject":{"path":["api","v2","automation","profiles","set_password"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"4a8db2a7-29ee-4efe-b0ea-eb52af335dc8","name":"Set Profiles Password","originalRequest":{"method":"POST","header":[{"key":"X-Octo-Api-Token","value":"Unset password for profile by given profile uuid. Password required.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"08c74e9e-43d6-46d9-a689-b78e19d29a0c","id":"08c74e9e-43d6-46d9-a689-b78e19d29a0c","name":"Profiles","type":"folder"}},"urlObject":{"path":["api","v2","automation","profiles",":uuid","clear_password"],"host":["/"],"query":[],"variable":[{"id":"362fd00c-23df-4ae5-8373-1442bceaf3d3","description":{"content":"Profile UUID
\n","type":"text/plain"},"type":"any","value":"","key":"uuid"}]}},"response":[{"id":"28e59298-5f41-48d0-a8d9-381624f7c517","name":"Clear Profile Password","originalRequest":{"method":"POST","header":[{"key":"X-Octo-Api-Token","value":"API Token
\n","key":"X-Octo-Api-Token","value":""}],"url":"//api/v2/automation/tags","urlObject":{"path":["api","v2","automation","tags"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"d467fad7-5c3c-46b8-83af-a57576be6c30","name":"Get Tags","originalRequest":{"method":"GET","header":[{"key":"X-Octo-Api-Token","value":""}],"url":"//api/v2/automation/tags"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"\",\n \"data\": [\n {\n \"uuid\": \"3524ff6e3f0245ffbbcb5ea3d0446a8e\",\n \"name\": \"aaaa\",\n \"color\": \"grey\"\n },\n {\n \"uuid\": \"07fd5038fc0743cd955d963a19edb3d9\",\n \"name\": \"facebook\",\n \"color\": \"blue\"\n },\n {\n \"uuid\": \"ab1391ce01aa46fcbdd9d02a4569bec4\",\n \"name\": \"google\",\n \"color\": \"yellow\"\n },\n {\n \"uuid\": \"7891009afee84952a926b03e7bc0af52\",\n \"name\": \"octo\",\n \"color\": \"orange\"\n }\n ]\n}"}],"_postman_id":"5f552375-0eeb-4dd8-a479-75c0ad44aa60"},{"name":"Create Tag","id":"9fe015c7-31b0-495c-b80b-9682544a718e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Octo-Api-Token","value":""}],"body":{"mode":"raw","raw":"{\n \"name\": \"supertag\",\n \"color\": \"blue\" //optional\n}"},"url":"//api/v2/automation/tags","description":"Available colors for tags:
grey blue cyan orange green purple red yellow
API Token
\n","key":"X-Octo-Api-Token","value":""}],"url":"//api/v2/automation/tags/:uuid","urlObject":{"path":["api","v2","automation","tags",":uuid"],"host":["/"],"query":[],"variable":[{"description":{"content":"Tag UUID
\n","type":"text/plain"},"type":"any","value":"8e7c08beb89f4366aa854bdbd7473702","key":"uuid"}]}},"response":[{"id":"17a853bd-c606-4742-9959-73f573d8ce45","name":"Remove Tag","originalRequest":{"method":"DELETE","header":[{"key":"X-Octo-Api-Token","value":""}],"url":{"raw":"//api/v2/automation/tags/:uuid","host":["/"],"path":["api","v2","automation","tags",":uuid"],"variable":[{"key":"uuid","value":"8e7c08beb89f4366aa854bdbd7473702","description":"Tag UUID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"\",\n \"data\": \"\"\n}"}],"_postman_id":"77e37e26-8bf5-42d8-8847-18b662c4d329"},{"name":"Update Tag","id":"8a48ebbe-bad8-444c-b531-f021a66751fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"description":"API Token
\n","key":"X-Octo-Api-Token","value":""}],"body":{"mode":"raw","raw":"{\n \"name\": \"supertag1\",\n \"color\": \"orange\" //optional\n}"},"url":"//api/v2/automation/tags/:uuid","urlObject":{"path":["api","v2","automation","tags",":uuid"],"host":["/"],"query":[],"variable":[{"description":{"content":"Tag UUID
\n","type":"text/plain"},"type":"any","value":"8e7c08beb89f4366aa854bdbd7473702","key":"uuid"}]}},"response":[{"id":"f4f58cd1-0d33-4fd1-85c6-8b3b1a32fceb","name":"Update Tag","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Octo-Api-Token","value":""}],"body":{"mode":"raw","raw":"{\n \"name\": \"supertag1\",\n \"color\": \"orange\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"//api/v2/automation/tags/:uuid","host":["/"],"path":["api","v2","automation","tags",":uuid"],"variable":[{"key":"uuid","value":"8e7c08beb89f4366aa854bdbd7473702","description":"Tag UUID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"\",\n \"data\": {\n \"uuid\": \"ab003313e690425cb1f01e67b9b3a5da\",\n \"name\": \"supertag1\",\n \"color\": \"orange\"\n }\n}"}],"_postman_id":"8a48ebbe-bad8-444c-b531-f021a66751fe"}],"id":"09c7c94f-0033-4b7c-b71f-3a064f00776a","_postman_id":"09c7c94f-0033-4b7c-b71f-3a064f00776a","description":""},{"name":"Proxies","item":[{"name":"Get Proxies","id":"07a33d6b-e154-45d2-83ed-dc86bdf3e144","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"API Token
\n","key":"X-Octo-Api-Token","value":""}],"url":"//api/v2/automation/proxies","urlObject":{"path":["api","v2","automation","proxies"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"89ab0403-cd64-49f2-9bdb-b45d52b930b3","name":"Get Proxies","originalRequest":{"method":"GET","header":[{"description":"API Token","key":"X-Octo-Api-Token","value":""}],"url":"//api/v2/automation/proxies"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 19 Sep 2022 11:13:49 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"access-control-allow-origin","value":"*","enabled":true},{"key":"retry-after","value":"60","enabled":true},{"key":"x-ratelimit-limit","value":"250","enabled":true},{"key":"x-ratelimit-remaining","value":"249","enabled":true},{"key":"x-ratelimit-reset","value":"1663586090","enabled":true},{"key":"CF-Cache-Status","value":"DYNAMIC","enabled":true},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=0q27NDr%2BFV7CHzqNtnm97%2BmsquMdyvLExyYNnzcuFlO%2FpKCSsD5a11MUYsdiV6QKIDZ%2F6TbLWuEeetWiKHH3Z5Q7XWlOSO9%2Fs0nxThs60BJl6YsnoDm81NqjoyLa5BzBQv4O1CY%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}","enabled":true},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}","enabled":true},{"key":"Server","value":"cloudflare","enabled":true},{"key":"CF-RAY","value":"74d1e4e98cee9d4f-DME","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"\",\n \"data\": [\n {\n \"uuid\": \"963d30cb2d7247c89da222c8a9dcab29\",\n \"type\": \"socks5\",\n \"port\": 29801,\n \"host\": \"localhost\",\n \"login\": \"some_login\",\n \"password\": \"some_password\",\n \"change_ip_url\": \"https://localhost/api/v1/change-ip?uuid=c26dc4d6-0de7-4aeb-bbef-de3d98362f4e\",\n \"external_id\": null,\n \"profiles_count\": 0,\n \"title\": \"example proxy\"\n }\n ]\n}"}],"_postman_id":"07a33d6b-e154-45d2-83ed-dc86bdf3e144"},{"name":"Create Proxy","id":"e9a733e7-11c7-43b7-95d0-85b6ad338588","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"description":"API Token
\n","key":"X-Octo-Api-Token","value":""}],"body":{"mode":"raw","raw":"{\n \"type\": \"socks\",\n \"host\": \"localhost\",\n \"port\": 1081,\n \"login\": \"user\", // [optional]\n \"password\": \"secret111\", // [optional]\n \"title\": \"super proxy\",\n \"change_ip_url\": \"http://example.com\", // [optional]\n \"external_id\": \"12345\" // [optional]\n}","options":{"raw":{"language":"json"}}},"url":"//api/v2/automation/proxies","urlObject":{"path":["api","v2","automation","proxies"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"71331bc8-2355-464e-bb63-3b4dc94271f8","name":"Create Proxy","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"description":"API Token","key":"X-Octo-Api-Token","value":""}],"body":{"mode":"raw","raw":"{\n \"type\": \"socks\",\n \"host\": \"localhost\",\n \"port\": 1081,\n \"login\": \"user\",\n \"password\": \"secret111\",\n \"title\": \"super proxy\",\n \"change_ip_url\": \"http://localhost:1082/change_ip\",\n \"external_id\": \"my_custom_id=1\"\n}","options":{"raw":{"language":"json"}}},"url":"//api/v2/automation/proxies"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 19 Sep 2022 11:16:26 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"306","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"access-control-allow-origin","value":"*","enabled":true},{"key":"retry-after","value":"60","enabled":true},{"key":"x-ratelimit-limit","value":"250","enabled":true},{"key":"x-ratelimit-remaining","value":"249","enabled":true},{"key":"x-ratelimit-reset","value":"1663586247","enabled":true},{"key":"CF-Cache-Status","value":"DYNAMIC","enabled":true},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=1HtU2ry2W72GLuJ0FNJf%2FB8jBx2OwFjEn5H5XxtC%2FxDqNe7uBpDdT8tsSfT2%2Bli50mX3WiHGI57YZbeu4ihTte67mON9N7U1Qu9KvMmJSdlMp5oYSs1FOgymZluB3UYrYgBFPy8%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}","enabled":true},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}","enabled":true},{"key":"Server","value":"cloudflare","enabled":true},{"key":"CF-RAY","value":"74d1e8bf7b871646-DME","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"\",\n \"data\": {\n \"uuid\": \"789f4d3f898d4e10acf2bebd249fcf95\",\n \"type\": \"socks\",\n \"port\": 1081,\n \"host\": \"localhost\",\n \"login\": \"user\",\n \"password\": \"secret111\",\n \"change_ip_url\": \"http://localhost:1082/change_ip\",\n \"external_id\": \"my_custom_id=1\",\n \"profiles_count\": 0,\n \"title\": \"super proxy\"\n }\n}"}],"_postman_id":"e9a733e7-11c7-43b7-95d0-85b6ad338588"},{"name":"Remove Proxy","id":"c588e9db-fd57-4d88-9551-4307f1f398fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"description":"API Token
\n","key":"X-Octo-Api-Token","value":""}],"url":"//api/v2/automation/proxies/:uuid","urlObject":{"path":["api","v2","automation","proxies",":uuid"],"host":["/"],"query":[],"variable":[{"id":"575c4a8b-1085-4300-a3d3-8c8d0fb1b457","description":{"content":"Proxy UUID
\n","type":"text/plain"},"type":"any","value":"6cbecae429ba48d48836f22baf0e99a0","key":"uuid"}]}},"response":[{"id":"7089144b-e2df-4553-977d-fc2cee41259e","name":"Remove Proxy","originalRequest":{"method":"DELETE","header":[{"description":"API Token","key":"X-Octo-Api-Token","value":""}],"url":{"raw":"//api/v2/automation/proxies/:uuid","host":["/"],"path":["api","v2","automation","proxies",":uuid"],"variable":[{"id":"575c4a8b-1085-4300-a3d3-8c8d0fb1b457","key":"uuid","value":"6cbecae429ba48d48836f22baf0e99a0","description":"Proxy UUID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 19 Sep 2022 11:16:58 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"40","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"access-control-allow-origin","value":"*","enabled":true},{"key":"retry-after","value":"59","enabled":true},{"key":"x-ratelimit-limit","value":"250","enabled":true},{"key":"x-ratelimit-remaining","value":"248","enabled":true},{"key":"x-ratelimit-reset","value":"1663586278","enabled":true},{"key":"CF-Cache-Status","value":"DYNAMIC","enabled":true},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=o5kar3sE3jLR503x8i2nxcByBreOqyw9n1y3DgV7hAHQTHLQgBb98t%2BsNHY99m6ptbpnHy1Q4BRkmN0DW84IXenkPqIA%2Bm8dgAque%2F5RsAerLHeyo6%2BfouVQhn1pd4ymSxWDMWs%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}","enabled":true},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}","enabled":true},{"key":"Server","value":"cloudflare","enabled":true},{"key":"CF-RAY","value":"74d1e9862c2a1646-DME","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"\",\n \"data\": \"\"\n}"}],"_postman_id":"c588e9db-fd57-4d88-9551-4307f1f398fc"},{"name":"Update Proxy","id":"0629a3f9-938d-4365-971f-c2b1c93438f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"description":"API Token
\n","key":"X-Octo-Api-Token","value":""}],"body":{"mode":"raw","raw":"{\n \"type\": \"socks\", // [optional]\n \"host\": \"localhost\", // [optional]\n \"port\": 1081, // [optional]\n \"login\": \"user\", // [optional]\n \"password\": \"secret111\", // [optional]\n \"title\": \"new title\", // [optional]\n \"change_ip_url\": \"http://example.com\", // [optional]\n \"external_id\": \"12345\" // [optional]\n}","options":{"raw":{"language":"json"}}},"url":"//api/v2/automation/proxies/:uuid","urlObject":{"path":["api","v2","automation","proxies",":uuid"],"host":["/"],"query":[],"variable":[{"description":{"content":"Proxy UUID
\n","type":"text/plain"},"type":"any","value":"6cbecae429ba48d48836f22baf0e99a0","key":"uuid"}]}},"response":[{"id":"bd82fb52-1036-40aa-9aae-fb8d66c78aa3","name":"Update Proxy","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Octo-Api-Token","value":"{API_TOKEN}"}],"body":{"mode":"raw","raw":"{\n \"title\": \"new title\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"//api/v2/automation/proxies/:uuid","host":["/"],"path":["api","v2","automation","proxies",":uuid"],"variable":[{"key":"uuid","value":"6cbecae429ba48d48836f22baf0e99a0","description":"Proxy UUID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"\",\n \"data\": {\n \"uuid\": \"5246b94778f549859e2e6577d98d90aa\",\n \"type\": \"socks5\",\n \"port\": 40000,\n \"host\": \"127.0.0.1\",\n \"login\": \"\",\n \"password\": \"\",\n \"change_ip_url\": null,\n \"external_id\": null,\n \"profiles_count\": 0,\n \"title\": \"renew title\"\n }\n}"}],"_postman_id":"0629a3f9-938d-4365-971f-c2b1c93438f4"}],"id":"5663545a-1a21-4e8d-9769-106269fea5dc","_postman_id":"5663545a-1a21-4e8d-9769-106269fea5dc","description":""},{"name":"Local client API","item":[{"name":"List Active Profiles","id":"4bb9ac4e-83d4-4695-ab5b-e0e346cec7f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/api/profiles/active","description":"Shows the list of profiles launched on your device. webSocketDebuggerUrl will be shown only for profiles that are launched in the headless mode.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"60de5347-92d8-45a7-bb7f-ae4b31b31b98","id":"60de5347-92d8-45a7-bb7f-ae4b31b31b98","name":"Local client API","type":"folder"}},"urlObject":{"path":["api","profiles","active"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"923723f4-af87-41ec-82e0-5698dc9bf620","name":"List Active Profiles","originalRequest":{"method":"GET","header":[],"url":"/api/profiles/active"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET,HEAD,PUT,PATCH,POST,DELETE"},{"key":"Access-Control-Allow-Headers","value":"content-type"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Content-Type","value":"application/json","description":""},{"key":"Date","value":"Fri, 26 Nov 2021 13:48:16 GMT"},{"key":"Content-Length","value":"205"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"uuid\": \"2bbfd1dbaf3349cf979787f15a9e413d\",\n \"state\": \"STARTED\",\n \"headless\": true,\n \"start_time\": 1724173918,\n \"ws_endpoint\": \"ws://127.0.0.1:55834/devtools/browser/a26c9612-6479-43f1-87ef-34590321a99a\",\n \"debug_port\": \"55834\",\n \"one_time\": false,\n \"browser_pid\": 26616\n }\n]"}],"_postman_id":"4bb9ac4e-83d4-4695-ab5b-e0e346cec7f8"},{"name":"Start Profile","id":"21d97c8f-ad7f-4a46-aa35-f5ea9236d7de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"uuid\": \"\",\n \"headless\": false,\n \"debug_port\": true,\n \"only_local\": true,\n \"flags\": [],\n \"timeout\": 120,\n \"password\": \"password\" // [optional]\n}","options":{"raw":{"language":"json"}}},"url":"/api/profiles/start","description":"debug_port=true enables the automation port. A random free port will be selected.
debug_port=20000 launches the browser on a specific port. Allowed values: 1024-65534.
timeout - seconds overrides the default start timeout value. This is usually required if you are using slow proxies.
flags - list[string] allows you to add additional Chromium flags. Note: we recommend against adding any flags and we don't guarantee correct browser work if you decide to do so. Use this only if you are certain that you absolutely need this and you know precisely what you are doing.
profile_data - mapping allows to override some profile fields during start (images_load_limit: null, size in bytes)
--disk-cache-dir allows you to change the default cache folder. If you want to save your cached data (images, scripts, etc.), you can add this flag and add a path to the desired folder. The path should be outside the profile folder. By default the cache is cleared every time you close the profile.
example: flags:[\"--disk-cache-dir=C:/Cache\"]
--disable-backgrounding-occluded-windows can be useful if you automate many profiles at the same time and your scripts do not work correctly in windows that are out of focus (running in the background).
To listen to, e.g., 0.0.0.0 interface you can add \"flags\": [\"--remote-debugging-address=0.0.0.0\"]
chromedrivers allows you to download official chromedrivers.
\nSTART_ERROR_CODES = {\n ComponentNotFoundException: 1,\n ProfileAlreadyRunningException: 2,\n ProfileStartFailedException: 3,\n GetProxyDataFailedException: 4,\n InvalidProxyDataException: 5,\n ProfileNotFoundException: 6,\n NoSubscriptionException: 7,\n OutdatedVersionException: 8,\n ProfileVersionConsistencyError: 9,\n}\n\nRequires Octo Browser 1.7 or later
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"60de5347-92d8-45a7-bb7f-ae4b31b31b98","id":"60de5347-92d8-45a7-bb7f-ae4b31b31b98","name":"Local client API","type":"folder"}},"urlObject":{"path":["api","profiles","force_stop"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"0a181e9e-075f-4364-9a0b-03a4c3fe9194","name":"Force Stop Profile","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"uuid\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/profiles/force_stop"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Profile stopped successfully\"\n}"}],"_postman_id":"f4df4877-2c92-4050-aaf9-d27fb617d43e"},{"name":"Login","id":"f436653b-db3f-4c26-ab02-e670b9df5e62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"useremail@domain.net\",\n \"password\": \"userpassword\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/auth/login","description":"Requires Octo Browser 1.8.0 or later
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"60de5347-92d8-45a7-bb7f-ae4b31b31b98","id":"60de5347-92d8-45a7-bb7f-ae4b31b31b98","name":"Local client API","type":"folder"}},"urlObject":{"path":["api","auth","login"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"e9a69fe3-a6b3-4af5-aa84-30dc0294a2b1","name":"Login","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"useremail@domain.net\",\n \"password\": \"userpassword\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/auth/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Logged in successfully\"\n}"}],"_postman_id":"f436653b-db3f-4c26-ab02-e670b9df5e62"},{"name":"Logout","id":"a1b01c93-e5e4-4c3e-990b-c07f7cc2c3d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/api/auth/logout","description":"Requires Octo Browser 1.8.0 or later
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"60de5347-92d8-45a7-bb7f-ae4b31b31b98","id":"60de5347-92d8-45a7-bb7f-ae4b31b31b98","name":"Local client API","type":"folder"}},"urlObject":{"path":["api","auth","logout"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"fa7ca370-1a06-4d13-b3ba-4922705eff9e","name":"Logout","originalRequest":{"method":"POST","header":[],"url":"/api/auth/logout"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Logged out successfully\"\n}"}],"_postman_id":"a1b01c93-e5e4-4c3e-990b-c07f7cc2c3d6"},{"name":"Get Client Version","id":"92a43f59-a608-4da9-8f2e-25a4ea763813","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/api/update","description":"Shows the current and latest available browser versions. Update_required field indicates a critical update availability. A critical update means that the current browser version is no longer supported and an update is strongly recommended.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"60de5347-92d8-45a7-bb7f-ae4b31b31b98","id":"60de5347-92d8-45a7-bb7f-ae4b31b31b98","name":"Local client API","type":"folder"}},"urlObject":{"path":["api","update"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"b100e513-e948-4526-ab6c-129919abfa1c","name":"Update","originalRequest":{"method":"GET","header":[],"url":"/api/update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"current\": \"1.8.2\",\n \"latest\": \"1.8.3\",\n \"update_required\": false\n}"},{"id":"f806600f-c272-4ca2-8e18-68cb2c30586b","name":"Critical update available","originalRequest":{"method":"GET","header":[],"url":"/api/update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"current\": \"1.7.6\",\n \"latest\": \"1.8.3\",\n \"update_required\": true\n}"}],"_postman_id":"92a43f59-a608-4da9-8f2e-25a4ea763813"},{"name":"Update Client","id":"1c40e57f-6709-4b75-a000-e39c07f6e735","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/api/update","description":"Triggers an update to the latest available version. If the browser is up to date this will return an error.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"60de5347-92d8-45a7-bb7f-ae4b31b31b98","id":"60de5347-92d8-45a7-bb7f-ae4b31b31b98","name":"Local client API","type":"folder"}},"urlObject":{"path":["api","update"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"ec42b3c4-1d46-4ee5-a06f-474abf5401a2","name":"Update","originalRequest":{"method":"POST","header":[],"url":"/api/update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"update to 1.8.3 triggerred successfully\"\n}"},{"id":"7ffbb8f8-ebfa-40ca-8850-83f96dbcd7c5","name":"Update No Available Version Error","originalRequest":{"method":"POST","header":[],"url":"/api/update"},"code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"client.update_failed\",\n \"error\": \"Update is not triggered. No available version\"\n}"}],"_postman_id":"1c40e57f-6709-4b75-a000-e39c07f6e735"},{"name":"Username","id":"ed6afde5-9d95-476a-9204-ae9004b17761","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/api/username","description":"Returns the current user username.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"60de5347-92d8-45a7-bb7f-ae4b31b31b98","id":"60de5347-92d8-45a7-bb7f-ae4b31b31b98","name":"Local client API","type":"folder"}},"urlObject":{"path":["api","username"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"20a8834e-4213-42ac-832f-3cf35851b7d4","name":"Username","originalRequest":{"method":"GET","header":[],"url":"/api/username"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"username\": \"user@example.com\"\n}"}],"_postman_id":"ed6afde5-9d95-476a-9204-ae9004b17761"},{"name":"One-time profile","event":[{"listen":"test","script":{"id":"3fc50c44-f5b7-4099-b565-f129af6df8c6","exec":["pm.test(\"responce body have puuid\"), function(){\r"," pm.response.to.have.jsonBody('browser_pid')\r","}"],"type":"text/javascript"}}],"id":"35ae6b86-a02e-4fcd-a3c6-b1ba7fddcb07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"profile_data\": {\n \"fingerprint\": {\n \"os\": \"win\",\n \"os_version\": \"11\", // [optional]\n \"os_arch\": \"x86\", // [optional]\n \"user_agent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/138.0.0.0 Safari/537.36\", // [optional]\n \"screen\": \"1920x1080\", // [optional]\n \"languages\": { // [optional]\n \"type\": \"ip\"\n },\n \"timezone\": { // [optional]\n \"type\": \"ip\"\n },\n \"geolocation\": { // [optional]\n \"type\": \"ip\"\n },\n \"cpu\": 4, // [optional]\n \"ram\": 8, // [optional]\n \"noise\": { // [optional]\n \"webgl\": true,\n \"canvas\": false,\n \"audio\": true,\n \"client_rects\": false\n },\n \"webrtc\": { // [optional]\n \"type\": \"ip\"\n },\n \"dns\": \"1.1.1.1\", // [optional]\n \"media_devices\": { // [optional]\n \"video_in\": 1,\n \"audio_in\": 1,\n \"audio_out\": 1\n }\n },\n \"extensions\": [ // [optional]\n \"ewbjmajocgfcbeboaewbfgobmjsjcoja@1.0\"\n ],\n \"start_pages\": [ // [optional]\n \"https://fb.com\"\n ],\n \"proxy\": { // [optional]\n \"type\": \"socks5\",\n \"host\": \"1.1.1.1\",\n \"port\": 5555,\n \"login\": \"\",\n \"password\": \"\"\n },\n \"local_cache\": true, // [optional]\n \"cookies\": [ // [optional]\n {\n \"domain\": \".google.com\",\n \"expirationDate\": 1639134293.313654,\n \"hostOnly\": false,\n \"httpOnly\": false,\n \"name\": \"1P_JAR\",\n \"path\": \"/\",\n \"sameSite\": \"no_restriction\",\n \"secure\": true,\n \"value\": \"2021-11-10-11\"\n }\n ]\n },\n \"headless\": false, // [optional]\n \"debug_port\": true, // [optional]\n \"flags\": [], // [optional]\n \"timeout\": 60 // [optional]\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:58888/api/profiles/one_time/start","description":"Note: if you don't specify a given parameter, we will generate the best values for it on our servers. Change only the parameters you need to customize.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"60de5347-92d8-45a7-bb7f-ae4b31b31b98","id":"60de5347-92d8-45a7-bb7f-ae4b31b31b98","name":"Local client API","type":"folder"}},"urlObject":{"protocol":"http","port":"58888","path":["api","profiles","one_time","start"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"be017a79-e209-4072-b288-1a8797c8f470","name":"Start One-time Profile","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"profile_data\": {\n \"fingerprint\": {\n \"os\": \"win\",\n \"os_version\": \"11\", // [optional]\n \"os_arch\": \"x86\", // [optional]\n \"user_agent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/138.0.0.0 Safari/537.36\", // [optional]\n \"screen\": \"1920x1080\", // [optional]\n \"languages\": { // [optional]\n \"type\": \"ip\"\n },\n \"timezone\": { // [optional]\n \"type\": \"ip\"\n },\n \"geolocation\": { // [optional]\n \"type\": \"ip\"\n },\n \"cpu\": 4, // [optional]\n \"ram\": 8, // [optional]\n \"noise\": { // [optional]\n \"webgl\": true,\n \"canvas\": false,\n \"audio\": true,\n \"client_rects\": false\n },\n \"webrtc\": { // [optional]\n \"type\": \"ip\"\n },\n \"dns\": \"1.1.1.1\", // [optional]\n \"media_devices\": { // [optional]\n \"video_in\": 1,\n \"audio_in\": 1,\n \"audio_out\": 1\n }\n },\n \"extensions\": [ // [optional]\n \"ewbjmajocgfcbeboaewbfgobmjsjcoja@1.0\"\n ],\n \"start_pages\": [ // [optional]\n \"https://fb.com\"\n ],\n \"proxy\": { // [optional]\n \"type\": \"socks5\",\n \"host\": \"1.1.1.1\",\n \"port\": 5555,\n \"login\": \"\",\n \"password\": \"\"\n },\n \"local_cache\": true, // [optional]\n \"cookies\": [ // [optional]\n {\n \"domain\": \".google.com\",\n \"expirationDate\": 1639134293.313654,\n \"hostOnly\": false,\n \"httpOnly\": false,\n \"name\": \"1P_JAR\",\n \"path\": \"/\",\n \"sameSite\": \"no_restriction\",\n \"secure\": true,\n \"value\": \"2021-11-10-11\"\n }\n ]\n },\n \"headless\": false, // [optional]\n \"debug_port\": true, // [optional]\n \"flags\": [], // [optional]\n \"timeout\": 60 // [optional]\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:58888/api/profiles/one_time/start"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"9a906e7d45124e6fb37388633277c22f\",\n \"state\": \"STARTED\",\n \"headless\": false,\n \"start_time\": 1702904780,\n \"ws_endpoint\": \"ws://127.0.0.1:63269/devtools/browser/f7aa4e97-c300-404f-b9c7-2633db0c1515\",\n \"debug_port\": \"63269\",\n \"one_time\": true,\n \"browser_pid\": 4684,\n \"connection_data\": {\n \"ip\": \"188.188.188.88\",\n \"country\": \"Germany\"\n }\n}"}],"_postman_id":"35ae6b86-a02e-4fcd-a3c6-b1ba7fddcb07"},{"name":"Set profile password","id":"b13db255-975f-47f1-bbe6-4ef4363c143a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"uuid\": \"9585dc0cdc1e497896afe81ba1fbcdb6\",\n \"password\": \"password\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:58888/api/profiles/password","description":"Sets password of profile
Minimal length - at least 4 characters
Unsets password of profile
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"60de5347-92d8-45a7-bb7f-ae4b31b31b98","id":"60de5347-92d8-45a7-bb7f-ae4b31b31b98","name":"Local client API","type":"folder"}},"urlObject":{"protocol":"http","port":"58888","path":["api","profiles","password"],"host":["localhost"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"2d4ab535-7c28-4b34-96a3-0ea8f31cf60b","name":"Delete profile password","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"uuid\": \"9585dc0cdc1e497896afe81ba1fbcdb6\",\n \"password\": \"password\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"http://localhost:58888/api/profiles/password","protocol":"http","host":["localhost"],"port":"58888","path":["api","profiles","password"],"query":[{"key":"","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Profile password has been cleared\"\n}"},{"id":"99a364ee-4cc9-4de1-8298-69391a0e3609","name":"Incorrect password","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"uuid\": \"9585dc0cdc1e497896afe81ba1fbcdb6\",\n \"password\": \"password\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"http://localhost:58888/api/profiles/password","protocol":"http","host":["localhost"],"port":"58888","path":["api","profiles","password"],"query":[{"key":"","value":"","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"profiles.invalid_password\",\n \"error\": \"Profile password incorrect\",\n \"error_code\": 1\n}"},{"id":"96a162a2-90bc-472d-9710-98c960eb60ac","name":"Delete password error","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"uuid\": \"9585dc0cdc1e497896afe81ba1fbcdb6\",\n \"password\": \"password\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"http://localhost:58888/api/profiles/password","protocol":"http","host":["localhost"],"port":"58888","path":["api","profiles","password"],"query":[{"key":"","value":"","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Failed to clear profile password\",\n \"error_code\": 1\n}"},{"id":"e48f8fdb-49f2-4f43-86ff-f7e7a17d444f","name":"Another operation in progress","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"uuid\": \"9585dc0cdc1e497896afe81ba1fbcdb6\",\n \"password\": \"password\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"http://localhost:58888/api/profiles/password","protocol":"http","host":["localhost"],"port":"58888","path":["api","profiles","password"],"query":[{"key":"","value":"","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Another profile's operation in progress\",\n \"error_code\": 3\n}"}],"_postman_id":"cf7ead7d-093b-4653-b4ea-ffcd1ca91071"}],"id":"60de5347-92d8-45a7-bb7f-ae4b31b31b98","description":"This is a local client API to run profiles.
\nThe default server port is 58888.
\nThe API URL is http://localhost:58888.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"71ab954b-1367-492f-9173-83e946e6b5a0"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"a761f177-e899-431c-bc64-38c061988859"}}],"_postman_id":"60de5347-92d8-45a7-bb7f-ae4b31b31b98"},{"name":"Automation Libraries","item":[{"name":"Puppeteer/Pyppeteer","item":[],"id":"36440a21-6ec4-4a02-a908-9e13e9562e31","description":"Connecting Puppeteer
\nconst puppeteer = require('puppeteer');\nconst axios = require('axios');\nconst OCTO_REMOTE_API = axios.create({\n baseURL: 'https://app.octobrowser.net/api/v2/automation/',\n timeout: 2000,\n headers: {\n 'X-Octo-Api-Token': 'Token' //Put your Token here\n }\n});\nconst OCTO_LOCAL_API = axios.create({\n baseURL: 'http://127.0.0.1:58888/api/profiles/',\n timeout: 100000\n})\nasync function createProfile() {\n return OCTO_REMOTE_API.post(`/profiles`, {\n title: 'API Test profile',\n fingerprint: {\n os: \"win\"\n }\n }).then((response) => response.data).catch((error) => error.response ? error.response.data : null)\n}\nasync function startProfile(uuid) {\n return OCTO_LOCAL_API.post('/start', {\n uuid: uuid,\n headless: true,\n debug_port: true\n }).then((response) => response.data).catch((error) => error.response ? error.response.data : null)\n}\n(async () => {\n const response = await createProfile();\n const profile_uuid = response.data.uuid;\n const start_response = await startProfile(profile_uuid);\n const ws_endpoint = start_response.ws_endpoint;\n const browser = await puppeteer.connect({\n browserWSEndpoint: ws_endpoint,\n defaultViewport: null\n });\n const page = await browser.newPage();\n await page.goto('https://google.com/');\n})();\n\nPyppeteer (python version)
\nimport asyncio\nimport logging\nimport os\nimport httpx\nimport pyppeteer\nlogging.basicConfig(level=logging.INFO, format='%(asctime)s [%(levelname)s] %(name)s: %(message)s')\nlog = logging.getLogger('octo')\nOCTO_TOKEN = os.getenv('OCTO_TOKEN', 'PUT_TOKEN_HERE')\nOCTO_API = 'https://app.octobrowser.net/api/v2/automation/profiles'\nLOCAL_API = 'http://localhost:58888/api/profiles/start'\nHEADERS = {'X-Octo-Api-Token': OCTO_TOKEN}\nasync def get_profile(cli):\n profiles = (await cli.get(OCTO_API, headers=HEADERS)).json()\n log.info(f'Profiles: {profiles}')\n return profiles['data'][0]['uuid']\nasync def get_cdp(cli):\n uuid = await get_profile(cli)\n resp = (await cli.post(LOCAL_API, json={'uuid': uuid, 'debug_port': True})).json()\n log.info(f'Start profile resp: {resp}')\n return resp['ws_endpoint']\nasync def main():\n async with httpx.AsyncClient() as cli:\n ws_url = await get_cdp(cli)\n browser = await pyppeteer.launcher.connect(browserWSEndpoint=ws_url)\n try:\n page = await browser.newPage()\n url = 'https://duckduckgo.com/'\n await page.goto(url)\n values = await page.querySelector('p.badge-link__social')\n it = await values.getProperty('innerText')\n text_value = await it.jsonValue()\n log.info(f'Element text: {text_value}')\n finally:\n await browser.close()\nif __name__ == '__main__':\n asyncio.run(main())\n\nConnecting Playwright
\nconst axios = require('axios');\nconst pw = require('playwright');\nconst OCTO_REMOTE_API = axios.create({\n baseURL: 'https://app.octobrowser.net/api/v2/automation/',\n timeout: 2000,\n headers: {\n 'X-Octo-Api-Token': 'Token' //Put Your Token Here\n }\n});\nconst OCTO_LOCAL_API = axios.create({\n baseURL: 'http://127.0.0.1:58888/api/profiles/',\n timeout: 100000\n})\nasync function createProfile() {\n return OCTO_REMOTE_API.post(`/profiles`, {\n title: 'API Test profile',\n fingerprint: {\n os: \"win\"\n }\n }).then((response) => response.data).catch((error) => error.response ? error.response.data : null)\n}\nasync function startProfile(uuid) {\n return OCTO_LOCAL_API.post('/start', {\n uuid: uuid,\n headless: false, //should be false if you want to see actions\n debug_port: true\n }).then((response) => response.data).catch((error) => error.response ? error.response.data : null)\n}\n(async () => {\n const response = await createProfile();\n const profile_uuid = response.data.uuid;\n const start_response = await startProfile(profile_uuid);\n const ws_endpoint = start_response.ws_endpoint;\n const browser = await pw.chromium.connectOverCDP(ws_endpoint);\n const context = browser.contexts()[0];\n const page = context.pages()[0];\n await page.goto('https://google.com'); \n})();\n\nPlaywright Sync Python
\nimport httpx\nfrom playwright.sync_api import sync_playwright\nPROFILE_UUID = \"UUID_OF_YOUR_PROFILE\"\ndef main():\n with sync_playwright() as p:\n start_response = httpx.post(\n 'http://127.0.0.1:58888/api/profiles/start',\n json={\n 'uuid': PROFILE_UUID,\n 'headless': False,\n 'debug_port': True\n }\n )\n if not start_response.is_success:\n print(f'Start response is not success: {start_response.json()}')\n return\n ws_endpoint = start_response.json().get('ws_endpoint')\n browser = p.chromium.connect_over_cdp(ws_endpoint)\n page = browser.contexts[0].pages[0]\n page.goto('https://google.com')\n browser.close()\nif __name__ == '__main__':\n main()\n\nPlaywright Async Python
\nimport httpx\nimport asyncio\nfrom playwright.async_api import async_playwright\nPROFILE_UUID = \"UUID_OF_YOUR_PROFILE\"\nasync def main():\n async with async_playwright() as p:\n async with httpx.AsyncClient() as client:\n response = await client.post(\n 'http://127.0.0.1:58888/api/profiles/start',\n json={\n 'uuid': PROFILE_UUID,\n 'headless': False,\n 'debug_port': True\n }\n )\n if not response.is_success:\n print(f'Start response is not successful: {response.json()}')\n return\n start_response = response.json()\n ws_endpoint = start_response.get('ws_endpoint')\n browser = await p.chromium.connect_over_cdp(ws_endpoint)\n page = browser.contexts[0].pages[0]\n await page.goto('https://google.com')\n await browser.close()\nif __name__ == '__main__':\n asyncio.run(main())\n\nConnecting Selenium
\nNB: By default Selenium is exposed in the browser and can be detected by some sites. It should work fine for most cases; however, if it doesn't, you need to use another automation library (puppeteer, chrome dev protocol).
\nAlternatively, consider changing default Selenium to undetected-chromedriver.
\nimport requests\nfrom selenium import webdriver\nfrom selenium.webdriver.chrome.options import Options\nfrom selenium.webdriver.chrome.service import Service\nPROFILE_ID = 'PROFILE_UUID'\nWEBDRIVERPATH = Service(\n executable_path=r'./chromedriver/chromedriver-win64/chromedriver.exe')\nLOCAL_API = 'http://localhost:58888/api/profiles'\ndef get_webdriver(port):\n chrome_options = Options()\n chrome_options.add_experimental_option(\n 'debuggerAddress', f'127.0.0.1:{port}')\n # Change chrome driver path accordingly\n driver = webdriver.Chrome(service=WEBDRIVERPATH, options=chrome_options)\n return driver\ndef get_debug_port(profile_id):\n data = requests.post(\n f'{LOCAL_API}/start', json={'uuid': profile_id, 'headless': False, 'debug_port': True}\n ).json()\n return data['debug_port']\ndef main():\n port = get_debug_port(PROFILE_ID)\n driver = get_webdriver(port)\n driver.get('http://amazon.com')\nif __name__ == '__main__':\n main()\n\nimport org.apache.http.client.methods.CloseableHttpResponse;\nimport org.apache.http.client.methods.HttpPost;\nimport org.apache.http.entity.StringEntity;\nimport org.apache.http.impl.client.CloseableHttpClient;\nimport org.apache.http.impl.client.HttpClients;\nimport org.apache.http.util.EntityUtils;\nimport org.json.JSONObject;\nimport org.openqa.selenium.WebDriver;\nimport org.openqa.selenium.chrome.ChromeDriver;\nimport org.openqa.selenium.chrome.ChromeOptions;\npublic class Main {\n private static final String PROFILE_ID = \"PROFILE_UUID\"; //Profile UUID\n private static final String CHROME_DRIVER = \"./path/to/chromedriver.exe\"; //Change this Path to your chromedriver.exe\n private static final String LOCAL_API = \"http://127.0.0.1:58888/api/profiles\";\n public static void main(String[] args) throws Exception {\n int port = getDebugPort(PROFILE_ID);\n WebDriver driver = getWebDriver(port);\n driver.get(\"http://google.com\");\n }\n public static WebDriver getWebDriver(int port) {\n ChromeOptions chromeOptions = new ChromeOptions();\n chromeOptions.setExperimentalOption(\"debuggerAddress\", \"127.0.0.1:\" + port);\n System.setProperty(\"webdriver.chrome.driver\", CHROME_DRIVER);\n return new ChromeDriver(chromeOptions);\n }\n public static int getDebugPort(String profileId) throws Exception {\n int debugPort;\n try (CloseableHttpClient httpClient = HttpClients.createDefault()) {\n HttpPost httpPost = new HttpPost(LOCAL_API + \"/start\");\n JSONObject json = new JSONObject();\n json.put(\"uuid\", profileId);\n json.put(\"headless\", false);\n json.put(\"debug_port\", true);\n StringEntity entity = new StringEntity(json.toString());\n httpPost.setEntity(entity);\n httpPost.setHeader(\"Accept\", \"application/json\");\n httpPost.setHeader(\"Content-type\", \"application/json\");\n try (CloseableHttpResponse response = httpClient.execute(httpPost)) {\n String responseString = EntityUtils.toString(response.getEntity());\n JSONObject responseJson = new JSONObject(responseString);\n debugPort = responseJson.getInt(\"debug_port\");\n }\n }\n return debugPort;\n }\n}\n\nVisual Basic .NET Example
\nImports System\nImports System.Net.Http\nImports System.Text\nImports Newtonsoft.Json.Linq\nImports OpenQA.Selenium\nImports OpenQA.Selenium.Chrome\nModule Program\nPublic Class Main\n Private Shared ReadOnly PROFILE_ID As String = \"PROFILE_UUID_SHOULD_BE_HERE\" 'Profile UUID\n Private Shared ReadOnly CHROME_DRIVER As String = \"./chromedriver-win64/chromedriver.exe\" 'Change this Path to your chromedriver.exe\n Private Shared ReadOnly LOCAL_API As String = \"http://127.0.0.1:58888/api/profiles\"\n Public Shared Sub Main(args As String())\n Dim port As Integer = GetDebugPort(PROFILE_ID)\n Dim driver As IWebDriver = GetWebDriver(port)\n driver.Navigate().GoToUrl(\"http://google.com\")\n End Sub\n Public Shared Function GetWebDriver(port As Integer) As IWebDriver\n Dim chromeOptions As New ChromeOptions()\n chromeOptions.DebuggerAddress = \"127.0.0.1:\" & port\n Environment.SetEnvironmentVariable(\"webdriver.chrome.driver\", CHROME_DRIVER)\n Return New ChromeDriver(chromeOptions)\n End Function\n Public Shared Function GetDebugPort(profileId As String) As Integer\n Dim debugPort As Integer\n Using httpClient As New HttpClient()\n Dim httpPost As New HttpRequestMessage(HttpMethod.Post, LOCAL_API & \"/start\")\n Dim json As New JObject()\n json(\"uuid\") = profileId\n json(\"headless\") = False\n json(\"debug_port\") = True\n httpPost.Content = New StringContent(json.ToString(), Encoding.UTF8, \"application/json\")\n httpPost.Headers.Accept.ParseAdd(\"application/json\")\n Using response = httpClient.SendAsync(httpPost).Result\n Dim responseString As String = response.Content.ReadAsStringAsync().Result\n Dim responseJson As JObject = JObject.Parse(responseString)\n debugPort = responseJson(\"debug_port\")\n End Using\n End Using\n Return debugPort\n End Function\nEnd Class\nEnd Module\n\nExamples of connecting automation libraries to a running profile, in different programming languages.
\n","_postman_id":"09a98d3a-2cc8-4d21-a8a1-ddc2db7da097"},{"name":"Teams","item":[{"name":"Get Extensions","id":"185359ba-c28e-4406-afe1-c53498f72512","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Octo-Api-Token","value":"","description":"API Token
\n"}],"url":"//api/v2/automation/teams/extensions?start=0&limit=25","description":"Returns extensions used by a team installed in any profile.
\n","urlObject":{"path":["api","v2","automation","teams","extensions"],"host":["/"],"query":[{"description":{"content":"(Optional)
\n","type":"text/plain"},"key":"start","value":"0"},{"description":{"content":"(Optional, max value 100)
\n","type":"text/plain"},"key":"limit","value":"25"}],"variable":[]}},"response":[{"id":"385afdfa-f996-4fbf-8ce0-5ae7d1bf8be9","name":"Get Extensions","originalRequest":{"method":"GET","header":[{"key":"X-Octo-Api-Token","value":"","description":"API Token"}],"url":{"raw":"//api/v2/automation/teams/extensions?start=0&limit=25","host":["/"],"path":["api","v2","automation","teams","extensions"],"query":[{"key":"start","value":"0","description":"(Optional)"},{"key":"limit","value":"25","description":"(Optional, max value 100)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"\",\n \"data\": [\n {\n \"uuid\": \"54d6ff5042c545b990349a7a7e653e81@2.0.12\",\n \"name\": \"Google Translate\",\n \"version\": \"2.0.12\"\n }\n ]\n}"}],"_postman_id":"185359ba-c28e-4406-afe1-c53498f72512"},{"name":"Delete Extensions","id":"72038513-2a89-4df6-9f75-a6e7e012e5f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-Octo-Api-Token","value":"","description":"API Token
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"uuids\": [\n \"ppdakpfeaodfo@9.0.19\"\n ]\n}"},"url":"//api/v2/automation/teams/extensions","description":"Deletes extensions of a team using UUIDs. The maximum UUID batch length is 100.
\nIMPORTANT: If any profile is running during this request, the deleted extensions will continue to be available and functioning for this profile. After such a profile stops, these extensions will return to the extensions list. Please make sure that extensions you would like to delete are not in use in any running profile at the time of deletion.
\n","urlObject":{"path":["api","v2","automation","teams","extensions"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"de13be93-b6dc-4daf-b60f-927c706cdd73","name":"Delete Extensions","originalRequest":{"method":"DELETE","header":[{"key":"X-Octo-Api-Token","value":"","description":"API Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"uuids\": [\n \"ppdakpfeaodfo@9.0.19\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"//api/v2/automation/teams/extensions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"Extensions deleted successfully\",\n \"data\": \"\"\n}"}],"_postman_id":"72038513-2a89-4df6-9f75-a6e7e012e5f1"},{"name":"Get subaccounts","id":"7575606d-235d-4581-957b-4c7121db3791","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Octo-Api-Token","value":""}],"url":"//api/v2/automation/teams/subaccounts","urlObject":{"path":["api","v2","automation","teams","subaccounts"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"8bbb11db-3c78-48d9-88d2-f432736e337a","name":"Get subaccounts","originalRequest":{"method":"GET","header":[{"key":"X-Octo-Api-Token","value":""}],"url":"//api/v2/automation/teams/subaccounts"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"success\":true,\n \"msg\":\"\",\n \"total_count\":1,\n \"data\":[\n {\n \"uuid\":\"54d6ff5042c545b990349a7a7e653e81\",\n \"email\":\"test@octo.com\",\n \"master\":false,\n \"created_at\":\"2023-11-27 13:07:28\",\n \"permissions\":{\n \"manage_team\":false,\n \"edit_tags\":false,\n \"view_all_tags\":false,\n \"manage_action_log\":false,\n \"proxies\":{\n \"create\":false,\n \"edit\":false,\n \"delete\":false\n },\n \"paid_proxies\":{\n \"create\":false\n },\n \"profiles\":{\n \"transfer\":false,\n \"clone\":false,\n \"create\":false,\n \"edit\":false,\n \"delete\":false,\n \"passwords\":false\n },\n \"templates\":{\n \"create\":false,\n \"edit\":false,\n \"delete\":false\n },\n \"extensions\":{\n \"delete\":false\n },\n \"tasks\":{\n \"view\":false,\n \"manage\":false\n },\n \"visible_tags\":[\n \"tag_name\"\n ]\n }\n }\n ]\n}"}],"_postman_id":"7575606d-235d-4581-957b-4c7121db3791"},{"name":"Get invites","id":"10a71eca-f3b5-4b25-b787-dcdf45a201f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Octo-Api-Token","value":""}],"url":"//api/v2/automation/teams/invites","urlObject":{"path":["api","v2","automation","teams","invites"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"8cdf9a6c-335f-459a-b3af-f06c4d0c5894","name":"Get invites","originalRequest":{"method":"GET","header":[{"key":"X-Octo-Api-Token","value":""}],"url":"//api/v2/automation/teams/invites"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"success\":true,\n \"msg\":\"\",\n \"total_count\":1,\n \"data\":[\n {\n \"receiver\":\"test_receiver@octo.net\",\n \"created_at\":\"2023-11-27 13:07:28\"\n }\n ]\n}"}],"_postman_id":"10a71eca-f3b5-4b25-b787-dcdf45a201f2"},{"name":"Delete invite","id":"a8b0db2b-258f-423b-bf75-63e7b50c92cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-Octo-Api-Token","value":""}],"body":{"mode":"raw","raw":"{\n \"receiver\": \"test@octo.net\"\n}","options":{"raw":{"language":"json"}}},"url":"//api/v2/automation/teams/invites","urlObject":{"path":["api","v2","automation","teams","invites"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"b083c64e-515b-4c00-87d0-96b59ef7276b","name":"Delete invite","originalRequest":{"method":"DELETE","header":[{"key":"X-Octo-Api-Token","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"receiver\": \"test@octo.net\"\n}","options":{"raw":{"language":"json"}}},"url":"//api/v2/automation/teams/invites"},"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"Invite deleted\",\n \"data\": \"\"\n}"}],"_postman_id":"a8b0db2b-258f-423b-bf75-63e7b50c92cc"},{"name":"Create subaccount","id":"6b38897b-a4f9-48ff-a159-5ec0f16ace09","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Octo-Api-Token","value":"","description":"API Token
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"test@octo.net\",\n \"permissions\": {\n \"manage_team\": false, // [optional]\n \"edit_tags\": false, // [optional]\n \"view_all_tags\": false, // [optional]\n \"manage_action_log\": false, // [optional]\n \"proxies\": { // [optional]\n \"create\": false,\n \"edit\": false,\n \"delete\": false\n },\n \"paid_proxies\": { // [optional]\n \"create\": false\n },\n \"profiles\": { // [optional]\n \"transfer\": false,\n \"clone\": false,\n \"create\": false,\n \"edit\": false,\n \"delete\": false,\n \"passwords\": false\n },\n \"templates\": { // [optional]\n \"create\": false,\n \"edit\": false,\n \"delete\": false\n },\n \"extensions\": { // [optional]\n \"delete\": false\n },\n \"tasks\": { // [optional]\n \"view\": false,\n \"manage\": false\n },\n \"visible_tags\": [\"tag_name\"] // [optional]\n }\n}","options":{"raw":{"language":"json"}}},"url":"//api/v2/automation/teams/subaccounts","description":"IMPORTANT: If a permission is not specified, it will be set as false.
API Token
\n","type":"text"}],"url":"//api/v2/automation/fingerprint/renderers?page_len=100&page=0&os=win&os_arch=x86","urlObject":{"path":["api","v2","automation","fingerprint","renderers"],"host":["/"],"query":[{"description":{"content":"(Optional)
\n","type":"text/plain"},"key":"page_len","value":"100"},{"description":{"content":"(Optional)
\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"(Optional)
\n","type":"text/plain"},"key":"os","value":"win"},{"description":{"content":"(Optional)
\n","type":"text/plain"},"key":"os_arch","value":"x86"}],"variable":[]}},"response":[{"id":"44608df3-f331-45b7-9b9e-62f47cd7a53b","name":"Get Renderers","originalRequest":{"method":"GET","header":[{"key":"X-Octo-Api-Token","value":"","description":"API Token"}],"url":{"raw":"//api/v2/automation/fingerprint/renderers?page_len=100&page=0","host":["/"],"path":["api","v2","automation","fingerprint","renderers"],"query":[{"key":"page_len","value":"100","description":"(Optional)"},{"key":"page","value":"0","description":"(Optional)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"\",\n \"data\": [\n {\n \"value\": \"ATI Radeon HD 3200 Graphics (Microsoft Corporation WDDM 1.1)\", \n \"platform\": \"win\",\n \"archs\": [\"x86\"]\n }, \n {\n \"value\": \"ATI Radeon 3100 Graphics (Microsoft Corporation WDDM 1.1)\", \n \"platform\": \"win\",\n \"archs\": [\"x86\"]\n }, \n {\n \"value\": \"NVIDIA GeForce GTX 660\", \n \"platform\": \"win\",\n \"archs\": [\"x86\"]\n }, \n {\n \"value\": \"ATI Radeon HD 3400 Series\", \n \"platform\": \"win\",\n \"archs\": [\"x86\"]\n }, \n {\n \"value\": \"NVIDIA GeForce 210\", \n \"platform\": \"win\",\n \"archs\": [\"x86\"]\n }, \n {\n \"value\": \"AMD Radeon HD 6800 Series\", \n \"platform\": \"win\",\n \"archs\": [\"x86\"]\n }, \n {\n \"value\": \"NVIDIA Tegra K1 (nvgpu)/integrated\", \n \"platform\": \"lin\",\n \"archs\": [\"x86\"]\n },\n {\n \"value\": \"Apple M2 Pro\", \n \"platform\": \"mac\",\n \"archs\": [\"arm\"]\n }\n ],\n \"total_count\": 250,\n \"page\": 0\n}"}],"_postman_id":"6a78e070-37a5-4d6e-9269-82179eec79ef"},{"name":"Get Screens","id":"055bcaee-f8f1-4596-8bbe-008b84369c83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Octo-Api-Token","value":"","description":"API Token
\n"}],"url":"//api/v2/automation/fingerprint/screens?os=win&os_arch=x86","urlObject":{"path":["api","v2","automation","fingerprint","screens"],"host":["/"],"query":[{"description":{"content":"(Optional)
\n","type":"text/plain"},"key":"os","value":"win"},{"description":{"content":"(Optional)
\n","type":"text/plain"},"key":"os_arch","value":"x86"}],"variable":[]}},"response":[{"id":"b4eec999-6584-49f2-8193-0117331a8a19","name":"Get Screens","originalRequest":{"method":"GET","header":[{"key":"X-Octo-Api-Token","value":"","description":"API Token"}],"url":{"raw":"//api/v2/automation/fingerprint/screens?os=win&os_arch=x86","host":["/"],"path":["api","v2","automation","fingerprint","screens"],"query":[{"key":"os","value":"win"},{"key":"os_arch","value":"x86"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn/20.0.4"},{"key":"Date","value":"Tue, 25 Jun 2024 08:32:09 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"527"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"\",\n \"data\": [\n {\n \"value\": \"1440x900\",\n \"platform\": \"win\",\n \"archs\": [\n \"x86\"\n ]\n },\n {\n \"value\": \"1536x864\",\n \"platform\": \"win\",\n \"archs\": [\n \"x86\"\n ]\n },\n {\n \"value\": \"1536x960\",\n \"platform\": \"win\",\n \"archs\": [\n \"x86\"\n ]\n },\n {\n \"value\": \"1600x900\",\n \"platform\": \"win\",\n \"archs\": [\n \"x86\"\n ]\n },\n {\n \"value\": \"1680x1050\",\n \"platform\": \"win\",\n \"archs\": [\n \"x86\"\n ]\n },\n {\n \"value\": \"1920x1080\",\n \"platform\": \"win\",\n \"archs\": [\n \"x86\"\n ]\n },\n {\n \"value\": \"1920x1200\",\n \"platform\": \"win\",\n \"archs\": [\n \"x86\"\n ]\n },\n {\n \"value\": \"2560x1440 (2K)\",\n \"platform\": \"win\",\n \"archs\": [\n \"x86\"\n ]\n }\n ]\n}"}],"_postman_id":"055bcaee-f8f1-4596-8bbe-008b84369c83"},{"name":"Get Mobile Device Models","id":"2272f8e8-10bc-4f59-87fc-24894dcf80b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Octo-Api-Token","value":"","description":"API Token
\n"}],"url":"//api/v2/automation/fingerprint/device_models?device_type=phone","urlObject":{"path":["api","v2","automation","fingerprint","device_models"],"host":["/"],"query":[{"description":{"content":"phone or tablet
\n","type":"text/plain"},"key":"device_type","value":"phone"}],"variable":[]}},"response":[{"id":"f67fa464-8b69-451a-af02-24e00831d3e0","name":"Get Mobile Device Models","originalRequest":{"method":"GET","header":[{"key":"X-Octo-Api-Token","value":"","description":"API Token"}],"url":"//api/v2/automation/fingerprint/device_models"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"msg\": \"\",\r\n \"data\": [\r\n {\r\n \"value\": \"M2102J20SG\",\r\n \"os\": \"android\",\r\n \"os_versions\": [\r\n \"12\"\r\n ],\r\n \"archs\": [\r\n \"arm\"\r\n ],\r\n \"device_type\": \"phone\"\r\n },\r\n {\r\n \"value\": \"21051182G\",\r\n \"os\": \"android\",\r\n \"os_versions\": [\r\n \"13\"\r\n ],\r\n \"archs\": [\r\n \"arm\"\r\n ],\r\n \"device_type\": \"tablet\"\r\n },\r\n {\r\n \"value\": \"SM-T970\",\r\n \"os\": \"android\",\r\n \"os_versions\": [\r\n \"13\"\r\n ],\r\n \"archs\": [\r\n \"arm\"\r\n ],\r\n \"device_type\": \"tablet\"\r\n },\r\n {\r\n \"value\": \"M2007J20CG\",\r\n \"os\": \"android\",\r\n \"os_versions\": [\r\n \"12\"\r\n ],\r\n \"archs\": [\r\n \"arm\"\r\n ],\r\n \"device_type\": \"phone\"\r\n },\r\n {\r\n \"value\": \"SM-M526B\",\r\n \"os\": \"android\",\r\n \"os_versions\": [\r\n \"13\"\r\n ],\r\n \"archs\": [\r\n \"arm\"\r\n ],\r\n \"device_type\": \"phone\"\r\n },\r\n {\r\n \"value\": \"moto g32\",\r\n \"os\": \"android\",\r\n \"os_versions\": [\r\n \"13\"\r\n ],\r\n \"archs\": [\r\n \"arm\"\r\n ],\r\n \"device_type\": \"phone\"\r\n }\r\n ]\r\n}"}],"_postman_id":"2272f8e8-10bc-4f59-87fc-24894dcf80b6"}],"id":"2680ff9b-74c5-4dd5-89fb-3f0ab850b640","event":[{"listen":"prerequest","script":{"id":"4ab2aafb-3d45-4574-9fe2-56474cb59501","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ecbb1e49-0a4d-4ea6-a09d-17cf81ede979","type":"text/javascript","exec":[""]}}],"_postman_id":"2680ff9b-74c5-4dd5-89fb-3f0ab850b640","description":""},{"name":"Docker","item":[],"id":"2803d731-63fd-4af7-a87f-276d336e51d5","description":"You can use examples below to run Octo Browser in docker containers.
\nDockerfile
\nFROM ubuntu:22.04\nARG TZ=America/Los_Angeles\nARG DEBIAN_FRONTEND=noninteractive\nENV LANG=\"C.UTF-8\"\nRUN apt-get update && apt-get install -y \\\n apt-transport-https \\\n ca-certificates \\\n curl \\\n gnupg \\\n unzip \\\n libgles2 libegl1 xvfb \\\n --no-install-recommends \\\n && curl -sSL https://dl.google.com/linux/linux_signing_key.pub | apt-key add - \\\n && echo \"deb https://dl.google.com/linux/chrome/deb/ stable main\" > /etc/apt/sources.list.d/google-chrome.list \\\n && apt-get update && apt-get install -y \\\n fontconfig \\\n fonts-ipafont-gothic \\\n fonts-kacst \\\n fonts-noto \\\n fonts-symbola \\\n fonts-thai-tlwg \\\n fonts-wqy-zenhei \\\n connect-proxy \\\n dnsutils \\\n fonts-freefont-ttf \\\n iproute2 \\\n iptables \\\n iputils-ping \\\n net-tools \\\n openvpn \\\n procps \\\n socat \\\n ssh \\\n sshpass \\\n sudo \\\n tcpdump \\\n telnet \\\n traceroute \\\n tzdata \\\n vim-nox\nRUN curl https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb --output /tmp/chrome.deb\nRUN apt install -y /tmp/chrome.deb\n# Install Octo dependencies\nRUN apt update \\\n && apt install -y libgl1 libglib2.0-0 xvfb zip\n# Create\nRUN mkdir -p /home/octo/browser\n# Create new user\nRUN groupadd -r octo && \\\n useradd -r -g octo -s /bin/bash -m -G audio,video,sudo -p $(echo 1 | openssl passwd -1 -stdin) octo && \\\n mkdir -p /home/octo/ && \\\n chown -R octo:octo /home/octo\n# Create sudoers.d directory and add sudo permissions for the octo user\nRUN mkdir -p /etc/sudoers.d && \\\n echo 'octo ALL=(ALL) NOPASSWD:ALL' > /etc/sudoers.d/octo && \\\n chmod 0440 /etc/sudoers.d/octo\n#sudo octo\nRUN usermod -a -G sudo octo\nUSER octo\n# Install Octo browser\nRUN curl -o /home/octo/browser/octo-browser.tar.gz https://binaries.octobrowser.net/releases/installer/OctoBrowser.linux.tar.gz\n# Unzip Octo browser\nRUN tar -xzf /home/octo/browser/octo-browser.tar.gz -C /home/octo/browser\n# Start virtual display and Octo Browser in headless mode\nCMD Xvfb :1 -ac -screen 0 \"1920x1080x24\" -nolisten tcp +extension GLX +render -noreset & \\\n sudo chown -R octo:octo /home/octo && \\\n sleep 5 && DISPLAY=:1 OCTO_HEADLESS=1 /home/octo/browser/OctoBrowser.AppImage\n\nrun.sh
\nexport EMAIL=your_email\nexport PASSWORD=your_password\nexport PROFILE_UUID=PUT_UUID_HERE\ndocker build -t octobrowser:latest .\ndocker run --name octo -it --rm \\\n --security-opt seccomp:unconfined \\\n -v '/srv/docker_octo/cache:/home/octo/.Octo Browser/' \\\n -p 58895:58888 \\\n octobrowser:latest\n# get xh: https://github.com/ducaale/xh/releases\nxh POST localhost:58895/api/auth/login email=${EMAIL} password=${PASSWORD}\nxh POST localhost:58895/api/profiles/start uuid=${PROFILE_UUID} headless:=true debug_port:=true\n\nIf you would like to run the browser inside a kubernetes pod, make sure to properly configure shared memory limits and capabilities
\napiVersion: apps/v1\nkind: Deployment\nspec:\n template:\n spec:\n containers:\n - name: cloud-instance\n image: {{ .Values.octoImage }}:{{ .Values.tag }}\n securityContext:\n capabilities:\n add:\n - NET_ADMIN\n - SYS_ADMIN\n volumeMounts:\n - name: dshm\n mountPath: /dev/shm\n volumes:\n - name: default-data\n emptyDir:\n medium: Memory\n sizeLimit: 1Gi\n - name: dshm\n emptyDir:\n medium: Memory\n sizeLimit: 4Gi\n\nCreating Profiles in Bulk
\nconst axios = require('axios');\n// This is the configuration. Insert your API token and specify the desired number of profiles\nconst config = {\n octo_token: \"OCTO_API_TOKEN\", // Specify your API token here\n quantity_of_profiles: 10, // Specify the desired number of profiles\n octo_api_base_url: \"https://app.octobrowser.net/api/v2/automation/\"\n};\nconst OCTO_REMOTE_API = axios.create({\n baseURL: config.octo_api_base_url,\n timeout: 10000,\n headers: {\n 'X-Octo-Api-Token': config.octo_token,\n 'Content-Type': \"application/json\"\n }\n});\nasync function sleep(ms) {\n return new Promise(resolve => setTimeout(resolve, ms));\n}\nasync function check_limits(response) {\n function parse_int_safe(value) {\n const parsed = parseInt(value, 10);\n return isNaN(parsed) ? 0 : parsed;\n }\n const ratelimit_header = response.headers.ratelimit;\n if (!ratelimit_header) {\n console.warn('No ratelimit header found!');\n return;\n }\n const limit_entries = ratelimit_header.split(',').map(entry => entry.trim());\n for (const entry of limit_entries) {\n const name_match = entry.match(/^([^;]+)/);\n const r_match = entry.match(/;r=(\\d+)/);\n const t_match = entry.match(/;t=(\\d+)/);\n if (!r_match || !t_match) {\n console.warn(`Invalid ratelimit format: ${entry}`);\n continue;\n }\n const limit_name = name_match ? name_match[1] : 'unknown_limit';\n const remaining_quantity = parse_int_safe(r_match[1]);\n const window_seconds = parse_int_safe(t_match[1]);\n if (remaining_quantity < 5) {\n const wait_time = window_seconds + 1;\n console.log(`Waiting ${wait_time} seconds due to ${limit_name} limit`);\n await sleep(wait_time);\n }\n }\n}\nasync function create_profile(quantity) {\n for (let i = 0; i < quantity; i++) {\n const data = {\n \"title\": `Profile ${i}`,\n \"fingerprint\": {\n \"os\": \"win\"\n }\n };\n try {\n const response = await OCTO_REMOTE_API.post('profiles', data);\n await check_limits(response);\n console.log(`Profile ${data.title} created successfully:`, response.data);\n } catch (error) {\n console.error(`Error creating profile ${i}:`, error.response ? error.response.data : error.message);\n }\n }\n}\n(async () => {\n await create_profile(config.quantity_of_profiles);\n})();\n\nHow to get the extension UUID using API:
\n- \n
Add the desired extension to any profile (read How to connect extensions to profiles to learn more).
\n \nGet the profile with the desired extension using a GET request.
\n \nThe server response will contain all data about the profile, including UUIDs of connected extensions.
\n \nYou can remove unnecessary server response fields to show only the extensions:
\n \n
const axios = require('axios');\nconst uuid = 'UUID'; // Specify the profile UUID here\nconst api_token = 'OCTO_API_TOKEN' // Specify your API token here\nconst config = {\n method: 'get',\n maxBodyLength: Infinity,\n url: `https://app.octobrowser.net/api/v2/automation/profiles/${uuid}`,\n headers: { \n 'X-Octo-Api-Token': api_token\n }\n};\naxios(config)\n.then(function (response) {\n console.dir(response.data.data.extensions);\n})\n.catch(function (error) {\n console.log(error);\n});\n\nAdding Extensions/Start Pages/Bookmarks to Multiple Profiles
\nconst axios = require('axios');\n// This is the configuration. Specify your Octo API Token here; you can modify this for your personal needs\nconst config = {\n octo_token: \"OCTO_API_TOKEN\", // Specify your API token here\n octo_api_base_url: \"https://app.octobrowser.net/api/v2/automation/\",\n profiles_to_update: [\n \"UUID_1\",\n \"UUID_2\"\n // Add UUIDs of profiles\n ],\n data: {\n extensions: [\"nkbihfbeogaeaoehlefnkodbefgpgknn@12.17.2\"],\n bookmarks: [\n { name: \"google\", url: \"https://google.com\" },\n { name: \"facebook\", url: \"https://facebook.com\" }\n ],\n start_pages: [\"https://google.com\", \"https://facebook.com\"]\n }\n};\nconst OCTO_REMOTE_API = axios.create({\n baseURL: config.octo_api_base_url,\n timeout: 10000,\n headers: {\n 'X-Octo-Api-Token': config.octo_token,\n 'Content-Type': \"application/json\"\n }\n});\nasync function sleep(ms) {\n return new Promise(resolve => setTimeout(resolve, ms));\n}\nasync function check_limits(response) {\n function parse_int_safe(value) {\n const parsed = parseInt(value, 10);\n return isNaN(parsed) ? 0 : parsed;\n }\n const ratelimit_header = response.headers.ratelimit;\n if (!ratelimit_header) {\n console.warn('No ratelimit header found!');\n return;\n }\n const limit_entries = ratelimit_header.split(',').map(entry => entry.trim());\n for (const entry of limit_entries) {\n const name_match = entry.match(/^([^;]+)/);\n const r_match = entry.match(/;r=(\\d+)/);\n const t_match = entry.match(/;t=(\\d+)/);\n if (!r_match || !t_match) {\n console.warn(`Invalid ratelimit format: ${entry}`);\n continue;\n }\n const limit_name = name_match ? name_match[1] : 'unknown_limit';\n const remaining_quantity = parse_int_safe(r_match[1]);\n const window_seconds = parse_int_safe(t_match[1]);\n if (remaining_quantity < 5) {\n const wait_time = window_seconds + 1;\n console.log(`Waiting ${wait_time} seconds due to ${limit_name} limit`);\n await sleep(wait_time);\n }\n }\n}\nasync function update_profile(uuid) {\n try {\n const response = await OCTO_REMOTE_API.patch(`/profiles/${uuid}`, config.data);\n await check_limits(response);\n console.log(`Profile ${uuid} updated successfully`);\n } catch (error) {\n console.error(`Error updating profile ${uuid}:`, error.response?.data || error.message);\n }\n}\n(async () => {\n for (const uuid of config.profiles_to_update) {\n await update_profile(uuid);\n }\n})();\n\nAdding Extensions/Start Pages/Bookmarks to all Profiles on your Account
\nconst axios = require('axios');\n// This is the configuration. Specify your Octo API Token here; you can modify this for your personal needs\nconst config = {\n octo_token: \"OCTO_API_TOKEN\", // Specify your API token here\n octo_api_base_url: \"https://app.octobrowser.net/api/v2/automation/\",\n data: {\n \"extensions\": [\"aapfglkgnhmiaabhiijkjpfmhllaodgp@4.2.3\"],\n \"bookmarks\": [\n { \"name\": \"google\", \"url\": \"https://google.com\" },\n { \"name\": \"facebook\", \"url\": \"https://facebook.com\" }\n ],\n \"start_pages\": [\"https://google.com\", \"https://facebook.com\"]\n }\n}\nconst OCTO_REMOTE_API = axios.create({\n baseURL: config.octo_api_base_url,\n timeout: 10000,\n headers: {\n 'X-Octo-Api-Token': config.octo_token,\n 'Content-Type': \"application/json\"\n }\n});\n//functions\nasync function sleep(ms) {\n return new Promise(resolve => setTimeout(resolve, ms * 1000));\n}\nasync function check_limits(response) {\n function parse_int_safe(value) {\n const parsed = parseInt(value, 10);\n return isNaN(parsed) ? 0 : parsed;\n }\n const ratelimit_header = response.headers.ratelimit;\n if (!ratelimit_header) {\n console.warn('No ratelimit header found!');\n return;\n }\n const limit_entries = ratelimit_header.split(',').map(entry => entry.trim());\n for (const entry of limit_entries) {\n const name_match = entry.match(/^([^;]+)/);\n const r_match = entry.match(/;r=(\\d+)/);\n const t_match = entry.match(/;t=(\\d+)/);\n if (!r_match || !t_match) {\n console.warn(`Invalid ratelimit format: ${entry}`);\n continue;\n }\n const limit_name = name_match ? name_match[1] : 'unknown_limit';\n const remaining_quantity = parse_int_safe(r_match[1]);\n const window_seconds = parse_int_safe(t_match[1]);\n if (remaining_quantity < 5) {\n const wait_time = window_seconds + 1;\n console.log(`Waiting ${wait_time} seconds due to ${limit_name} limit`);\n await sleep(wait_time);\n }\n }\n}\nasync function get_total_profiles() {\n const response = await OCTO_REMOTE_API.get('/profiles?page=0&page_len=10');\n const total_profiles = response.data.total_count;\n const total_pages = Math.ceil(response.data.total_count / 100);\n console.log(`Total Profiles: ${total_profiles}\\nTotal Pages: ${total_pages}`);\n await check_limits(response);\n return total_pages;\n}\nasync function get_all_profiles_uuids(total_pages) {\n let profiles = [];\n for (let i = 0; i < total_pages; i++) {\n let response = await OCTO_REMOTE_API.get(`/profiles?page=${i}&page_len=100`);\n await check_limits(response);\n profiles.push(...response.data.data);\n }\n return profiles;\n}\nasync function patch_all_profiles(profiles) {\n let updated = [];\n let not_updated = [];\n for (let profile of profiles) {\n try {\n const response = await OCTO_REMOTE_API.patch(`/profiles/${profile.uuid}`, config.data);\n await check_limits(response);\n updated.push(profile);\n console.log(`Successfully updated ${profile.uuid}`);\n } catch (error) {\n not_updated.push(profile);\n console.error(`ERROR: Can't patch profile ${profile.uuid}`);\n }\n }\n return [updated, not_updated];\n}\n(async () => {\n const total = await get_total_profiles();\n const profiles = await get_all_profiles_uuids(total);\n const [updated, not_updated] = await patch_all_profiles(profiles);\n console.log(`Finished process:\\nUpdated: ${updated.length}\\nNot updated: ${not_updated.length}`);\n})();\n\nAdding Extensions/Start Pages/Bookmarks to Profiles with Certain Tags
\nNote: You will get all profiles with the specified tag. This means that if a profile has other tags, it will still be included, so keep that in mind. If you specify two tags, you will only get profiles containing both tags.
\nconst axios = require('axios');\n//This is the configuration. Specify your Octo API Token here; you can modify this for your personal needs\nconst config = {\n octo_token: \"OCTO_API_TOKEN\", // Specify your API token here\n octo_api_base_url: \"https://app.octobrowser.net/api/v2/automation/\",\n tags: ['tag1', 'tag2'], // Specify the required tags\n page_len: 100,\n extensions: ['nkbihfbeogaeaoehlefnkodbefgpgknn@12.17.2'],\n start_pages: [\"https://google.com\", \"https://facebook.com\", \"https://amazon.com\"],\n bookmarks: [\n { name: \"google\", url: \"https://google.com\" },\n { name: \"facebook\", url: \"https://facebook.com\" }\n ]\n};\nconst OCTO_REMOTE_API = axios.create({\n baseURL: config.octo_api_base_url,\n timeout: 10000,\n headers: {\n 'X-Octo-Api-Token': config.octo_token,\n 'Content-Type': \"application/json\"\n }\n});\nasync function sleep(ms) {\n return new Promise(resolve => setTimeout(resolve, ms));\n}\nasync function check_limits(response) {\n function parse_int_safe(value) {\n const parsed = parseInt(value, 10);\n return isNaN(parsed) ? 0 : parsed;\n }\n const ratelimit_header = response.headers.ratelimit;\n if (!ratelimit_header) {\n console.warn('No ratelimit header found!');\n return;\n }\n const limit_entries = ratelimit_header.split(',').map(entry => entry.trim());\n for (const entry of limit_entries) {\n const name_match = entry.match(/^([^;]+)/);\n const r_match = entry.match(/;r=(\\d+)/);\n const t_match = entry.match(/;t=(\\d+)/);\n if (!r_match || !t_match) {\n console.warn(`Invalid ratelimit format: ${entry}`);\n continue;\n }\n const limit_name = name_match ? name_match[1] : 'unknown_limit';\n const remaining_quantity = parse_int_safe(r_match[1]);\n const window_seconds = parse_int_safe(t_match[1]);\n if (remaining_quantity < 5) {\n const wait_time = window_seconds + 1;\n console.log(`Waiting ${wait_time} seconds due to ${limit_name} limit`);\n await sleep(wait_time);\n }\n }\n}\nasync function get_total_pages() {\n const search_tags = config.tags.join(',');\n const response = await OCTO_REMOTE_API.get(`/profiles?page=0&page_len=${config.page_len}&search_tags=${search_tags}`);\n await check_limits(response);\n const total_count = response.data.total_count;\n return Math.ceil(total_count / config.page_len);\n}\nasync function get_profiles_by_tags(page) {\n const search_tags = config.tags.join(',');\n const response = await OCTO_REMOTE_API.get(`/profiles?page=${page}&page_len=${config.page_len}&search_tags=${search_tags}`);\n await check_limits(response);\n return response.data.data;\n}\nasync function update_profile(uuid) {\n const data = {\n extensions: config.extensions,\n bookmarks: config.bookmarks,\n start_pages: config.start_pages\n };\n try {\n const response = await OCTO_REMOTE_API.patch(`/profiles/${uuid}`, data);\n await check_limits(response);\n console.log(`Profile ${uuid} updated successfully`);\n } catch (error) {\n console.error(`Error updating profile ${uuid}:`, error.response?.data || error.message);\n }\n}\n(async () => {\n const total_pages = await get_total_pages();\n console.log(`Total pages to process: ${total_pages}`);\n for (let page = 0; page < total_pages; page++) {\n const profiles = await get_profiles_by_tags(page);\n if (profiles.length === 0) {\n console.log(`No profiles found on page ${page} with tags ${config.tags.join(', ')}`);\n continue;\n }\n for (const profile of profiles) {\n await update_profile(profile.uuid);\n }\n }\n})();\n\nTo use the following code, you need to have a .TXT file with the proxy data in the following format:
\nprotocol;host;port;login;password;title;change_ip_url
\nThe \"change_ip_url\" parameter is optional.
\nThe proxy data must be provided strictly in the specified order.
\nUse only the following protocols: socks5, http, ssh.
\nAn example file:
\nconst axios = require('axios');\nconst fs = require('fs').promises;\nconst config = {\n octo_token: \"OCTO_API_TOKEN\", // Specify your API token here\n proxies_file: \"proxies.txt\", // Specify the proxy file name\n octo_api_base_url: \"https://app.octobrowser.net/api/v2/automation/\"\n};\nconst octo_remote_api = axios.create({\n baseURL: config.octo_api_base_url,\n timeout: 10000,\n headers: {\n 'X-Octo-Api-Token': config.octo_token,\n 'Content-Type': \"application/json\"\n }\n});\nasync function sleep(ms) {\n return new Promise(resolve => setTimeout(resolve, ms));\n}\nasync function check_limits(response) {\n function parse_int_safe(value) {\n const parsed = parseInt(value, 10);\n return isNaN(parsed) ? 0 : parsed;\n }\n const ratelimit_header = response.headers.ratelimit;\n if (!ratelimit_header) {\n console.warn('No ratelimit header found!');\n return;\n }\n const limit_entries = ratelimit_header.split(',').map(entry => entry.trim());\n for (const entry of limit_entries) {\n const name_match = entry.match(/^([^;]+)/);\n const r_match = entry.match(/;r=(\\d+)/);\n const t_match = entry.match(/;t=(\\d+)/);\n if (!r_match || !t_match) {\n console.warn(`Invalid ratelimit format: ${entry}`);\n continue;\n }\n const limit_name = name_match ? name_match[1] : 'unknown_limit';\n const remaining_quantity = parse_int_safe(r_match[1]);\n const window_seconds = parse_int_safe(t_match[1]);\n if (remaining_quantity < 5) {\n const wait_time = window_seconds + 1;\n console.log(`Waiting ${wait_time} seconds due to ${limit_name} limit`);\n await sleep(wait_time);\n }\n }\n}\nasync function create_proxy(proxy_data) {\n try {\n const response = await octo_remote_api.post('proxies', proxy_data);\n await check_limits(response);\n console.log(`Proxy ${proxy_data.title} created, UUID: ${response.data.data.uuid}`);\n return response.data.data.uuid;\n } catch (error) {\n console.error(`Error creating proxy ${proxy_data.title}:`, error.response ? error.response.data : error.message);\n return null;\n }\n}\nasync function create_profile(profile_number, proxy_uuid, profile_title) {\n const data = {\n title: profile_title || `Profile ${profile_number}`,\n proxy: { uuid: proxy_uuid },\n fingerprint: { os: \"win\" }\n };\n try {\n const response = await octo_remote_api.post('profiles', data);\n await check_limits(response);\n console.log(`Profile ${data.title} created successfully`);\n } catch (error) {\n console.error(`Error creating profile ${profile_number}:`, error.response ? error.response.data : error.message);\n }\n}\nasync function main() {\n try {\n const data = await fs.readFile(config.proxies_file, 'utf-8');\n const lines = data.split(/\\r?\\n/).filter(line => line.trim().length > 0);\n for (let i = 0; i < lines.length; i++) {\n const splitted = lines[i].split(';');\n let proxy_data;\n if (splitted.length === 7) {\n let [type, host, port, login, password, title, change_ip_url] = splitted;\n proxy_data = {\n type,\n host,\n port: parseInt(port),\n login,\n password,\n title,\n change_ip_url\n };\n } else if (splitted.length === 6) {\n let [type, host, port, login, password, title] = splitted;\n proxy_data = {\n type,\n host,\n port: parseInt(port),\n login,\n password,\n title\n };\n } else {\n console.log(`Skipping invalid proxy data on line ${i + 1}`);\n continue;\n }\n const proxy_uuid = await create_proxy(proxy_data);\n if (proxy_uuid) {\n await create_profile(i + 1, proxy_uuid, proxy_data.title);\n }\n }\n } catch (err) {\n console.error(\"Error reading proxies file:\", err);\n }\n}\nmain();\n\nHow to get the UUID of a saved proxy using API:
\nGetting the favorite proxy's UUID from the profile data:
\n- \n
Connect the desired proxy to any profile.
\n \nGet the profile with the desired proxy using a GET request.
\n \nThe server response will contain all data about the profile, including the UUID of the saved proxy.
\n \nYou can remove unnecessary server response fields and display only the UUID of the saved proxy.
\n \n
console.dir(response.data.data.proxy.uuid);\n// We don't have to output the whole response to the console, only the proxy's UUID.\n// Example of a server response:\n'f9092a2f33384823be70554442311cc6'\n\nGetting the saved proxy's UUID from the Proxy Manager list:
\n- \n
Use a Get Proxies request (you can find it in the documentation). You will get the data for all proxies saved in the Proxy Manager of your Octo Browser account; copy the UUID of the proxy that you need.
\n \nExample of a server response:
\n \n
{\n uuid: 'cbc173cc120747c7b57d4f6ea2496141',\n type: 'socks5',\n port: 5003,\n host: '127.0.0.1',\n login: 'admin',\n password: 'admin',\n change_ip_url: null,\n external_id: null,\n profiles_count: 0,\n title: 'USA #2'\n},\n\nAdding a Proxy to a Profile
\nconst axios = require('axios');\nconst config = {\n octo_token: \"OCTO_API_TOKEN\", // Specify your API token here\n octo_api_base_url: \"https://app.octobrowser.net/api/v2/automation/\",\n profile_uuid: \"PROFILE_UUID\", // UUID of the profile to be updated\n proxy_uuid: \"PROXY_UUID\" // UUID of the proxy to be assigned to the profile\n};\nconst OCTO_REMOTE_API = axios.create({\n baseURL: config.octo_api_base_url,\n timeout: 10000,\n headers: {\n 'Content-Type': 'application/json',\n 'X-Octo-Api-Token': config.octo_token\n }\n});\nconst patch_data = {\n proxy: {\n uuid: config.proxy_uuid\n }\n};\nconst patch_config = {\n method: 'patch',\n url: `/profiles/${config.profile_uuid}`,\n data: patch_data\n};\nOCTO_REMOTE_API(patch_config)\n .then(response => {\n console.log('Profile updated successfully:', response.data);\n })\n .catch(error => {\n console.error('Error updating profile:', error.response ? error.response.data : error.message);\n });\n\nThis example collects profile data from the Export List and, based on that data, creates files with the .octo extension to be imported later.
\nUse an already existing folder for the \"path_to_folder\" parameter.
\nconst axios = require('axios');\nconst fs = require('fs').promises;\nconst path = require('path');\nconst octo_api_token = \"OCTO_API_TOKEN\"; // Specify your API token here\nconst path_to_folder = \"C:\\\\PATH\\\\TO\\\\YOUR\\\\FOLDER\"; // Specify the path to an existing folder\nconst octo_remote_api = axios.create({\n baseURL: 'https://app.octobrowser.net/api/v2/automation/',\n headers: {\n 'X-Octo-Api-Token': octo_api_token,\n 'Content-Type': 'application/json'\n }\n});\nlet export_profiles_data = [];\nasync function get_total_profiles() {\n try {\n const response = await octo_remote_api.get('profiles/export?page=0');\n return response.data.data.total || 0;\n } catch (error) {\n console.error('Error fetching total profiles:', error.message);\n return 0;\n }\n}\nasync function get_profiles(total_profiles) {\n const total_pages = Math.ceil(total_profiles / 100);\n console.log(`Total pages: ${total_pages}`);\n for (let page = 0; page < total_pages; page++) {\n try {\n const response = await octo_remote_api.get(`profiles/export?page=${page}&page_len=100`);\n export_profiles_data.push(...response.data.data.data);\n } catch (error) {\n console.error(`Error fetching page ${page}:`, error.message);\n }\n }\n}\nasync function ensure_dir_exists(dir) {\n try {\n await fs.access(dir);\n } catch {\n await fs.mkdir(dir, { recursive: true });\n }\n}\nasync function write_to_files() {\n await ensure_dir_exists(path_to_folder);\n const used_file_names = {};\n for (const item of export_profiles_data) {\n const inner_json_string = JSON.stringify(item);\n const outer_object = { data: inner_json_string };\n const json_to_write = JSON.stringify(outer_object);\n let filename = item.title.replace(/[^a-z0-9]/gi, '_').toLowerCase();\n if (used_file_names[filename] !== undefined) {\n used_file_names[filename]++;\n filename += `_${used_file_names[filename]}`;\n } else {\n used_file_names[filename] = 0;\n }\n const file_path = path.join(path_to_folder, `${filename}.octo`);\n try {\n await fs.writeFile(file_path, json_to_write);\n } catch (error) {\n console.error(`Error writing file ${filename}:`, error.message);\n }\n }\n}\n(async () => {\n const total_profiles = await get_total_profiles();\n console.log(`Total profiles in export list: ${total_profiles}`);\n if (total_profiles === 0) {\n console.log('No profiles found or error fetching total.');\n return;\n }\n await get_profiles(total_profiles);\n console.log(`Quantity of profiles fetched: ${export_profiles_data.length}`);\n await write_to_files();\n console.log('Profiles saved successfully.');\n})();\n\nThis script retrieves all profile titles and saves them into a text file named profiles_titles.txt.
The output file is created in the current working directory.
const fs = require('fs').promises;\nconst axios = require('axios');\n//This is the configuration. Specify your Octo API Token here\nconst config = {\n octo_token: \"OCTO_API_TOKEN\", // Specify your API token here\n octo_api_base_url: \"https://app.octobrowser.net/api/v2/automation/\",\n}\nconst OCTO_REMOTE_API = axios.create({\n baseURL: config.octo_api_base_url,\n timeout: 10000,\n headers: {\n 'X-Octo-Api-Token': config.octo_token,\n 'Content-Type': \"application/json\"\n }\n});\nasync function sleep(ms) {\n return new Promise(resolve => setTimeout(resolve, ms * 1000));\n}\nasync function check_limits(response) {\n function parse_int_safe(value) {\n const parsed = parseInt(value, 10);\n return isNaN(parsed) ? 0 : parsed;\n }\n const ratelimit_header = response.headers.ratelimit;\n if (!ratelimit_header) {\n console.warn('No ratelimit header found!');\n return;\n }\n const limit_entries = ratelimit_header.split(',').map(entry => entry.trim());\n for (const entry of limit_entries) {\n const name_match = entry.match(/^([^;]+)/);\n const r_match = entry.match(/;r=(\\d+)/);\n const t_match = entry.match(/;t=(\\d+)/);\n if (!r_match || !t_match) {\n console.warn(`Invalid ratelimit format: ${entry}`);\n continue;\n }\n const limit_name = name_match ? name_match[1] : 'unknown_limit';\n const remaining_quantity = parse_int_safe(r_match[1]);\n const window_seconds = parse_int_safe(t_match[1]);\n if (remaining_quantity < 5) {\n const wait_time = window_seconds + 1;\n console.log(`Waiting ${wait_time} seconds due to ${limit_name} limit`);\n await sleep(wait_time);\n }\n }\n}\nasync function get_total_pages() {\n const response = await OCTO_REMOTE_API.get('/profiles?page=0&page_len=10');\n const total_profiles = response.data.total_count;\n const total_pages = Math.ceil(response.data.total_count / 100);\n console.log(`Total Profiles: ${total_profiles}\\nTotal Pages: ${total_pages}`);\n await check_limits(response);\n return total_pages;\n}\nasync function get_all_profiles_titles(total_pages) {\n let profiles = [];\n for (let i = 0; i < total_pages; i++) {\n let response = await OCTO_REMOTE_API.get(`/profiles?page=${i}&page_len=100&fields=title`);\n await check_limits(response);\n profiles.push(...response.data.data);\n }\n return profiles;\n}\nasync function write_file(profiles) {\n const titles = profiles.map(item => item.title).filter(Boolean);\n try {\n await fs.writeFile('./profiles_titles.txt', titles.join('\\n'), 'utf-8');\n } catch (error) {\n console.error(`ERROR: While trying writing the file some error occured:\\n${error}`);\n }\n}\n(async () => {\n const total_pages = await get_total_pages();\n const profiles = await get_all_profiles_titles(total_pages);\n await write_file(profiles);\n console.log('Finished. Check profiles_titles.txt file...');\n})()\n\nExamples of useful scripts for Node.js
\n","_postman_id":"9a2295a2-2872-464b-a622-dc39ab54039c"},{"name":"Python","item":[{"name":"Create Profiles in Bulk","item":[],"id":"23e21132-f61b-4571-a06e-d8828f3ea94a","description":"Creating Profiles in Bulk
\nimport requests\nimport time\n# Configuration is here. Insert your API token and specify the desired number of profiles\nconfig = {\n \"octo_token\": \"OCTO_API_TOKEN\", # Place your API token here\n \"quantity_of_profiles\": 10, # Specify the desired number of profiles\n \"octo_api_base_url\": \"https://app.octobrowser.net/api/v2/automation/\"\n}\nsession = requests.Session()\nsession.headers.update({\n \"X-Octo-Api-Token\": config[\"octo_token\"],\n \"Content-Type\": \"application/json\"\n})\nsession.timeout = 10\ndef sleep(ms):\n time.sleep(ms)\ndef parse_int_safe(value):\n try:\n return int(value)\n except (ValueError, TypeError):\n return 0\ndef check_limits(response):\n ratelimit_header = response.headers.get('ratelimit')\n if not ratelimit_header:\n print('No ratelimit header found!')\n return\n limit_entries = [entry.strip() for entry in ratelimit_header.split(',')]\n for entry in limit_entries:\n parts = entry.split(';')\n limit_name = parts[0] if parts else 'unknown_limit'\n remaining_quantity = 0\n window_seconds = 0\n for part in parts[1:]:\n if part.startswith('r='):\n remaining_quantity = parse_int_safe(part[2:])\n elif part.startswith('t='):\n window_seconds = parse_int_safe(part[2:])\n print(f'{limit_name}: remaining={remaining_quantity}, window={window_seconds}s')\n if remaining_quantity < 5:\n wait_time = window_seconds + 1\n print(f'Waiting {wait_time} seconds due to {limit_name} limit')\n sleep(wait_time)\ndef create_profiles(quantity):\n for i in range(quantity):\n data = {\n \"title\": f\"Profile {i}\",\n \"fingerprint\": {\n \"os\": \"win\"\n }\n }\n try:\n response = session.post(f\"{config['octo_api_base_url']}profiles\", json=data)\n response.raise_for_status()\n check_limits(response)\n print(f\"Profile {data['title']} created successfully:\", response.json())\n except requests.RequestException as e:\n error_msg = e.response.json() if e.response else str(e)\n print(f\"Error creating profile {i}:\", error_msg)\nif __name__ == \"__main__\":\n create_profiles(config[\"quantity_of_profiles\"])\n\nHow to get the extension UUID using API:
\n- \n
Add the desired extension to any profile (read How to connect extensions to profiles to learn more).
\n \nGet the profile with the desired extension using a GET request.
\n \nThe server response will contain all data about the profile, including UUIDs of connected extensions.
\n \nYou can remove unnecessary server response fields to show only the extensions:
\n \n
import requests\nuuid = 'UUID' # Specify the profile UUID here\napi_token = 'OCTO_API_TOKEN' # Specify your API token here\nurl = f\"https://app.octobrowser.net/api/v2/automation/profiles/{uuid}\"\npayload = {}\nheaders = {\n 'X-Octo-Api-Token': api_token\n}\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\ndata = response.json()\nextensions = data['data']['extensions']\nprint(extensions)\n\nAdding Extensions/Start Pages/Bookmarks to Multiple Profiles
\nimport requests\nimport time\n# This is the configuration. Specify your Octo API Token here; you can modify this for your personal needs\nconfig = {\n \"octo_token\": \"OCTO_API_TOKEN\", # Specify your API token here\n \"octo_api_base_url\": \"https://app.octobrowser.net/api/v2/automation/\",\n \"profiles_to_update\": [\n \"UUID_1\",\n \"UUID_2\" # Add UUIDs of profiles\n ],\n \"data\": {\n \"extensions\": [\"nkbihfbeogaeaoehlefnkodbefgpgknn@12.17.2\"],\n \"bookmarks\": [\n {\"name\": \"google\", \"url\": \"https://google.com\"},\n {\"name\": \"facebook\", \"url\": \"https://facebook.com\"}\n ],\n \"start_pages\": [\"https://google.com\", \"https://facebook.com\"]\n }\n}\nsession = requests.Session()\nsession.headers.update({\n \"X-Octo-Api-Token\": config[\"octo_token\"],\n \"Content-Type\": \"application/json\"\n})\nsession.timeout = 10\ndef sleep(seconds):\n time.sleep(seconds)\ndef parse_int_safe(value):\n try:\n return int(value)\n except (ValueError, TypeError):\n return 0\ndef check_limits(response):\n ratelimit_header = response.headers.get('ratelimit')\n if not ratelimit_header:\n print('No ratelimit header found!')\n return\n limit_entries = [entry.strip() for entry in ratelimit_header.split(',')]\n for entry in limit_entries:\n parts = entry.split(';')\n limit_name = parts[0] if parts else 'unknown_limit'\n remaining_quantity = 0\n window_seconds = 0\n for part in parts[1:]:\n if part.startswith('r='):\n remaining_quantity = parse_int_safe(part[2:])\n elif part.startswith('t='):\n window_seconds = parse_int_safe(part[2:])\n print(f'{limit_name}: remaining={remaining_quantity}, window={window_seconds}s')\n if remaining_quantity < 5:\n wait_time = window_seconds + 1\n print(f'Waiting {wait_time} seconds due to {limit_name} limit')\n sleep(wait_time)\ndef update_profile(uuid):\n try:\n response = session.patch(\n f\"{config['octo_api_base_url']}profiles/{uuid}\",\n json=config[\"data\"]\n )\n response.raise_for_status()\n check_limits(response)\n print(f\"Profile {uuid} updated successfully\")\n except Exception as e:\n print(f\"Error updating profile {uuid}: {str(e)}\")\nif __name__ == \"__main__\":\n for uuid in config[\"profiles_to_update\"]:\n update_profile(uuid)\n\nAdding Extensions/Start Pages/Bookmarks to all Profiles on your Account
\nimport requests\nimport math\nimport time\n# This is the configuration. Specify your Octo API Token here; you can modify this for your personal needs\nconfig = {\n \"octo_token\": \"OCTO_API_TOKEN\", # Specify your API token here\n \"octo_api_base_url\": \"https://app.octobrowser.net/api/v2/automation/\",\n \"data\": {\n \"extensions\": [\"aapfglkgnhmiaabhiijkjpfmhllaodgp@4.2.3\"],\n \"bookmarks\": [\n {\"name\": \"google\", \"url\": \"https://google.com\"},\n {\"name\": \"facebook\", \"url\": \"https://facebook.com\"}\n ],\n \"start_pages\": [\"https://google.com\", \"https://facebook.com\"]\n }\n}\nsession = requests.Session()\nsession.headers.update({\n \"X-Octo-Api-Token\": config[\"octo_token\"],\n \"Content-Type\": \"application/json\"\n})\nsession.timeout = 10\ndef sleep(seconds):\n time.sleep(seconds)\ndef parse_int_safe(value):\n try:\n return int(value)\n except (ValueError, TypeError):\n return 0\ndef check_limits(response):\n ratelimit_header = response.headers.get('ratelimit')\n if not ratelimit_header:\n print('No ratelimit header found!')\n return\n limit_entries = [entry.strip() for entry in ratelimit_header.split(',')]\n for entry in limit_entries:\n parts = entry.split(';')\n limit_name = parts[0] if parts else 'unknown_limit'\n remaining_quantity = 0\n window_seconds = 0\n for part in parts[1:]:\n if part.startswith('r='):\n remaining_quantity = parse_int_safe(part[2:])\n elif part.startswith('t='):\n window_seconds = parse_int_safe(part[2:])\n print(f'{limit_name}: remaining={remaining_quantity}, window={window_seconds}s')\n if remaining_quantity < 5:\n wait_time = window_seconds + 1\n print(f'Waiting {wait_time} seconds due to {limit_name} limit')\n sleep(wait_time)\ndef get_total_profiles():\n response = session.get(f\"{config['octo_api_base_url']}profiles?page=0&page_len=10\")\n response.raise_for_status()\n total_profiles = response.json()[\"total_count\"]\n total_pages = math.ceil(total_profiles / 100)\n print(f\"Total Profiles: {total_profiles}\\nTotal Pages: {total_pages}\")\n check_limits(response)\n return total_pages\ndef get_all_profiles_uuids(total_pages):\n profiles = []\n for i in range(total_pages):\n response = session.get(f\"{config['octo_api_base_url']}profiles?page={i}&page_len=100\")\n response.raise_for_status()\n check_limits(response)\n profiles.extend(response.json()[\"data\"])\n return profiles\ndef patch_all_profiles(profiles):\n updated = []\n not_updated = []\n for profile in profiles:\n try:\n response = session.patch(\n f\"{config['octo_api_base_url']}profiles/{profile['uuid']}\",\n json=config[\"data\"]\n )\n response.raise_for_status()\n check_limits(response)\n updated.append(profile)\n print(f\"Successfully updated {profile['uuid']}\")\n except Exception as e:\n not_updated.append(profile)\n print(f\"ERROR: Can't patch profile {profile['uuid']} - {str(e)}\")\n return updated, not_updated\nif __name__ == \"__main__\":\n try:\n total = get_total_profiles()\n profiles = get_all_profiles_uuids(total)\n updated, not_updated = patch_all_profiles(profiles)\n print(f\"Finished process:\\nUpdated: {len(updated)}\\nNot updated: {len(not_updated)}\")\n except Exception as e:\n print(f\"Fatal error: {str(e)}\")\n\nAdding Extensions/Start Pages/Bookmarks to Profiles with Certain Tags
\nNote: You will get all profiles with the specified tag. This means that if a profile has other tags, it will still be included, so keep that in mind. If you specify two tags, you will only get profiles containing both tags.
\nimport requests\nimport math\nimport time\n# here is config. Paste your Octo API Token here and you can modify this for your personal needs\nconfig = {\n \"octo_token\": \"OCTO_API_TOKEN\", # Place your API token here\n \"octo_api_base_url\": \"https://app.octobrowser.net/api/v2/automation/\",\n \"tags\": ['tag1', 'tag2'], # Specify the required tags\n \"page_len\": 100,\n \"extensions\": ['nkbihfbeogaeaoehlefnkodbefgpgknn@12.17.2'],\n \"start_pages\": [\"https://google.com\", \"https://facebook.com\", \"https://amazon.com\"],\n \"bookmarks\": [\n {\"name\": \"google\", \"url\": \"https://google.com\"},\n {\"name\": \"facebook\", \"url\": \"https://facebook.com\"}\n ]\n}\nsession = requests.Session()\nsession.headers.update({\n \"X-Octo-Api-Token\": config[\"octo_token\"],\n \"Content-Type\": \"application/json\"\n})\nsession.timeout = 10\ndef sleep(seconds):\n time.sleep(seconds)\ndef parse_int_safe(value):\n try:\n return int(value)\n except (ValueError, TypeError):\n return 0\ndef check_limits(response):\n ratelimit_header = response.headers.get('ratelimit')\n if not ratelimit_header:\n print('No ratelimit header found!')\n return\n limit_entries = [entry.strip() for entry in ratelimit_header.split(',')]\n for entry in limit_entries:\n parts = entry.split(';')\n limit_name = parts[0] if parts else 'unknown_limit'\n remaining_quantity = 0\n window_seconds = 0\n for part in parts[1:]:\n if part.startswith('r='):\n remaining_quantity = parse_int_safe(part[2:])\n elif part.startswith('t='):\n window_seconds = parse_int_safe(part[2:])\n print(f'{limit_name}: remaining={remaining_quantity}, window={window_seconds}s')\n if remaining_quantity < 5:\n wait_time = window_seconds + 1\n print(f'Waiting {wait_time} seconds due to {limit_name} limit')\n sleep(wait_time)\ndef get_total_pages():\n search_tags = \",\".join(config[\"tags\"])\n url = f\"{config['octo_api_base_url']}profiles?page=0&page_len={config['page_len']}&search_tags={search_tags}\"\n response = session.get(url)\n response.raise_for_status()\n check_limits(response)\n total_count = response.json().get(\"total_count\", 0)\n return math.ceil(total_count / config[\"page_len\"])\ndef get_profiles_by_tags(page):\n search_tags = \",\".join(config[\"tags\"])\n url = f\"{config['octo_api_base_url']}profiles?page={page}&page_len={config['page_len']}&search_tags={search_tags}\"\n response = session.get(url)\n response.raise_for_status()\n check_limits(response)\n return response.json().get(\"data\", [])\ndef update_profile(uuid):\n data = {\n \"extensions\": config[\"extensions\"],\n \"bookmarks\": config[\"bookmarks\"],\n \"start_pages\": config[\"start_pages\"]\n }\n try:\n url = f\"{config['octo_api_base_url']}profiles/{uuid}\"\n response = session.patch(url, json=data)\n response.raise_for_status()\n check_limits(response)\n print(f\"Profile {uuid} updated successfully\")\n except requests.RequestException as e:\n error_info = e.response.json() if e.response else str(e)\n print(f\"Error updating profile {uuid}: {error_info}\")\ndef main():\n total_pages = get_total_pages()\n print(f\"Total pages to process: {total_pages}\")\n for page in range(total_pages):\n profiles = get_profiles_by_tags(page)\n if not profiles:\n print(f\"No profiles found on page {page} with tags {', '.join(config['tags'])}\")\n continue\n for profile in profiles:\n update_profile(profile.get(\"uuid\"))\nif __name__ == \"__main__\":\n main()\n\nTo work with this example of code, you should have a .TXT file with proxy data in the following format:
\nprotocol;host;port;login;password;title;change_ip_url
\nchange ip URL is optional.
\nThe proxy data must be provided strictly in the specified order.
\nUse only the following protocols:
socks5, http, ssh
An example file:
\nimport requests\nimport time\nconfig = {\n \"octo_token\": \"OCTO_API_TOKEN\", # Your API Token\n \"proxies_file\": \"proxies.txt\", # File with proxies\n \"octo_api_base_url\": \"https://app.octobrowser.net/api/v2/automation/\"\n}\nsession = requests.Session()\nsession.headers.update({\n 'X-Octo-Api-Token': config[\"octo_token\"],\n 'Content-Type': \"application/json\"\n})\ndef sleep(ms):\n time.sleep(ms)\ndef parse_int_safe(value):\n try:\n return int(value)\n except (ValueError, TypeError):\n return 0\ndef check_limits(response):\n ratelimit_header = response.headers.get('ratelimit')\n if not ratelimit_header:\n print('No ratelimit header found!')\n return\n limit_entries = [entry.strip() for entry in ratelimit_header.split(',')]\n for entry in limit_entries:\n parts = entry.split(';')\n limit_name = parts[0] if parts else 'unknown_limit'\n remaining_quantity = 0\n window_seconds = 0\n for part in parts[1:]:\n if part.startswith('r='):\n remaining_quantity = parse_int_safe(part[2:])\n elif part.startswith('t='):\n window_seconds = parse_int_safe(part[2:])\n print(f'{limit_name}: remaining={remaining_quantity}, window={window_seconds}s')\n if remaining_quantity < 5:\n wait_time = window_seconds + 1\n print(f'Waiting {wait_time} seconds due to {limit_name} limit')\n sleep(wait_time)\ndef create_proxy(proxy_data):\n try:\n response = session.post(f\"{config['octo_api_base_url']}proxies\", json=proxy_data, timeout=10)\n response.raise_for_status()\n check_limits(response)\n uuid = response.json().get('data', {}).get('uuid')\n print(f\"Proxy {proxy_data.get('title')} created, UUID: {uuid}\")\n return uuid\n except Exception as e:\n print(f\"Error creating proxy {proxy_data.get('title')}: {e}\")\n return None\ndef create_profile(profile_number, proxy_uuid, profile_title):\n data = {\n \"title\": profile_title or f\"Profile {profile_number}\",\n \"proxy\": {\"uuid\": proxy_uuid},\n \"fingerprint\": {\"os\": \"win\"}\n }\n try:\n response = session.post(f\"{config['octo_api_base_url']}profiles\", json=data, timeout=10)\n response.raise_for_status()\n check_limits(response)\n print(f\"Profile {data['title']} created successfully\")\n except Exception as e:\n print(f\"Error creating profile {profile_number}: {e}\")\ndef main():\n try:\n with open(config[\"proxies_file\"], \"r\", encoding=\"utf-8\") as f:\n lines = [line.strip() for line in f if line.strip()]\n except Exception as e:\n print(f\"Error reading proxies file: {e}\")\n return\n for i, line in enumerate(lines):\n splitted = line.split(';')\n if len(splitted) == 7:\n type_, host, port, login, password, title, change_ip_url = splitted\n proxy_data = {\n \"type\": type_,\n \"host\": host,\n \"port\": int(port),\n \"login\": login,\n \"password\": password,\n \"title\": title,\n \"change_ip_url\": change_ip_url\n }\n elif len(splitted) == 6:\n type_, host, port, login, password, title = splitted\n proxy_data = {\n \"type\": type_,\n \"host\": host,\n \"port\": int(port),\n \"login\": login,\n \"password\": password,\n \"title\": title\n }\n else:\n print(f\"Skipping invalid proxy data on line {i + 1}\")\n continue\n proxy_uuid = create_proxy(proxy_data)\n if proxy_uuid:\n create_profile(i + 1, proxy_uuid, proxy_data.get(\"title\"))\nif __name__ == \"__main__\":\n main()\n\nHow to get the UUID of a saved proxy using API:
\nGetting the favorite proxy's UUID from the profile data:
\n- \n
Connect the desired proxy to any profile.
\n \nGet the profile with the desired proxy using a GET request.
\n \nThe server response will contain all data about the profile, including the UUID of the saved proxy.
\n \nYou can remove unnecessary server response fields and display only the UUID of the saved proxy.
\n \n
import requests\nuuid = 'UUID' # Place the profile UUID here\napi_token = 'OCTO_API_TOKEN' # Place your API token here\nurl = f'https://app.octobrowser.net/api/v2/automation/profiles/{uuid}'\nheaders = {\n 'X-Octo-Api-Token': api_token\n}\ntry:\n response = requests.get(url, headers=headers)\n response.raise_for_status()\n data = response.json()\n proxy_uuid = data['data']['proxy']['uuid']\n print(proxy_uuid)\nexcept requests.exceptions.RequestException as e:\n print(f\"Error: {e}\")\n\nGetting the saved proxy's UUID from the Proxy Manager list:
\n- \n
Use a Get Proxies request (you can find it in the documentation). You will get the data for all proxies saved in the Proxy Manager of your Octo Browser account; copy the UUID of the proxy that you need.
\n \nExample of a server response:
\n \n
{\n uuid: 'cbc173cc120747c7b57d4f6ea2496141',\n type: 'socks5',\n port: 5003,\n host: '127.0.0.1',\n login: 'admin',\n password: 'admin',\n change_ip_url: None,\n external_id: None,\n title: 'USA #2',\n profiles_count: 0\n}\n\nAdding a Proxy to a Profile
\nimport requests\nconfig = {\n \"octo_token\": \"OCTO_API_TOKEN\", # Your API token\n \"octo_api_base_url\": \"https://app.octobrowser.net/api/v2/automation/\",\n \"profile_uuid\": \"PROFILE_UUID\", # UUID of the profile to update\n \"proxy_uuid\": \"PROXY_UUID\" # UUID of the proxy to assign to the profile\n}\nheaders = {\n \"Content-Type\": \"application/json\",\n \"X-Octo-Api-Token\": config[\"octo_token\"]\n}\npatch_data = {\n \"proxy\": {\n \"uuid\": config[\"proxy_uuid\"]\n }\n}\ntry:\n url = f\"{config['octo_api_base_url']}profiles/{config['profile_uuid']}\"\n response = requests.patch(url, json=patch_data, headers=headers, timeout=10)\n response.raise_for_status()\n print(\"Profile updated successfully:\", response.json())\nexcept requests.RequestException as e:\n if e.response is not None:\n print(\"Error updating profile:\", e.response.json())\n else:\n print(\"Error updating profile:\", str(e))\n\nThis example collects profile data from the Export List and, based on that data, creates files with the .octo extension to be imported later.
\nUse an already existing folder for the \"PATH_TO_FOLDER\" parameter.
\nimport asyncio\nimport httpx\nimport json\nfrom pathlib import Path\nfrom typing import List, Dict, Any\n# Configuration\nOCTO_API_TOKEN = \"OCTO_API_TOKEN\" # Place your API token here\nPATH_TO_FOLDER = \"C:\\\\PATH\\\\TO\\\\YOUR\\\\FOLDER\" # Specify the path to an existing folder\n# HTTP client setup\nheaders = {\n 'X-Octo-Api-Token': OCTO_API_TOKEN,\n 'Content-Type': 'application/json'\n}\nclient = httpx.AsyncClient(\n base_url='https://app.octobrowser.net/api/v2/automation/',\n headers=headers\n)\nexport_profiles_data: List[Dict[str, Any]] = []\nasync def get_total_profiles() -> int:\n \"\"\"Get total number of profiles\"\"\"\n try:\n response = await client.get('profiles/export?page=0')\n data = response.json()\n return data.get('data', {}).get('total', 0)\n except Exception as e:\n print(f'Error fetching total profiles: {e}')\n return 0\nasync def get_profiles(total_profiles: int) -> None:\n total_pages = (total_profiles + 99) // 100\n print(f'Total pages: {total_pages}')\n for page in range(total_pages):\n try:\n response = await client.get(f'profiles/export?page={page}&page_len=100')\n data = response.json()\n export_profiles_data.extend(data.get('data', {}).get('data', []))\n except Exception as e:\n print(f'Error fetching page {page}: {e}')\nasync def ensure_dir_exists(directory: str) -> None:\n path = Path(directory)\n path.mkdir(parents=True, exist_ok=True)\nasync def write_to_files() -> None:\n await ensure_dir_exists(PATH_TO_FOLDER)\n used_file_names: Dict[str, int] = {}\n for item in export_profiles_data:\n inner_json_string = json.dumps(item)\n outer_object = {'data': inner_json_string}\n json_to_write = json.dumps(outer_object)\n filename = ''.join(c if c.isalnum() else '_' for c in item.get('title', '')).lower()\n if filename in used_file_names:\n used_file_names[filename] += 1\n filename += f'_{used_file_names[filename]}'\n else:\n used_file_names[filename] = 0\n file_path = Path(PATH_TO_FOLDER) / f'{filename}.octo'\n try:\n with open(file_path, 'w', encoding='utf-8') as f:\n f.write(json_to_write)\n except Exception as e:\n print(f'Error writing file {filename}: {e}')\nasync def main():\n total_profiles = await get_total_profiles()\n print(f'Total profiles in export list: {total_profiles}')\n if total_profiles == 0:\n print('No profiles found or error fetching total.')\n return\n await get_profiles(total_profiles)\n print(f'Quantity of profiles fetched: {len(export_profiles_data)}')\n await write_to_files()\n print('Profiles saved successfully.')\n await client.aclose()\nif __name__ == \"__main__\":\n asyncio.run(main())\n\nThis script retrieves all profile titles and saves them into a text file named profiles_titles.txt.
The output file is created in the current working directory.
import httpx\nimport asyncio\nfrom pathlib import Path\n#config. Paste your API Token here\nconfig = {\n \"octo_token\": \"OCTO_API_TOKEN\",\n \"octo_api_base_url\": \"https://app.octobrowser.net/api/v2/automation/\",\n}\nheaders = {\n \"X-Octo-Api-Token\": config[\"octo_token\"],\n \"Content-Type\": \"application/json\",\n}\nasync def sleep(seconds):\n await asyncio.sleep(seconds)\ndef parse_int_safe(value):\n try:\n return int(value)\n except (ValueError, TypeError):\n return 0\nasync def check_limits(response):\n ratelimit_header = response.headers.get('ratelimit')\n if not ratelimit_header:\n print('No ratelimit header found!')\n return\n limit_entries = [entry.strip() for entry in ratelimit_header.split(',')]\n for entry in limit_entries:\n parts = entry.split(';')\n limit_name = parts[0] if parts else 'unknown_limit'\n remaining_quantity = 0\n window_seconds = 0\n for part in parts[1:]:\n if part.startswith('r='):\n remaining_quantity = parse_int_safe(part[2:])\n elif part.startswith('t='):\n window_seconds = parse_int_safe(part[2:])\n print(f'{limit_name}: remaining={remaining_quantity}, window={window_seconds}s')\n if remaining_quantity < 5:\n wait_time = window_seconds + 1\n print(f'Waiting {wait_time} seconds due to {limit_name} limit')\n await sleep(wait_time)\nasync def get_total_pages(client):\n response = await client.get(\"profiles?page=0&page_len=10\")\n data = response.json()\n total_profiles = data[\"total_count\"]\n total_pages = (total_profiles + 99) // 100\n print(f\"Total Profiles: {total_profiles}\\nTotal Pages: {total_pages}\")\n await check_limits(response)\n return total_pages\nasync def get_all_profiles_titles(client, total_pages):\n profiles = []\n for page in range(total_pages):\n response = await client.get(\n f\"profiles?page={page}&page_len=100&fields=title\"\n )\n data = response.json()\n await check_limits(response)\n profiles.extend(data[\"data\"])\n return profiles\nasync def write_file(profiles):\n titles = [item[\"title\"] for item in profiles if item.get(\"title\")]\n try:\n Path(\"profiles_titles.txt\").write_text(\"\\n\".join(titles), encoding=\"utf-8\")\n except Exception as e:\n print(f\"ERROR: While trying writing the file some error occurred:\\n{e}\")\nasync def main():\n async with httpx.AsyncClient(\n base_url=config[\"octo_api_base_url\"],\n headers=headers\n ) as client:\n total_pages = await get_total_pages(client)\n profiles = await get_all_profiles_titles(client, total_pages)\n await write_file(profiles)\n print(\"Finished. Check profiles_titles.txt file...\")\nif __name__ == \"__main__\":\n asyncio.run(main())\n\nExamples of useful scripts for Python
\n","_postman_id":"7a99bc92-74b0-4742-93a2-f0fb6cbe5898"}],"id":"2e79b10a-07ed-4973-8c8e-eb053101cb91","_postman_id":"2e79b10a-07ed-4973-8c8e-eb053101cb91","description":""},{"name":"Action Log","item":[],"id":"a753117d-a8b0-4490-9b9a-04a5689ee239","description":"Action log stream
\nEndpoint
\n- \n
Type: WebSocket
\n \nURL:
\nwss://app.octobrowser.net//api/v2/automation/ws/action_log\nAuthentication: Auto API Token (header
\nX-Octo-Api-Token) \n
Response Format
\nEach WebSocket message contains a StreamPage:
{\n\"items\": [\n {\n \"uuid\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"action\": \"profiles.started\",\n \"time\": 1707053400,\n \"user_email\": \"user@example.com\",\n \"object_type\": \"profile\",\n \"object_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"object_title\": \"Octo Browser Profile\"\n }\n ],\n \"watermark\": {\n \"uuid\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"time\": 1707053400\n }\n}\n\nExamples
\nInitial Connection
\nwss://app.octobrowser.net/api/v2/automation/ws/action_log
Reconnect After Disconnect
\nUse the watermark UUID to resume:
\nwss://app.octobrowser.net/api/v2/automation/ws/action_log?after_uuid=abc-123
Start From Specific Time
\nwss://app.octobrowser.net/api/v2/automation/ws/action_log?from_timestamp=1707053400
Event Types (Actions)
\n- \n
\nprofiles.started- Profile browser was started \n
\nprofiles.stopped- Profile browser was stopped \n
\nprofiles.force_stopped- Profile browser was force stopped \n
Query Parameters
\n- \n
after_uuid (string, UUID, optional) - UUID of the last received audit entry. Use this to resume streaming from a specific point.
\n \nfrom_timestamp (integer, Unix timestamp, optional) - Start streaming from this timestamp. Events are only available for 24 hours.
\n \n
How It Works
\n- \n
Connect to the WebSocket endpoint
\n \nReceive pages of events as JSON messages
\n \nUse the watermark from each response to track your position in the stream and use these values in case of reconnection
\n \n
Watermark Mechanics
\nThe watermark acts as a cursor for pagination:
\n- \n
Contains
\nuuidandtimeof the last record \nEnsures stable pagination even when multiple records share the same timestamp
\n \nUse
\nafter_uuidparameter on reconnect to resume from where you left off \nUse the
\nfrom_timeparameter when reconnecting to continue from a specific time \n
Constraints
\n- \n
Event retention: 24 hours
\n \nBatch size: Up to 100 records per page
\n \nRequirements: Team must have API option in subscription
\n \n