BEAT Web API

• Introduction
• Web API
  • Introduction
  • Privacy
  • User authentication
  • Usage of the API
  • Data Format API
    • Retrieving a list of all the data formats accessible by the user
    • Retrieving a specific data format
    • Creating a new data format
    • Checking the validity of a data format name
    • Updating an existing data format
    • Deleting an existing data format
    • Sharing an existing data format
    • Comparing two data formats
  • Algorithm API
    • Retrieving a list of all the algorithms accessible by the user
    • Retrieving a specific algorithm
    • Creating a new algorithm
    • Checking the validity of an algorithm name
    • Updating an existing algorithm
    • Deleting an existing algorithm
    • Sharing an existing algorithm
    • Comparing two algorithms
  • Library API
    • Retrieving a list of all the libraries accessible by the user
    • Retrieving a specific library
    • Creating a new library
    • Checking the validity of a library name
    • Updating an existing library
    • Deleting an existing library
    • Sharing an existing library
    • Comparing two libraries
  • Toolchain API
    • Retrieving a list of all the toolchains accessible by the user
    • Retrieving a specific toolchain
    • Creating a new toolchain
    • Checking the validity of a toolchain name
    • Updating an existing toolchain
    • Deleting an existing toolchain
    • Sharing an existing toolchain
    • Comparing two toolchains
  • Experiment API
    • Retrieving a list of all the experiments accessible by the user
    • Retrieving a specific experiment
    • Creating a new experiment
    • Updating an existing experiment
    • Deleting an existing experiment
    • Starting an existing experiment
    • Canceling a running experiment
    • Sharing an existing experiment
    • Retrieving experiment results from an attestation number
  • Database API
    • Retrieving a list of all the databases accessible by the user
    • Retrieving a list of all the database templates accessible by the user
    • Retrieving a specific database
  • Backend API
    • Retrieving the scheduler (and workers) state
    • Canceling all the experiments
    • Updating scheduler configuration
    • Cleaning-up the cache
    • Telling a web server that the execution of a block has started
    • Telling a web server that the execution of a block has finished
    • Retrieving a list of all the environments accessible by the user
  • Team API
    • Retrieving a list of all the teams accessible by a user
    • Retrieving a specific team
    • Creating a new team
    • Updating an existing team
    • Deleting an existing team
  • Search API
    • Retrieving a list of all searches accessible by the user
    • Creating a new search
    • Updating an existing search
    • Deleting an existing search
    • Sharing an existing search
  • Attestation API
    • Retrieving a list of all attestations of a given user
    • Creating a new attestation
    • Unlocking an attestation

Indices and tables

• Index

• Module Index

• Search Page