Console API

Synopsis

jetstream api [api-options] command [command-options]

Description

jetstream api command (the api subcommand of jetstream) can be used to interact with the JetStream API from command line.

Options

jetstream api

Options

--host arg (=localhost)

Address of JetStream server to control

--api-control-port arg (=8886)

Default API port

--user arg

User name for API authentication (cannot be used at the same time as token)

--authToken arg

Token for API authentication (cannot be used at the same time as user)

--authTokenSession arg

Token session for sharing transfers between instances of token authentication

--superuser

Run the API command as a superuser

--no-auth

Skip API authentication. If used, the --user, --authToken, --authTokenSession and --superuser options are ignored

For a list of supported API commands execute jetstream api help, and for more detailed information on each command execute jetstream api help <command>. For further reference on each API command, please refer to the specific functions in Python API.

Environment

JETSTREAM_API_PASSWORD

Used to specify user’s password through the environment, instead of the command line parameter

JETSTREAM_TRANSFER_PASSWORD

Used to specify a password through the environment when creating transfers, instead of the command line parameter

Examples

• Console API Examples
  • Connecting To A Server
  • Creating a Manifest
  • Monitoring a Manifest
  • Creating a Destination
  • Creating a Transfer
  • Monitoring A Transfer