Get the latest successfully pruned ledger offsets

GET /v2/state/latest-pruned-offsets

Request

curl --request GET \
  --url 'http://localhost:7575/v2/state/latest-pruned-offsets' \
  --header 'Authorization: Bearer $TOKEN'

200 response

{
  "participantPrunedUpToInclusive": 0,
  "allDivulgedContractsPrunedUpToInclusive": 0
}

JSON Ledger API

Get the latest successfully pruned ledger offsets

OpenAPISince 3.4Changed 3.5

Get the latest successfully pruned ledger offsets

Protocol Details

Inputs

Outputs

200

application/json

participantPrunedUpToInclusive · integer (int64)

It will always be a non-negative integer. If positive, the absolute offset up to which the ledger has been pruned, disregarding the state of all divulged contracts pruning. If zero, the ledger has not been pruned yet. Optional

allDivulgedContractsPrunedUpToInclusive · integer (int64)

It will always be a non-negative integer. If positive, the absolute offset up to which all divulged events have been pruned on the ledger. It can be at or before the participant_pruned_up_to_inclusive offset. For more details about all divulged events pruning, see PruneRequest.prune_all_divulged_contracts in participant_pruning_service.proto. If zero, the divulged events have not been pruned yet. Optional

400

text/plain

value · string · required

default

application/json

code · string · required

cause · string · required

correlationId · string

traceId · string

context · Map_String · required

resources · Tuple2_String_String[]

errorCategory · integer (int32) · required

grpcCodeValue · integer (int32)

retryInfo · string

definiteAnswer · boolean

History

Changed3.5

The GET /v2/state/latest-pruned-offsets operation changed in this snapshot.

Introduced3.4

Request

curl --request GET \
  --url 'http://localhost:7575/v2/state/latest-pruned-offsets' \
  --header 'Authorization: Bearer $TOKEN'

200 response

{
  "participantPrunedUpToInclusive": 0,
  "allDivulgedContractsPrunedUpToInclusive": 0
}