2. REST API

The REANA Server offers a REST API for management workloads (workflows, jobs, tasks, etc.) running on REANA Cloud. Detailed REST API documentation can be found here.

Reana-Server Ping-functionality Flask-Blueprint.

reana_server.rest.ping.ping()

Endpoint to ping the server. Responds with a pong.

Reana-Server User Endpoints.

reana_server.rest.users.create_user()

Endpoint to create users.

reana_server.rest.users.get_user()

Endpoint to get user information from the server.

Reana-Server workflow-functionality Flask-Blueprint.

reana_server.rest.workflows.create_workflow()

Create a workflow.

reana_server.rest.workflows.download_file(workflow_id_or_name, file_name)

Download a file from the workspace.

reana_server.rest.workflows.get_files(workflow_id_or_name)

List all files contained in a workspace.

reana_server.rest.workflows.get_workflow_logs(workflow_id_or_name)

Get workflow logs.

reana_server.rest.workflows.get_workflow_status(workflow_id_or_name)

Get workflow status.

reana_server.rest.workflows.get_workflows()

Get all current workflows in REANA.

reana_server.rest.workflows.set_workflow_status(workflow_id_or_name)

Set workflow status.

reana_server.rest.workflows.upload_file(workflow_id_or_name)

Upload file to workspace.