Using Jetstream API¶
There are two ways of working with Jetstream API:
- Python API
- Command Line API (e.g. bash)
Both interfaces accept the same functions and arguments.
Python¶
The Python API module can be integrated into other projects or tools, and is completely independent and does not require any of the Jetstream Server binaries.
See also
Command Line¶
The command line API relies on the jetstream server executable, however, you do not need a license to use the Jetstream API. The jetstream executable can be found in:
- Linux:
/usr/local/bin/jetstream
- MacOS:
/usr/local/jetstream/bin/jetstream
- Windows:
C:\\Program Files\\Cumul8\\Jetstream Server\\bin\jetstream.exe
To access the API, specify the api
subcommand:
jetstream api
For a list of API commands add a help
parameter:
jetstream api help
For detailed help about a particular API function, run the following command, or refer to the Python API.
jetstream api help [api-function]
See also
For further help with the jetstream api command, refer to Console API.