{"id":2458,"date":"2023-08-09T10:00:37","date_gmt":"2023-08-09T02:00:37","guid":{"rendered":"https:\/\/www.xlogin.us\/help\/docs\/api-automation\/api-launch-the-browser-profile\/"},"modified":"2024-12-04T15:26:14","modified_gmt":"2024-12-04T07:26:14","slug":"api-launch-the-browser-profile","status":"publish","type":"docs","link":"https:\/\/www.xlogin.us\/help\/docs\/api-automation\/api-launch-the-browser-profile\/","title":{"rendered":"API Launch the Browser Profile"},"content":{"rendered":"\n<p class=\"has-medium-font-size\"><strong>API Launch the browser profile\uff1a<\/strong><\/p>\n\n\n\n<p><br><\/p>\n\n\n\n<p class=\"has-medium-font-size\">Request Url: <\/p>\n\n\n\n<p><br><\/p>\n\n\n\n<pre class=\"wp-block-code has-medium-font-size\"><code><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\">http:\/\/127.0.0.1:35000\/api\/v1\/profile\/start?profileId=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx<\/mark><\/code><\/pre>\n\n\n\n<p><br><\/p>\n\n\n\n<p class=\"has-medium-font-size\">Request Type: POST\/GET<\/p>\n\n\n\n<p><br><\/p>\n\n\n\n<figure class=\"wp-block-table has-medium-font-size\"><table><tbody><tr><td><strong>Name<\/strong><\/td><td><strong>Type<\/strong><\/td><td><strong>Description<\/strong><\/td><td><strong>required<\/strong><\/td><\/tr><tr><td>profileId<\/td><td>string<\/td><td>Browser profile ID<\/td><td>true<\/td><\/tr><tr><td>skiplock<\/td><td>boolean<\/td><td>Start the browser by skipping the session lock<\/td><td>false<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p><br><br><\/p>\n\n\n\n<p class=\"has-medium-font-size\"><strong>Note:<\/strong><\/p>\n\n\n\n<p><br><\/p>\n\n\n\n<p class=\"has-medium-font-size\">1. Enable browser automation settings and save the settings on the XLogin client. For the tutorial, please refer to the <strong><a href=\"https:\/\/www.xlogin.us\/help\/docs\/api-automation\/launch-the-browser-automation-port\/\" data-type=\"link\" data-id=\"https:\/\/www.xlogin.us\/help\/docs\/api-automation\/launch-the-browser-automation-port\/\" target=\"_blank\" rel=\"noreferrer noopener\">\"Launch the browser automation port\"<\/a><\/strong>;<\/p>\n\n\n\n<p><br><\/p>\n\n\n\n<p class=\"has-medium-font-size\">2. profileId: Please refer to the <strong><a href=\"https:\/\/www.xlogin.us\/help\/docs\/api-automation\/where-can-the-profile-id-be-found\/\" data-type=\"link\" data-id=\"https:\/\/www.xlogin.us\/help\/docs\/api-automation\/where-can-the-profile-id-be-found\/\" target=\"_blank\" rel=\"noreferrer noopener\">\"Where can the Profile ID be Found?\"<\/a><\/strong> tutorial or use the <strong><a href=\"https:\/\/www.xlogin.us\/help\/docs\/api-automation\/api-get-the-list-of-all-available-browser-profiles\/\" data-type=\"link\" data-id=\"https:\/\/www.xlogin.us\/help\/docs\/api-automation\/api-get-the-list-of-all-available-browser-profiles\/\" target=\"_blank\" rel=\"noreferrer noopener\">profile\/list interface<\/a><\/strong> to get all profileId.<\/p>\n\n\n\n<figure class=\"wp-block-image size-full\"><img loading=\"lazy\" decoding=\"async\" width=\"790\" height=\"546\" src=\"https:\/\/www.xlogin.us\/help\/wp-content\/uploads\/2023\/08\/\u56fe1-3.png\" alt=\"\" class=\"wp-image-2506\" srcset=\"https:\/\/www.xlogin.us\/help\/wp-content\/uploads\/2023\/08\/\u56fe1-3.png 790w, https:\/\/www.xlogin.us\/help\/wp-content\/uploads\/2023\/08\/\u56fe1-3-300x207.png 300w, https:\/\/www.xlogin.us\/help\/wp-content\/uploads\/2023\/08\/\u56fe1-3-768x531.png 768w\" sizes=\"auto, (max-width: 790px) 100vw, 790px\" \/><\/figure>\n\n\n\n<p><\/p>\n\n\n\n<p><\/p>\n\n\n\n<p><\/p>\n","protected":false},"featured_media":0,"parent":810,"menu_order":32,"comment_status":"closed","ping_status":"closed","template":"","doc_tag":[],"class_list":["post-2458","docs","type-docs","status-publish","hentry"],"comment_count":0,"_links":{"self":[{"href":"https:\/\/www.xlogin.us\/help\/wp-json\/wp\/v2\/docs\/2458","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.xlogin.us\/help\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/www.xlogin.us\/help\/wp-json\/wp\/v2\/types\/docs"}],"replies":[{"embeddable":true,"href":"https:\/\/www.xlogin.us\/help\/wp-json\/wp\/v2\/comments?post=2458"}],"version-history":[{"count":6,"href":"https:\/\/www.xlogin.us\/help\/wp-json\/wp\/v2\/docs\/2458\/revisions"}],"predecessor-version":[{"id":3366,"href":"https:\/\/www.xlogin.us\/help\/wp-json\/wp\/v2\/docs\/2458\/revisions\/3366"}],"up":[{"embeddable":true,"href":"https:\/\/www.xlogin.us\/help\/wp-json\/wp\/v2\/docs\/810"}],"next":[{"title":"API Stop\/Close the Browser Profile","link":"https:\/\/www.xlogin.us\/help\/docs\/api-automation\/api-stop-close-the-browser-profile\/","href":"https:\/\/www.xlogin.us\/help\/wp-json\/wp\/v2\/docs\/2462"}],"prev":[{"title":"API Get the List of all Available Browser Profiles","link":"https:\/\/www.xlogin.us\/help\/docs\/api-automation\/api-get-the-list-of-all-available-browser-profiles\/","href":"https:\/\/www.xlogin.us\/help\/wp-json\/wp\/v2\/docs\/2443"}],"wp:attachment":[{"href":"https:\/\/www.xlogin.us\/help\/wp-json\/wp\/v2\/media?parent=2458"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/www.xlogin.us\/help\/wp-json\/wp\/v2\/doc_tag?post=2458"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}