xrpl-dev-portal/content/rippled-api-methods/validator_list_sites.md

validator_list_sites

[Source]

The validator_list_sites command returns status information of sites serving validator lists. [New in: rippled 0.80.1][]

The validator_list_sites request is an admin command that cannot be run by unprivileged users!

Request Format

An example of the request format:

WebSocket

{
    "id": 1,
    "command": "validator_list_sites"
}

JSON-RPC

{
    "method": "validator_list_sites",
    "params": [
        {}
    ]
}

Commandline

#Syntax: validator_list_sites
rippled validator_list_sites

The request includes no parameters.

Response Format

An example of a successful response:

WebSocket

{
    "id":5,
    "status":"success",
    "type":"response",
    "result": {
        "validator_sites": [
            {
                "last_refresh_status": "accepted",
                "last_refresh_time": "2017-Oct-13 21:26:37",
                "refresh_interval_min": 5,
                "uri": "http://127.0.0.1:51447/validators"
            }
        ]
    }
}
}

JSON-RPC

200 OK
{
    "result": {
        "status": "success",
        "validator_sites": [
            {
                "last_refresh_status": "accepted",
                "last_refresh_time": "2017-Oct-13 21:26:37",
                "refresh_interval_min": 5,
                "uri": "http://127.0.0.1:51447/validators"
            }
        ]
    }
}

Commandline

Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
{
    "result": {
        "status": "success",
        "validator_sites": [
            {
                "last_refresh_status": "accepted",
                "last_refresh_time": "2017-Oct-13 21:26:37",
                "refresh_interval_min": 5,
                "uri": "http://127.0.0.1:51447/validators"
            }
        ]
    }
}

The response follows the standard format, with a successful result containing the following field:

Field	Type	Description
validator_sites	Array	Array of validator site objects.

Each member of the validator_sites field array is an object with the following fields:

Field	Type	Description
last_refresh_status	String	If present, theListDisposition of the most recent refresh of the site. If missing, the site has not yet been succesfully queried.
last_refresh_time	String	Human readable time when the site was last queried. If missing, the site has not yet been succesfully queried.
refresh_interval_min	Unsigned Integer	The number of minutes between refresh attempts.
uri	String	The URI of the site.

Possible Errors

• Any of the universal error types.