{"id":2992,"date":"2023-06-25T16:21:38","date_gmt":"2023-06-25T08:21:38","guid":{"rendered":"https:\/\/www.vmlogin.us\/help\/?p=2992"},"modified":"2024-02-26T10:35:09","modified_gmt":"2024-02-26T02:35:09","slug":"api-interface-examples","status":"publish","type":"post","link":"https:\/\/www.vmlogin.us\/help\/api\/api-interface-examples.html","title":{"rendered":"REST API Interfaces Introduction and Examples"},"content":{"rendered":"\n

Groups<\/mark><\/strong><\/p>\n\n\n\n

Type<\/strong><\/td>Description<\/strong><\/td>API<\/strong><\/td><\/tr>
GET<\/td>Create a group<\/td>\/tag\/create<\/a><\/strong><\/td><\/tr>
GET<\/td>Remove a group<\/td>\/tag\/remove<\/a><\/strong><\/td><\/tr>
GET<\/td>Rename a group<\/td>\/tag\/rename<\/a><\/strong><\/td><\/tr>
GET<\/td>Get a list of all groups available on your account<\/td>\/tag\/list<\/a><\/strong><\/td><\/tr>
GET<\/td>Move browser profile to specific group<\/td>\/tag\/profile\/add<\/a><\/strong><\/td><\/tr>
GET<\/td>Remove the current group from the browser profile
(Merge to default group)<\/td>		\/tag\/profile\/remove<\/a><\/strong><\/td><\/tr>
GET<\/td>Gets a list of profiles based on a specific group ID<\/td>\/tag\/profile\/list<\/a><\/strong><\/a><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n


<\/p>\n\n\n\n

Profiles<\/mark><\/strong><\/p>\n\n\n\n

Type<\/strong><\/td>Description<\/strong><\/td>API<\/strong><\/td><\/tr>
POST<\/td>Randomly create browser profile<\/td>\/profile\/random<\/a><\/strong><\/td><\/tr>
POST<\/td>Customize all parameters to create browser profile<\/td>\/profile\/create<\/a><\/strong><\/td><\/tr>
POST<\/td>Update browser profile settings<\/td>\/profile\/update<\/a><\/strong><\/td><\/tr>
GET<\/td>Detail browser profile<\/td>\/profile\/detail<\/a><\/strong><\/td><\/tr>
GET<\/td>Sharing browser profile (batch operation)<\/td>\/profile\/share<\/a><\/strong><\/td><\/tr>
GET<\/td>Browser profile unshare (batch operation)<\/td>\/profile\/cancelShare<\/a><\/strong><\/td><\/tr>
GET<\/td>Transfer browser profile\u2019s ownership (batch operation)<\/td>\/profile\/transferOwnership<\/a><\/strong><\/td><\/tr>
GET<\/td>Release the browser profile (batch operation)<\/td>\/profile\/release<\/a><\/strong><\/td><\/tr>
GET<\/td>Remove browser profile (batch operation)<\/td>\/profile\/remove<\/a><\/strong><\/td><\/tr>
GET<\/td>Get a list of all available browser profiles<\/td>\/profile\/list<\/a><\/strong><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n


<\/p>\n\n\n\n

UserAgent<\/mark><\/strong><\/p>\n\n\n\n

Type<\/strong><\/td>Description<\/strong><\/td>API<\/strong><\/td><\/tr>
GET\/POST<\/td>Get random UA by specifying OS and kernel version <\/td>\/ua\/rand<\/a><\/strong><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n


<\/p>\n\n\n\n

Local REST API<\/mark><\/strong><\/p>\n\n\n\n

Type<\/strong><\/td>Description<\/strong><\/td>API<\/strong><\/td><\/tr>
GET<\/td>Launch the browser profile<\/td>\/profile\/start<\/a><\/strong><\/td><\/tr>
GET<\/td>Stop the browser profile<\/td>\/profile\/stop<\/a><\/strong><\/td><\/tr>
GET<\/td>Refresh the browser profile<\/td>\/profile\/refresh<\/a><\/strong><\/td><\/tr>
GET<\/td>Open the specified page on the current tabs<\/td>\/profile\/openurl<\/a><\/strong><\/td><\/tr>
GET<\/td>Open a new TAB<\/td>\/profile\/newtab<\/a><\/strong><\/td><\/tr>
GET<\/td>Get webpage source code<\/td>\/profile\/source<\/strong><\/a><\/strong><\/td><\/tr>
GET<\/td>Send the file to the webpage<\/td>\/profile\/sendKeys<\/a><\/strong><\/td><\/tr>
GET<\/td>Check the profile is running correctly<\/td>\/profile\/active<\/a><\/strong><\/td><\/tr>
GET<\/td>Get a random profile information<\/td>\/profile\/randomProfile<\/a><\/strong><\/td><\/tr>
GET<\/td>Delete a profile of local TEMP folder<\/td>\/profile\/delete<\/a><\/strong><\/td><\/tr>
POST<\/td>Create the local profile and launch it<\/td>\/profile\/create_start<\/a><\/strong><\/td><\/tr>
GET<\/td>Export the cookies from profile<\/td>\/profile\/cookies\/export\/webext<\/a><\/strong><\/td><\/tr>
POST<\/td>Import cookie to browser profile<\/td>\/profile\/cookies\/import\/webext<\/a><\/strong><\/td><\/tr>
POST<\/td>Execute Script<\/td>\/profile\/ExecuteScript<\/a><\/strong><\/td><\/tr>
POST<\/td>Screen Shot<\/td>\/profile\/ScreenShot<\/a><\/strong><\/td><\/tr>
POST<\/td>Get ALL Cookie<\/td>\/profile\/getCookies<\/a><\/strong><\/td><\/tr>
POST<\/td>Ask if the current page is loaded<\/td>\/profile\/readyState<\/a><\/strong><\/td><\/tr>
GET<\/td>Switch TAB<\/td>\/profile\/page\/bringToFront<\/a><\/strong><\/td><\/tr>
GET<\/td>Closed TAB<\/td>\/profile\/page\/close<\/a><\/strong><\/td><\/tr>
GET<\/td>Warn you if passwords are exposed in a data breach<\/td>\/profile\/browser\/password_<\/strong>
manager_leak_detection<\/strong><\/a><\/td><\/tr>
GET<\/td>Restart client (no request parameters)<\/td>\/client\/restart<\/a><\/strong><\/td><\/tr>
GET<\/td>Test Proxy<\/td>\/proxy\/test<\/a><\/strong><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n


<\/p>\n\n\n\n

Description of Settings in the Profiles<\/mark><\/strong><\/p>\n\n\n\n

Name<\/strong><\/td>Specific Description<\/strong><\/td><\/tr>
Create Profile<\/td>createProfileRequest<\/a><\/strong><\/td><\/tr>
deviceOS List<\/td>devicesOS<\/a><\/strong><\/td><\/tr>
acceptLanguage List<\/td>acceptLanguage<\/a><\/strong><\/td><\/tr>
fontList<\/td>fontList<\/a><\/strong><\/td><\/tr><\/tbody><\/table><\/figure>\n","protected":false},"excerpt":{"rendered":"

Groups Type Description API GET Create a group \/tag\/cre […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[13],"tags":[],"class_list":["post-2992","post","type-post","status-publish","format-standard","hentry","category-api"],"_links":{"self":[{"href":"https:\/\/www.vmlogin.us\/help\/wp-json\/wp\/v2\/posts\/2992","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.vmlogin.us\/help\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.vmlogin.us\/help\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.vmlogin.us\/help\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.vmlogin.us\/help\/wp-json\/wp\/v2\/comments?post=2992"}],"version-history":[{"count":23,"href":"https:\/\/www.vmlogin.us\/help\/wp-json\/wp\/v2\/posts\/2992\/revisions"}],"predecessor-version":[{"id":3735,"href":"https:\/\/www.vmlogin.us\/help\/wp-json\/wp\/v2\/posts\/2992\/revisions\/3735"}],"wp:attachment":[{"href":"https:\/\/www.vmlogin.us\/help\/wp-json\/wp\/v2\/media?parent=2992"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.vmlogin.us\/help\/wp-json\/wp\/v2\/categories?post=2992"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.vmlogin.us\/help\/wp-json\/wp\/v2\/tags?post=2992"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}