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

Migrate content syntax via script

Browse Source 
The changes in this commit were auto-generated by running

tool/migrate.sh

Following this commit, the Dactyl build no longer works but the Redocly
build (mostly) should.
This commit is contained in:
mDuo13
2024-01-31 16:09:41 -08:00
parent 96121303b2
commit 554a3732d4
898 changed files with 19879 additions and 18631 deletions
Download Patch File Download Diff File Expand all files Collapse all files

76
content/references/http-websocket-apis/admin-api-methods/index.md
View File

@@ -9,69 +9,69 @@ labels:
Administer a `rippled` server using these admin API methods. 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.
Admin commands are available only if you connect to `rippled` on a host and port that the `rippled.cfg` file identifies as admin. By default, the commandline client uses an admin connection. For more information on connecting to `rippled`, see [Getting Started with the `rippled` API](get-started-using-http-websocket-apis.html).
Admin commands are available only if you connect to `rippled` on a host and port that the `rippled.cfg` file identifies as admin. By default, the commandline client uses an admin connection. For more information on connecting to `rippled`, see [Getting Started with the `rippled` API](../../../tutorials/get-started/get-started-using-http-websocket-apis.md).
## [Key Generation Methods](key-generation-methods.html)
## [Key Generation Methods](key-generation-methods/index.md)
Use these methods to generate and manage keys.
* **[`validation_create`](validation_create.html)** - Generate formatted for `rippled` node key pair. (Validators should use [tokens](run-rippled-as-a-validator.html) instead of keys generated by this method.)
* **[`wallet_propose`](wallet_propose.html)** - Generate keys for a new account.
* **[`validation_create`](key-generation-methods/validation_create.md)** - Generate formatted for `rippled` node key pair. (Validators should use [tokens](../../../infrastructure/configuration/server-modes/run-rippled-as-a-validator.md) instead of keys generated by this method.)
* **[`wallet_propose`](key-generation-methods/wallet_propose.md)** - Generate keys for a new account.
## [Logging and Data Management Methods](logging-and-data-management-methods.html)
## [Logging and Data Management Methods](logging-and-data-management-methods/index.md)
Use these methods to manage log levels and other data, such as ledgers.
* **[`can_delete`](can_delete.html)** - Allow online deletion of ledgers up to a specific ledger.
* **[`download_shard`](download_shard.html)** - Download a specific shard of ledger history.
* **[`ledger_cleaner`](ledger_cleaner.html)** - Configure the ledger cleaner service to check for corrupted data.
* **[`ledger_request`](ledger_request.html)** - Query a peer server for a specific ledger version.
* **[`log_level`](log_level.html)** - Get or modify log verbosity.
* **[`logrotate`](logrotate.html)** - Reopen the log file.
* **[`node_to_shard`](node_to_shard.html)** - Copy data from the ledger store to the shard store.
* **[`can_delete`](logging-and-data-management-methods/can_delete.md)** - Allow online deletion of ledgers up to a specific ledger.
* **[`download_shard`](logging-and-data-management-methods/download_shard.md)** - Download a specific shard of ledger history.
* **[`ledger_cleaner`](logging-and-data-management-methods/ledger_cleaner.md)** - Configure the ledger cleaner service to check for corrupted data.
* **[`ledger_request`](logging-and-data-management-methods/ledger_request.md)** - Query a peer server for a specific ledger version.
* **[`log_level`](logging-and-data-management-methods/log_level.md)** - Get or modify log verbosity.
* **[`logrotate`](logging-and-data-management-methods/logrotate.md)** - Reopen the log file.
* **[`node_to_shard`](logging-and-data-management-methods/node_to_shard.md)** - Copy data from the ledger store to the shard store.
## [Server Control Methods](server-control-methods.html)
## [Server Control Methods](server-control-methods/index.md)
Use these methods to manage the `rippled` server.
* **[`ledger_accept`](ledger_accept.html)** - Close and advance the ledger in stand-alone mode.
* **[`stop`](stop.html)** - Shut down the `rippled` server.
* **[`ledger_accept`](server-control-methods/ledger_accept.md)** - Close and advance the ledger in stand-alone mode.
* **[`stop`](server-control-methods/stop.md)** - Shut down the `rippled` server.
## [Signing Methods](signing-methods.html)
## [Signing Methods](signing-methods/index.md)
Use these methods to sign transactions.
* **[`sign`](sign.html)** - Cryptographically sign a transaction.
* **[`sign_for`](sign_for.html)** - Contribute to a multi-signature.
* **[`sign`](signing-methods/sign.md)** - Cryptographically sign a transaction.
* **[`sign_for`](signing-methods/sign_for.md)** - Contribute to a multi-signature.
By default, these methods are [admin-only](get-started-using-http-websocket-apis.html#admin-access). They can be used as public methods if the server admin has [enabled public signing](enable-public-signing.html).
By default, these methods are [admin-only](../../../tutorials/get-started/get-started-using-http-websocket-apis.md#admin-access). They can be used as public methods if the server admin has [enabled public signing](../../../infrastructure/configuration/enable-public-signing.md).
## [Peer Management Methods](peer-management-methods.html)
## [Peer Management Methods](peer-management-methods/index.md)
Use these methods to manage the server's connections in the peer-to-peer XRP Ledger network.
* **[`connect`](connect.html)** - Force the `rippled` server to connect to a specific peer.
* **[`peer_reservations_add`](peer_reservations_add.html)** - Add or update a reserved slot for a specific peer.
* **[`peer_reservations_del`](peer_reservations_del.html)** - Remove a reserved slot for a specific peer.
* **[`peer_reservations_list`](peer_reservations_list.html)** - List reserved slots for specific peers.
* **[`peers`](peers.html)** - Get information about the peer servers connected.
* **[`connect`](peer-management-methods/connect.md)** - Force the `rippled` server to connect to a specific peer.
* **[`peer_reservations_add`](peer-management-methods/peer_reservations_add.md)** - Add or update a reserved slot for a specific peer.
* **[`peer_reservations_del`](peer-management-methods/peer_reservations_del.md)** - Remove a reserved slot for a specific peer.
* **[`peer_reservations_list`](peer-management-methods/peer_reservations_list.md)** - List reserved slots for specific peers.
* **[`peers`](peer-management-methods/peers.md)** - Get information about the peer servers connected.
## [Status and Debugging Methods](status-and-debugging-methods.html)
## [Status and Debugging Methods](status-and-debugging-methods/index.md)
Use these methods to check the status of the network and server.
* **[`consensus_info`](consensus_info.html)** - Get information about the state of consensus as it happens.
* **[`feature`](feature.html)** - Get information about protocol amendments.
* **[`fetch_info`](fetch_info.html)** - Get information about the server's sync with the network.
* **[`get_counts`](get_counts.html)** - Get statistics about the server's internals and memory usage.
* **[`manifest`](manifest.html)** - Get the latest public key information about a known validator.
* **[`print`](print.html)** - Get information about internal subsystems.
* **[`validator_info`](validator_info.html)** - Get information about the server's validator settings, if configured as a validator.
* **[`validator_list_sites`](validator_list_sites.html)** - Get information about sites that publish validator lists.
* **[`validators`](validators.html)** - Get information about the current validators.
* **[`consensus_info`](status-and-debugging-methods/consensus_info.md)** - Get information about the state of consensus as it happens.
* **[`feature`](status-and-debugging-methods/feature.md)** - Get information about protocol amendments.
* **[`fetch_info`](status-and-debugging-methods/fetch_info.md)** - Get information about the server's sync with the network.
* **[`get_counts`](status-and-debugging-methods/get_counts.md)** - Get statistics about the server's internals and memory usage.
* **[`manifest`](../public-api-methods/server-info-methods/manifest.md)** - Get the latest public key information about a known validator.
* **[`print`](status-and-debugging-methods/print.md)** - Get information about internal subsystems.
* **[`validator_info`](status-and-debugging-methods/validator_info.md)** - Get information about the server's validator settings, if configured as a validator.
* **[`validator_list_sites`](status-and-debugging-methods/validator_list_sites.md)** - Get information about sites that publish validator lists.
* **[`validators`](status-and-debugging-methods/validators.md)** - Get information about the current validators.
## Deprecated Methods
@@ -84,8 +84,4 @@ The following admin commands are deprecated and may be removed without further n
The [validation_seed method][] has been removed since `rippled` v0.29.1.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}