ETH Zurich – CSCS FirecREST v2 HPC API

# Harvested verbatim from the live production host on 2026-08-19.
# method: searched  source: https://api.cscs.ch/hpc/firecrest/v2/openapi.json
# x-operator: institution — CSCS (Swiss National Supercomputing Centre) is an
# autonomous unit of ETH Zurich; servers[] names api.cscs.ch and the upstream
# source carries 'Copyright (c) 2019-2024, ETH Zurich'.
openapi: 3.1.0
info:
  title: FirecREST
  version: 2.5.6
servers:
- url: https://api.cscs.ch/hpc/firecrest/v2
  description: HPCp Environment
paths:
  /status/systems:
    get:
      tags:
      - status
      summary: Get Systems
      description: Get the list of systems and health status
      operationId: get_systems_status_systems_get
      responses:
        '200':
          description: System list returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSystemsResponse'
        4XX:
          description: Client Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
        5XX:
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
      security:
      - APIAuthDependency: []
      - HTTPBearer: []
  /status/{system_name}/nodes:
    get:
      tags:
      - status
      summary: Get System Nodes
      description: Get the list of nodes of a `{system_name}`
      operationId: get_system_nodes_status__system_name__nodes_get
      security:
      - APIAuthDependency: []
      - HTTPBearer: []
      parameters:
      - name: system_name
        in: path
        required: true
        schema:
          type: string
          title: System Name
      responses:
        '200':
          description: Nodes list returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetNodesResponse'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Client Error
        5XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Server Error
  /status/{system_name}/reservations:
    get:
      tags:
      - status
      summary: Get System Reservations
      description: Get the list of reservations of a `{system_name}`
      operationId: get_system_reservations_status__system_name__reservations_get
      security:
      - APIAuthDependency: []
      - HTTPBearer: []
      parameters:
      - name: system_name
        in: path
        required: true
        schema:
          type: string
          title: System Name
      responses:
        '200':
          description: Reservations list returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetReservationsResponse'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Client Error
        5XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Server Error
  /status/{system_name}/partitions:
    get:
      tags:
      - status
      summary: Get System Partitions
      description: Get the list of partitions of a `{system_name}`
      operationId: get_system_partitions_status__system_name__partitions_get
      security:
      - APIAuthDependency: []
      - HTTPBearer: []
      parameters:
      - name: system_name
        in: path
        required: true
        schema:
          type: string
          title: System Name
      - name: show_hidden
        in: query
        required: false
        schema:
          type: boolean
          description: Show hidden partitions (only applies to Slurm scheduler).
          default: false
          title: Show Hidden
        description: Show hidden partitions (only applies to Slurm scheduler).
      responses:
        '200':
          description: Partitions list returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPartitionsResponse'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Client Error
        5XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Server Error
  /status/{system_name}/userinfo:
    get:
      tags:
      - status
      summary: Get Userinfo
      description: Get current user information on a `{system_name}`
      operationId: get_userinfo_status__system_name__userinfo_get
      security:
      - APIAuthDependency: []
      - HTTPBearer: []
      parameters:
      - name: system_name
        in: path
        required: true
        schema:
          type: string
          title: System Name
      responses:
        '200':
          description: User information returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserInfoResponse'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Client Error
        5XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Server Error
  /status/liveness/:
    get:
      tags:
      - status
      summary: Get Liveness
      description: Get liveness status of FirecREST
      operationId: get_liveness_status_liveness__get
      responses:
        '200':
          description: Liveness status returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLiveness'
        4XX:
          description: Client Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
        5XX:
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
  /compute/{system_name}/jobs:
    post:
      tags:
      - compute
      summary: Post Job Submit
      description: Submit a new job
      operationId: post_job_submit_compute__system_name__jobs_post
      security:
      - APIAuthDependency: []
      - HTTPBearer: []
      parameters:
      - name: system_name
        in: path
        required: true
        schema:
          type: string
          title: System Name
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostJobSubmitRequest'
      responses:
        '201':
          description: Job submitted correctly
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostJobSubmissionResponse'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Client Error
        5XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Server Error
    get:
      tags:
      - compute
      summary: Get Jobs
      description: Get status of all jobs
      operationId: get_jobs_compute__system_name__jobs_get
      security:
      - APIAuthDependency: []
      - HTTPBearer: []
      parameters:
      - name: system_name
        in: path
        required: true
        schema:
          type: string
          title: System Name
      - name: allusers
        in: query
        required: false
        schema:
          type: boolean
          description: If set to `true` returns all jobs visible by the current user, otherwise only the
            current user owned jobs
          default: false
          title: Allusers
        description: If set to `true` returns all jobs visible by the current user, otherwise only the
          current user owned jobs
      - name: account
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: If specified, filter jobs by account name
          title: Account
        description: If specified, filter jobs by account name
      responses:
        '200':
          description: Jobs status returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetJobResponse'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Client Error
        5XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Server Error
  /compute/{system_name}/jobs/{job_id}:
    get:
      tags:
      - compute
      summary: Get Job
      description: Get status of a job by `{job_id}`
      operationId: get_job_compute__system_name__jobs__job_id__get
      security:
      - APIAuthDependency: []
      - HTTPBearer: []
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z0-9]+$
          description: Job id
          title: Job Id
        description: Job id
      - name: system_name
        in: path
        required: true
        schema:
          type: string
          title: System Name
      responses:
        '200':
          description: Jobs status returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetJobResponse'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Client Error
        5XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Server Error
    delete:
      tags:
      - compute
      summary: Delete Job Cancel
      description: Cancel a job
      operationId: delete_job_cancel_compute__system_name__jobs__job_id__delete
      security:
      - APIAuthDependency: []
      - HTTPBearer: []
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z0-9]+$
          description: Job id
          title: Job Id
        description: Job id
      - name: system_name
        in: path
        required: true
        schema:
          type: string
          title: System Name
      responses:
        '204':
          description: Job cancelled successfully
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Client Error
        5XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Server Error
  /compute/{system_name}/jobs/{job_id}/metadata:
    get:
      tags:
      - compute
      summary: Get Job Metadata
      description: Get metadata of a job by `{job_id}`
      operationId: get_job_metadata_compute__system_name__jobs__job_id__metadata_get
      security:
      - APIAuthDependency: []
      - HTTPBearer: []
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z0-9]+$
          description: Job id
          title: Job Id
        description: Job id
      - name: system_name
        in: path
        required: true
        schema:
          type: string
          title: System Name
      responses:
        '200':
          description: Jobs metadata returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetJobMetadataResponse'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Client Error
        5XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Server Error
  /compute/{system_name}/jobs/{job_id}/attach:
    put:
      tags:
      - compute
      summary: Attach
      description: Attach a procces to a job by `{job_id}`
      operationId: attach_compute__system_name__jobs__job_id__attach_put
      security:
      - APIAuthDependency: []
      - HTTPBearer: []
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z0-9]+$
          description: Job id
          title: Job Id
        description: Job id
      - name: system_name
        in: path
        required: true
        schema:
          type: string
          title: System Name
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostJobAttachRequest'
      responses:
        '204':
          description: Process attached succesfully
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Client Error
        5XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Server Error
  /filesystem/{system_name}/transfer/upload:
    post:
      tags:
      - filesystem
      - filesystem
      summary: Post Upload
      description: Create asynchronous upload operation
      operationId: post_upload_filesystem__system_name__transfer_upload_post
      security:
      - APIAuthDependency: []
      - HTTPBearer: []
      parameters:
      - name: system_name
        in: path
        required: true
        schema:
          type: string
          title: System Name
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostFileUploadRequest'
      responses:
        '201':
          description: Upload operation created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UploadFileResponse'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Client Error
        5XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Server Error
  /filesystem/{system_name}/transfer/download:
    post:
      tags:
      - filesystem
      - filesystem
      summary: Post Download
      description: Create asynchronous download operation
      operationId: post_download_filesystem__system_name__transfer_download_post
      security:
      - APIAuthDependency: []
      - HTTPBearer: []
      parameters:
      - name: system_name
        in: path
        required: true
        schema:
          type: string
          title: System Name
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostFileDownloadRequest'
      responses:
        '201':
          description: Download operation created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DownloadFileResponse'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Client Error
        5XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Server Error
  /filesystem/{system_name}/transfer/mv:
    post:
      tags:
      - filesystem
      - filesystem
      summary: Move Mv
      description: Create move file or directory operation (`mv`)
      operationId: move_mv_filesystem__system_name__transfer_mv_post
      security:
      - APIAuthDependency: []
      - HTTPBearer: []
      parameters:
      - name: system_name
        in: path
        required: true
        schema:
          type: string
          title: System Name
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MoveRequest'
      responses:
        '201':
          description: Move file or directory operation created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoveResponse'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Client Error
        5XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Server Error
  /filesystem/{system_name}/transfer/cp:
    post:
      tags:
      - filesystem
      - filesystem
      summary: Post Cp
      description: Create copy file or directory operation (`cp`)
      operationId: post_cp_filesystem__system_name__transfer_cp_post
      security:
      - APIAuthDependency: []
      - HTTPBearer: []
      parameters:
      - name: system_name
        in: path
        required: true
        schema:
          type: string
          title: System Name
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CopyRequest'
      responses:
        '201':
          description: Copy file or directory operation created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CopyResponse'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Client Error
        5XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Server Error
  /filesystem/{system_name}/transfer/rm:
    delete:
      tags:
      - filesystem
      - filesystem
      summary: Delete Rm
      description: Create remove file or directory operation (`rm`)
      operationId: delete_rm_filesystem__system_name__transfer_rm_delete
      security:
      - APIAuthDependency: []
      - HTTPBearer: []
      parameters:
      - name: system_name
        in: path
        required: true
        schema:
          type: string
          title: System Name
      - name: path
        in: query
        required: true
        schema:
          type: string
          description: The path to delete
          title: Path
        description: The path to delete
      - name: account
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Account
      responses:
        '200':
          description: Remove file or directory operation created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Client Error
        5XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Server Error
  /filesystem/{system_name}/transfer/compress:
    post:
      tags:
      - filesystem
      - filesystem
      summary: Compress
      description: Create compress file or directory operation (`tar`)
      operationId: compress_filesystem__system_name__transfer_compress_post
      security:
      - APIAuthDependency: []
      - HTTPBearer: []
      parameters:
      - name: system_name
        in: path
        required: true
        schema:
          type: string
          title: System Name
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompressRequest'
      responses:
        '201':
          description: Compress file or directory operation created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompressResponse'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Client Error
        5XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Server Error
  /filesystem/{system_name}/transfer/extract:
    post:
      tags:
      - filesystem
      - filesystem
      summary: Extract
      description: Create extract file operation (`tar`)
      operationId: extract_filesystem__system_name__transfer_extract_post
      security:
      - APIAuthDependency: []
      - HTTPBearer: []
      parameters:
      - name: system_name
        in: path
        required: true
        schema:
          type: string
          title: System Name
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExtractRequest'
      responses:
        '201':
          description: Extract file or directory operation created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtractResponse'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Client Error
        5XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Server Error
  /filesystem/{system_name}/ops/chmod:
    put:
      tags:
      - filesystem
      - filesystem
      summary: Put Chmod
      description: Change the permission mode of a file(`chmod`)
      operationId: put_chmod_filesystem__system_name__ops_chmod_put
      security:
      - APIAuthDependency: []
      - HTTPBearer: []
      parameters:
      - name: system_name
        in: path
        required: true
        schema:
          type: string
          title: System Name
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutFileChmodRequest'
      responses:
        '200':
          description: File permissions changed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutFileChmodResponse'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Client Error
        5XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Server Error
  /filesystem/{system_name}/ops/chown:
    put:
      tags:
      - filesystem
      - filesystem
      summary: Put Chown
      description: Change the ownership of a given file (`chown`)
      operationId: put_chown_filesystem__system_name__ops_chown_put
      security:
      - APIAuthDependency: []
      - HTTPBearer: []
      parameters:
      - name: system_name
        in: path
        required: true
        schema:
          type: string
          title: System Name
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutFileChownRequest'
      responses:
        '200':
          description: File ownership changed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutFileChownResponse'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Client Error
        5XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Server Error
  /filesystem/{system_name}/ops/ls:
    get:
      tags:
      - filesystem
      - filesystem
      summary: Get Ls
      description: List the contents of the given directory (`ls`)
      operationId: get_ls_filesystem__system_name__ops_ls_get
      security:
      - APIAuthDependency: []
      - HTTPBearer: []
      parameters:
      - name: system_name
        in: path
        required: true
        schema:
          type: string
          title: System Name
      - name: path
        in: query
        required: true
        schema:
          type: string
          description: The path to list
          title: Path
        description: The path to list
      - name: showHidden
        in: query
        required: false
        schema:
          type: boolean
          description: Show hidden files
          default: false
          title: Showhidden
        description: Show hidden files
      - name: numericUid
        in: query
        required: false
        schema:
          type: boolean
          description: List numeric user and group IDs
          default: false
          title: Numericuid
        description: List numeric user and group IDs
      - name: recursive
        in: query
        required: false
        schema:
          type: boolean
          description: Recursively list files and folders
          default: false
          title: Recursive
        description: Recursively list files and folders
      - name: dereference
        in: query
        required: false
        schema:
          type: boolean
          description: Show information for the file the link references.
          default: false
          title: Dereference
        description: Show information for the file the link references.
      responses:
        '200':
          description: Directory listed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDirectoryLsResponse'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Client Error
        5XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Server Error
  /filesystem/{system_name}/ops/head:
    get:
      tags:
      - filesystem
      - filesystem
      summary: Get Head
      description: Output the first part of file/s (`head`)
      operationId: get_head_filesystem__system_name__ops_head_get
      security:
      - APIAuthDependency: []
      - HTTPBearer: []
      parameters:
      - name: system_name
        in: path
        required: true
        schema:
          type: string
          title: System Name
      - name: path
        in: query
        required: true
        schema:
          type: string
          description: File path
          title: Path
        description: File path
      - name: bytes
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: The output will be the first NUM bytes of each file.
          title: Bytes
        description: The output will be the first NUM bytes of each file.
      - name: lines
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: The output will be the first NUM lines of each file.
          title: Lines
        description: The output will be the first NUM lines of each file.
      - name: skipTrailing
        in: query
        required: false
        schema:
          type: boolean
          description: The output will be the whole file, without the last NUM bytes/lines of each file.
            NUM should be specified in the respective argument through `bytes` or `lines`.
          default: false
          title: Skiptrailing
        description: The output will be the whole file, without the last NUM bytes/lines of each file.
          NUM should be specified in the respective argument through `bytes` or `lines`.
      responses:
        '200':
          description: Head operation finished successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetFileHeadResponse'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Client Error
        5XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Server Error
  /filesystem/{system_name}/ops/view:
    get:
      tags:
      - filesystem
      - filesystem
      summary: Get View
      description: View file content
      operationId: get_view_filesystem__system_name__ops_view_get
      security:
      - APIAuthDependency: []
      - HTTPBearer: []
      parameters:
      - name: system_name
        in: path
        required: true
        schema:
          type: string
          title: System Name
      - name: path
        in: query
        required: true
        schema:
          type: string
          description: File path
          title: Path
        description: File path
      - name: size
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Value, in bytes, of the size of data to be retrieved from the file.
          default: 5242880
          title: Size
        description: Value, in bytes, of the size of data to be retrieved from the file.
      - name: offset
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Value in bytes of the offset.
          default: 0
          title: Offset
        description: Value in bytes of the offset.
      responses:
        '200':
          description: View operation finished successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetViewFileResponse'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Client Error
        5XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseError'
          description: Server Error
  /filesystem/{system_name}/ops/tail:
    get:
      tags:
      - filesystem
      - filesystem
      summary: Get Tail
      description: Output the last 

# --- truncated at 32 KB (104 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/eth-zurich/refs/heads/main/openapi/eth-zurich-firecrest-v2-api-openapi.yml