Skip to content

Latest commit

 

History

History

README.md

← Documentation

Reference

Detailed reference documentation for every aspect of custom platform scripts. Use this section when you need to look up a specific command, parameter, operation, or behavior.

Core References

Document Description
Script Structure JSON layout, top-level keys, operations, Do blocks, and functions.
Operations All 19 operations with credential contexts and feature flags.
Reserved Parameters Parameters SPP auto-populates (72 parameters documented).
Custom Parameters Defining your own parameters with types, defaults, and UI behavior.
Variables Variable interpolation, scope rules, and the expression engine.
Status Messages Predefined status messages available to scripts.
Imports Reusable SSH function libraries and the import catalog.
Compatibility Which features are available in which SPP versions.

Command Reference

The Commands section documents every command available in Do blocks, organized by category:

Category Commands Page
HTTP Request, NewHttpRequest, BaseAddress, Headers, HttpAuth, cookies, forms, JSON, encoding commands/
SSH/Telnet Connect, Disconnect, Send, Receive, ExecuteCommand, DiscoverSshHostKey commands/
Flow Control Condition, Switch, For, ForEach commands/
Functions Function, Return, Break, Eval commands/
Error Handling Try, Throw commands/
Utilities SetItem, Declare, Split, Comment commands/
Output WriteDiscoveredAccount, WriteDiscoveredService, WriteDiscoveredSshKey, WriteResponseObject commands/
Logging Log, Status, Wait commands/
Dependencies ExecuteDependentCommand commands/

See commands/index.md for the full navigable reference.