xrpl-dev-portal/content/references/http-websocket-apis/admin-api-methods/template-admin-method.md

html, parent, blurb, labels

html	parent	blurb	labels
TODO_PAGE_NAME.html	TODO_CATEGORY_FILENAME.html	TODO BLURB

TODO_method_name

[Source]

The {{currentpage.name}} method TODO_description.

The {{currentpage.name}} method is an admin method that cannot be run by unprivileged users.

Request Format

An example of the request format:

WebSocket

{
    TODO
}

JSON-RPC

{
    "method": "{{currentpage.name}}",
    "params": [{
        TODO
    }]
}

Commandline

#Syntax: {{currentpage.name}} TODO
rippled {{currentpage.name}}

The request includes the following parameters:

Field	Type	Description
TODO_request_params

Response Format

An example of a successful response:

WebSocket

{
    TODO
}

JSON-RPC

{
  TODO
}

Commandline

Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005

{
  TODO
}

The response follows the [standard format][], with a successful result containing the following fields:

Field	Type	Description
TODO_response_params

Possible Errors

• Any of the [universal error types][].
• TODO_errors
• invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.

{% include '_snippets/rippled-api-links.md' %} {% include '_snippets/tx-type-links.md' %} {% include '_snippets/rippled_versions.md' %}