admin_startWS

The startWS is an administrative method that starts an WebSocket based JSON RPC API webserver to handle client requests.

The method returns a boolean flag specifying whether the WebSocket RPC listener was opened or not. Please note, only one WebSocket endpoint is allowed to be active at any time.

JSONRPC: admin_startWS

Request

application/json

Body

method stringrequired

Default value: admin_startWS

Method name

id int64required

Default value: 1

Request ID, Random or Auto incrementation

jsonrpc stringrequired

Default value: 2.0

JSON-RPC Version (2.0)

params

undefined[]

required

Array [

Host Host

(optional) network interface to open the listener socket on (default "localhost").

Port Port

(optional) network port to open the listener socket on (default 8552).

Cors Cors

(optional) cross-origin resource sharing header to use (default "").

Apis Apis

(optional) API modules to offer over this interface (default "klay,net,rpc").

]

Responses

200

true if the WebSocket RPC listener was opened, false if not.

application/json

Schema

Schema

jsonrpc stringrequired

Default value: 2.0

id int64required

error

object

code int64required

A Number that indicates the error type that occurred. This MUST be an integer.

| code | message | description | |-----|-----|-------| | -32700 | Parse error | invalid JSON was received by the server. An error occurred on the server while parsing the JSON text. | |-32602 | Invalid params | Invalid method parameter(s). |

message string

A String providing a short description of the error. The message SHOULD be limited to a concise single sentence.

data string

A Primitive or Structured value that contains additional information about the error. This may be omitted. The value of this member is defined by the Server (e.g. detailed error information, nested errors etc.).

result boolean

true if the WebSocket RPC listener was opened, false if not.

Example (from schema)

{
  "jsonrpc": "2.0",
  "id": 0,
  "error": {
    "code": -32700,
    "message": "Parse error",
    "data": "string"
  },
  "result": true
}

Loading...