Read the Ledger API version

OpenAPI Updated 3.5

```bash cURL theme={"theme":{"light":"github-light","dark":"github-dark"}} curl --request GET \ --url 'http://localhost:7575/v2/version' \ --header 'Authorization: Bearer $TOKEN' ``` ```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}} import json import requests url = "http://localhost:7575/v2/version" headers = {'Authorization': 'Bearer '} response = requests.request("GET", url, headers=headers) print(response.text) ``` ```javascript JavaScript theme={"theme":{"light":"github-light","dark":"github-dark"}} const response = await fetch('http://localhost:7575/v2/version', { method: 'GET', headers: { "Authorization": "Bearer " }, }); console.log(await response.text()); ``` ```php PHP theme={"theme":{"light":"github-light","dark":"github-dark"}} 'http://localhost:7575/v2/version', CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_HTTPHEADER => [ "Authorization: Bearer " ], ]); $response = curl_exec($curl); echo $response; ``` ```go Go theme={"theme":{"light":"github-light","dark":"github-dark"}} package main import ( "fmt" "io" "net/http" ) func main() { req, _ := http.NewRequest("GET", "http://localhost:7575/v2/version", nil) req.Header.Set("Authorization", "Bearer ") response, _ := http.DefaultClient.Do(req) defer response.Body.Close() body, _ := io.ReadAll(response.Body) fmt.Println(string(body)) } ``` ```java Java theme={"theme":{"light":"github-light","dark":"github-dark"}} import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; var request = HttpRequest.newBuilder() .uri(URI.create("http://localhost:7575/v2/version")) .header("Authorization", "Bearer ") .method("GET", HttpRequest.BodyPublishers.noBody()) .build(); var response = HttpClient.newHttpClient().send( request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body()); ``` ```ruby Ruby theme={"theme":{"light":"github-light","dark":"github-dark"}} require 'net/http' require 'uri' uri = URI('http://localhost:7575/v2/version') request = Net::HTTP::Get.new(uri) request['Authorization'] = 'Bearer ' response = Net::HTTP.start(uri.hostname, uri.port) do |http| http.request(request) end puts response.body ``` ```json 200 theme={"theme":{"light":"github-light","dark":"github-dark"}} { "version": "", "features": { "experimental": { "staticTime": { "supported": false }, "commandInspectionService": { "supported": false } }, "userManagement": { "supported": false, "maxRightsPerUser": 123, "maxUsersPageSize": 123 }, "partyManagement": { "maxPartiesPageSize": 123 }, "offsetCheckpoint": { "maxOffsetCheckpointEmissionDelay": { "seconds": 123, "nanos": 123, "unknownFields": { "fields": {} } } }, "packageFeature": { "maxVettedPackagesPageSize": 123 } } } ``` ```text 400 theme={"theme":{"light":"github-light","dark":"github-dark"}} ``` ```json default theme={"theme":{"light":"github-light","dark":"github-dark"}} { "code": "", "cause": "", "correlationId": "", "traceId": "", "context": {}, "resources": [ [ "" ] ], "errorCategory": 123, "grpcCodeValue": 123, "retryInfo": "", "definiteAnswer": false } ``` ## Authorizations ### httpAuth HTTP bearer authentication. Send the token as `Authorization: Bearer <token>`. Ledger API standard JWT token ### apiKeyAuth API key authentication in the header. Ledger API standard JWT token (websocket) ## Responses ### 200

application/json

The version of the ledger API. Required The features supported by this Ledger API endpoint. Daml applications CAN use the feature descriptor on top of version constraints on the Ledger API version to determine whether a given Ledger API endpoint supports the features required to run the application. See the feature descriptions themselves for the relation between Ledger API versions and feature presence. Required See the feature message definitions for descriptions. Ledger is in the static time mode and exposes a time service. Required Whether the Ledger API supports command inspection service Required If set, then the Ledger API server supports user management. It is recommended that clients query this field to gracefully adjust their behavior for ledgers that do not support user management. Required Whether the Ledger API server provides the user management service. Required The maximum number of rights that can be assigned to a single user. Servers MUST support at least 100 rights per user. A value of 0 means that the server enforces no rights per user limit. Required The maximum number of users the server can return in a single response (page). Servers MUST support at least a 100 users per page. A value of 0 means that the server enforces no page size limit. Required If set, then the Ledger API server supports party management configurability. It is recommended that clients query this field to gracefully adjust their behavior to maximum party page size. Required The maximum number of parties the server can return in a single response (page). Required It contains the timeouts related to the periodic offset checkpoint emission Required The maximum delay to emmit a new OffsetCheckpoint if it exists Required This field is automatically added as part of protobuf to json mapping If set, then the Ledger API server supports package listing configurability. It is recommended that clients query this field to gracefully adjust their behavior to maximum package listing page size. Required The maximum number of vetted packages the server can return in a single response (page) when listing them. Required ### 400 Invalid value

text/plain

### default

application/json

## History

Updated 3.5

The GET /v2/version operation changed in this snapshot.