admin_startHTTP
The startHTTP is an administrative method that starts an HTTP based JSON RPC API webserver to handle client requests.
The method returns a boolean flag specifying whether the HTTP RPC listener was opened or not. Please note, only one HTTP endpoint is allowed to be active at any time.
NOTE: This API replaces admin_startRPC. The admin_startRPC will be deprecated soon.
JSONRPC: admin_startHTTP
Request
- application/json
Body
Array [
]
params
undefined[]
required
(optional) network interface to open the listener socket on (default "localhost").
(optional) network port to open the listener socket on (default 8551).
(optional) cross-origin resource sharing header to use (default "").
(optional) API modules to offer over this interface (default "kaia,net,rpc").
Responses
- 200
Return true if the HTTP RPC listener was opened, false if not.
- application/json
- Schema
- Example (from schema)
Schema
error
object
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). |
A String providing a short description of the error. The message SHOULD be limited to a concise single sentence.
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.).
true if the HTTP RPC listener was opened, false if not.
{
"jsonrpc": "2.0",
"id": 0,
"error": {
"code": -32700,
"message": "Parse error",
"data": "string"
},
"result": true
}