mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-20 19:55:54 +00:00
Reorg - redo admin methods landing page w/ deprecated methods
This commit is contained in:
@@ -5,16 +5,38 @@ Communicate directly with 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.
|
||||
<!--{# TODO: add a link to a doc that specifically talks about how to set this config setting #}-->
|
||||
|
||||
* **[Key Generation Methods](key-generation-methods.html)**
|
||||
<!--{# TODO: provide overview text of what this method type is all about #}-->
|
||||
## List of Admin Methods
|
||||
|
||||
* **[Logging and Data Management Methods](logging-and-data-management-methods.html)**
|
||||
<!--{# TODO: provide overview text of what this method type is all about #}-->
|
||||
* [`can_delete` - Allow online deletion of ledgers up to a specific ledger](can_delete.html)
|
||||
* [`connect` - Force the rippled server to connect to a specific peer](connect.html)
|
||||
* [`consensus_info` - Get information about the state of consensus as it happens](consensus_info.html)
|
||||
* [`feature` - Get information about protocol amendments](feature.html)
|
||||
* [`fetch_info` - Get information about the server's sync with the network](fetch_info.html)
|
||||
* [`get_counts` - Get statistics about the server's internals and memory usage](get_counts.html)
|
||||
* [`ledger_accept` - Close and advance the ledger in stand-alone mode](ledger_accept.html)
|
||||
* [`ledger_cleaner` - Configure the ledger cleaner service to check for corrupted data](ledger_cleaner.html)
|
||||
* [`ledger_request` - Query a peer server for a specific ledger version](ledger_request.html)
|
||||
* [`log_level` - Get or modify log verbosity](log_level.html)
|
||||
* [`logrotate` - Reopen the log file](logrotate.html)
|
||||
* [`peers` - Get information about the peer servers connected](peers.html)
|
||||
* [`print` - Get information about internal subsystems](print.html)
|
||||
* [`stop` - Shut down the rippled server](stop.html)
|
||||
* [`validation_create` - Generate keys for a new rippled validator](validation_create.html)
|
||||
* [`validation_seed` - Temporarily set key to be used for validating](validation_seed.html)
|
||||
* [`validators` - Get information about the current validators](validators.html)
|
||||
* [`validator_list_sites` - Get information about sites that publish validator lists](validator_list_sites.html)
|
||||
* [`wallet_propose` - Generate keys for a new account](wallet_propose.html)
|
||||
|
||||
* **[Server Control Methods](server-and-control-methods.html)**
|
||||
<!--{# TODO: provide overview text of what this method type is all about #}-->
|
||||
## Deprecated Methods
|
||||
|
||||
* **[Status and Debugging Methods](status-and-debugging-methods.html)**
|
||||
<!--{# TODO: provide overview text of what this method type is all about #}-->
|
||||
The following admin commands are deprecated and may be removed without further notice:
|
||||
|
||||
* `ledger_header` - Use the [ledger method][] instead.
|
||||
* `unl_add`, `unl_delete`, `unl_list`, `unl_load`, `unl_network`, `unl_reset`, `unl_score` - Use the configuration file for UNL management instead.
|
||||
* `wallet_seed` - Use the [wallet_propose method][] instead.
|
||||
|
||||
<!--{# common link defs #}-->
|
||||
{% include '_snippets/rippled-api-links.md' %}
|
||||
{% include '_snippets/tx-type-links.md' %}
|
||||
{% include '_snippets/rippled_versions.md' %}
|
||||
|
||||
@@ -556,35 +556,6 @@ API methods for the Websocket and JSON-RPC APIs are defined by command names, an
|
||||
|
||||
The `owner_info` command is deprecated. Use [`account_objects`](#account-objects) instead.
|
||||
|
||||
## List of Admin Commands
|
||||
|
||||
Admin commands are only available if you [connect to `rippled`](#connecting-to-rippled) on a host and port that the config file identifies as admin. (By default, the commandline client uses an admin connection.)
|
||||
|
||||
* [`can_delete` - Allow online deletion of ledgers up to a specific ledger](#can-delete)
|
||||
* [`connect` - Force the rippled server to connect to a specific peer](#connect)
|
||||
* [`consensus_info` - Get information about the state of consensus as it happens](#consensus-info)
|
||||
* [`feature` - Get information about protocol amendments](#feature)
|
||||
* [`fetch_info` - Get information about the server's sync with the network](#fetch-info)
|
||||
* [`get_counts` - Get statistics about the server's internals and memory usage](#get-counts)
|
||||
* [`ledger_accept` - Close and advance the ledger in stand-alone mode](#ledger-accept)
|
||||
* [`ledger_cleaner` - Configure the ledger cleaner service to check for corrupted data](#ledger-cleaner)
|
||||
* [`ledger_request` - Query a peer server for a specific ledger version](#ledger-request)
|
||||
* [`log_level` - Get or modify log verbosity](#log-level)
|
||||
* [`logrotate` - Reopen the log file](#logrotate)
|
||||
* [`peers` - Get information about the peer servers connected](#peers)
|
||||
* [`print` - Get information about internal subsystems](#print)
|
||||
* [`stop` - Shut down the rippled server](#stop)
|
||||
* [`validation_create` - Generate keys for a new rippled validator](#validation-create)
|
||||
* [`validation_seed` - Temporarily set key to be used for validating](#validation-seed)
|
||||
* [`validators` - Get information about the current validators](#validators)
|
||||
* [`validator_list_sites` - Get information about sites that publish validator lists](#validator-list-sites)
|
||||
* [`wallet_propose` - Generate keys for a new account](#wallet-propose)
|
||||
|
||||
The following admin commands are deprecated and may be removed without further notice:
|
||||
|
||||
* `ledger_header` - Use the [`ledger` command](#ledger) instead.
|
||||
* `unl_add`, `unl_delete`, `unl_list`, `unl_load`, `unl_network`, `unl_reset`, `unl_score` - Use the configuration file for UNL management instead.
|
||||
* `wallet_seed` - Use [`wallet_propose`](#wallet-propose) instead.
|
||||
|
||||
|
||||
## Commandline Access
|
||||
|
||||
@@ -570,7 +570,7 @@ pages:
|
||||
# - Server Info Methods (3)
|
||||
# - Utility Methods (3)
|
||||
|
||||
- name: Admin rippled Methods
|
||||
- md: references/rippled-api/admin-rippled-methods/admin-rippled-methods.md
|
||||
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
|
||||
@@ -582,7 +582,7 @@ pages:
|
||||
targets:
|
||||
- local
|
||||
|
||||
- name: Key Generation Methods #TODO: possible md landing content?
|
||||
- name: Key Generation Methods
|
||||
html: key-generation-methods.html
|
||||
blurb: Use these methods to generate and manage keys.
|
||||
funnel: Docs
|
||||
|
||||
Reference in New Issue
Block a user