curl --request GET \
--url 'http://localhost:7575/v2/version' \
--header 'Authorization: Bearer $TOKEN'
import json
import requests
url = "http://localhost:7575/v2/version"
headers = {'Authorization': 'Bearer <token>'}
response = requests.request("GET", url, headers=headers)
print(response.text)
const response = await fetch('http://localhost:7575/v2/version', {
method: 'GET',
headers: {
"Authorization": "Bearer <token>"
},
});
console.log(await response.text());
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'http://localhost:7575/v2/version',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
echo $response;
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "http://localhost:7575/v2/version", nil)
req.Header.Set("Authorization", "Bearer <token>")
response, _ := http.DefaultClient.Do(req)
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}
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 <token>")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
var response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
require 'net/http'
require 'uri'
uri = URI('http://localhost:7575/v2/version')
request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'Bearer <token>'
response = Net::HTTP.start(uri.hostname, uri.port) do |http|
http.request(request)
end
puts response.body
{
"version": "<string>",
"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
}
}
}
<string>
{
"code": "<string>",
"cause": "<string>",
"correlationId": "<string>",
"traceId": "<string>",
"context": {},
"resources": [
[
"<string>"
]
],
"errorCategory": 123,
"grpcCodeValue": 123,
"retryInfo": "<string>",
"definiteAnswer": false
}
GET /v2/version
Read the Ledger API version
GET
/
v2
/
version
curl --request GET \
--url 'http://localhost:7575/v2/version' \
--header 'Authorization: Bearer $TOKEN'
import json
import requests
url = "http://localhost:7575/v2/version"
headers = {'Authorization': 'Bearer <token>'}
response = requests.request("GET", url, headers=headers)
print(response.text)
const response = await fetch('http://localhost:7575/v2/version', {
method: 'GET',
headers: {
"Authorization": "Bearer <token>"
},
});
console.log(await response.text());
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'http://localhost:7575/v2/version',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
echo $response;
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "http://localhost:7575/v2/version", nil)
req.Header.Set("Authorization", "Bearer <token>")
response, _ := http.DefaultClient.Do(req)
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}
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 <token>")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
var response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
require 'net/http'
require 'uri'
uri = URI('http://localhost:7575/v2/version')
request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'Bearer <token>'
response = Net::HTTP.start(uri.hostname, uri.port) do |http|
http.request(request)
end
puts response.body
{
"version": "<string>",
"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
}
}
}
<string>
{
"code": "<string>",
"cause": "<string>",
"correlationId": "<string>",
"traceId": "<string>",
"context": {},
"resources": [
[
"<string>"
]
],
"errorCategory": 123,
"grpcCodeValue": 123,
"retryInfo": "<string>",
"definiteAnswer": false
}
Read the Ledger API version
curl --request GET \
--url 'http://localhost:7575/v2/version' \
--header 'Authorization: Bearer $TOKEN'
import json
import requests
url = "http://localhost:7575/v2/version"
headers = {'Authorization': 'Bearer <token>'}
response = requests.request("GET", url, headers=headers)
print(response.text)
const response = await fetch('http://localhost:7575/v2/version', {
method: 'GET',
headers: {
"Authorization": "Bearer <token>"
},
});
console.log(await response.text());
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'http://localhost:7575/v2/version',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
echo $response;
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "http://localhost:7575/v2/version", nil)
req.Header.Set("Authorization", "Bearer <token>")
response, _ := http.DefaultClient.Do(req)
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}
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 <token>")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
var response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
require 'net/http'
require 'uri'
uri = URI('http://localhost:7575/v2/version')
request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'Bearer <token>'
response = Net::HTTP.start(uri.hostname, uri.port) do |http|
http.request(request)
end
puts response.body
{
"version": "<string>",
"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
}
}
}
<string>
{
"code": "<string>",
"cause": "<string>",
"correlationId": "<string>",
"traceId": "<string>",
"context": {},
"resources": [
[
"<string>"
]
],
"errorCategory": 123,
"grpcCodeValue": 123,
"retryInfo": "<string>",
"definiteAnswer": false
}
Authorizations
httpAuth
string
required
HTTP bearer authentication. Send the token as
Authorization: Bearer <token>. Ledger API standard JWT tokenapiKeyAuth
string
required
API key authentication in the header. Ledger API standard JWT token (websocket)
Responses
200
application/json
string
required
The version of the ledger API. Required
FeaturesDescriptor
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
Show child attributes
Show child attributes
ExperimentalFeatures
required
See the feature message definitions for descriptions.
UserManagementFeature
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
Show child attributes
Show child attributes
boolean
required
Whether the Ledger API server provides the user management service. Required
integer (int32)
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
integer (int32)
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
PartyManagementFeature
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
Show child attributes
Show child attributes
integer (int32)
required
The maximum number of parties the server can return in a single response (page). Required
OffsetCheckpointFeature
required
It contains the timeouts related to the periodic offset checkpoint emission Required
Show child attributes
Show child attributes
PackageFeature
required
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
Show child attributes
Show child attributes
integer (int32)
required
The maximum number of vetted packages the server can return in a single response (page) when listing them. Required
400
Invalid valuetext/plain
string
required
default
application/json
string
required
string
required
string
string
Map_String
required
Tuple2_String_String[]
integer (int32)
required
integer (int32)
string
boolean
History
Updated
3.5The GET /v2/version operation was updated in this snapshot.
Added
3.4