Documentation/canton-network-docs/Admin APIgRPC APIPackagescom.digitalasset.canton.admin.participant.v30ServicesPingServiceView on canton-network-docs ↗
canton-network-docs/Admin APIgRPC APIPackagescom.digitalasset.canton.admin.participant.v30ServicesPingService

Ping

Participant Administration›Protobuf›com.digitalasset.canton.admin.participant.v30›Ping

com.digitalasset.canton.admin.participant.v30

​
Ping

gRPCSince 3.4.0
RPC/com.digitalasset.canton.admin.participant.v30.PingService/Ping

​
Protocol Details

​
Inputs

​
PingRequest

target_partiesrepeated string
validatorsrepeated string
timeoutDuration
levelsuint32
synchronizer_idstring
workflow_idstring
idstring

​
Outputs

​
PingResponse

successPingSuccess
failurePingFailure

​
Lifecycle Changes

3.4.0introduced

com.digitalasset.canton.admin.participant.v30.PingRequest

target_partiesrepeated string
validatorsrepeated string
timeoutDuration
levelsuint32
synchronizer_idstring
workflow_idstring
idstring

com.digitalasset.canton.admin.participant.v30.PingResponse

successPingSuccess
failurePingFailure

com.digitalasset.canton.admin.participant.v30.PingSuccess

ping_timeuint64
responderstring

com.digitalasset.canton.admin.participant.v30.PingFailure

reasonstring
grpcurl
grpcurl
# Add -plaintext if the server is not using TLS.
grpcurl \
  -d @ \
  <HOST:PORT> \
  com.digitalasset.canton.admin.participant.v30.PingService/Ping <<'EOF'
{
  "targetParties": [
    "string"
  ],
  "validators": [
    "string"
  ],
  "timeout": "string",
  "levels": 0,
  "synchronizerId": "string",
  "workflowId": "string",
  "id": "string"
}
EOF
OKapplication/json
OK
{
  "success": {
    "pingTime": "0",
    "responder": "string"
  }
}