admin_stopHTTP

The stopHTTP is an administrative method that closes the currently open HTTP RPC endpoint. As the node can only have a single HTTP endpoint running, this method takes no parameters, returning a boolean whether the endpoint was closed or not.

NOTE: This API replaces admin_stopRPC. The admin_stopRPC will be deprecated soon.

JSONRPC: admin_stopHTTP

Request

application/json

Body

params array

Responses

200

true if the endpoint was closed, false if not.

application/json

Schema

Schema

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 endpoint was closed, false if not.

Example (from schema)

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

Loading...