Skip to content

Commit e3ee7bf

Browse files
mDuo13mDuo13
committed
Update source links in admin api refs & elsewhere
1 parent d278881 commit e3ee7bf

File tree

28 files changed

+755
-813
lines changed

28 files changed

+755
-813
lines changed

‎docs/references/http-websocket-apis/admin-api-methods/key-generation-methods/validation_create.md‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,20 @@
11
---
2-
html: validation_create.html
3-
parent: key-generation-methods.html
42
seo:
53
description: Generate keys for a rippled server to identify itself to the network.
64
labels:
7-
- Security
8-
- Core Server
5+
- Security
6+
- Core Server
97
---
108
# validation_create
11-
[[Source]](https://github.com/XRPLF/rippled/blob/315a8b6b602798a4cff4d8e1911936011e12abdb/src/ripple/rpc/handlers/ValidationCreate.cpp "Source")
9+
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/ValidationCreate.cpp "Source")
1210

1311
Use the `validation_create` command to generate [cryptographic keys a `rippled` server can use to identify itself to the network](../../../../concepts/networks-and-servers/peer-protocol.md#node-key-pair). Similar to the [wallet_propose method][], this method only generates a set of keys in the proper format. It does not any makes changes to the XRP Ledger data or server configuration.
1412

1513
_The `validation_create` method is an [admin method](../index.md) that cannot be run by unprivileged users._
1614

1715
You can configure your server to use the generated key pair to sign validations (validation key pair) or regular peer-to-peer communications ([node key pair](../../../../concepts/networks-and-servers/peer-protocol.md#node-key-pair)).
1816

19-
{% admonition type="success" name="Tip" %}For configuring a robust validator, you should use the `validator-keys` tool (included in the `rippled` RPM) to generate validator tokens (which can be rotated) with an offline master key. For more information, see [Validator Setup](../../../../infrastructure/configuration/server-modes/run-rippled-as-a-validator.md#3-enable-validation-on-your-rippled-server).{% /admonition %}
17+
{% admonition type="success" name="Tip" %}For configuring a robust validator, you should use the `validator-keys` tool (included in the `rippled` package build) to generate validator tokens (which can be rotated) with an offline master key. For more information, see [Validator Setup](../../../../infrastructure/configuration/server-modes/run-rippled-as-a-validator.md#3-enable-validation-on-your-rippled-server).{% /admonition %}
2018

2119

2220
### Request Format

‎docs/references/http-websocket-apis/admin-api-methods/key-generation-methods/wallet_propose.md‎

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,17 @@
11
---
2-
html: wallet_propose.html
3-
parent: key-generation-methods.html
42
seo:
53
description: Generate keys for a new account.
64
labels:
7-
- Security
8-
- Accounts
5+
- Security
6+
- Accounts
97
---
108
# wallet_propose
11-
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/WalletPropose.cpp "Source")
9+
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/WalletPropose.cpp "Source")
1210

13-
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](../../../../concepts/accounts/index.md#creating-accounts) that provides enough XRP to meet the [reserve requirement](../../../../concepts/accounts/reserves.md).
11+
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 account in the ledger, the address must [receive a Payment transaction](../../../../concepts/accounts/index.md#creating-accounts) that provides enough XRP to meet the [reserve requirement](../../../../concepts/accounts/reserves.md).
1412

1513
*The `wallet_propose` method is an [admin method](../index.md) that cannot be run by unprivileged users!* (This command is restricted to protect against people sniffing network traffic for account secrets, since admin commands are not usually transmitted over the outside network.)
1614

17-
{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.31.0" %}Updated in: rippled 0.31.0{% /badge %}
18-
1915
### Request Format
2016

2117
An example of the request format:

‎docs/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/can_delete.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
---
2-
html: can_delete.html
3-
parent: logging-and-data-management-methods.html
42
seo:
53
description: Allow online deletion of ledgers up to a specific ledger.
64
labels:
7-
- Data Retention
5+
- Data Retention
86
---
97
# can_delete
10-
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/CanDelete.cpp "Source")
8+
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/CanDelete.cpp "Source")
119

1210
The `can_delete` method informs the `rippled` server of the latest ledger version which may be deleted when using [online deletion with advisory deletion enabled](../../../../infrastructure/configuration/data-retention/online-deletion.md#advisory-deletion). If advisory deletion is not enabled, this method does nothing.
1311

‎docs/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/ledger_cleaner.md‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
---
2-
html: ledger_cleaner.html
3-
parent: logging-and-data-management-methods.html
42
seo:
53
description: Configure the ledger cleaner service to check for corrupted data.
64
labels:
7-
- Data Retention
5+
- Data Retention
86
---
97
# ledger_cleaner
10-
[[Source]](https://github.com/XRPLF/rippled/blob/df54b47cd0957a31837493cd69e4d9aade0b5055/src/ripple/rpc/handlers/LedgerCleaner.cpp "Source")
8+
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/LedgerCleanerHandler.cpp "Source")
119

12-
The `ledger_cleaner` command controls the [Ledger Cleaner](https://github.com/XRPLF/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.
10+
The `ledger_cleaner` command controls the [Ledger Cleaner](https://github.com/XRPLF/rippled/tree/master/src/xrpld/app/ledger#the-ledger-cleaner), an asynchronous maintenance process that can find and repair corruption in `rippled`'s database of ledgers.
1311

1412
_The `ledger_cleaner` method is an [admin method](../index.md) that cannot be run by unprivileged users._
1513

‎docs/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/ledger_request.md‎

Lines changed: 61 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
---
2-
html: ledger_request.html
3-
parent: logging-and-data-management-methods.html
42
seo:
53
description: Query peer servers for a specific ledger version.
64
labels:
7-
- Data Retention
5+
- Data Retention
86
---
97
# ledger_request
10-
[[Source]](https://github.com/XRPLF/rippled/blob/e980e69eca9ea843d200773eb1f43abe3848f1a0/src/ripple/rpc/handlers/LedgerRequest.cpp "Source")
8+
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/LedgerRequest.cpp "Source")
119

1210
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.
1311

@@ -61,7 +59,7 @@ Loading: "/etc/rippled.cfg"
6159
Connecting to 127.0.0.1:5005
6260

6361
{
64-
"result" : {
62+
"result" : {
6563
"acquiring" : {
6664
"hash" : "01DDD89B6605E20338B8EEB8EB2B0E0DD2F685A2B164F3790C4D634B5734CC26",
6765
"have_header" : false,
@@ -76,7 +74,7 @@ Connecting to 127.0.0.1:5005
7674
"ledger_index" : 18851277
7775
},
7876
"status" : "error"
79-
}
77+
}
8078
}
8179
```
8280
{% /tab %}
@@ -87,43 +85,43 @@ Loading: "/etc/rippled.cfg"
8785
Connecting to 127.0.0.1:5005
8886

8987
{
90-
"result" : {
91-
"hash" : "EB68B5B4F6F06BF59B6D7532BCB98BB98E2F10C2435D895217AA0AA7E910FBD5",
92-
"have_header" : true,
93-
"have_state" : false,
94-
"have_transactions" : false,
95-
"needed_state_hashes" : [
96-
"C46F7B9E795135447AF24BAF999AB8FC1612A997F6EAAF8B784C226FF0BD8E25",
97-
"E48F528E4FC2A1DC492C6264B27B420E2285B2A3ECF3A253DB480DA5BFB7F858",
98-
"B62CD0B2E1277F78BC279FA037F3F747587299B60D23A551C3F63DD137DC0CF8",
99-
"30014C55701FB8426E496A47B297BEC9E8F5BFA47763CC22DBD9024CC81D39DD",
100-
"7EB59A853913898FCEA7B701637F33B1054BD36C32A0B910B612EFB9CDFF6334",
101-
"07ECAD3066D62583883979A2FADAADC8F7D89FA07375843C8A47452639AB2421",
102-
"97A87E5246AF78463485CB27E08D561E22AAF33D5E2F08FE2FACAE0D05CB5478",
103-
"50A0525E238629B32324C9F59B4ECBEFE3C21DC726DB9AB3B6758BD1838DFF68",
104-
"8C541B1ED47C9282E2A28F0B7F3DDFADF06644CAB71B15A3E67D04C5FAFE9BF4",
105-
"2C6CC536C778D8C0F601E35DA7DD9888C288897E4F603E76357CE2F47E8A7A9F",
106-
"309E78DEC67D5725476A59E114850556CC693FB6D92092997ADE97E3EFF473CC",
107-
"8EFF61B6A636AF6B4314CAC0C08F4FED0759E1F782178A822EDE98275E5E4B10",
108-
"9535645E5D249AC0B6126005B79BB981CBA00286E00154D20A3BCF65743EA3CA",
109-
"69F5D6FCB41D1E6CEA5ADD42CBD194086B45E957D497DF7AEE62ADAD485660CE",
110-
"07E93A95DBB0B8A00925DE0DF6D27E41CACC77EF75055A89815006109D82EAD3",
111-
"7FDF25F660235DCAD649676E3E6729DF920A9B0B4B6A3B090A3C64D7BDE2FB20"
112-
],
113-
"needed_transaction_hashes" : [
114-
"BA914854F2F5EDFCBD6E3E0B168E5D4CD0FC92927BEE408C6BD38D4F52505A34",
115-
"AE3A2DB537B01EB33BB3A677242DE52C9AE0A64BD9222EE55E52855276E7EA2A",
116-
"E145F737B255D93769673CBA6DEBA4F6AC7387A309DAACC72EA5B07ECF03C215",
117-
"073A118552AA60E1D3C6BE6F65E4AFA01C582D9C41CCC2887244C19D9BFA7741",
118-
"562DB8580CD3FE19AF5CEA61C2858C10091151B924DBF2AEB7CBB8722E683204",
119-
"437C0D1C2391057079E9539CF028823D29E6437A965284F6E54CEBF1D25C5D56",
120-
"1F069486AF5533883609E5C8DB907E97273D9A782DF26F5E5811F1C42ED63A3D",
121-
"CAA6B7DA68EBA71254C218C81A9EA029A179694BDD0D75A49FB03A7D57BCEE49"
122-
],
123-
"peers" : 6,
124-
"status" : "success",
125-
"timeouts" : 1
126-
}
88+
"result" : {
89+
"hash" : "EB68B5B4F6F06BF59B6D7532BCB98BB98E2F10C2435D895217AA0AA7E910FBD5",
90+
"have_header" : true,
91+
"have_state" : false,
92+
"have_transactions" : false,
93+
"needed_state_hashes" : [
94+
"C46F7B9E795135447AF24BAF999AB8FC1612A997F6EAAF8B784C226FF0BD8E25",
95+
"E48F528E4FC2A1DC492C6264B27B420E2285B2A3ECF3A253DB480DA5BFB7F858",
96+
"B62CD0B2E1277F78BC279FA037F3F747587299B60D23A551C3F63DD137DC0CF8",
97+
"30014C55701FB8426E496A47B297BEC9E8F5BFA47763CC22DBD9024CC81D39DD",
98+
"7EB59A853913898FCEA7B701637F33B1054BD36C32A0B910B612EFB9CDFF6334",
99+
"07ECAD3066D62583883979A2FADAADC8F7D89FA07375843C8A47452639AB2421",
100+
"97A87E5246AF78463485CB27E08D561E22AAF33D5E2F08FE2FACAE0D05CB5478",
101+
"50A0525E238629B32324C9F59B4ECBEFE3C21DC726DB9AB3B6758BD1838DFF68",
102+
"8C541B1ED47C9282E2A28F0B7F3DDFADF06644CAB71B15A3E67D04C5FAFE9BF4",
103+
"2C6CC536C778D8C0F601E35DA7DD9888C288897E4F603E76357CE2F47E8A7A9F",
104+
"309E78DEC67D5725476A59E114850556CC693FB6D92092997ADE97E3EFF473CC",
105+
"8EFF61B6A636AF6B4314CAC0C08F4FED0759E1F782178A822EDE98275E5E4B10",
106+
"9535645E5D249AC0B6126005B79BB981CBA00286E00154D20A3BCF65743EA3CA",
107+
"69F5D6FCB41D1E6CEA5ADD42CBD194086B45E957D497DF7AEE62ADAD485660CE",
108+
"07E93A95DBB0B8A00925DE0DF6D27E41CACC77EF75055A89815006109D82EAD3",
109+
"7FDF25F660235DCAD649676E3E6729DF920A9B0B4B6A3B090A3C64D7BDE2FB20"
110+
],
111+
"needed_transaction_hashes" : [
112+
"BA914854F2F5EDFCBD6E3E0B168E5D4CD0FC92927BEE408C6BD38D4F52505A34",
113+
"AE3A2DB537B01EB33BB3A677242DE52C9AE0A64BD9222EE55E52855276E7EA2A",
114+
"E145F737B255D93769673CBA6DEBA4F6AC7387A309DAACC72EA5B07ECF03C215",
115+
"073A118552AA60E1D3C6BE6F65E4AFA01C582D9C41CCC2887244C19D9BFA7741",
116+
"562DB8580CD3FE19AF5CEA61C2858C10091151B924DBF2AEB7CBB8722E683204",
117+
"437C0D1C2391057079E9539CF028823D29E6437A965284F6E54CEBF1D25C5D56",
118+
"1F069486AF5533883609E5C8DB907E97273D9A782DF26F5E5811F1C42ED63A3D",
119+
"CAA6B7DA68EBA71254C218C81A9EA029A179694BDD0D75A49FB03A7D57BCEE49"
120+
],
121+
"peers" : 6,
122+
"status" : "success",
123+
"timeouts" : 1
124+
}
127125
}
128126
```
129127
{% /tab %}
@@ -134,26 +132,26 @@ Loading: "/etc/rippled.cfg"
134132
Connecting to 127.0.0.1:5005
135133

136134
{
137-
"result" : {
138-
"ledger" : {
139-
"accepted" : true,
140-
"account_hash" : "84EBB27D9510AD5B9A3A328201921B3FD418D4A349E85D3DC69E33C7B506407F",
141-
"close_time" : 486691300,
142-
"close_time_human" : "2015-Jun-04 00:01:40",
143-
"close_time_resolution" : 10,
144-
"closed" : true,
145-
"hash" : "DCF5D723ECEE1EF56D2B0024CD9BDFF2D8E3DC211BD2B9460165922564ACD863",
146-
"ledger_hash" : "DCF5D723ECEE1EF56D2B0024CD9BDFF2D8E3DC211BD2B9460165922564ACD863",
147-
"ledger_index" : "13840000",
148-
"parent_hash" : "8A3F6FBC62C11DE4538D969F9C7966234635FE6CEB1133DDC37220978F8100A9",
149-
"seqNum" : "13840000",
150-
"totalCoins" : "99999022883526403",
151-
"total_coins" : "99999022883526403",
152-
"transaction_hash" : "3D759EF3AF1AE2F78716A8CCB2460C3030F82687E54206E883703372B9E1770C"
153-
},
154-
"ledger_index" : 13840000,
155-
"status" : "success"
156-
}
135+
"result" : {
136+
"ledger" : {
137+
"accepted" : true,
138+
"account_hash" : "84EBB27D9510AD5B9A3A328201921B3FD418D4A349E85D3DC69E33C7B506407F",
139+
"close_time" : 486691300,
140+
"close_time_human" : "2015-Jun-04 00:01:40",
141+
"close_time_resolution" : 10,
142+
"closed" : true,
143+
"hash" : "DCF5D723ECEE1EF56D2B0024CD9BDFF2D8E3DC211BD2B9460165922564ACD863",
144+
"ledger_hash" : "DCF5D723ECEE1EF56D2B0024CD9BDFF2D8E3DC211BD2B9460165922564ACD863",
145+
"ledger_index" : "13840000",
146+
"parent_hash" : "8A3F6FBC62C11DE4538D969F9C7966234635FE6CEB1133DDC37220978F8100A9",
147+
"seqNum" : "13840000",
148+
"totalCoins" : "99999022883526403",
149+
"total_coins" : "99999022883526403",
150+
"transaction_hash" : "3D759EF3AF1AE2F78716A8CCB2460C3030F82687E54206E883703372B9E1770C"
151+
},
152+
"ledger_index" : 13840000,
153+
"status" : "success"
154+
}
157155
}
158156

159157
```

‎docs/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/log_level.md‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
---
2-
html: log_level.html
3-
parent: logging-and-data-management-methods.html
42
seo:
5-
description: Get or modify log verbosity.
3+
description: Get or modify log verbosity.
64
labels:
7-
- Data Retention
5+
- Data Retention
86
---
97
# log_level
10-
[[Source]](https://github.com/XRPLF/rippled/blob/155fcdbcd0b4927152892c8c8be01d9cf62bed68/src/ripple/rpc/handlers/LogLevel.cpp "Source")
8+
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/LogLevel.cpp "Source")
119

1210
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.
1311

@@ -21,10 +19,10 @@ An example of the request format:
2119
{% tab label="WebSocket" %}
2220
```json
2321
{
24-
"id": "ll1",
25-
"command": "log_level",
26-
"severity": "debug",
27-
"partition": "PathRequest"
22+
"id": "ll1",
23+
"command": "log_level",
24+
"severity": "debug",
25+
"partition": "PathRequest"
2826
}
2927
```
3028
{% /tab %}

‎docs/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/logrotate.md‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
---
2-
html: logrotate.html
3-
parent: logging-and-data-management-methods.html
42
seo:
5-
description: Reopen the log file.
3+
description: Reopen the log file.
64
labels:
7-
- Data Retention
5+
- Data Retention
86
---
97
# logrotate
10-
[[Source]](https://github.com/XRPLF/rippled/blob/743bd6c9175c472814448ea889413be79dfd1c07/src/ripple/rpc/handlers/LogRotate.cpp "Source")
8+
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/LogRotate.cpp "Source")
119

1210
The `logrotate` command closes and reopens the log file. This is intended to help with log rotation on Linux file systems.
1311

@@ -49,8 +47,8 @@ An example of the request format:
4947
{% tab label="WebSocket" %}
5048
```json
5149
{
52-
"id": "lr1",
53-
"command": "logrotate"
50+
"id": "lr1",
51+
"command": "logrotate"
5452
}
5553
```
5654
{% /tab %}

‎docs/references/http-websocket-apis/admin-api-methods/peer-management-methods/connect.md‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
---
2-
html: connect.html
3-
parent: peer-management-methods.html
42
seo:
53
description: Force the rippled server to connect to a specific peer.
64
labels:
7-
- Core Server
5+
- Core Server
86
---
97
# connect
10-
[[Source]](https://github.com/XRPLF/rippled/blob/a61ffab3f9010d8accfaa98aa3cacc7d38e74121/src/ripple/rpc/handlers/Connect.cpp "Source")
8+
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/Connect.cpp "Source")
119

12-
The `connect` command forces the `rippled` server to connect to a specific peer `rippled` server.
10+
The `connect` command forces the `rippled` server to connect to a specific peer server.
1311

1412
*The `connect` method is an [admin method](../index.md) that cannot be run by unprivileged users!*
1513

‎docs/references/http-websocket-apis/admin-api-methods/peer-management-methods/peer_reservations_add.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
---
2-
html: peer_reservations_add.html
3-
parent: peer-management-methods.html
42
seo:
53
description: Add a reserved slot for a specific peer server.
64
labels:
7-
- Core Server
5+
- Core Server
86
---
97
# peer_reservations_add
10-
[[Source]](https://github.com/XRPLF/rippled/blob/4a1148eb2849513dd1e7ae080288fd47ab57a376/src/ripple/rpc/handlers/Reservations.cpp#L36 "Source")
8+
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/Reservations.cpp "Source")
119

1210
The {% code-page-name /%} method adds or updates a reserved slot for a specific peer server in the XRP Ledger [peer-to-peer network](../../../../concepts/networks-and-servers/peer-protocol.md).
1311

0 commit comments

Comments
 (0)