Update the vetted packages of this participant

POST /v2/package-vetting/update

Request

curl --request POST \
  --url 'http://localhost:7575/v2/package-vetting/update' \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"changes":[{}],"dryRun":false,"synchronizerId":"string","expectedTopologySerial":{"serial":{}},"updateVettedPackagesForceFlags":["UPDATE_VETTED_PACKAGES_FORCE_FLAG_UNSPECIFIED"]}'

200 response

{
  "pastVettedPackages": {
    "packages": [
      {}
    ],
    "participantId": "string",
    "synchronizerId": "string",
    "topologySerial": 0
  },
  "newVettedPackages": {
    "packages": [
      {}
    ],
    "participantId": "string",
    "synchronizerId": "string",
    "topologySerial": 0
  }
}

JSON Ledger API

Update the vetted packages of this participant

OpenAPISince 3.4Changed 3.5

Update the vetted packages of this participant

Protocol Details

Inputs

Request body

application/json

changes · object[] · required

OpenAPI type: VettedPackagesChange[].

Changes to apply to the current vetting state of the participant on the specified synchronizer. The changes are applied in order. Any package not changed will keep their previous vetting state. Required: must be non-empty

dryRun · boolean

If dry_run is true, then the changes are only prepared, but not applied. If a request would trigger an error when run (e.g. TOPOLOGY_DEPENDENCIES_NOT_VETTED), it will also trigger an error when dry_run. Use this flag to preview a change before applying it. Defaults to false. Optional

synchronizerId · string

If set, the requested changes will take place on the specified synchronizer. If synchronizer_id is unset and the participant is only connected to a single synchronizer, that synchronizer will be used by default. If synchronizer_id is unset and the participant is connected to multiple synchronizers, the request will error out with PACKAGE_SERVICE_CANNOT_AUTODETECT_SYNCHRONIZER. Optional

expectedTopologySerial · object

OpenAPI type: PriorTopologySerial.

The serial of last VettedPackages topology transaction on a given participant and synchronizer.

updateVettedPackagesForceFlags · string[]

Controls whether potentially unsafe vetting updates are allowed. Optional: can be empty

Outputs

200

application/json

pastVettedPackages · VettedPackages

The list of packages vetted on a given participant and synchronizer, modelled after VettedPackages in topology.proto <https://github.com/digital-asset/canton/blob/main/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L206>_. The list only contains packages that matched a filter in the query that originated it.

newVettedPackages · VettedPackages · required

The list of packages vetted on a given participant and synchronizer, modelled after VettedPackages in topology.proto <https://github.com/digital-asset/canton/blob/main/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L206>_. The list only contains packages that matched a filter in the query that originated it.

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 POST /v2/package-vetting/update operation changed in this snapshot.

Introduced3.4

Request

curl --request POST \
  --url 'http://localhost:7575/v2/package-vetting/update' \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"changes":[{}],"dryRun":false,"synchronizerId":"string","expectedTopologySerial":{"serial":{}},"updateVettedPackagesForceFlags":["UPDATE_VETTED_PACKAGES_FORCE_FLAG_UNSPECIFIED"]}'

200 response

{
  "pastVettedPackages": {
    "packages": [
      {}
    ],
    "participantId": "string",
    "synchronizerId": "string",
    "topologySerial": 0
  },
  "newVettedPackages": {
    "packages": [
      {}
    ],
    "participantId": "string",
    "synchronizerId": "string",
    "topologySerial": 0
  }
}