Cobrowse API v1.0.0

Cobrowse Api of the Fastify server in Nodejs.

info

You are viewing REST API documentation. This documentation is auto-generated from a swagger specification which itself is generated from annotations in the source code of the project. It is possible that this documentation includes bugs and that code samples are incomplete or wrong.

Authentication

HTTP Authentication, scheme: bearer

cobrowse

Events, Resume, Terminate a session

Resume session after sender has refreshed page

POST http://localhost:4444/cobrowser/api/session/resume HTTP/1.1
Host: localhost:4444
Content-Type: application/json
Accept: application/json

Request body

{
  "type": "ReconnectCobrowsingSession",
  "sessionId": "string",
  "timestamp": "string",
  "userId": "string",
  "userEndpointId": "string",
  "tabId": "string",
  "version": 0,
  "payload": {
    "previousId": "string",
    "previousEndpointId": "string"
  }
}

Parameters

Parameter	In	Type	Required	Description
body	body	object	true	none
» type	body	string	true	none
» sessionId	body	string	false	none
» timestamp	body	string	true	none
» userId	body	string	true	none
» userEndpointId	body	string	true	none
» tabId	body	string	false	none
» version	body	integer	true	none
» payload	body	object	false	none
»» previousId	body	string	true	none
»» previousEndpointId	body	string	true	none

Enumerated Values

Parameter	Value
» type	ReconnectCobrowsingSession
» type	ResumeCobrowsingSession
» type	EnableCobrowsingOption
» type	DisableCobrowsingOption
» type	RequestCobrowsingView
» type	RequestCobrowsingControl
» type	TerminateCobrowsingSession
» type	AcceptCobrowsingView
» type	AcceptCobrowsingControl
» type	RevokeCobrowsingView
» type	RevokeCobrowsingControl
» type	DenyCobrowsingView
» type	DenyCobrowsingControl
» type	UpdateCobrowsingPage
» type	UpdateCobrowsingCursor
» type	UpdateCobrowsingInput
» type	CreateCobrowsingSession

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Session resumed, sender updated	Inline
404	Not Found	Sesssion was not found	Inline

Response Schema

Status Code 200

Session resumed, sender updated

Name	Type	Required	Restrictions	Description
» status	string	true	none	none
» version	integer	true	none	none
» remotes	object	true	none	none
»» remoteEndpointIds	object	false	none	none
»»» remoteId	string	false	none	none
»»» permissions	object	true	none	none
»»»» view	boolean	false	none	none
»»»» control	boolean	false	none	none
» options	object	true	none	none
»» scroll	object	false	none	none
»»» enabled	boolean	false	none	none

Status Code 404

Sesssion was not found

Name	Type	Required	Restrictions	Description

Examples

{
  "status": "string",
  "version": 0,
  "remotes": {
    "remoteEndpointIds": {
      "remoteId": "string",
      "permissions": {
        "view": true,
        "control": true
      }
    }
  },
  "options": {
    "scroll": {
      "enabled": true
    }
  }
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

curl -X POST http://localhost:4444/cobrowser/api/session/resume \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "http://localhost:4444/cobrowser/api/session/resume", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

const fetch = require('node-fetch');
const input = '{
  "type": "ReconnectCobrowsingSession",
  "sessionId": "string",
  "timestamp": "string",
  "userId": "string",
  "userEndpointId": "string",
  "tabId": "string",
  "version": 0,
  "payload": {
    "previousId": "string",
    "previousEndpointId": "string"
  }
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('http://localhost:4444/cobrowser/api/session/resume', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://localhost:4444/cobrowser/api/session/resume");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'http://localhost:4444/cobrowser/api/session/resume',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'http://localhost:4444/cobrowser/api/session/resume',
  params: {}, headers: headers

p JSON.parse(result)

Reconnect to a session

POST http://localhost:4444/cobrowser/api/session/reconnect HTTP/1.1
Host: localhost:4444
Content-Type: application/json
Accept: application/json

Request body

{
  "type": "ReconnectCobrowsingSession",
  "sessionId": "string",
  "timestamp": "string",
  "userId": "string",
  "userEndpointId": "string",
  "tabId": "string",
  "version": 0,
  "payload": {
    "takeover": true,
    "previousOwnerTabId": "string"
  }
}

Parameters

Parameter	In	Type	Required	Description
body	body	object	true	none
» type	body	string	true	none
» sessionId	body	string	false	none
» timestamp	body	string	true	none
» userId	body	string	true	none
» userEndpointId	body	string	true	none
» tabId	body	string	false	none
» version	body	integer	true	none
» payload	body	object	false	none
»» takeover	body	boolean	false	none
»» previousOwnerTabId	body	string	false	none

Enumerated Values

Parameter	Value
» type	ReconnectCobrowsingSession
» type	ResumeCobrowsingSession
» type	EnableCobrowsingOption
» type	DisableCobrowsingOption
» type	RequestCobrowsingView
» type	RequestCobrowsingControl
» type	TerminateCobrowsingSession
» type	AcceptCobrowsingView
» type	AcceptCobrowsingControl
» type	RevokeCobrowsingView
» type	RevokeCobrowsingControl
» type	DenyCobrowsingView
» type	DenyCobrowsingControl
» type	UpdateCobrowsingPage
» type	UpdateCobrowsingCursor
» type	UpdateCobrowsingInput
» type	CreateCobrowsingSession

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Reconnected to session	Inline
403	Forbidden	Permission denied	Inline
404	Not Found	Sesssion was not found	Inline
409	Conflict	Session is active in another tab	Inline

Response Schema

Status Code 200

Reconnected to session

Name	Type	Required	Restrictions	Description
» status	string	true	none	none
» version	integer	true	none	none
» owner	object	true	none	none
»» id	string	false	none	none
»» endpoint	string	false	none	none
»» tabId	string	false	none	none
» remotes	object	true	none	none
»» remoteEndpointIds	object	false	none	none
»»» remoteId	string	false	none	none
»»» permissions	object	true	none	none
»»»» view	boolean	false	none	none
»»»» control	boolean	false	none	none
» options	object	true	none	none
»» scroll	object	false	none	none
»»» enabled	boolean	false	none	none

Status Code 403

Permission denied

Name	Type	Required	Restrictions	Description

Status Code 404

Sesssion was not found

Name	Type	Required	Restrictions	Description

Status Code 409

Session is active in another tab

Name	Type	Required	Restrictions	Description

Examples

{
  "status": "string",
  "version": 0,
  "owner": {
    "id": "string",
    "endpoint": "string",
    "tabId": "string"
  },
  "remotes": {
    "remoteEndpointIds": {
      "remoteId": "string",
      "permissions": {
        "view": true,
        "control": true
      }
    }
  },
  "options": {
    "scroll": {
      "enabled": true
    }
  }
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

curl -X POST http://localhost:4444/cobrowser/api/session/reconnect \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "http://localhost:4444/cobrowser/api/session/reconnect", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

const fetch = require('node-fetch');
const input = '{
  "type": "ReconnectCobrowsingSession",
  "sessionId": "string",
  "timestamp": "string",
  "userId": "string",
  "userEndpointId": "string",
  "tabId": "string",
  "version": 0,
  "payload": {
    "takeover": true,
    "previousOwnerTabId": "string"
  }
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('http://localhost:4444/cobrowser/api/session/reconnect', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://localhost:4444/cobrowser/api/session/reconnect");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'http://localhost:4444/cobrowser/api/session/reconnect',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'http://localhost:4444/cobrowser/api/session/reconnect',
  params: {}, headers: headers

p JSON.parse(result)

Create a new session

POST http://localhost:4444/cobrowser/api/session HTTP/1.1
Host: localhost:4444
Content-Type: application/json
Accept: application/json

Request body

{
  "type": "ReconnectCobrowsingSession",
  "sessionId": "string",
  "timestamp": "string",
  "userId": "string",
  "userEndpointId": "string",
  "tabId": "string",
  "version": 0,
  "payload": {
    "isTargetLocal": true,
    "targetId": "string",
    "targetEndpointId": "string",
    "compressionSupport": {
      "zstd": {
        "compress": true,
        "decompress": true
      }
    },
    "record": {
      "conversationId": "string",
      "instanceId": "string",
      "recorderId": "string"
    }
  }
}

Parameters

Parameter	In	Type	Required	Description
body	body	object	true	none
» type	body	string	true	none
» sessionId	body	string	false	none
» timestamp	body	string	true	none
» userId	body	string	true	none
» userEndpointId	body	string	true	none
» tabId	body	string	false	none
» version	body	integer	true	none
» payload	body	object	false	none
»» isTargetLocal	body	boolean	false	none
»» targetId	body	string	false	none
»» targetEndpointId	body	string	false	none
»» compressionSupport	body	object	false	none
»»» zstd	body	object	false	none
»»»» compress	body	boolean	false	none
»»»» decompress	body	boolean	false	none
»» record	body	object¦null	false	none
»»» conversationId	body	string	false	none
»»» instanceId	body	string	false	none
»»» recorderId	body	string	false	none

Enumerated Values

Parameter	Value
» type	ReconnectCobrowsingSession
» type	ResumeCobrowsingSession
» type	EnableCobrowsingOption
» type	DisableCobrowsingOption
» type	RequestCobrowsingView
» type	RequestCobrowsingControl
» type	TerminateCobrowsingSession
» type	AcceptCobrowsingView
» type	AcceptCobrowsingControl
» type	RevokeCobrowsingView
» type	RevokeCobrowsingControl
» type	DenyCobrowsingView
» type	DenyCobrowsingControl
» type	UpdateCobrowsingPage
» type	UpdateCobrowsingCursor
» type	UpdateCobrowsingInput
» type	CreateCobrowsingSession

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Created new session and share with target	Inline
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 200

Created new session and share with target

Name	Type	Required	Restrictions	Description
» status	string	false	none	none
» version	integer	false	none	none
» data	object	false	none	none
»» sessionId	string	false	none	none

Status Code 400

Bad Request

Name	Type	Required	Restrictions	Description

Examples

{
  "status": "string",
  "version": 0,
  "data": {
    "sessionId": "string"
  }
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

curl -X POST http://localhost:4444/cobrowser/api/session \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "http://localhost:4444/cobrowser/api/session", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

const fetch = require('node-fetch');
const input = '{
  "type": "ReconnectCobrowsingSession",
  "sessionId": "string",
  "timestamp": "string",
  "userId": "string",
  "userEndpointId": "string",
  "tabId": "string",
  "version": 0,
  "payload": {
    "isTargetLocal": true,
    "targetId": "string",
    "targetEndpointId": "string",
    "compressionSupport": {
      "zstd": {
        "compress": true,
        "decompress": true
      }
    },
    "record": {
      "conversationId": "string",
      "instanceId": "string",
      "recorderId": "string"
    }
  }
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('http://localhost:4444/cobrowser/api/session', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://localhost:4444/cobrowser/api/session");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'http://localhost:4444/cobrowser/api/session',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'http://localhost:4444/cobrowser/api/session',
  params: {}, headers: headers

p JSON.parse(result)

Get session info

GET http://localhost:4444/cobrowser/api/session/{id} HTTP/1.1
Host: localhost:4444
Accept: application/json

Parameters

Parameter	In	Type	Required	Description
id	path	string	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Session info	Inline
403	Forbidden	Permission denied	Inline
404	Not Found	Session not found	Inline

Response Schema

Status Code 200

Session info

Name	Type	Required	Restrictions	Description
» status	string	false	none	none
» payload	object	false	none	none

Status Code 403

Permission denied

Name	Type	Required	Restrictions	Description

Status Code 404

Session not found

Name	Type	Required	Restrictions	Description

Examples

{
  "status": "string",
  "payload": {}
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

curl -X GET http://localhost:4444/cobrowser/api/session/{id} \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "http://localhost:4444/cobrowser/api/session/{id}", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('http://localhost:4444/cobrowser/api/session/{id}', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://localhost:4444/cobrowser/api/session/{id}");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get(
  'http://localhost:4444/cobrowser/api/session/{id}',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'http://localhost:4444/cobrowser/api/session/{id}',
  params: {}, headers: headers

p JSON.parse(result)

Post dom event as document's owner

POST http://localhost:4444/cobrowser/api/session/owner/update HTTP/1.1
Host: localhost:4444
Accept: application/json

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Event posted	Inline
403	Forbidden	Permission denied	Inline
404	Not Found	Session not found	Inline
409	Conflict	Session ownership was transferred	Inline

Response Schema

Status Code 200

Event posted

Name	Type	Required	Restrictions	Description
» status	string	false	none	none
» version	integer	false	none	none

Status Code 403

Permission denied

Name	Type	Required	Restrictions	Description

Status Code 404

Session not found

Name	Type	Required	Restrictions	Description

Status Code 409

Session ownership was transferred

Name	Type	Required	Restrictions	Description

Examples

{
  "status": "string",
  "version": 0
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

curl -X POST http://localhost:4444/cobrowser/api/session/owner/update \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "http://localhost:4444/cobrowser/api/session/owner/update", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('http://localhost:4444/cobrowser/api/session/owner/update', {
  method: 'POST',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://localhost:4444/cobrowser/api/session/owner/update");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'http://localhost:4444/cobrowser/api/session/owner/update',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'http://localhost:4444/cobrowser/api/session/owner/update',
  params: {}, headers: headers

p JSON.parse(result)

Post dom event as viewer

POST http://localhost:4444/cobrowser/api/session/remote/update HTTP/1.1
Host: localhost:4444
Content-Type: application/json
Accept: application/json

Request body

{
  "type": "ReconnectCobrowsingSession",
  "sessionId": "string",
  "timestamp": "string",
  "userId": "string",
  "userEndpointId": "string",
  "tabId": "string",
  "version": 0,
  "payload": {
    "type": "string",
    "users": [
      {
        "userId": "string",
        "userEndpointId": "string"
      }
    ],
    "count": 0,
    "payload": {
      "events": [
        {
          "type": "string",
          "time": 0,
          "payload": {},
          "user": {
            "userId": "string",
            "userEndpointId": "string"
          }
        }
      ]
    }
  }
}

Parameters

Parameter	In	Type	Required	Description
body	body	object	true	none
» type	body	string	true	none
» sessionId	body	string	false	none
» timestamp	body	string	true	none
» userId	body	string	true	none
» userEndpointId	body	string	true	none
» tabId	body	string	false	none
» version	body	integer	true	none
» payload	body	object	false	none
»» type	body	string	true	none
»» users	body	[object]	false	none
»»» userId	body	string	false	none
»»» userEndpointId	body	string	false	none
»» count	body	integer	true	none
»» payload	body	object	true	none
»»» events	body	[object]	false	none
»»»» type	body	string	true	none
»»»» time	body	integer	false	none
»»»» payload	body	object	false	none
»»»» user	body	object	false	none
»»»»» userId	body	string	false	none
»»»»» userEndpointId	body	string	false	none

Enumerated Values

Parameter	Value
» type	ReconnectCobrowsingSession
» type	ResumeCobrowsingSession
» type	EnableCobrowsingOption
» type	DisableCobrowsingOption
» type	RequestCobrowsingView
» type	RequestCobrowsingControl
» type	TerminateCobrowsingSession
» type	AcceptCobrowsingView
» type	AcceptCobrowsingControl
» type	RevokeCobrowsingView
» type	RevokeCobrowsingControl
» type	DenyCobrowsingView
» type	DenyCobrowsingControl
» type	UpdateCobrowsingPage
» type	UpdateCobrowsingCursor
» type	UpdateCobrowsingInput
» type	CreateCobrowsingSession

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Event posted	Inline
403	Forbidden	Permission denied	Inline
404	Not Found	Session not found	Inline

Response Schema

Status Code 200

Event posted

Name	Type	Required	Restrictions	Description
» status	string	false	none	none
» version	integer	false	none	none

Status Code 403

Permission denied

Name	Type	Required	Restrictions	Description

Status Code 404

Session not found

Name	Type	Required	Restrictions	Description

Examples

{
  "status": "string",
  "version": 0
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

curl -X POST http://localhost:4444/cobrowser/api/session/remote/update \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "http://localhost:4444/cobrowser/api/session/remote/update", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

const fetch = require('node-fetch');
const input = '{
  "type": "ReconnectCobrowsingSession",
  "sessionId": "string",
  "timestamp": "string",
  "userId": "string",
  "userEndpointId": "string",
  "tabId": "string",
  "version": 0,
  "payload": {
    "type": "string",
    "users": [
      {
        "userId": "string",
        "userEndpointId": "string"
      }
    ],
    "count": 0,
    "payload": {
      "events": [
        {
          "type": "string",
          "time": 0,
          "payload": {},
          "user": {
            "userId": "string",
            "userEndpointId": "string"
          }
        }
      ]
    }
  }
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('http://localhost:4444/cobrowser/api/session/remote/update', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://localhost:4444/cobrowser/api/session/remote/update");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'http://localhost:4444/cobrowser/api/session/remote/update',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'http://localhost:4444/cobrowser/api/session/remote/update',
  params: {}, headers: headers

p JSON.parse(result)

Terminate a cobrowse session

POST http://localhost:4444/cobrowser/api/session/terminate HTTP/1.1
Host: localhost:4444
Content-Type: application/json
Accept: application/json

Request body

{
  "type": "ReconnectCobrowsingSession",
  "sessionId": "string",
  "timestamp": "string",
  "userId": "string",
  "userEndpointId": "string",
  "tabId": "string",
  "version": 0,
  "payload": {}
}

Parameters

Parameter	In	Type	Required	Description
body	body	object	true	none
» type	body	string	true	none
» sessionId	body	string	false	none
» timestamp	body	string	true	none
» userId	body	string	true	none
» userEndpointId	body	string	true	none
» tabId	body	string	false	none
» version	body	integer	true	none
» payload	body	object	false	none

Enumerated Values

Parameter	Value
» type	ReconnectCobrowsingSession
» type	ResumeCobrowsingSession
» type	EnableCobrowsingOption
» type	DisableCobrowsingOption
» type	RequestCobrowsingView
» type	RequestCobrowsingControl
» type	TerminateCobrowsingSession
» type	AcceptCobrowsingView
» type	AcceptCobrowsingControl
» type	RevokeCobrowsingView
» type	RevokeCobrowsingControl
» type	DenyCobrowsingView
» type	DenyCobrowsingControl
» type	UpdateCobrowsingPage
» type	UpdateCobrowsingCursor
» type	UpdateCobrowsingInput
» type	CreateCobrowsingSession

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Session terminated	Inline
403	Forbidden	Permission denied	Inline
404	Not Found	Session not found	Inline
409	Conflict	Session ownership was transferred	Inline

Response Schema

Status Code 200

Session terminated

Name	Type	Required	Restrictions	Description
» status	string	false	none	none
» version	integer	false	none	none

Status Code 403

Permission denied

Name	Type	Required	Restrictions	Description

Status Code 404

Session not found

Name	Type	Required	Restrictions	Description

Status Code 409

Session ownership was transferred

Name	Type	Required	Restrictions	Description

Examples

{
  "status": "string",
  "version": 0
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

curl -X POST http://localhost:4444/cobrowser/api/session/terminate \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "http://localhost:4444/cobrowser/api/session/terminate", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

const fetch = require('node-fetch');
const input = '{
  "type": "ReconnectCobrowsingSession",
  "sessionId": "string",
  "timestamp": "string",
  "userId": "string",
  "userEndpointId": "string",
  "tabId": "string",
  "version": 0,
  "payload": {}
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('http://localhost:4444/cobrowser/api/session/terminate', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://localhost:4444/cobrowser/api/session/terminate");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'http://localhost:4444/cobrowser/api/session/terminate',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'http://localhost:4444/cobrowser/api/session/terminate',
  params: {}, headers: headers

p JSON.parse(result)

permissions

Request, Accept, Revoke and Deny

Request to view remote page

POST http://localhost:4444/cobrowser/api/session/permissions/view/request HTTP/1.1
Host: localhost:4444
Content-Type: application/json
Accept: application/json

Request body

{
  "type": "ReconnectCobrowsingSession",
  "sessionId": "string",
  "timestamp": "string",
  "userId": "string",
  "userEndpointId": "string",
  "tabId": "string",
  "version": 0,
  "payload": {
    "compressionSupport": {
      "zstd": {
        "compress": true,
        "decompress": true
      }
    },
    "record": {
      "conversationId": "string",
      "instanceId": "string",
      "recorderId": "string"
    }
  }
}

Parameters

Parameter	In	Type	Required	Description
body	body	object	true	none
» type	body	string	true	none
» sessionId	body	string	false	none
» timestamp	body	string	true	none
» userId	body	string	true	none
» userEndpointId	body	string	true	none
» tabId	body	string	false	none
» version	body	integer	true	none
» payload	body	object	false	none
»» compressionSupport	body	object	false	none
»»» zstd	body	object	false	none
»»»» compress	body	boolean	false	none
»»»» decompress	body	boolean	false	none
»» record	body	object	false	none
»»» conversationId	body	string	false	none
»»» instanceId	body	string	false	none
»»» recorderId	body	string	false	none

Enumerated Values

Parameter	Value
» type	ReconnectCobrowsingSession
» type	ResumeCobrowsingSession
» type	EnableCobrowsingOption
» type	DisableCobrowsingOption
» type	RequestCobrowsingView
» type	RequestCobrowsingControl
» type	TerminateCobrowsingSession
» type	AcceptCobrowsingView
» type	AcceptCobrowsingControl
» type	RevokeCobrowsingView
» type	RevokeCobrowsingControl
» type	DenyCobrowsingView
» type	DenyCobrowsingControl
» type	UpdateCobrowsingPage
» type	UpdateCobrowsingCursor
» type	UpdateCobrowsingInput
» type	CreateCobrowsingSession

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Created new session and requested view access from target	Inline
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 200

Created new session and requested view access from target

Name	Type	Required	Restrictions	Description
» status	string	false	none	none
» version	integer	false	none	none
» data	object	false	none	none
»» sessionId	string	false	none	none

Status Code 400

Bad Request

Name	Type	Required	Restrictions	Description

Examples

{
  "status": "string",
  "version": 0,
  "data": {
    "sessionId": "string"
  }
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

curl -X POST http://localhost:4444/cobrowser/api/session/permissions/view/request \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "http://localhost:4444/cobrowser/api/session/permissions/view/request", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

const fetch = require('node-fetch');
const input = '{
  "type": "ReconnectCobrowsingSession",
  "sessionId": "string",
  "timestamp": "string",
  "userId": "string",
  "userEndpointId": "string",
  "tabId": "string",
  "version": 0,
  "payload": {
    "compressionSupport": {
      "zstd": {
        "compress": true,
        "decompress": true
      }
    },
    "record": {
      "conversationId": "string",
      "instanceId": "string",
      "recorderId": "string"
    }
  }
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('http://localhost:4444/cobrowser/api/session/permissions/view/request', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://localhost:4444/cobrowser/api/session/permissions/view/request");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'http://localhost:4444/cobrowser/api/session/permissions/view/request',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'http://localhost:4444/cobrowser/api/session/permissions/view/request',
  params: {}, headers: headers

p JSON.parse(result)

Accept request to view page

POST http://localhost:4444/cobrowser/api/session/permissions/view/accept HTTP/1.1
Host: localhost:4444
Content-Type: application/json
Accept: application/json

Request body

{
  "type": "ReconnectCobrowsingSession",
  "sessionId": "string",
  "timestamp": "string",
  "userId": "string",
  "userEndpointId": "string",
  "tabId": "string",
  "version": 0,
  "payload": {
    "compressionSupport": {
      "zstd": {
        "compress": true,
        "decompress": true
      }
    }
  }
}

Parameters

Parameter	In	Type	Required	Description
body	body	object	true	none
» type	body	string	true	none
» sessionId	body	string	false	none
» timestamp	body	string	true	none
» userId	body	string	true	none
» userEndpointId	body	string	true	none
» tabId	body	string	false	none
» version	body	integer	true	none
» payload	body	object	false	none
»» compressionSupport	body	object	false	none
»»» zstd	body	object	false	none
»»»» compress	body	boolean	false	none
»»»» decompress	body	boolean	false	none

Enumerated Values

Parameter	Value
» type	ReconnectCobrowsingSession
» type	ResumeCobrowsingSession
» type	EnableCobrowsingOption
» type	DisableCobrowsingOption
» type	RequestCobrowsingView
» type	RequestCobrowsingControl
» type	TerminateCobrowsingSession
» type	AcceptCobrowsingView
» type	AcceptCobrowsingControl
» type	RevokeCobrowsingView
» type	RevokeCobrowsingControl
» type	DenyCobrowsingView
» type	DenyCobrowsingControl
» type	UpdateCobrowsingPage
» type	UpdateCobrowsingCursor
» type	UpdateCobrowsingInput
» type	CreateCobrowsingSession

Responses

Overview

Status	Meaning	Description	Schema
200	OK	View request was accepted	Inline
404	Not Found	Session not found	Inline
409	Conflict	State mismatch	Inline

Response Schema

Status Code 200

View request was accepted

Name	Type	Required	Restrictions	Description
» status	string	false	none	none
» version	integer	false	none	none

Status Code 404

Session not found

Name	Type	Required	Restrictions	Description

Status Code 409

State mismatch

Name	Type	Required	Restrictions	Description

Examples

{
  "status": "string",
  "version": 0
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

curl -X POST http://localhost:4444/cobrowser/api/session/permissions/view/accept \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "http://localhost:4444/cobrowser/api/session/permissions/view/accept", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

const fetch = require('node-fetch');
const input = '{
  "type": "ReconnectCobrowsingSession",
  "sessionId": "string",
  "timestamp": "string",
  "userId": "string",
  "userEndpointId": "string",
  "tabId": "string",
  "version": 0,
  "payload": {
    "compressionSupport": {
      "zstd": {
        "compress": true,
        "decompress": true
      }
    }
  }
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('http://localhost:4444/cobrowser/api/session/permissions/view/accept', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://localhost:4444/cobrowser/api/session/permissions/view/accept");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'http://localhost:4444/cobrowser/api/session/permissions/view/accept',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'http://localhost:4444/cobrowser/api/session/permissions/view/accept',
  params: {}, headers: headers

p JSON.parse(result)

Revoke view access of participant

POST http://localhost:4444/cobrowser/api/session/permissions/view/revoke HTTP/1.1
Host: localhost:4444
Content-Type: application/json
Accept: application/json

Request body

{
  "type": "ReconnectCobrowsingSession",
  "sessionId": "string",
  "timestamp": "string",
  "userId": "string",
  "userEndpointId": "string",
  "tabId": "string",
  "version": 0,
  "payload": {}
}

Parameters

Parameter	In	Type	Required	Description
body	body	object	true	none
» type	body	string	true	none
» sessionId	body	string	false	none
» timestamp	body	string	true	none
» userId	body	string	true	none
» userEndpointId	body	string	true	none
» tabId	body	string	false	none
» version	body	integer	true	none
» payload	body	object	false	none

Enumerated Values

Parameter	Value
» type	ReconnectCobrowsingSession
» type	ResumeCobrowsingSession
» type	EnableCobrowsingOption
» type	DisableCobrowsingOption
» type	RequestCobrowsingView
» type	RequestCobrowsingControl
» type	TerminateCobrowsingSession
» type	AcceptCobrowsingView
» type	AcceptCobrowsingControl
» type	RevokeCobrowsingView
» type	RevokeCobrowsingControl
» type	DenyCobrowsingView
» type	DenyCobrowsingControl
» type	UpdateCobrowsingPage
» type	UpdateCobrowsingCursor
» type	UpdateCobrowsingInput
» type	CreateCobrowsingSession

Responses

Overview

Status	Meaning	Description	Schema
200	OK	View access was revoked	Inline
403	Forbidden	Permission denied	Inline

Response Schema

Status Code 200

View access was revoked

Name	Type	Required	Restrictions	Description
» status	string	false	none	none
» version	integer	false	none	none

Status Code 403

Permission denied

Name	Type	Required	Restrictions	Description

Examples

{
  "status": "string",
  "version": 0
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

curl -X POST http://localhost:4444/cobrowser/api/session/permissions/view/revoke \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "http://localhost:4444/cobrowser/api/session/permissions/view/revoke", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

const fetch = require('node-fetch');
const input = '{
  "type": "ReconnectCobrowsingSession",
  "sessionId": "string",
  "timestamp": "string",
  "userId": "string",
  "userEndpointId": "string",
  "tabId": "string",
  "version": 0,
  "payload": {}
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('http://localhost:4444/cobrowser/api/session/permissions/view/revoke', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://localhost:4444/cobrowser/api/session/permissions/view/revoke");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'http://localhost:4444/cobrowser/api/session/permissions/view/revoke',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'http://localhost:4444/cobrowser/api/session/permissions/view/revoke',
  params: {}, headers: headers

p JSON.parse(result)

Request to control page

POST http://localhost:4444/cobrowser/api/session/permissions/control/request HTTP/1.1
Host: localhost:4444
Content-Type: application/json
Accept: application/json

Request body

{
  "type": "ReconnectCobrowsingSession",
  "sessionId": "string",
  "timestamp": "string",
  "userId": "string",
  "userEndpointId": "string",
  "tabId": "string",
  "version": 0,
  "payload": {}
}

Parameters

Parameter	In	Type	Required	Description
body	body	object	true	none
» type	body	string	true	none
» sessionId	body	string	false	none
» timestamp	body	string	true	none
» userId	body	string	true	none
» userEndpointId	body	string	true	none
» tabId	body	string	false	none
» version	body	integer	true	none
» payload	body	object	false	none

Enumerated Values

Parameter	Value
» type	ReconnectCobrowsingSession
» type	ResumeCobrowsingSession
» type	EnableCobrowsingOption
» type	DisableCobrowsingOption
» type	RequestCobrowsingView
» type	RequestCobrowsingControl
» type	TerminateCobrowsingSession
» type	AcceptCobrowsingView
» type	AcceptCobrowsingControl
» type	RevokeCobrowsingView
» type	RevokeCobrowsingControl
» type	DenyCobrowsingView
» type	DenyCobrowsingControl
» type	UpdateCobrowsingPage
» type	UpdateCobrowsingCursor
» type	UpdateCobrowsingInput
» type	CreateCobrowsingSession

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Control access was requested	Inline
400	Bad Request	Missing target property	Inline
403	Forbidden	Permission denied	Inline
404	Not Found	Session not found	Inline

Response Schema

Status Code 200

Control access was requested

Name	Type	Required	Restrictions	Description
» status	string	false	none	none
» version	integer	false	none	none

Status Code 400

Missing target property

Name	Type	Required	Restrictions	Description

Status Code 403

Permission denied

Name	Type	Required	Restrictions	Description

Status Code 404

Session not found

Name	Type	Required	Restrictions	Description

Examples

{
  "status": "string",
  "version": 0
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

curl -X POST http://localhost:4444/cobrowser/api/session/permissions/control/request \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "http://localhost:4444/cobrowser/api/session/permissions/control/request", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

const fetch = require('node-fetch');
const input = '{
  "type": "ReconnectCobrowsingSession",
  "sessionId": "string",
  "timestamp": "string",
  "userId": "string",
  "userEndpointId": "string",
  "tabId": "string",
  "version": 0,
  "payload": {}
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('http://localhost:4444/cobrowser/api/session/permissions/control/request', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://localhost:4444/cobrowser/api/session/permissions/control/request");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'http://localhost:4444/cobrowser/api/session/permissions/control/request',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'http://localhost:4444/cobrowser/api/session/permissions/control/request',
  params: {}, headers: headers

p JSON.parse(result)

Accept request to control page

POST http://localhost:4444/cobrowser/api/session/permissions/control/accept HTTP/1.1
Host: localhost:4444
Content-Type: application/json
Accept: application/json

Request body

{
  "type": "ReconnectCobrowsingSession",
  "sessionId": "string",
  "timestamp": "string",
  "userId": "string",
  "userEndpointId": "string",
  "tabId": "string",
  "version": 0,
  "payload": {}
}

Parameters

Parameter	In	Type	Required	Description
body	body	object	true	none
» type	body	string	true	none
» sessionId	body	string	false	none
» timestamp	body	string	true	none
» userId	body	string	true	none
» userEndpointId	body	string	true	none
» tabId	body	string	false	none
» version	body	integer	true	none
» payload	body	object	false	none

Enumerated Values

Parameter	Value
» type	ReconnectCobrowsingSession
» type	ResumeCobrowsingSession
» type	EnableCobrowsingOption
» type	DisableCobrowsingOption
» type	RequestCobrowsingView
» type	RequestCobrowsingControl
» type	TerminateCobrowsingSession
» type	AcceptCobrowsingView
» type	AcceptCobrowsingControl
» type	RevokeCobrowsingView
» type	RevokeCobrowsingControl
» type	DenyCobrowsingView
» type	DenyCobrowsingControl
» type	UpdateCobrowsingPage
» type	UpdateCobrowsingCursor
» type	UpdateCobrowsingInput
» type	CreateCobrowsingSession

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Control access was accepted	Inline
403	Forbidden	Permission denied	Inline
404	Not Found	Session not found	Inline

Response Schema

Status Code 200

Control access was accepted

Name	Type	Required	Restrictions	Description
» status	string	false	none	none
» version	integer	false	none	none

Status Code 403

Permission denied

Name	Type	Required	Restrictions	Description

Status Code 404

Session not found

Name	Type	Required	Restrictions	Description

Examples

{
  "status": "string",
  "version": 0
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

curl -X POST http://localhost:4444/cobrowser/api/session/permissions/control/accept \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "http://localhost:4444/cobrowser/api/session/permissions/control/accept", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

const fetch = require('node-fetch');
const input = '{
  "type": "ReconnectCobrowsingSession",
  "sessionId": "string",
  "timestamp": "string",
  "userId": "string",
  "userEndpointId": "string",
  "tabId": "string",
  "version": 0,
  "payload": {}
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('http://localhost:4444/cobrowser/api/session/permissions/control/accept', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://localhost:4444/cobrowser/api/session/permissions/control/accept");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'http://localhost:4444/cobrowser/api/session/permissions/control/accept',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'http://localhost:4444/cobrowser/api/session/permissions/control/accept',
  params: {}, headers: headers

p JSON.parse(result)

Revoke control access for participant

POST http://localhost:4444/cobrowser/api/session/permissions/control/revoke HTTP/1.1
Host: localhost:4444
Content-Type: application/json
Accept: application/json

Request body

{
  "type": "ReconnectCobrowsingSession",
  "sessionId": "string",
  "timestamp": "string",
  "userId": "string",
  "userEndpointId": "string",
  "tabId": "string",
  "version": 0,
  "payload": {}
}

Parameters

Parameter	In	Type	Required	Description
body	body	object	true	none
» type	body	string	true	none
» sessionId	body	string	false	none
» timestamp	body	string	true	none
» userId	body	string	true	none
» userEndpointId	body	string	true	none
» tabId	body	string	false	none
» version	body	integer	true	none
» payload	body	object	false	none

Enumerated Values

Parameter	Value
» type	ReconnectCobrowsingSession
» type	ResumeCobrowsingSession
» type	EnableCobrowsingOption
» type	DisableCobrowsingOption
» type	RequestCobrowsingView
» type	RequestCobrowsingControl
» type	TerminateCobrowsingSession
» type	AcceptCobrowsingView
» type	AcceptCobrowsingControl
» type	RevokeCobrowsingView
» type	RevokeCobrowsingControl
» type	DenyCobrowsingView
» type	DenyCobrowsingControl
» type	UpdateCobrowsingPage
» type	UpdateCobrowsingCursor
» type	UpdateCobrowsingInput
» type	CreateCobrowsingSession

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Control access was revoked	Inline
403	Forbidden	Permission denied	Inline
404	Not Found	Session not found	Inline

Response Schema

Status Code 200

Control access was revoked

Name	Type	Required	Restrictions	Description
» status	string	false	none	none
» version	integer	false	none	none

Status Code 403

Permission denied

Name	Type	Required	Restrictions	Description

Status Code 404

Session not found

Name	Type	Required	Restrictions	Description

Examples

{
  "status": "string",
  "version": 0
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

curl -X POST http://localhost:4444/cobrowser/api/session/permissions/control/revoke \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "http://localhost:4444/cobrowser/api/session/permissions/control/revoke", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

const fetch = require('node-fetch');
const input = '{
  "type": "ReconnectCobrowsingSession",
  "sessionId": "string",
  "timestamp": "string",
  "userId": "string",
  "userEndpointId": "string",
  "tabId": "string",
  "version": 0,
  "payload": {}
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('http://localhost:4444/cobrowser/api/session/permissions/control/revoke', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://localhost:4444/cobrowser/api/session/permissions/control/revoke");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'http://localhost:4444/cobrowser/api/session/permissions/control/revoke',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'http://localhost:4444/cobrowser/api/session/permissions/control/revoke',
  params: {}, headers: headers

p JSON.parse(result)

Deny permission request

POST http://localhost:4444/cobrowser/api/session/permissions/deny HTTP/1.1
Host: localhost:4444
Content-Type: application/json
Accept: application/json

Request body

{
  "type": "ReconnectCobrowsingSession",
  "sessionId": "string",
  "timestamp": "string",
  "userId": "string",
  "userEndpointId": "string",
  "tabId": "string",
  "version": 0,
  "payload": {
    "targetId": "string",
    "targetEndpointId": "string",
    "permission": "view"
  }
}

Parameters

Parameter	In	Type	Required	Description
body	body	object	true	none
» type	body	string	true	none
» sessionId	body	string	false	none
» timestamp	body	string	true	none
» userId	body	string	true	none
» userEndpointId	body	string	true	none
» tabId	body	string	false	none
» version	body	integer	true	none
» payload	body	object	false	none
»» targetId	body	string	true	none
»» targetEndpointId	body	string	true	none
»» permission	body	string	true	none

Enumerated Values

Parameter	Value
» type	ReconnectCobrowsingSession
» type	ResumeCobrowsingSession
» type	EnableCobrowsingOption
» type	DisableCobrowsingOption
» type	RequestCobrowsingView
» type	RequestCobrowsingControl
» type	TerminateCobrowsingSession
» type	AcceptCobrowsingView
» type	AcceptCobrowsingControl
» type	RevokeCobrowsingView
» type	RevokeCobrowsingControl
» type	DenyCobrowsingView
» type	DenyCobrowsingControl
» type	UpdateCobrowsingPage
» type	UpdateCobrowsingCursor
» type	UpdateCobrowsingInput
» type	CreateCobrowsingSession
»» permission	view
»» permission	control

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Permission request denied	Inline
403	Forbidden	Permission denied	Inline
404	Not Found	Session not found	Inline

Response Schema

Status Code 200

Permission request denied

Name	Type	Required	Restrictions	Description
» status	string	false	none	none
» version	integer	false	none	none

Status Code 403

Permission denied

Name	Type	Required	Restrictions	Description

Status Code 404

Session not found

Name	Type	Required	Restrictions	Description

Examples

{
  "status": "string",
  "version": 0
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

curl -X POST http://localhost:4444/cobrowser/api/session/permissions/deny \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "http://localhost:4444/cobrowser/api/session/permissions/deny", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

const fetch = require('node-fetch');
const input = '{
  "type": "ReconnectCobrowsingSession",
  "sessionId": "string",
  "timestamp": "string",
  "userId": "string",
  "userEndpointId": "string",
  "tabId": "string",
  "version": 0,
  "payload": {
    "targetId": "string",
    "targetEndpointId": "string",
    "permission": "view"
  }
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('http://localhost:4444/cobrowser/api/session/permissions/deny', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://localhost:4444/cobrowser/api/session/permissions/deny");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'http://localhost:4444/cobrowser/api/session/permissions/deny',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'http://localhost:4444/cobrowser/api/session/permissions/deny',
  params: {}, headers: headers

p JSON.parse(result)

options

Enable and Disable options

Enable an option

POST http://localhost:4444/cobrowser/api/session/options/enable HTTP/1.1
Host: localhost:4444
Content-Type: application/json
Accept: application/json

Request body

{
  "type": "ReconnectCobrowsingSession",
  "sessionId": "string",
  "timestamp": "string",
  "userId": "string",
  "userEndpointId": "string",
  "tabId": "string",
  "version": 0,
  "payload": {
    "option": "scroll",
    "settings": {}
  }
}

Parameters

Parameter	In	Type	Required	Description
body	body	object	true	none
» type	body	string	true	none
» sessionId	body	string	false	none
» timestamp	body	string	true	none
» userId	body	string	true	none
» userEndpointId	body	string	true	none
» tabId	body	string	false	none
» version	body	integer	true	none
» payload	body	object	false	none
»» option	body	string	false	none
»» settings	body	object	false	none

Enumerated Values

Parameter	Value
» type	ReconnectCobrowsingSession
» type	ResumeCobrowsingSession
» type	EnableCobrowsingOption
» type	DisableCobrowsingOption
» type	RequestCobrowsingView
» type	RequestCobrowsingControl
» type	TerminateCobrowsingSession
» type	AcceptCobrowsingView
» type	AcceptCobrowsingControl
» type	RevokeCobrowsingView
» type	RevokeCobrowsingControl
» type	DenyCobrowsingView
» type	DenyCobrowsingControl
» type	UpdateCobrowsingPage
» type	UpdateCobrowsingCursor
» type	UpdateCobrowsingInput
» type	CreateCobrowsingSession
»» option	scroll
»» option	record

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Option was enabled	Inline
403	Forbidden	Permission denied	Inline
404	Not Found	Session not found	Inline

Response Schema

Status Code 200

Option was enabled

Name	Type	Required	Restrictions	Description
» status	string	false	none	none
» version	integer	false	none	none

Status Code 403

Permission denied

Name	Type	Required	Restrictions	Description

Status Code 404

Session not found

Name	Type	Required	Restrictions	Description

Examples

{
  "status": "string",
  "version": 0
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

curl -X POST http://localhost:4444/cobrowser/api/session/options/enable \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "http://localhost:4444/cobrowser/api/session/options/enable", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

const fetch = require('node-fetch');
const input = '{
  "type": "ReconnectCobrowsingSession",
  "sessionId": "string",
  "timestamp": "string",
  "userId": "string",
  "userEndpointId": "string",
  "tabId": "string",
  "version": 0,
  "payload": {
    "option": "scroll",
    "settings": {}
  }
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('http://localhost:4444/cobrowser/api/session/options/enable', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://localhost:4444/cobrowser/api/session/options/enable");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'http://localhost:4444/cobrowser/api/session/options/enable',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'http://localhost:4444/cobrowser/api/session/options/enable',
  params: {}, headers: headers

p JSON.parse(result)

Disable an option

POST http://localhost:4444/cobrowser/api/session/options/disable HTTP/1.1
Host: localhost:4444
Content-Type: application/json
Accept: application/json

Request body

{
  "type": "ReconnectCobrowsingSession",
  "sessionId": "string",
  "timestamp": "string",
  "userId": "string",
  "userEndpointId": "string",
  "tabId": "string",
  "version": 0,
  "payload": {
    "option": "scroll"
  }
}

Parameters

Parameter	In	Type	Required	Description
body	body	object	true	none
» type	body	string	true	none
» sessionId	body	string	false	none
» timestamp	body	string	true	none
» userId	body	string	true	none
» userEndpointId	body	string	true	none
» tabId	body	string	false	none
» version	body	integer	true	none
» payload	body	object	false	none
»» option	body	string	false	none

Enumerated Values

Parameter	Value
» type	ReconnectCobrowsingSession
» type	ResumeCobrowsingSession
» type	EnableCobrowsingOption
» type	DisableCobrowsingOption
» type	RequestCobrowsingView
» type	RequestCobrowsingControl
» type	TerminateCobrowsingSession
» type	AcceptCobrowsingView
» type	AcceptCobrowsingControl
» type	RevokeCobrowsingView
» type	RevokeCobrowsingControl
» type	DenyCobrowsingView
» type	DenyCobrowsingControl
» type	UpdateCobrowsingPage
» type	UpdateCobrowsingCursor
» type	UpdateCobrowsingInput
» type	CreateCobrowsingSession
»» option	scroll
»» option	record

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Option was disabled	Inline
403	Forbidden	Permission denied	Inline
404	Not Found	Session not found	Inline

Response Schema

Status Code 200

Option was disabled

Name	Type	Required	Restrictions	Description
» status	string	false	none	none
» version	integer	false	none	none

Status Code 403

Permission denied

Name	Type	Required	Restrictions	Description

Status Code 404

Session not found

Name	Type	Required	Restrictions	Description

Examples

{
  "status": "string",
  "version": 0
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: bearerAuth

Code samples

curl -X POST http://localhost:4444/cobrowser/api/session/options/disable \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "http://localhost:4444/cobrowser/api/session/options/disable", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

const fetch = require('node-fetch');
const input = '{
  "type": "ReconnectCobrowsingSession",
  "sessionId": "string",
  "timestamp": "string",
  "userId": "string",
  "userEndpointId": "string",
  "tabId": "string",
  "version": 0,
  "payload": {
    "option": "scroll"
  }
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('http://localhost:4444/cobrowser/api/session/options/disable', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://localhost:4444/cobrowser/api/session/options/disable");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'http://localhost:4444/cobrowser/api/session/options/disable',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'http://localhost:4444/cobrowser/api/session/options/disable',
  params: {}, headers: headers

p JSON.parse(result)

logs

Get extension version

GET http://localhost:4444/cobrowser/extension HTTP/1.1
Host: localhost:4444
Accept: application/json

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Default Response	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» version	string	false	none	none

Examples

{
  "version": "string"
}

tip

This operation does not require authentication

Code samples

curl -X GET http://localhost:4444/cobrowser/extension \
  -H 'Accept: application/json'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "http://localhost:4444/cobrowser/extension", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json'
}

fetch('http://localhost:4444/cobrowser/extension', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://localhost:4444/cobrowser/extension");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

headers = {
  'Accept': 'application/json'
}

r = requests.get(
  'http://localhost:4444/cobrowser/extension',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:4444/cobrowser/extension',
  params: {}, headers: headers

p JSON.parse(result)

Get log ticket by ID

GET http://localhost:4444/cobrowser/extension/tickets/{id} HTTP/1.1
Host: localhost:4444
Accept: application/json

Parameters

Parameter	In	Type	Required	Description
id	path	string	true	Log ticket ID

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Default Response	Inline
404	Not Found	Default Response	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string	false	none	none
» name	string	false	none	none
» usedCount	number	false	none	none
» maxCount	number	false	none	none
» sessions	[object]	false	none	none
»» sessionId	string	false	none	none
»» createdAt	string(date-time)	false	none	none
»» files	[object]	false	none	none
»»» filename	string	false	none	none
»»» path	string	false	none	none
»»» size	number	false	none	none
»»» uploadedAt	string(date-time)	false	none	none
» createdAt	string(date-time)	false	none	none

Status Code 404

Name	Type	Required	Restrictions	Description
» error	string	false	none	none

Examples

{
  "id": "string",
  "name": "string",
  "usedCount": 0,
  "maxCount": 0,
  "sessions": [
    {
      "sessionId": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "files": [
        {
          "filename": "string",
          "path": "string",
          "size": 0,
          "uploadedAt": "2019-08-24T14:15:22Z"
        }
      ]
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z"
}

tip

This operation does not require authentication

Code samples

curl -X GET http://localhost:4444/cobrowser/extension/tickets/{id} \
  -H 'Accept: application/json'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "http://localhost:4444/cobrowser/extension/tickets/{id}", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json'
}

fetch('http://localhost:4444/cobrowser/extension/tickets/{id}', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://localhost:4444/cobrowser/extension/tickets/{id}");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

headers = {
  'Accept': 'application/json'
}

r = requests.get(
  'http://localhost:4444/cobrowser/extension/tickets/{id}',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:4444/cobrowser/extension/tickets/{id}',
  params: {}, headers: headers

p JSON.parse(result)

Create new log ticket, origin dependent

POST http://localhost:4444/cobrowser/extension/tickets HTTP/1.1
Host: localhost:4444
Content-Type: application/json
Accept: application/json

Request body

{
  "maxCount": 10,
  "name": "string"
}

Parameters

Parameter	In	Type	Required	Description
body	body	object	false	none
» maxCount	body	number	false	Maximum number of sessions allowed
» name	body	string	false	Name of who requested the ticket (e.g., company name)

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Default Response	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string	false	none	none
» name	string	false	none	none
» usedCount	number	false	none	none
» maxCount	number	false	none	none
» sessions	[any]	false	none	none
» createdAt	string(date-time)	false	none	none

Examples

{
  "id": "string",
  "name": "string",
  "usedCount": 0,
  "maxCount": 0,
  "sessions": [
    null
  ],
  "createdAt": "2019-08-24T14:15:22Z"
}

tip

This operation does not require authentication

Code samples

curl -X POST http://localhost:4444/cobrowser/extension/tickets \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "http://localhost:4444/cobrowser/extension/tickets", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

const fetch = require('node-fetch');
const input = '{
  "maxCount": 10,
  "name": "string"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json'
}

fetch('http://localhost:4444/cobrowser/extension/tickets', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://localhost:4444/cobrowser/extension/tickets");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post(
  'http://localhost:4444/cobrowser/extension/tickets',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:4444/cobrowser/extension/tickets',
  params: {}, headers: headers

p JSON.parse(result)

Upload log file

POST http://localhost:4444/cobrowser/extension/uploads/logs HTTP/1.1
Host: localhost:4444
Accept: application/json
x-log-id: string

Upload a log file with filename format: type_domain_session-id_date.ext

Parameters

Parameter	In	Type	Required	Description
x-log-id	header	string	true	Log ticket ID

Responses

Overview

Status	Meaning	Description	Schema
200	OK	Default Response	Inline
400	Bad Request	Default Response	string
403	Forbidden	Default Response	string
503	Service Unavailable	Default Response	string

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» success	boolean	true	none	none

Examples

{
  "success": true
}

tip

This operation does not require authentication

Code samples

curl -X POST http://localhost:4444/cobrowser/extension/uploads/logs \
  -H 'Accept: application/json' \  -H 'x-log-id: string'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "x-log-id": []string{"string"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "http://localhost:4444/cobrowser/extension/uploads/logs", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'x-log-id': 'string'
}

fetch('http://localhost:4444/cobrowser/extension/uploads/logs', {
  method: 'POST',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://localhost:4444/cobrowser/extension/uploads/logs");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

headers = {
  'Accept': 'application/json',
  'x-log-id': 'string'
}

r = requests.post(
  'http://localhost:4444/cobrowser/extension/uploads/logs',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'x-log-id' => 'string'
}

result = RestClient.post 'http://localhost:4444/cobrowser/extension/uploads/logs',
  params: {}, headers: headers

p JSON.parse(result)

Download file from ticket session

GET http://localhost:4444/cobrowser/extension/files/{ticketId}/{sessionId}/{filename} HTTP/1.1
Host: localhost:4444
Accept: application/json

Parameters

Parameter	In	Type	Required	Description
ticketId	path	string	true	Log ticket ID
sessionId	path	string	true	Session ID
filename	path	string	true	File name

Responses

Overview

Status	Meaning	Description	Schema
200	OK	File content	string
404	Not Found	Default Response	Inline

Response Schema

Status Code 404

Name	Type	Required	Restrictions	Description
» error	string	false	none	none

Examples

"string"

tip

This operation does not require authentication

Code samples

curl -X GET http://localhost:4444/cobrowser/extension/files/{ticketId}/{sessionId}/{filename} \
  -H 'Accept: application/json'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "http://localhost:4444/cobrowser/extension/files/{ticketId}/{sessionId}/{filename}", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json'
}

fetch('http://localhost:4444/cobrowser/extension/files/{ticketId}/{sessionId}/{filename}', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://localhost:4444/cobrowser/extension/files/{ticketId}/{sessionId}/{filename}");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

headers = {
  'Accept': 'application/json'
}

r = requests.get(
  'http://localhost:4444/cobrowser/extension/files/{ticketId}/{sessionId}/{filename}',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:4444/cobrowser/extension/files/{ticketId}/{sessionId}/{filename}',
  params: {}, headers: headers

p JSON.parse(result)

Authentication​

cobrowse​

Resume session after sender has refreshed page​

Request body​

Parameters​

Enumerated Values​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

Reconnect to a session​

Request body​

Parameters​

Enumerated Values​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

Create a new session​

Request body​

Parameters​

Enumerated Values​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

Get session info​

Parameters​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

Post dom event as document's owner​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

Post dom event as viewer​

Request body​

Parameters​

Enumerated Values​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

Terminate a cobrowse session​

Request body​

Parameters​

Enumerated Values​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

permissions​

Request to view remote page​

Request body​

Parameters​

Enumerated Values​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

Accept request to view page​

Request body​

Parameters​

Enumerated Values​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

Revoke view access of participant​

Authentication

cobrowse

Resume session after sender has refreshed page

Request body

Parameters

Enumerated Values

Responses

Overview

Response Schema

Examples

Code samples

Reconnect to a session

Request body

Parameters

Enumerated Values

Responses

Overview

Response Schema

Examples

Code samples

Create a new session

Request body

Parameters

Enumerated Values

Responses

Overview

Response Schema

Examples

Code samples

Get session info

Parameters

Responses

Overview

Response Schema

Examples

Code samples

Post dom event as document's owner

Responses

Overview

Response Schema

Examples

Code samples

Post dom event as viewer

Request body

Parameters

Enumerated Values

Responses

Overview

Response Schema

Examples

Code samples

Terminate a cobrowse session

Request body

Parameters

Enumerated Values

Responses

Overview

Response Schema

Examples

Code samples

permissions

Request to view remote page

Request body

Parameters

Enumerated Values

Responses

Overview

Response Schema

Examples

Code samples

Accept request to view page

Request body

Parameters

Enumerated Values

Responses

Overview

Response Schema

Examples

Code samples

Revoke view access of participant