The filesystem API from ETH Zurich – Swiss Federal Institute of Technology — 23 operation(s) for filesystem.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/eth-zurich-filesystem-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: FirecREST Filesystem API
version: 2.5.6
servers:
- url: https://api.cscs.ch/hpc/firecrest/v2
description: HPCp Environment
tags:
- name: filesystem
paths:
/filesystem/{system_name}/transfer/upload:
post:
tags:
- 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
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
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
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
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
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
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
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
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
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
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
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
summary: Get Tail
description: Output the last part of a file (`tail`)
operationId: get_tail_filesystem__system_name__ops_tail_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 last NUM bytes of each file.
title: Bytes
description: The output will be the last NUM bytes of each file.
- name: lines
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
description: The output will be the last NUM lines of each file.
title: Lines
description: The output will be the last NUM lines of each file.
- name: skipHeading
in: query
required: false
schema:
type: boolean
description: The output will be the whole file, without the first NUM bytes/lines of each file. NUM should be specified in the respective argument through `bytes` or `lines`.
default: false
title: Skipheading
description: The output will be the whole file, without the first NUM bytes/lines of each file. NUM should be specified in the respective argument through `bytes` or `lines`.
responses:
'200':
description: '`tail` operation finished successfully'
content:
application/json:
schema:
$ref: '#/components/schemas/GetFileTailResponse'
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/checksum:
get:
tags:
- filesystem
summary: Get Checksum
description: Output the checksum of a file (using SHA-256 algotithm)
operationId: get_checksum_filesystem__system_name__ops_checksum_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: Target system
title: Path
description: Target system
responses:
'200':
description: Checksum returned successfully
content:
application/json:
schema:
$ref: '#/components/schemas/GetFileChecksumResponse'
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/file:
get:
tags:
- filesystem
summary: Get File
description: Output the type of a file or directory
operationId: get_file_filesystem__system_name__ops_file_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: A file or folder path
title: Path
description: A file or folder path
responses:
'200':
description: Type returned successfully
content:
application/json:
schema:
$ref: '#/components/schemas/GetFileTypeResponse'
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/stat:
get:
tags:
- filesystem
summary: Get Stat
description: Output the `stat` of a file
operationId: get_stat_filesystem__system_name__ops_stat_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: A file or folder path
title: Path
description: A file or folder path
- name: dereference
in: query
required: false
schema:
type: boolean
description: Follow symbolic links
default: false
title: Dereference
description: Follow symbolic links
responses:
'200':
description: Stat returned successfully
content:
application/json:
schema:
$ref: '#/components/schemas/GetFileStatResponse'
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/rm:
delete:
tags:
- filesystem
summary: Delete Rm
description: Delete file or directory operation (`rm`)
operationId: delete_rm_filesystem__system_name__ops_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
responses:
'204':
description: File or directory deleted 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
/filesystem/{system_name}/ops/mkdir:
post:
tags:
- filesystem
summary: Post Mkdir
description: Create directory operation (`mkdir`)
operationId: post_mkdir_filesystem__system_name__ops_mkdir_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/PostMakeDirRequest'
responses:
'201':
description: Directory created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/PostMkdirResponse'
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/symlink:
post:
tags:
- filesystem
summary: Post Symlink
description: Create symlink operation (`ln`)
operationId: post_symlink_filesystem__system_name__ops_symlink_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/PostFileSymlinkRequest'
responses:
'201':
description: Symlink created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/PostFileSymlinkResponse'
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/download:
get:
tags:
- filesystem
summary: Get Download
description: Download a small file
operationId: get_download_filesystem__system_name__ops_download_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: A file to download
title: Path
description: A file to download
responses:
'200':
description: File downloaded successfully
content:
application/json:
schema: {}
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/upload:
post:
tags:
- filesystem
summary: Post Upload
description: Upload a small file
operationId: post_upload_filesystem__system_name__ops_upload_post
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: Specify path where file should be uploaded.
title: Path
description: Specify path where file should be uploaded.
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/Body_post_upload_filesystem__system_name__ops_upload_post'
responses:
'204':
description: File uploaded 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
/filesystem/{system_name}/ops/compress:
post:
tags:
- filesystem
summary: Post Compress
description: Compress files and directories using `tar` command
operationId: post_compress_filesystem__system_name__ops_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/PostCompressRequest'
responses:
'204':
description: File and/or directories compressed 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
/filesystem/{system_name}/ops/extract:
post:
tags:
- filesystem
summary: Post Extract
description: Extract `tar` `gzip` archives
operationId: post_extract_filesystem__system_name__ops_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/PostExtractRequest'
responses:
'204':
description: File extracted 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
components:
schemas:
ExtractResponse:
propertie
# --- truncated at 32 KB (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/eth-zurich/refs/heads/main/openapi/eth-zurich-filesystem-api-openapi.yml