--- html: server_info.html parent: server-info-methods.html blurb: Retrieve status of the server in human-readable format. labels: - Core Server --- # server_info (rippled) [[Source]](https://github.com/ripple/rippled/blob/master/src/ripple/rpc/handlers/ServerInfo.cpp "Source") The `server_info` command asks the server for a human-readable version of various information about [the `rippled` server](xrpl-servers.html) being queried. For [Clio servers](the-clio-server.html), see [`server_info` (Clio)](server_info-clio.html) instead. ## Request Format An example of the request format: *WebSocket* ```json { "id": 1, "command": "server_info" } ``` *JSON-RPC* ```json { "method": "server_info", "params": [ {} ] } ``` *Commandline* ```sh #Syntax: server_info rippled server_info ``` [Try it! >](websocket-api-tool.html#server_info) The request does not take any parameters. ## Response Format An example of a successful response: *WebSocket* ```json { "id": 1, "result": { "info": { "build_version": "1.9.4", "complete_ledgers": "32570-75801736", "hostid": "ARMY", "initial_sync_duration_us": "273518294", "io_latency_ms": 1, "jq_trans_overflow": "2282", "last_close": { "converge_time_s": 3.002, "proposers": 35 }, "load_factor": 1, "network_id": 0, "peer_disconnects": "3194", "peer_disconnects_resources": "3", "peers": 20, "pubkey_node": "n9KKBZvwPZ95rQi4BP3an1MRctTyavYkZiLpQwasmFYTE6RYdeX3", "server_state": "full", "server_state_duration_us": "69205850392", "state_accounting": { "connected": { "duration_us": "141058919", "transitions": "7" }, "disconnected": { "duration_us": "514136273", "transitions": "3" }, "full": { "duration_us": "4360230140761", "transitions": "32" }, "syncing": { "duration_us": "50606510", "transitions": "30" }, "tracking": { "duration_us": "40245486", "transitions": "34" } }, "time": "2022-Nov-16 21:50:22.711679 UTC", "uptime": 4360976, "validated_ledger": { "age": 1, "base_fee_xrp": 0.00001, "hash": "3147A41F5F013209581FCDCBBB7A87A4F01EF6842963E13B2B14C8565E00A22B", "reserve_base_xrp": 10, "reserve_inc_xrp": 2, "seq": 75801736 }, "validation_quorum": 28 } }, "status": "success", "type": "response" } ``` *JSON-RPC* ```json 200 OK { "result": { "info": { "build_version": "1.9.4", "complete_ledgers": "32570-75801747", "hostid": "ABET", "initial_sync_duration_us": "566800928", "io_latency_ms": 1, "jq_trans_overflow": "47035", "last_close": { "converge_time_s": 3, "proposers": 35 }, "load_factor": 1, "network_id": 0, "peer_disconnects": "542", "peer_disconnects_resources": "1", "peers": 24, "pubkey_node": "n9LvjJyaYHBWUvQUat632RrnpS7UHVLW2tLUGXSZ2yXouh4goDHX", "server_state": "full", "server_state_duration_us": "3612238603", "state_accounting": { "connected": { "duration_us": "125498126", "transitions": "67" }, "disconnected": { "duration_us": "473415516", "transitions": "2" }, "full": { "duration_us": "4365855930299", "transitions": "337" }, "syncing": { "duration_us": "1383837914", "transitions": "311" }, "tracking": { "duration_us": "518995710", "transitions": "374" } }, "time": "2022-Nov-16 21:51:03.737667 UTC", "uptime": 4368357, "validated_ledger": { "age": 1, "base_fee_xrp": 0.00001, "hash": "D54A94D5EF620DC212EAB5958D592EC641FC94ED92146477A04DCE5B006DFF05", "reserve_base_xrp": 10, "reserve_inc_xrp": 2, "seq": 75801747 }, "validation_quorum": 28 }, "status": "success" } } ``` *Commandline* ```json Loading: "/etc/opt/ripple/rippled.cfg" 2020-Mar-24 01:28:22.288484766 UTC HTTPClient:NFO Connecting to 127.0.0.1:5005 { "result": { "info": { "build_version": "1.9.4", "complete_ledgers": "32570-75801747", "hostid": "ABET", "initial_sync_duration_us": "566800928", "io_latency_ms": 1, "jq_trans_overflow": "47035", "last_close": { "converge_time_s": 3, "proposers": 35 }, "load_factor": 1, "network_id": 0, "peer_disconnects": "542", "peer_disconnects_resources": "1", "peers": 24, "pubkey_node": "n9LvjJyaYHBWUvQUat632RrnpS7UHVLW2tLUGXSZ2yXouh4goDHX", "server_state": "full", "server_state_duration_us": "3612238603", "state_accounting": { "connected": { "duration_us": "125498126", "transitions": "67" }, "disconnected": { "duration_us": "473415516", "transitions": "2" }, "full": { "duration_us": "4365855930299", "transitions": "337" }, "syncing": { "duration_us": "1383837914", "transitions": "311" }, "tracking": { "duration_us": "518995710", "transitions": "374" } }, "time": "2022-Nov-16 21:51:03.737667 UTC", "uptime": 4368357, "validated_ledger": { "age": 1, "base_fee_xrp": 0.00001, "hash": "D54A94D5EF620DC212EAB5958D592EC641FC94ED92146477A04DCE5B006DFF05", "reserve_base_xrp": 10, "reserve_inc_xrp": 2, "seq": 75801747 }, "validation_quorum": 28 }, "status": "success" } } ``` The response follows the [standard format][], with a successful result containing an `info` object as its only field. The `info` object may have some arrangement of the following fields: | `Field` | Type | Description | |:------------------------------------|:----------------|:---------------------| | `amendment_blocked` | Boolean | _(May be omitted)_ If `true`, this server is [amendment blocked](amendments.html#amendment-blocked-servers). If the server is not amendment blocked, the response omits this field. [New in: rippled 0.80.0][] | | `build_version` | String | The version number of the running `rippled` server. | | `closed_ledger` | Object | _(May be omitted)_ Information on the most recently closed ledger that has not been validated by consensus. If the most recently validated ledger is available, the response omits this field and includes `validated_ledger` instead. The member fields are the same as the `validated_ledger` field. | | `complete_ledgers` | String | Range expression indicating the sequence numbers of the ledger versions the local `rippled` has in its database. This may be a disjoint sequence such as `24900901-24900984,24901116-24901158`. If the server does not have any complete ledgers (for example, it recently started syncing with the network), this is the string `empty`. | | `hostid` | String | On an admin request, returns the hostname of the server running the `rippled` instance; otherwise, returns a single [RFC-1751][] word based on the [node public key](peer-protocol.html#node-key-pair). | | `io_latency_ms` | Number | Amount of time spent waiting for I/O operations, in milliseconds. If this number is not very, very low, then the `rippled` server is probably having serious load issues. | | `jq_trans_overflow` | String - Number | The number of times (since starting up) that this server has had over 250 transactions waiting to be processed at once. A large number here may mean that your server is unable to handle the transaction load of the XRP Ledger network. For detailed recommendations of future-proof server specifications, see [Capacity Planning](capacity-planning.html). [New in: rippled 0.90.0][] | | `last_close` | Object | Information about the last time the server closed a ledger, including the amount of time it took to reach a consensus and the number of trusted validators participating. | | `last_close.converge_time_s` | Number | The amount of time it took to reach a consensus on the most recently validated ledger version, in seconds. | | `last_close.proposers` | Number | How many trusted validators the server considered (including itself, if configured as a validator) in the consensus process for the most recently validated ledger version. | | `load` | Object | _(Admin only)_ Detailed information about the current load state of the server. | | `load.job_types` | Array | _(Admin only)_ Information about the rate of different types of jobs the server is doing and how much time it spends on each. | | `load.threads` | Number | _(Admin only)_ The number of threads in the server's main job pool. | | `load_factor` | Number | The load-scaled open ledger transaction cost the server is currently enforcing, as a multiplier on the base transaction cost. For example, at `1000` load factor and a reference transaction cost of 10 drops of XRP, the load-scaled transaction cost is 10,000 drops (0.01 XRP). The load factor is determined by the highest of the [individual server's load factor](transaction-cost.html#local-load-cost), the cluster's load factor, the [open ledger cost](transaction-cost.html#open-ledger-cost) and the overall network's load factor. [Updated in: rippled 0.33.0][] | | `load_factor_local` | Number | _(May be omitted)_ Current multiplier to the [transaction cost][] based on load to this server. | | `load_factor_net` | Number | _(May be omitted)_ Current multiplier to the [transaction cost][] being used by the rest of the network (estimated from other servers' reported load values). | | `load_factor_cluster` | Number | _(May be omitted)_ Current multiplier to the [transaction cost][] based on load to servers in [this cluster](clustering.html). | | `load_factor_fee_escalation` | Number | _(May be omitted)_ The current multiplier to the [transaction cost][] that a transaction must pay to get into the open ledger. [New in: rippled 0.32.0][] | | `load_factor_fee_queue` | Number | _(May be omitted)_ The current multiplier to the [transaction cost][] that a transaction must pay to get into the queue, if the queue is full. [New in: rippled 0.32.0][] | | `load_factor_server` | Number | _(May be omitted)_ The load factor the server is enforcing, not including the [open ledger cost](transaction-cost.html#open-ledger-cost). [New in: rippled 0.33.0][] | | `peers` | Number | _(Omitted by [reporting mode][Reporting mode] servers)_ How many other `rippled` servers this one is currently connected to. | | `pubkey_node` | String | Public key used to verify this server for peer-to-peer communications. This [_node key pair_](peer-protocol.html#node-key-pair) is automatically generated by the server the first time it starts up. (If deleted, the server can create a new pair of keys.) You can set a persistent value in the config file using the `[node_seed]` config option, which is useful for [clustering](clustering.html). | | `pubkey_validator` | String | _(Admin only)_ Public key used by this node to sign ledger validations. This _validation key pair_ is derived from the `[validator_token]` or `[validation_seed]` config field. | | `reporting` | Object | _([Reporting mode](rippled-server-modes.html) servers only)_ Information about this server's reporting-mode specific configurations. | | `reporting.etl_sources` | Array | _([Reporting mode](rippled-server-modes.html) servers only)_ A list of P2P-mode servers this reporting mode is retrieving data from. Each entry in this array is an [ETL Source object](#etl-source-object). | | `reporting.is_writer` | Boolean | _([Reporting mode](rippled-server-modes.html) servers only)_ If `true`, this server is writing to the external database with ledger data. If `false`, it is not currently writing, possibly because another reporting mode server is currently populating a shared database, or because it's configured as read-only.| | `reporting.last_publish_time` | String | _([Reporting mode](rippled-server-modes.html) servers only)_ An ISO 8601 timestamp indicating when this server last published a validated ledger to its [subscription streams](subscribe.html). | | `server_state` | String | A string indicating to what extent the server is participating in the network. See [Possible Server States](rippled-server-states.html) for more details. | | `server_state_duration_us` | Number | The number of consecutive microseconds the server has been in the current state. [New in: rippled 1.2.0][] | | `state_accounting` | Object | A map of various [server states](rippled-server-states.html) with information about the time the server spends in each. This can be useful for tracking the long-term health of your server's connectivity to the network. [New in: rippled 0.30.1][] | | `state_accounting.*.duration_us` | String | The number of microseconds the server has spent in this state. (This is updated whenever the server transitions into another state.) [New in: rippled 0.30.1][] | | `state_accounting.*.transitions` | String | The number of times the server has changed into this state. [New in: rippled 0.30.1][] | | `time` | String | The current time in UTC, according to the server's clock. [Updated in: rippled 1.5.0][] | | `uptime` | Number | Number of consecutive seconds that the server has been operational. [New in: rippled 0.30.1][] | | `validated_ledger` | Object | _(May be omitted)_ Information about the most recent fully-validated ledger. If the most recent validated ledger is not available, the response omits this field and includes `closed_ledger` instead. | | `validated_ledger.age` | Number | The time since the ledger was closed, in seconds. | | `validated_ledger.base_fee_xrp` | Number | Base fee, in XRP. This may be represented in scientific notation such as `1e-05` for 0.00001. | | `validated_ledger.hash` | String | Unique hash for the ledger, as hexadecimal. | | `validated_ledger.reserve_base_xrp` | Number | Minimum amount of XRP (not drops) necessary for every account to keep in reserve | | `validated_ledger.reserve_inc_xrp` | Number | Amount of XRP (not drops) added to the account reserve for each object an account owns in the ledger. | | `validated_ledger.seq` | Number | The [ledger index][] of the latest validated ledger. | | `validation_quorum` | Number | Minimum number of trusted validations required to validate a ledger version. Some circumstances may cause the server to require more validations. | | `validator_list_expires` | String | _(Admin only)_ Either the human readable time, in UTC, when the current validator list expires, the string `unknown` if the server has yet to load a published validator list or the string `never` if the server uses a static validator list. [Updated in: rippled 1.5.0][] | **Note:** If the `closed_ledger` field is present and has a small `seq` value (less than 8 digits), that indicates `rippled` does not currently have a copy of the validated ledger from the peer-to-peer network. This could mean your server is still syncing. Typically, it takes about 5 minutes to sync with the network, depending on your connection speed and hardware specs. {% include '_snippets/etl-source-object.md' %} ## Possible Errors * Any of the [universal error types][]. {% include '_snippets/rippled-api-links.md' %} {% include '_snippets/tx-type-links.md' %} {% include '_snippets/rippled_versions.md' %}