Files
xrpl-dev-portal/docs/references/http-websocket-apis/public-api-methods/utility-methods/json.md
mDuo13 7645140477 Re-levelization: move non-docs content, rename content→docs
For better URLs, the content folder has been renamed 'docs' and all
other files have been moved up a level. Also, non-docs images have been
moved to the static folder at the top level where they belong.

Many relative paths had to be fixed to make this work.
2024-01-31 17:53:52 -08:00

1.1 KiB

html, parent, seo, labels
html parent seo labels
json.html utility-methods.html
description
Pass JSON through the commandline.
Core Server

json

The json method is a proxy to running other commands, and accepts the parameters for the command as a JSON value. It is exclusive to the Commandline client, and intended for cases where the commandline syntax for specifying parameters is inadequate or undesirable.

Request Format

An example of the request format:

{% tabs %}

{% tab label="Commandline" %}

# Syntax: json method json_stanza
rippled -q json ledger_closed '{}'

{% /tab %}

{% /tabs %}

Response Format

An example of a successful response:

{% tabs %}

{% tab label="WebSocket" %}

{
   "result" : {
      "ledger_hash" : "8047C3ECF1FA66326C1E57694F6814A1C32867C04D3D68A851367EE2F89BBEF3",
      "ledger_index" : 390308,
      "status" : "success"
   }
}

{% /tab %}

{% /tabs %}

The response follows the [standard format][], with whichever fields are appropriate to the type of command made.

{% raw-partial file="/docs/_snippets/common-links.md" /%}