rootUnsubscribe

rootUnsubscribe — Cancel a root subscription

post
/

Unsubscribe from root notifications. This method cancels an existing root subscription identified by the subscription ID that was returned from a previous rootSubscribe call. Once unsubscribed, you will no longer receive rootNotification messages when the validator sets new root slots. Parameters

  1. subscriptionId (required) — Subscription id returned by rootSubscribe.

Authorizations
AuthorizationstringOptional

Pass Authorization: <api-key> on each request.

Body
jsonrpcstring · enumRequired

JSON-RPC protocol version.

Example: 2.0Possible values:
idone ofRequired

Request identifier echoed back in the response.

Example: 1
stringOptional
or
integerOptional
methodstring · enumRequired

Must be rootUnsubscribe.

Example: rootUnsubscribePossible values:
Responses
200

Successful rootUnsubscribe response.

application/json

Base envelope of every JSON-RPC 2.0 response.

jsonrpcstring · enumRequiredExample: 2.0Possible values:
idone ofRequired

Echoed request id.

Example: 1
stringOptional
or
integerOptional
resultbooleanRequired

True if the unsubscribe succeeded.

Example: true
post
/

Last updated