RustFS Health API

The Health API from RustFS — 2 operation(s) for health.

Operations 2

GET /health Liveness probe that checks if the server is running #
GET /health/{healthid} Liveness — returns 200 as long as the process is up #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/rustfs:rustfs-health-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

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 Specification

rustfs-health-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: RustFS Health API
  version: '2026-10-13'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-13: 30 operation(s) read from 21 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; RustFS has published no machine-readable contract that the pipeline could find. Engine: anthropic.'
  x-evidence-tiers:
    code-example: 8
    documentation: 22
    pages-with-code: 12
    pages-read: 21
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-13'
  x-generator: generate-contract-from-docs.py
  x-engine: anthropic
  x-sources:
  - https://docs.rustfs.com/en/operations/rc
  - https://docs.rustfs.com/en/installation/linux/quick-start
  - https://py.iceberg.apache.org/configuration
  - https://docs.rustfs.com/en/installation/cloud-native
  - https://docs.rustfs.com/en/administration/cors
  - https://docs.rustfs.com/en/security-compliance/audit-logs
  - https://docs.rustfs.com/en/operations/credentials
  - https://docs.rustfs.com/en/operations/cluster-lifecycle
  - https://docs.rustfs.com/en/operations/observability
  - https://docs.rustfs.com/en/operations/status-check
  - https://docs.rustfs.com/en/security-compliance/iam/sts
  - https://docs.rustfs.com/en/developer/sdk/python
  - https://docs.rustfs.com/en/developer/sdk/other
  - https://docs.rustfs.com/en/installation/linux/prerequisites-and-service
  - https://docs.rustfs.com/en/installation/container/docker
  - https://docs.rustfs.com/en/installation/container/podman
  - https://docs.rustfs.com/en/administration/data/s3-tables
  - https://docs.rustfs.com/en/administration/data/bucket/creation
  - https://docs.rustfs.com/en/administration/data/object/creation
  - https://docs.rustfs.com/en/security-compliance/iam/policies
  - https://docs.rustfs.com/en/security-compliance/oidc/keycloak
  x-ownership: RustFS is self-hosted software; no RustFS-operated API host exists. Paths are from docs.rustfs.com pages (x-source per operation). Download/installer URLs and a Keycloak realm discovery URL the generator caught were removed as not RustFS API operations.
servers:
- url: '{scheme}://{host}:{port}'
  description: 'Self-hosted RustFS deployment: S3 API, admin API and health endpoints on port 9000 (console on 9001), per https://docs.rustfs.com/en/operations/status-check'
  variables:
    scheme:
      default: http
      enum:
      - http
      - https
    host:
      default: localhost
    port:
      default: '9000'
tags:
- name: Health
paths:
  /health:
    get:
      operationId: get_health
      tags:
      - Health
      summary: Liveness probe that checks if the server is running
      x-source: https://docs.rustfs.com/en/installation/cloud-native
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetHealthResponse'
      x-evidence:
        kind: documentation
  /health/{healthid}:
    get:
      operationId: get_health_healthid
      tags:
      - Health
      summary: Liveness — returns 200 as long as the process is up
      x-source: https://docs.rustfs.com/en/operations/status-check
      parameters:
      - name: healthid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
        collapsed_from: 2 example path(s) differing only at healthId
components:
  schemas:
    GetHealthResponse:
      type: object
      properties:
        status:
          type: string