BEEflow REST API

This is a REST API for beeflow itself. It provides a way to remotely submit workflows to the system. The REST API was created primarily for the purpose of connecting CI resources to beeflow, but could also be used to setup remote “workers”.

module:

beeflow.remote.remote

show-refs:

True

Endpoints

beeflow.remote.remote.get_wf_status()

WIP - This endpoint is planned to give you a status on an actively running workflow.

beeflow.remote.remote.get_drop_point()

Transmit the scp location to be used for the storage of workflow tarballs.

Users are required to ensure that this directory has the appropriate permissions.

beeflow.remote.remote.get_owner()

Transmit the owner of this BEEflow instance.

beeflow.remote.remote.submit_new_wf(filename: str)

WIP: Submit a new workflow with a tarball for the workflow at a given path.

beeflow.remote.remote.submit_new_wf_long(wf_name: str, tarball_name: str, main_cwl_file: str, job_file: str)

Submit a new workflow with a tarball for the workflow at a given path.

This makes the following assumptions:n The workflow tarball should be at <DROPPOINT_PATH>/<tarball name>n The workdir should be at <DROPPOINT_PATH>/<tarball name>-workdir and should have the required input files.

beeflow.remote.remote.show_drops()

WIP: This endpoint will give a list of workflows in the droppoint.

beeflow.remote.remote.cleanup_wf_directory()

WIP: This endpoint is planned to delete all the temporarily stored workflow tarballs.

beeflow.remote.remote.get_core_status()

Check the status of BEEflow and the components.