Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

System Controls

Methods for managing engine lifecycle, session control, and batch operations.

Previous: Events


Methods

MethodDescriptionParametersReturns
pin.purgeDownloadResultPurges completed/error/removed downloads.[]OK (String)
pin.removeDownloadResultRemoves a specific task from memory.[gid (String)]OK (String)
pin.getVersionReturns engine version information.[]Version (Object)
pin.getSessionInfoReturns the current session ID.[]SessionInfo (Object)
pin.shutdownGracefully saves session and stops the engine.[]OK (String)
pin.forceShutdownImmediately exits the engine without saving.[]OK (String)
pin.saveSessionManually triggers a session save to disk.[]OK (String)
system.multicallExecutes multiple JSON-RPC calls in a single batch.[calls (Array of Objects)]Array of Results
system.listMethodsReturns all available JSON-RPC methods.[]Array of Strings
system.listNotificationsReturns all possible WebSocket notifications.[]Array of Strings