mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-07 21:35:49 +00:00
126 lines
2.1 KiB
Markdown
126 lines
2.1 KiB
Markdown
---
|
|
seo:
|
|
description: Retrieve API version information.
|
|
labels:
|
|
- Core Server
|
|
---
|
|
# version
|
|
|
|
[[Source]](https://github.com/XRPLF/rippled/blob/develop/src/ripple/beast/core/SemanticVersion.cpp "Source")
|
|
|
|
The `version` command retrieves the API version information for the rippled server. For `Clio` servers, see [`version` (`clio`)](../clio-methods/version.md) instead.
|
|
|
|
|
|
## Request Format
|
|
An example of the request format:
|
|
|
|
{% tabs %}
|
|
|
|
{% tab label="WebSocket" %}
|
|
```json
|
|
{
|
|
"command": "version"
|
|
}
|
|
```
|
|
{% /tab %}
|
|
|
|
{% tab label="JSON-RPC" %}
|
|
```json
|
|
{
|
|
"method": "version",
|
|
"params": [
|
|
{}
|
|
]
|
|
}
|
|
```
|
|
{% /tab %}
|
|
|
|
{% tab label="Commandline" %}
|
|
```sh
|
|
#Syntax: version
|
|
rippled version
|
|
```
|
|
{% /tab %}
|
|
|
|
{% /tabs %}
|
|
|
|
[Try it! >](/resources/dev-tools/websocket-api-tool#version)
|
|
|
|
The request does not takes any parameters.
|
|
|
|
## Response Format
|
|
|
|
An example of a successful response:
|
|
|
|
{% tabs %}
|
|
|
|
{% tab label="WebSocket" %}
|
|
```json
|
|
{
|
|
"result": {
|
|
"version": {
|
|
"first": "1.0.0",
|
|
"good": "1.0.0",
|
|
"last": "1.0.0"
|
|
}
|
|
},
|
|
"status": "success",
|
|
"type": "response"
|
|
}
|
|
```
|
|
{% /tab %}
|
|
|
|
{% tab label="JSON-RPC" %}
|
|
```json
|
|
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" %}
|
|
```json
|
|
{
|
|
"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" /%}
|