Interface ServerStateRequest

The server_state command asks the server for various machine-readable information about the rippled server's current state. The response is almost the same as the server_info method, but uses units that are easier to process instead of easier to read.

interface ServerStateRequest {
    api_version?: number;
    command: "server_state";
    id?: string | number;
    [x: string]: unknown;
}

Hierarchy (View Summary)

Indexable

  • [x: string]: unknown

Properties

api_version? command id?

Properties

Optionalapi_version

api_version?: number

The API version to use. If omitted, use version 1.

command

command: "server_state"

The name of the API method.

Optionalid

id?: string | number

A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

Settings

Member Visibility

On This Page

Properties