Skip to content

Puhti and Mahti computing services have been decommissioned. Puhti and Mahti login nodes and storage services will remain available until 15 October 2026, but are no longer covered by service contracts. Please clean up and migrate your data to Roihu ASAP. See Roihu data migration guide for instructions.

FirecREST HPC API

The FirecREST HPC API provides a standardized RESTful HTTP interface for accessing computing resources on Roihu. It offers APIs for managing jobs through Slurm scheduler, performing file system operations over personal and project data, and for transferring large amounts of data to or from the system.

It is an ideal solution for building automated access to computing resources, as well as for creating and running personal web-based client applications that consume computing resources.

FirecREST HPC API is available for LUMI and Roihu.

How to get access to the API?

All LUMI and Roihu users can use the FirecREST HPC API using time-limited personal access tokens. This effectively allows using the REST API as an alternative to a direct SSH connection, as all API operations are executed on the target system using your CSC identity and privileges.

Personal access tokens can be generated in MyCSC FirecREST token service. MyCSC tokens work for both LUMI (national users) and Roihu APIs.

International LUMI users without CSC user account can retrieve similar personal access token(s) via the LUMI web interface.

In order to use the REST API for building more serious integrations, such as CI pipelines or building web applications, you can request for a machine-to-machine robot account to be created for your project.

About robot accounts

Robot accounts are tied to a specific project. They have access to the same computing resources, and consume your project's resource allocations, as any regular project member would.

FirecREST HPC API does not impose any additional restrictions for robot account. It can schedule any Slurm job, or perform any data transfer or file system operation within the scope of your project.

If a robot account is used to provide a HPC backend for a web application intended for humans, please be mindful of having sufficient guardrails, input validation and user authorization in the application itself to prevent unauthorized workloads or commands being run under your project's privileges.

Getting started

Check out the following documentation to get started with FirecREST HPC API on Roihu:

  1. Connect to FirecREST HPC API
  2. FirecREST API documentation on LUMI, FirecREST API documentation on Roihu
  3. Transfer data with FirecREST
  4. Set up PyFirecREST for use with Python applications