{"info":{"_postman_id":"50c82b5e-0696-4bb3-9b73-05daf655bde8","name":"SessionBox One Local API V1","description":"

This API is for programmatically accessing SessionBox One application running on your computer. You can build applications and solutions leveraging SessionBox One profile isolation power. You can seamlessly integrate profiles with any automation framework using this API.

Authorization

Enable local API

To enable local api go to the settings in the application and select Issue API key option. This will issue an API key for the logged in user. The API key is tied to a user account, so make sure the correct user is logged into the application before you start using our API. The API key isn't tied to the machine so you can use it anywhere where the user is logged in.

How to use API key

Put the API key into the Authorization header in every API request you make.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"12504551","collectionId":"50c82b5e-0696-4bb3-9b73-05daf655bde8","publishedId":"2s946o4pV8","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"62E698"},"publishDate":"2023-07-25T11:57:25.000Z"},"item":[{"name":"Managing profiles","item":[{"name":"List profiles","id":"acbe6612-9554-4275-b515-2c5c7b261cda","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:54789/local-api/v1/profiles","description":"

List all profiles which the user has access to. The list will contain all personal profiles and profiles from teams as well.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"50c82b5e-0696-4bb3-9b73-05daf655bde8","id":"50c82b5e-0696-4bb3-9b73-05daf655bde8","name":"SessionBox One Local API V1","type":"collection"}},"urlObject":{"protocol":"http","port":"54789","path":["local-api","v1","profiles"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"8d61b2cf-55bd-4cc8-9b22-148ca24d60a4","name":"List profiles","originalRequest":{"method":"GET","header":[],"url":"http://localhost:54789/local-api/v1/profiles"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"Origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"222"},{"key":"Date","value":"Sun, 23 Jul 2023 01:24:18 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"profiles\": [\n {\n \"id\": \"875b9a29-6754-4098-9c3f-f2ae465fbbee\",\n \"teamId\": \"ijNHC8ekbzeicVYl1b0gLTowSR73\",\n \"launchUrl\": \"https://facebook.com\",\n \"name\": \"Facebook\",\n \"color\": \"red\",\n \"group\": \"Private profiles\",\n \"icon\": \"box\"\n }\n ]\n}"}],"_postman_id":"acbe6612-9554-4275-b515-2c5c7b261cda"},{"name":"Get profile","id":"55c47020-ded7-4101-a204-9aa01cc265c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:54789/local-api/v1/profiles/:profileId","description":"

Get details of a specific profile.

The id of the profile to fetch

\n","type":"text/plain"},"type":"any","value":"","key":"profileId"}]}},"response":[{"id":"ca3c5c0e-e387-42cd-b8f4-923faa4742d4","name":"Get profile","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://localhost:54789/local-api/v1/profiles/:profileId","protocol":"http","host":["localhost"],"port":"54789","path":["local-api","v1","profiles",":profileId"],"variable":[{"key":"profileId","value":"875b9a29-6754-4098-9c3f-f2ae465fbbee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"Origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"219"},{"key":"Date","value":"Mon, 24 Jul 2023 12:01:11 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"profile\": {\n \"id\": \"875b9a29-6754-4098-9c3f-f2ae465fbbee\",\n \"teamId\": \"ijNHC8ekbzeicVYl1b0gLTowSR73\",\n \"launchUrl\": \"https://facebook.com\",\n \"name\": \"Facebook\",\n \"color\": \"red\",\n \"group\": \"Private profiles\",\n \"icon\": \"box\"\n }\n}"}],"_postman_id":"55c47020-ded7-4101-a204-9aa01cc265c5"},{"name":"Create profile","id":"b3c11559-be9d-4254-9c57-85ba7cdaf1f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"color\": \"red\",\n \"group\": \"Private profiles\",\n \"name\": \"Facebook\",\n \"url\": \"https://facebook.com\",\n \"storageType\": \"local\",\n \"cookies\": []\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:54789/local-api/v1/profiles","description":"

Create a new stored profile. To create a temporary profile use the create action token endpoint directly.

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
name*	string	Name of the profile
storageType*	`cloud` or `local`	Type of the profile
url*	string	Default launch url of the profile. This url will open automatically if a user clicks on the profile
group	string	The group of the profile. If not provided the default group will be used.
teamId	string	Id of the team which the new profile belongs to. If not provided the logged in user's private team will be used.
color	string	The color of the new profile. If not provided random color will be assigned. See the list of color names in the Types section.
cookies	Cookie[]	Cookies to initialize the profile.
sbProxyId	string	Id of the proxy to set. The proxy has to be in the same team as the profile.

Delete a stored profile.

Id of the profile to delete

\n","type":"text/plain"},"type":"any","value":"","key":"profileId"}]}},"response":[{"id":"505cb66c-2614-47c6-b1e1-f39c93de920e","name":"Delete profile","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"http://localhost:54789/local-api/v1/profiles/:profileId","protocol":"http","host":["localhost"],"port":"54789","path":["local-api","v1","profiles",":profileId"],"variable":[{"key":"profileId","value":"0215c55f-c49a-4d76-88bb-0db24a8aa4c7","description":"Id of the profile to delete"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"Origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"16"},{"key":"Date","value":"Mon, 24 Jul 2023 13:00:38 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"7ef71c05-7394-40e7-980a-7762e266af4c"},{"name":"Update profile","id":"735dcd8a-496c-464c-9a8c-a3565dd1e8fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"color\": \"red\",\n \"group\": \"New group\",\n \"name\": \"New name\",\n \"sbProxyId\": \"9c260ebd-c7c6-4ac3-b0d3-b4cc60d5dff9\",\n \"url\": \"https://sessionbox.io\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:54789/local-api/v1/profiles/:profileId","description":"

Update an existing profile

Id of the profile to delete

\n","type":"text/plain"},"type":"any","value":"","key":"profileId"}]}},"response":[{"id":"aaf5f7c5-11a5-4854-b935-0376663260c1","name":"Update profile","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"color\": \"red\",\n \"group\": \"New group\",\n \"name\": \"New name\",\n \"sbProxyId\": \"9c260ebd-c7c6-4ac3-b0d3-b4cc60d5dff9\",\n \"url\": \"https://sessionbox.io\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"http://localhost:54789/local-api/v1/profiles/:profileId","protocol":"http","host":["localhost"],"port":"54789","path":["local-api","v1","profiles",":profileId"],"variable":[{"key":"profileId","value":"e2e39a56-419c-4f76-b1ad-ab6265f220fb","description":"Id of the profile to delete"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"Origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"16"},{"key":"Date","value":"Tue, 25 Jul 2023 10:40:07 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"735dcd8a-496c-464c-9a8c-a3565dd1e8fa"}],"id":"882bbf9e-695f-49b5-b745-566546c48734","description":"

You can manage stored profiles through this API (cloud and local). If you wish to create a temporary profile you can use the Create action token endpoint directly.

\n","_postman_id":"882bbf9e-695f-49b5-b745-566546c48734","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"50c82b5e-0696-4bb3-9b73-05daf655bde8","id":"50c82b5e-0696-4bb3-9b73-05daf655bde8","name":"SessionBox One Local API V1","type":"collection"}}},{"name":"Managing proxies","item":[{"name":"List proxies","id":"b86315a4-6a38-4449-ba1d-44e00f9259d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:54789/local-api/v1/proxies","description":"

Get a list of the proxies. It will contain all proxies from the teams the current user has access.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"50c82b5e-0696-4bb3-9b73-05daf655bde8","id":"50c82b5e-0696-4bb3-9b73-05daf655bde8","name":"SessionBox One Local API V1","type":"collection"}},"urlObject":{"protocol":"http","port":"54789","path":["local-api","v1","proxies"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"feb11a29-1d62-4452-b502-3128efaff7de","name":"List proxies","originalRequest":{"method":"GET","header":[],"url":"http://localhost:54789/local-api/v1/proxies"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"Origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"223"},{"key":"Date","value":"Mon, 24 Jul 2023 13:35:40 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"proxies\": [\n {\n \"id\": \"b5bf99f1-fc39-4463-9711-c453e25555ce\",\n \"port\": \"8899\",\n \"type\": \"http\",\n \"name\": \"Test proxy\",\n \"ip\": \"localhost\",\n \"password\": \"password\",\n \"teamId\": \"ijNHC8ekbzeicVYl1b0gLTowSR73\",\n \"username\": \"username\"\n }\n ]\n}"}],"_postman_id":"b86315a4-6a38-4449-ba1d-44e00f9259d3"},{"name":"Add proxy","id":"414ed9ee-5a63-45d5-9189-5974bab11071","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Test proxy\",\n \"type\": \"http\",\n \"username\": \"testuser\",\n \"password\": \"testpass\",\n \"ip\": \"localhost\",\n \"port\": \"1234\",\n \"teamId\": \"ijNHC8ekbzeicVYl1b0gLTowSR73\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:54789/local-api/v1/proxies","description":"

Create new proxy. Username and password field is not supported for SOCKS5 proxies.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"50c82b5e-0696-4bb3-9b73-05daf655bde8","id":"50c82b5e-0696-4bb3-9b73-05daf655bde8","name":"SessionBox One Local API V1","type":"collection"}},"urlObject":{"protocol":"http","port":"54789","path":["local-api","v1","proxies"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"62690039-7a9e-4dfe-8c79-d299d4dd6374","name":"Add proxy","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Test proxy\",\n \"type\": \"http\",\n \"username\": \"testuser\",\n \"password\": \"testpass\",\n \"ip\": \"localhost\",\n \"port\": \"1234\",\n \"teamId\": \"ijNHC8ekbzeicVYl1b0gLTowSR73\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:54789/local-api/v1/proxies"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"Origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"179"},{"key":"Date","value":"Mon, 24 Jul 2023 14:14:28 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"proxy\": {\n \"id\": \"daec40cc-3e29-41d8-acc4-70dee849d327\",\n \"name\": \"Test proxy\",\n \"type\": \"http\",\n \"username\": \"testuser\",\n \"password\": \"testpass\",\n \"ip\": \"localhost\",\n \"port\": \"1234\"\n }\n}"}],"_postman_id":"414ed9ee-5a63-45d5-9189-5974bab11071"},{"name":"Delete proxy","id":"24cc074b-8627-4b97-84c7-c93524783e55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"http://localhost:54789/local-api/v1/proxies/:proxyId","description":"

Delete a proxy.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"50c82b5e-0696-4bb3-9b73-05daf655bde8","id":"50c82b5e-0696-4bb3-9b73-05daf655bde8","name":"SessionBox One Local API V1","type":"collection"}},"urlObject":{"protocol":"http","port":"54789","path":["local-api","v1","proxies",":proxyId"],"host":["localhost"],"query":[],"variable":[{"id":"df02b2b7-1a1d-4a47-b215-b4d41d984009","type":"any","value":"daec40cc-3e29-41d8-acc4-70dee849d327","key":"proxyId"}]}},"response":[{"id":"b108eb4f-d291-41a7-8abd-3f2d61dbdbd7","name":"Delete proxy","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"http://localhost:54789/local-api/v1/proxies/:proxyId","protocol":"http","host":["localhost"],"port":"54789","path":["local-api","v1","proxies",":proxyId"],"variable":[{"key":"proxyId","value":"daec40cc-3e29-41d8-acc4-70dee849d327"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"Origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"16"},{"key":"Date","value":"Mon, 24 Jul 2023 14:26:49 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"24cc074b-8627-4b97-84c7-c93524783e55"}],"id":"07a91ff5-d43a-4f42-9302-e9312b88d471","description":"

Proxies can be managed through this API.

\n","_postman_id":"07a91ff5-d43a-4f42-9302-e9312b88d471","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"50c82b5e-0696-4bb3-9b73-05daf655bde8","id":"50c82b5e-0696-4bb3-9b73-05daf655bde8","name":"SessionBox One Local API V1","type":"collection"}}},{"name":"Managing teams","item":[{"name":"List teams","id":"1d4994d6-7fa5-467a-9e2c-7c7408d507b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:54789/local-api/v1/teams","description":"

Get all teams accessible by the current user.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"50c82b5e-0696-4bb3-9b73-05daf655bde8","id":"50c82b5e-0696-4bb3-9b73-05daf655bde8","name":"SessionBox One Local API V1","type":"collection"}},"urlObject":{"protocol":"http","port":"54789","path":["local-api","v1","teams"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"d7e235e7-806e-4098-bcab-a2faf114fbcf","name":"List teams","originalRequest":{"method":"GET","header":[],"url":"http://localhost:54789/local-api/v1/teams"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"Origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"405"},{"key":"Date","value":"Mon, 24 Jul 2023 14:38:00 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"teams\": [\n {\n \"teamId\": \"ijNHC8ekbzeicVYl1b0gLTowSR73\",\n \"members\": [\n \"ijNHC8ekbzeicVYl1b0gLTowSR73\"\n ],\n \"invited\": [],\n \"color\": \"\",\n \"name\": \"\",\n \"isPrivate\": true,\n \"owners\": [\n \"ijNHC8ekbzeicVYl1b0gLTowSR73\"\n ]\n },\n {\n \"name\": \"My team\",\n \"teamId\": \"59a6a84a-cbc2-4385-beca-f00e38627bed\",\n \"owners\": [\n \"ijNHC8ekbzeicVYl1b0gLTowSR73\"\n ],\n \"isPrivate\": false,\n \"invited\": [],\n \"members\": [\n \"ijNHC8ekbzeicVYl1b0gLTowSR73\"\n ],\n \"color\": \"#36a4ba\"\n }\n ]\n}"}],"_postman_id":"1d4994d6-7fa5-467a-9e2c-7c7408d507b1"}],"id":"c04ea28d-7594-4bab-a752-383b528178bd","description":"

Teams can be fetched for the logged in user. You can use team ids to assign resources to them.

All user have a private team, which holds its private resources. The private team is flagged isPrivate: true property.

\n","_postman_id":"c04ea28d-7594-4bab-a752-383b528178bd","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"50c82b5e-0696-4bb3-9b73-05daf655bde8","id":"50c82b5e-0696-4bb3-9b73-05daf655bde8","name":"SessionBox One Local API V1","type":"collection"}}},{"name":"Open profile in browser","item":[{"name":"Create action token","id":"d18951d7-f4a7-4788-9694-7d3186b2090e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"action\": \"open\",\n \"profileId\": \"b92b8924-dd71-4ab3-9f74-244844c0ce2e\",\n \"url\": \"https://sessionbox.io\"\n}\n","options":{"raw":{"language":"json"}}},"url":"http://localhost:54789/local-api/v1/action-token","description":"

You can use this action token to open a profile in a Chrome, Firefox or Edge web browser

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
action*	`temp`, `cloud`, `local` or `open`	The type of the action. The `open` action will open an existing profile. In this case `profileId` parameter is mandatory. Otherwise a new profile will be created with the matching profile type.
url*	string	The URL of the page what the browser will open.
profileId	string	When action type is `open` this property is required. The id of the profile to open.
cookies	Cookie[]	The listed cookies will be added to the new profile.

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"50c82b5e-0696-4bb3-9b73-05daf655bde8","id":"50c82b5e-0696-4bb3-9b73-05daf655bde8","name":"SessionBox One Local API V1","type":"collection"}},"urlObject":{"protocol":"http","port":"54789","path":["local-api","v1","action-token"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"86d44562-cbbf-4542-8fe2-a0023d103d63","name":"Create profile with preset cookies","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"action\": \"open\",\n \"url\": \"https://sessionbox.io\",\n \"cookies\": [\n {\n \"name\": \"MY_COOKIE\",\n \"value\": \"value\",\n \"secure\": true\n },\n {\n \"name\": \"MY_COOKIE_2\",\n \"value\": \"value2\",\n \"secure\": true\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:54789/local-api/v1/action-token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"Origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"411"},{"key":"Date","value":"Mon, 24 Jul 2023 15:52:16 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY3Rpb24iOiJvcGVuIiwiZW5kcG9pbnQiOiJodHRwOi8vbG9jYWxob3N0OjU0Nzg5Iiwic2Vzc2lvbklkIjoiNmI2YTg5ZjctMDA0OC00MmQ2LTg4NWEtMGI0MWQ1OWU5ZDdmIiwidWlkIjoiaWpOSEM4ZWtiemVpY1ZZbDFiMGdMVG93U1I3MyIsInVybCI6Imh0dHBzOi8vc2Vzc2lvbmJveC5pbyIsImxhbmciOiJlbiIsInRyaWdnZXJlZEJ5IjoiYXV0b21hdGlvbiIsImlhdCI6MTY5MDIxMzkzNn0.EbDGOrk1kG9oAuGWShFirRR0lwHm8eloj109NmP7vXQ\"\n}"},{"id":"73ef7502-73da-4f3b-8ca4-81e6f13ab71d","name":"Create temporary profile","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"action\": \"temp\",\n \"url\": \"https://sessionbox.io\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:54789/local-api/v1/action-token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"Origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"411"},{"key":"Date","value":"Mon, 24 Jul 2023 15:53:21 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY3Rpb24iOiJvcGVuIiwiZW5kcG9pbnQiOiJodHRwOi8vbG9jYWxob3N0OjU0Nzg5Iiwic2Vzc2lvbklkIjoiYjkyYjg5MjQtZGQ3MS00YWIzLTlmNzQtMjQ0ODQ0YzBjZTJlIiwidWlkIjoiaWpOSEM4ZWtiemVpY1ZZbDFiMGdMVG93U1I3MyIsInVybCI6Imh0dHBzOi8vc2Vzc2lvbmJveC5pbyIsImxhbmciOiJlbiIsInRyaWdnZXJlZEJ5IjoiYXV0b21hdGlvbiIsImlhdCI6MTY5MDIxNDAwMX0.VxRrUrc1UgKtVIGt34z6rErHvcKg6wQOpx7_WXVaS0s\"\n}"},{"id":"b7712de2-cce8-4739-a602-dbe51f034371","name":"Open existing profile","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"action\": \"open\",\n \"profileId\": \"b92b8924-dd71-4ab3-9f74-244844c0ce2e\",\n \"url\": \"https://sessionbox.io\"\n}\n","options":{"raw":{"language":"json"}}},"url":"http://localhost:54789/local-api/v1/action-token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"Origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"411"},{"key":"Date","value":"Mon, 24 Jul 2023 15:55:04 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY3Rpb24iOiJvcGVuIiwiZW5kcG9pbnQiOiJodHRwOi8vbG9jYWxob3N0OjU0Nzg5Iiwic2Vzc2lvbklkIjoiYjkyYjg5MjQtZGQ3MS00YWIzLTlmNzQtMjQ0ODQ0YzBjZTJlIiwidWlkIjoiaWpOSEM4ZWtiemVpY1ZZbDFiMGdMVG93U1I3MyIsInVybCI6Imh0dHBzOi8vc2Vzc2lvbmJveC5pbyIsImxhbmciOiJlbiIsInRyaWdnZXJlZEJ5IjoiYXV0b21hdGlvbiIsImlhdCI6MTY5MDIxNDEwNH0.fLOZsPbWgrl4Jy-L6WIVHb8ch4K4UEDcvtKHhfvCM-k\"\n}"}],"_postman_id":"d18951d7-f4a7-4788-9694-7d3186b2090e"}],"id":"66778694-0671-4f39-b1b7-d2ed38d1ac77","description":"

Concept

This method lets you integrate SessionBox One profiles with your existing tools or connect automation tools to the page.

You can open profiles in Chrome, Edge, or Firefox browser.

How to open a SessionBox One profile in your browser

To open a profile, you will need a token. You can acquire tokens from the local instance of your SessionBox One application. To get a token, you can use the /create-token endpoint. After you acquire a token, open the following URL in the browser: https://open.sessionbox.dev/?sbo_token=. The browser will load the requested profile.

The browser where you open the profile has to have the SessionBox extension installed. See our guide on installing extensions to headless browsers for automation.

\n","_postman_id":"66778694-0671-4f39-b1b7-d2ed38d1ac77","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"50c82b5e-0696-4bb3-9b73-05daf655bde8","id":"50c82b5e-0696-4bb3-9b73-05daf655bde8","name":"SessionBox One Local API V1","type":"collection"}}},{"name":"Types","item":[],"id":"b0a98d91-1e31-404b-9048-6dc1232f9f3a","description":"\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type
name*	string
value*	string
domain	string
expirationDate	number
hostOnly	boolean
httpOnly	boolean
path	string
sameSite	`unspecified` `no_restriction` `lax` `strict`
secure	boolean
session	boolean

Color names

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Color string
red
pink
purple
deep purple
indigo
light blue
cyan
teal
green
light green
lime
yellow
amber
orange
deep orange
brown
grey
blue grey

","_postman_id":"b0a98d91-1e31-404b-9048-6dc1232f9f3a","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"50c82b5e-0696-4bb3-9b73-05daf655bde8","id":"50c82b5e-0696-4bb3-9b73-05daf655bde8","name":"SessionBox One Local API V1","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"81bad0fb-346b-4ff3-ade3-549c903d15db","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"39da912f-ddf2-4968-a63b-32618547cbde","type":"text/javascript","exec":[""]}}],"variable":[{"key":"API_KEY","value":"","type":"string"}]}

Authorization

Enable local API

How to use API key

Body parameters

Body parameters

Concept

How to open a SessionBox One profile in your browser

Cookie

Color names