add version topics

2025-11-21 04:05:49 +00:00 · 2024-05-17 16:21:58 -07:00
parent 52233899b5
commit bedd174645
3 changed files with 239 additions and 0 deletions
--- a/docs/references/http-websocket-apis/public-api-methods/server-info-methods/version.md
+++ b/docs/references/http-websocket-apis/public-api-methods/server-info-methods/version.md
@@ -0,0 +1,125 @@
+---
+seo:
+    description: Retrieve API version information.
+labels:
+  - Core Server
+---
+# version
+
+[[Source]](https://github.com/XRPLF/clio/blob/master/src/ripple/beast/core/SemanticVersion.cpp "Source")
+
+The `version` command asks the server for API version information. 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" /%}