Skip to content

flux-framework/flux-restful-api

Repository files navigation

Flux RESTFul API

All Contributors

DOI

img/flux-restful-eyes-small.png

This is a small Flux Python API (using FastAPI) that can be containerized alongside Flux, and provide an easy means to interact with Flux via the API. With Flux RESTful we can:

  1. provide simple endpoints to submit jobs, list jobs, or get job status
  2. eventually support subscribing to events and a user interface job table
  3. option to kill or stop the server (intended for Flux Operator)
  4. allow for start with a user name and token (for basic auth)

This project is new and we look forward to hearing your feedback. See our ⭐️ Documentation ⭐️ to get started, and take a look at the clients we provide to interact with the server.

img/flux-restful.png

😁️ Contributors 😁️

We use the all-contributors tool to generate a contributors graphic below.

Vanessasaurus
Vanessasaurus

💻
Todd Gamblin
Todd Gamblin

💻
Khoi Nguyen
Khoi Nguyen

💻
dupgit
dupgit

💻

Release

SPDX-License-Identifier: LGPL-3.0

LLNL-CODE-764420