REST API#

EOS has a REST API to control the orchestrator. Example functions include:

  • Submit tasks, experiments, and campaigns

  • Cancel tasks, experiments, and campaigns

  • Load, unload, and reload experiments and laboratories

  • Get the status of tasks, experiments, and campaigns

  • Download task output files

Warning

Be very careful to who accesses REST API. The REST API currently has no authentication.

Only use it internally in its current state. If you need to make it accessible over the web use a VPN and set up a firewall.

Warning

EOS will likely have control over expensive (and potentially dangerous) hardware and unchecked REST API access could have severe consequences.

Documentation#

To view the REST API documentation, start the EOS REST API:

eos api

The REST API is documented using OpenAPI and can be accessed at:

http://localhost:8000/docs

or whatever host and port you have configured for the REST API server.

On this page