ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-20 11:45:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

added blurbs, demoted headers

Browse Source
This commit is contained in:
Ryan Young
2018-05-09 14:12:45 -07:00
parent 05733d6067
commit 52ec01222f
20 changed files with 114 additions and 97 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
content/references/rippled-api/admin-rippled-methods/key-generation-methods/validation_create.md
View File

@@ -1,11 +1,11 @@
## validation_create
# validation_create
[[Source]<br>](https://github.com/ripple/rippled/blob/315a8b6b602798a4cff4d8e1911936011e12abdb/src/ripple/rpc/handlers/ValidationCreate.cpp "Source")
Use the `validation_create` command to generate the keys for a rippled [validator](tutorial-rippled-setup.html#validator-setup). Similar to the [wallet_propose](#wallet-propose) command, this command makes no real changes, but only generates a set of keys in the proper format.
_The `validation_create` method is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users._
#### Request Format
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
@@ -50,7 +50,7 @@ The request includes the following parameters:
**Note:** The security of your validator depends on the entropy of your seed. Do not use a secret value for real business purposes unless it is generated with a strong source of randomness. Ripple recommends omitting the `secret` when generating new credentials for the first time.
#### Response Format
### Response Format
An example of a successful response:
@@ -94,7 +94,7 @@ The response follows the [standard format](#response-formatting), with a success
| `validation_public_key` | String | The public key for these validation credentials, in Ripple's [base58][] encoded string format. |
| `validation_seed` | String | The secret key for these validation credentials, in Ripple's [base58][] encoded string format. |
#### Possible Errors
### Possible Errors
* Any of the [universal error types](#universal-errors).
* `badSeed` - The request provided an invalid seed value. This usually means that the seed value appears to be a valid string of a different format, such as an account address or validation public key.

10
content/references/rippled-api/admin-rippled-methods/key-generation-methods/wallet_propose.md
View File

@@ -1,4 +1,4 @@
## wallet_propose
# wallet_propose
[[Source]<br>](https://github.com/ripple/rippled/blob/master/src/ripple/rpc/handlers/WalletPropose.cpp "Source")
Use the `wallet_propose` method to generate a key pair and XRP Ledger address. This command only generates key and address values, and does not affect the XRP Ledger itself in any way. To become a funded address stored in the ledger, the address must [receive a Payment transaction](reference-transaction-format.html#creating-accounts) that provides enough XRP to meet the [reserve requirement](concept-reserves.html).
@@ -7,7 +7,7 @@ Use the `wallet_propose` method to generate a key pair and XRP Ledger address. T
[Updated in: rippled 0.31.0][New in: rippled 0.31.0]
#### Request Format
### Request Format
An example of the request format:
@@ -81,7 +81,7 @@ You must provide **at most one** of the following fields: `passphrase`, `seed`,
**Note:** [Ed25519](https://ed25519.cr.yp.to/) support is experimental. The commandline version of this command cannot generate Ed25519 keys.
##### Specifying a Seed
#### Specifying a Seed
For most cases, you should use a seed value generated from a strong source of randomness. Anyone who knows the seed value for an address has full power to [send transactions signed by that address](reference-transaction-format.html#authorizing-transactions). Generally, running this command with no parameters is a good way to generate a random seed.
@@ -101,7 +101,7 @@ If you do specify a seed, you can specify it in any of the following formats:
[RFC-1751]: https://tools.ietf.org/html/rfc1751
[hexadecimal]: https://en.wikipedia.org/wiki/Hexadecimal
#### Response Format
### Response Format
An example of a successful response:
@@ -185,7 +185,7 @@ For more information about master and regular key pairs, see [Cryptographic Keys
For more information about multi-signing and signer lists, see [Multi-Signing](reference-transaction-format.html#multi-signing).
#### Possible Errors
### Possible Errors
* Any of the [universal error types](#universal-errors).
* `invalidParams` - One or more fields are specified incorrectly.

6
content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/can_delete.md
View File

@@ -1,11 +1,11 @@
## can_delete
# can_delete
[[Source]<br>](https://github.com/ripple/rippled/blob/develop/src/ripple/rpc/handlers/CanDelete.cpp "Source")
With `online_delete` and `advisory_delete` configuration options enabled, the `can_delete` method informs the rippled server of the latest ledger which may be deleted.
_The `can_delete` method is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users._
#### Request Format
### Request Format
An example of the request format:
@@ -60,7 +60,7 @@ a successful result containing the following fields:
Use this command with no parameter to query the existing `can_delete` setting.
#### Possible Errors
### Possible Errors
* Any of the [universal error types](#universal-errors).
* `notEnabled` - Not enabled in configuration.

8
content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/ledger_cleaner.md
View File

@@ -1,11 +1,11 @@
## ledger_cleaner
# ledger_cleaner
[[Source]<br>](https://github.com/ripple/rippled/blob/df54b47cd0957a31837493cd69e4d9aade0b5055/src/ripple/rpc/handlers/LedgerCleaner.cpp "Source")
The `ledger_cleaner` command controls the [Ledger Cleaner](https://github.com/ripple/rippled/blob/f313caaa73b0ac89e793195dcc2a5001786f916f/src/ripple/app/ledger/README.md#the-ledger-cleaner), an asynchronous maintenance process that can find and repair corruption in `rippled`'s database of ledgers.
_The `ledger_cleaner` method is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users._
#### Request Format
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
@@ -35,7 +35,7 @@ The request includes the following parameters:
| `check_nodes` | Boolean | _(Optional)_ If true, correct ledger state objects in the specified ledger(s). Overrides `full` if provided. |
| `stop` | Boolean | _(Optional)_ If true, disable the ledger cleaner. |
#### Response Format
### Response Format
An example of a successful response:
@@ -62,7 +62,7 @@ The response follows the [standard format](#response-formatting), with a success
|:----------|:-------|:---------------------------------|
| `message` | String | `Cleaner configured` on success. |
#### Possible Errors
### Possible Errors
* Any of the [universal error types](#universal-errors).
* `internal` if one the parameters is specified incorrectly. (This is a bug; the intended error code is `invalidParams`.)

10
content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/ledger_request.md
View File

@@ -1,11 +1,11 @@
## ledger_request
# ledger_request
[[Source]<br>](https://github.com/ripple/rippled/blob/e980e69eca9ea843d200773eb1f43abe3848f1a0/src/ripple/rpc/handlers/LedgerRequest.cpp "Source")
The `ledger_request` command tells server to fetch a specific ledger version from its connected peers. This only works if one of the server's immediately-connected peers has that ledger. You may need to run the command several times to completely fetch a ledger.
*The `ledger_request` request is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users!*
#### Request Format
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
@@ -37,7 +37,7 @@ The request includes the following parameters:
You must provide either `ledger_index` or `ledger_hash` but not both.
#### Response Format
### Response Format
The response follows the [standard format](#response-formatting). However, the request returns a failure response if it does not have the specified ledger _even if it successfully instructed the `rippled` server to start retrieving the ledger_.
@@ -156,7 +156,7 @@ The three possible response formats are as follows:
2. When the response shows the server is currently fetching the ledger, the body of the result is a [Ledger Request Object](#ledger-request-object) indicating the progress of fetching the ledger from the peer-to-peer network.
3. When the ledger is fully available, the response is a representation of the [ledger header](reference-ledger-format.html#header-format).
#### Ledger Request Object
### Ledger Request Object
When the server is in the progress of fetching a ledger, but has not yet finished, the `rippled` server returns a ledger request object indicating its progress towards fetching the ledger. This object has the following fields:
@@ -171,7 +171,7 @@ When the server is in the progress of fetching a ledger, but has not yet finishe
| `peers` | Number | How many peers the server is querying to find this ledger. |
| `timeouts` | Number | Number of times fetching this ledger has timed out so far. |
#### Possible Errors
### Possible Errors
* Any of the [universal error types](#universal-errors).
* `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing. This error can also occur if you specify a ledger index equal or higher than the current in-progress ledger.

8
content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/log_level.md
View File

@@ -1,11 +1,11 @@
## log_level
# log_level
[[Source]<br>](https://github.com/ripple/rippled/blob/155fcdbcd0b4927152892c8c8be01d9cf62bed68/src/ripple/rpc/handlers/LogLevel.cpp "Source")
The `log_level` command changes the `rippled` server's logging verbosity, or returns the current logging level for each category (called a _partition_) of log messages.
_The `log_level` method is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users._
#### Request Format
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
@@ -37,7 +37,7 @@ The request includes the following parameters:
| `severity` | String | _(Optional)_ What level of verbosity to set logging at. Valid values are, in order from least to most verbose: `fatal`, `error`, `warn`, `info`, `debug`, and `trace`. If omitted, return current log verbosity for all categories. |
| `partition` | String | _(Optional)_ Ignored unless `severity` is provided. Which logging category to modify. If omitted, or if provided with the value `base`, set logging level for all categories. |
#### Response Format
### Response Format
Examples of successful responses:
@@ -129,7 +129,7 @@ Otherwise, the request contains the following field:
|:--------|:-------|:----------------------------------------------------------|
| `level` | Object | The current log levels of each category. This list of categories is subject to change without notice in future releases. You can use the field names as values to `partition` in requests to this command. |
#### Possible Errors
### Possible Errors
* Any of the [universal error types](#universal-errors).
* `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing.

8
content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/logrotate.md
View File

@@ -1,11 +1,11 @@
## logrotate
# logrotate
[[Source]<br>](https://github.com/ripple/rippled/blob/743bd6c9175c472814448ea889413be79dfd1c07/src/ripple/rpc/handlers/LogRotate.cpp "Source")
The `logrotate` command closes and reopens the log file. This is intended to help with log rotation on Linux file systems.
_The `logrotate` method is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users._
#### Request Format
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
@@ -29,7 +29,7 @@ rippled logrotate
The request includes no parameters.
#### Response Format
### Response Format
An example of a successful response:
@@ -70,6 +70,6 @@ The response follows the [standard format](#response-formatting), with a success
|:----------|:-------|:--------------------------------------------------------|
| `message` | String | On success, contains the message `The log file was closed and reopened.` |
#### Possible Errors
### Possible Errors
* Any of the [universal error types](#universal-errors).

8
content/references/rippled-api/admin-rippled-methods/server-control-methods/connect.md
View File

@@ -1,11 +1,11 @@
## connect
# connect
[[Source]<br>](https://github.com/ripple/rippled/blob/a61ffab3f9010d8accfaa98aa3cacc7d38e74121/src/ripple/rpc/handlers/Connect.cpp "Source")
The `connect` command forces the `rippled` server to connect to a specific peer `rippled` server.
*The `connect` request is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users!*
#### Request Format
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
@@ -51,7 +51,7 @@ The request includes the following parameters:
| `ip` | String | IP address of the server to connect to |
| `port` | Number | _(Optional)_ Port number to use when connecting. Defaults to 6561. |
#### Response Format
### Response Format
An example of a successful response:
@@ -89,7 +89,7 @@ The response follows the [standard format](#response-formatting), with a success
|:----------|:-------|:-------------------------------------------------------|
| `message` | String | The value `connecting`, if the command was successful. |
#### Possible Errors
### Possible Errors
* Any of the [universal error types](#universal-errors).
* `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing.

8
content/references/rippled-api/admin-rippled-methods/server-control-methods/ledger_accept.md
View File

@@ -1,11 +1,11 @@
## ledger_accept
# ledger_accept
[[Source]<br>](https://github.com/ripple/rippled/blob/a61ffab3f9010d8accfaa98aa3cacc7d38e74121/src/ripple/rpc/handlers/LedgerAccept.cpp "Source")
The `ledger_accept` method forces the server to close the current-working ledger and move to the next ledger number. This method is intended for testing purposes only, and is only available when the `rippled` server is running stand-alone mode.
*The `ledger_accept` method is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users!*
#### Request Format
### Request Format
An example of the request format:
@@ -31,7 +31,7 @@ rippled ledger_accept
The request accepts no parameters.
#### Response Format
### Response Format
An example of a successful response:
```js
@@ -53,7 +53,7 @@ The response follows the [standard format](#response-formatting), with a success
**Note:** When you close a ledger, `rippled` determines the canonical order of transactions in that ledger and replays them. This can change the outcome of transactions that were provisionally applied to the current ledger.
#### Possible Errors
### Possible Errors
* Any of the [universal error types](#universal-errors).
* `notStandAlone` - If the `rippled` server is not currently running in stand-alone mode.

8
content/references/rippled-api/admin-rippled-methods/server-control-methods/stop.md
View File

@@ -1,11 +1,11 @@
## stop
# stop
[[Source]<br>](https://github.com/ripple/rippled/blob/develop/src/ripple/rpc/handlers/Stop.cpp "Source")
Gracefully shuts down the server.
*The `stop` request is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users!*
#### Request Format
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
@@ -40,7 +40,7 @@ rippled stop
The request includes no parameters.
#### Response Format
### Response Format
An example of a successful response:
@@ -78,6 +78,6 @@ The response follows the [standard format](#response-formatting), with a success
|:----------|:-------|:-------------------------------------|
| `message` | String | `ripple server stopping` on success. |
#### Possible Errors
### Possible Errors
* Any of the [universal error types](#universal-errors).

8
content/references/rippled-api/admin-rippled-methods/server-control-methods/validation_seed.md
View File

@@ -1,11 +1,11 @@
## validation_seed
# validation_seed
[[Source]<br>](https://github.com/ripple/rippled/blob/a61ffab3f9010d8accfaa98aa3cacc7d38e74121/src/ripple/rpc/handlers/ValidationSeed.cpp "Source")
The `validation_seed` command temporarily sets the secret value that rippled uses to sign validations. This value resets based on the config file when you restart the server.
*The `validation_seed` request is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users!*
#### Request Format
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
@@ -35,7 +35,7 @@ The request includes the following parameters:
|:---------|:-------|:---------------------------------------------------------|
| `secret` | String | _(Optional)_ If present, use this value as the secret value for the validating key pair. Valid formats include [base58][], [RFC-1751](https://tools.ietf.org/html/rfc1751), or as a passphrase. If omitted, disables proposing validations to the network. |
#### Response Format
### Response Format
An example of a successful response:
@@ -80,7 +80,7 @@ The response follows the [standard format](#response-formatting), with a success
| `validation_public_key` | String | (Omitted if proposing disabled) The public key for these validation credentials, in Ripple's [base58][] encoded string format. |
| `validation_seed` | String | (Omitted if proposing disabled) The secret key for these validation credentials, in Ripple's [base58][] encoded string format. |
#### Possible Errors
### Possible Errors
* Any of the [universal error types](#universal-errors).
* `badSeed` - The request provided an invalid secret value. This usually means that the secret value appears to be a valid string of a different format, such as an account address or validation public key.

8
content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/consensus_info.md
View File

@@ -1,11 +1,11 @@
## consensus_info
# consensus_info
[[Source]<br>](https://github.com/ripple/rippled/blob/a61ffab3f9010d8accfaa98aa3cacc7d38e74121/src/ripple/rpc/handlers/ConsensusInfo.cpp "Source")
The `consensus_info` command provides information about the consensus process for debugging purposes.
_The `consensus_info` method is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users._
#### Request Format
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
@@ -41,7 +41,7 @@ rippled consensus_info
The request has no parameters.
#### Response Format
### Response Format
An example of a successful response:
@@ -223,6 +223,6 @@ It is also normal to get a minimal result where the only field in `info` is `"co
The results of the `consensus_info` command can vary dramatically if you run it several times, even in short succession.
#### Possible Errors
### Possible Errors
* Any of the [universal error types](#universal-errors).

8
content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/feature.md
View File

@@ -1,4 +1,4 @@
## feature
# feature
[[Source]<br>](https://github.com/ripple/rippled/blob/develop/src/ripple/rpc/handlers/Feature1.cpp "Source")
The `feature` command returns information about [amendments](concept-amendments.html) this server knows about, including whether they are enabled and whether the server is voting in favor of those amendments in the [amendment process](concept-amendments.html#amendment-process). [New in: rippled 0.31.0][]
@@ -7,7 +7,7 @@ You can use the `feature` command to temporarily configure the server to vote ag
_The `feature` method is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users._
#### Request Format
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
@@ -64,7 +64,7 @@ The request includes the following parameters:
**Note:** You can configure your server to vote in favor of a new amendment, even if the server does not currently know how to apply that amendment, by specifying the amendment ID in the `feature` field. For example, you might want to do this if you plan to upgrade soon to a new `rippled` version that _does_ support the amendment.
#### Response Format
### Response Format
An example of a successful response:
@@ -182,7 +182,7 @@ The response follows the [standard format](#response-formatting), with a success
**Caution:** The `name` for an amendment does not strictly indicate what that amendment does. The name is not guaranteed to be unique or consistent across servers.
#### Possible Errors
### Possible Errors
* Any of the [universal error types](#universal-errors).
* `badFeature` - The `feature` specified was invalidly formatted, or the server does not know an amendment with that name.

8
content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/fetch_info.md
View File

@@ -1,11 +1,11 @@
## fetch_info
# fetch_info
[[Source]<br>](https://github.com/ripple/rippled/blob/315a8b6b602798a4cff4d8e1911936011e12abdb/src/ripple/rpc/handlers/FetchInfo.cpp "Source")
The `fetch_info` command returns information about objects that this server is currently fetching from the network, and how many peers have that information. It can also be used to reset current fetches.
_The `fetch_info` method is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users._
#### Request Format
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
@@ -48,7 +48,7 @@ The request includes the following parameters:
|:--------|:--------|:---------------------------------------------------------|
| `clear` | Boolean | If `true`, reset current fetches. Otherwise, only get status of fetches in progress. |
#### Response Format
### Response Format
An example of a successful response:
@@ -151,6 +151,6 @@ The fields describing a fetch in progress are subject to change without notice.
| `peers` | Number | The number of peers who have this item available. |
| `timeouts` | Number | The number of times that fetching this item has resulted in a timeout (2.5 seconds). |
#### Possible Errors
### Possible Errors
* Any of the [universal error types](#universal-errors).

8
content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/get_counts.md
View File

@@ -1,11 +1,11 @@
## get_counts
# get_counts
[[Source]<br>](https://github.com/ripple/rippled/blob/c7118a183a660648aa88a3546a6b2c5bce858440/src/ripple/rpc/handlers/GetCounts.cpp "Source")
The `get_counts` command provides various stats about the health of the server, mostly the number of objects of different types that it currently holds in memory.
_The `get_counts` method is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users._
#### Request Format
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
@@ -48,7 +48,7 @@ The request includes the following parameters:
|:------------|:--------------------------|:-----------------------------------|
| `min_count` | Number (Unsigned Integer) | Only return fields with a value at least this high. |
#### Response Format
### Response Format
An example of a successful response:
@@ -142,7 +142,7 @@ The response follows the [standard format](#response-formatting). The list of fi
For most other entries, the value indicates the number of objects of that type currently in memory.
#### Possible Errors
### Possible Errors
* Any of the [universal error types](#universal-errors).
* `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing.

8
content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/peers.md
View File

@@ -1,11 +1,11 @@
## peers
# peers
[[Source]<br>](https://github.com/ripple/rippled/blob/52f298f150fc1530d201d3140c80d3eaf781cb5f/src/ripple/rpc/handlers/Peers.cpp "Source")
The `peers` command returns a list of all other `rippled` servers currently connected to this one, including information on their connection and sync status.
*The `peers` request is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users!*
#### Request Format
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
@@ -29,7 +29,7 @@ rippled peers
The request includes no additional parameters.
#### Response Format
### Response Format
An example of a successful response:
@@ -404,6 +404,6 @@ Each member of the `peers` array is a peer object with the following fields:
| `uptime` | Number | The number of seconds that your `rippled` server has been continuously connected to this peer. [New in: rippled 0.30.1][] |
| `version` | string | (May be omitted) The `rippled` version number of the peer server |
#### Possible Errors
### Possible Errors
* Any of the [universal error types](#universal-errors).

8
content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/print.md
View File

@@ -1,11 +1,11 @@
## print
# print
[[Source]<br>](https://github.com/ripple/rippled/blob/315a8b6b602798a4cff4d8e1911936011e12abdb/src/ripple/rpc/handlers/Print.cpp "Source")
The `print` command returns the current status of various internal subsystems, including peers, the ledger cleaner, and the resource manager.
*The `print` request is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users!*
#### Request Format
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
@@ -29,7 +29,7 @@ rippled print
The request includes no parameters.
#### Response Format
### Response Format
An example of a successful response:
@@ -226,6 +226,6 @@ Connecting to 127.0.0.1:5005
The response follows the [standard format](#response-formatting). Additional fields in the result depend on the internal state of the `rippled` server. The results of this command are subject to change without notice.
#### Possible Errors
### Possible Errors
* Any of the [universal error types](#universal-errors).

8
content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/validator_list_sites.md
View File

@@ -1,11 +1,11 @@
## validator_list_sites
# validator_list_sites
[[Source]<br>](https://github.com/ripple/rippled/blob/master/src/ripple/rpc/handlers/ValidatorListSites.cpp "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](#connecting-to-rippled) that cannot be run by unprivileged users!*
#### Request Format
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
@@ -41,7 +41,7 @@ rippled validator_list_sites
The request includes no parameters.
#### Response Format
### Response Format
An example of a successful response:
@@ -124,6 +124,6 @@ Each member of the `validator_sites` field array is an object with the following
| `refresh_interval_min` | Unsigned Integer | The number of minutes between refresh attempts. |
| `uri` | String | The URI of the site. |
#### Possible Errors
### Possible Errors
* Any of the [universal error types](#universal-errors).

8
content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/validators.md
View File

@@ -1,11 +1,11 @@
## validators
# validators
[[Source]<br>](https://github.com/ripple/rippled/blob/master/src/ripple/rpc/handlers/Validators.cpp "Source")
The `validators` command returns human readable information about the current list of published and trusted validators used by the server. [New in: rippled 0.80.1][]
*The `validators` request is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users!*
#### Request Format
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
@@ -41,7 +41,7 @@ rippled validators
The request includes no parameters.
#### Response Format
### Response Format
An example of a successful response:
@@ -172,6 +172,6 @@ Each member of the `publisher_lists` array is an object with the following field
| `seq` | Unsigned Integer | The sequence number of this published list. |
| `version` | Unsigned Integer | The version of the list format. |
#### Possible Errors
### Possible Errors
* Any of the [universal error types](#universal-errors).

57
dactyl-config.yml
View File

@@ -570,8 +570,9 @@ pages:
# - Server Info Methods (3)
# - Utility Methods (3)
- md: references/rippled-api/admin-rippled-methods/admin-rippled-methods.md
- name: Admin rippled Methods
html: admin-rippled-methods.html
blurb: Admin methods are meant only for trusted personnel in charge of keeping the server operational. Admin methods include commands for managing, monitoring, and debugging the server.
funnel: Docs
doc_type: References
supercategory: rippled API
@@ -583,6 +584,7 @@ pages:
- name: Key Generation Methods #TODO: possible md landing content?
html: key-generation-methods.html
blurb: Use these methods to generate and manage keys.
funnel: Docs
doc_type: References
supercategory: rippled API
@@ -594,6 +596,7 @@ pages:
- md: references/rippled-api/admin-rippled-methods/key-generation-methods/validation_create.md
html: validation_create.html
blurb: Generate keys for a new rippled validator.
funnel: Docs
doc_type: References
supercategory: rippled API
@@ -604,6 +607,7 @@ pages:
- md: references/rippled-api/admin-rippled-methods/key-generation-methods/wallet_propose.md
html: wallet_propose.html
blurb: Generate keys for a new account.
funnel: Docs
doc_type: References
supercategory: rippled API
@@ -614,6 +618,7 @@ pages:
- name: Logging and Data Management Methods
html: logging-and-data-management-methods.html
blurb: Use these methods to manage log levels and other data, such as ledgers.
funnel: Docs
doc_type: References
supercategory: rippled API
@@ -625,6 +630,7 @@ pages:
- md: references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/can_delete.md
html: can_delete.html
blurb: Allow online deletion of ledgers up to a specific ledger.
funnel: Docs
doc_type: References
supercategory: rippled API
@@ -635,6 +641,7 @@ pages:
- md: references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/ledger_cleaner.md
html: ledger_cleaner.html
blurb: Configure the ledger cleaner service to check for corrupted data.
funnel: Docs
doc_type: References
supercategory: rippled API
@@ -645,6 +652,7 @@ pages:
- md: references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/ledger_request.md
html: ledger_request.html
blurb: Query a peer server for a specific ledger version.
funnel: Docs
doc_type: References
supercategory: rippled API
@@ -655,6 +663,7 @@ pages:
- md: references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/log_level.md
html: log_level.html
blurb: Get or modify log verbosity.
funnel: Docs
doc_type: References
supercategory: rippled API
@@ -665,6 +674,7 @@ pages:
- md: references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/logrotate.md
html: logrotate.html
blurb: Reopen the log file.
funnel: Docs
doc_type: References
supercategory: rippled API
@@ -675,6 +685,7 @@ pages:
- name: Server Control Methods
html: server-and-control-methods.html
blurb: Use these methods to manage the rippled server.
funnel: Docs
doc_type: References
supercategory: rippled API
@@ -686,7 +697,8 @@ pages:
- md: references/rippled-api/admin-rippled-methods/server-control-methods/connect.md
html: connect.html
funnel: docs
blurb: Force the rippled server to connect to a specific peer.
funnel: Docs
doc_type: References
supercategory: rippled API
category: Admin rippled Methods
@@ -696,7 +708,8 @@ pages:
- md: references/rippled-api/admin-rippled-methods/server-control-methods/ledger_accept.md
html: ledger_accept.html
funnel: docs
blurb: Close and advance the ledger in stand-alone mode.
funnel: Docs
doc_type: References
supercategory:
category: Admin rippled Methods
@@ -706,7 +719,8 @@ pages:
- md: references/rippled-api/admin-rippled-methods/server-control-methods/stop.md
html: stop.html
funnel: docs
blurb: Shut down the rippled server.
funnel: Docs
doc_type: References
supercategory: rippled API
category: Admin rippled Methods
@@ -716,7 +730,8 @@ pages:
- md: references/rippled-api/admin-rippled-methods/server-control-methods/validation_seed.md
html: validation_seed.html
funnel: docs
blurb: Temporarily set key to be used for validating.
funnel: Docs
doc_type: References
supercategory: rippled API
category: Admin rippled Methods
@@ -726,6 +741,7 @@ pages:
- name: Status and Debugging Methods
html: status-and-debugging-methods.html
blurb: Use these methods to check the status of the network and server.
funnel: Docs
doc_type: References
supercategory: rippled API
@@ -738,7 +754,8 @@ pages:
- md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/consensus_info.md
html: consensus_info.html
funnel: docs
blurb: Get information about the state of consensus as it happens.
funnel: Docs
doc_type: References
supercategory: rippled API
category: Admin rippled Methods
@@ -748,7 +765,8 @@ pages:
- md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/feature.md
html: feature.html
funnel: docs
blurb: Get information about protocol amendments.
funnel: Docs
doc_type: References
supercategory: rippled API
category: Admin rippled Methods
@@ -758,7 +776,8 @@ pages:
- md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/fetch_info.md
html: fetch_info.html
funnel: docs
blurb: Get information about the server's sync with the network.
funnel: Docs
doc_type: References
supercategory: rippled API
category: Admin rippled Methods
@@ -768,7 +787,8 @@ pages:
- md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/get_counts.md
html: get_counts.html
funnel: docs
blurb: Get statistics about the server's internals and memory usage.
funnel: Docs
doc_type: References
supercategory: rippled API
category: Admin rippled Methods
@@ -778,7 +798,8 @@ pages:
- md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/peers.md
html: peers.html
funnel: docs
blurb: Get information about the peer servers connected.
funnel: Docs
doc_type: References
supercategory: rippled API
category: Admin rippled Methods
@@ -788,7 +809,8 @@ pages:
- md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/print.md
html: print.html
funnel: docs
blurb: Get information about internal subsystems.
funnel: Docs
doc_type: References
supercategory: rippled API
category: Admin rippled Methods
@@ -798,7 +820,8 @@ pages:
- md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/validator_list_sites.md
html: validator_list_sites.html
funnel: docs
blurb: Get information about sites that publish validator lists.
funnel: Docs
doc_type: References
supercategory: rippled API
category: Admin rippled Methods
@@ -808,7 +831,8 @@ pages:
- md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/validators.md
html: validators.html
funnel: docs
blurb: Get information about the current validators.
funnel: Docs
doc_type: References
supercategory: rippled API
category: Admin rippled Methods
@@ -816,13 +840,6 @@ pages:
targets:
- local
# TODO: Subcategory landings and pages for:
# - Logging and Data Management Methods (5)
# - Server Control Methods (4)
# - Status and Debugging Messages (8)
- md: references/rippled-api/ledger-data-formats/ledger-data-formats.md
html: ledger-data-formats.html
funnel: Docs