mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-06 12:55:50 +00:00
2.1 KiB
2.1 KiB
seo, labels
| seo | labels | |||
|---|---|---|---|---|
|
|
version
The version command retrieves the API version information for the rippled server. For Clio servers, see version (clio) instead.
Request Format
An example of the request format:
{% tabs %}
{% tab label="WebSocket" %}
{
"command": "version"
}
{% /tab %}
{% tab label="JSON-RPC" %}
{
"method": "version",
"params": [
{}
]
}
{% /tab %}
{% tab label="Commandline" %}
#Syntax: version
rippled version
{% /tab %}
{% /tabs %}
The request does not takes any parameters.
Response Format
An example of a successful response:
{% tabs %}
{% tab label="WebSocket" %}
{
"result": {
"version": {
"first": "1.0.0",
"good": "1.0.0",
"last": "1.0.0"
}
},
"status": "success",
"type": "response"
}
{% /tab %}
{% tab label="JSON-RPC" %}
200 OK
Headers
{
"result": {
"version": {
"first": "1.0.0",
"good": "1.0.0",
"last": "1.0.0"
}
},
"status": "success",
"type": "response"
}
{% /tab %}
{% tab label="Commandline" %}
{
"result": {
"version": {
"first": "1.0.0",
"good": "1.0.0",
"last": "1.0.0"
}
},
"status": "success",
"type": "response"
}
{% /tab %}
{% /tabs %}
The response follows the [standard format][], with a successful result containing a version object as its only field.
The version object returns some arrangement of the following fields:
Field |
Type | Description |
|---|---|---|
first |
String | Lowest supported API release |
last |
String | Highest supported API release |
good |
String | Default API if none specified |
Possible Errors
- Any of the [universal error types][].
{% raw-partial file="/docs/_snippets/common-links.md" /%}