EHRbase

EHRbase Status and Metrics API

A version heartbeat at /rest/status reporting the running EHRbase, openEHR SDK, Archie, JVM, OS and PostgreSQL versions, plus the Spring Boot Actuator surface at /management providing health, liveness, readiness, metrics and Prometheus scrape endpoints. The Actuator surface is disabled by default and its exposure is configurable as admin-only, private or public.

GitHub OpenAPI

Operations 1

GET /rest/status Get status information on running EHRbase server instance #

Documentation

📖
Documentation
https://docs.ehrbase.org/docs/EHRbase/Explore/Status-And-Metrics

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ehrbase/refs/heads/main/openapi/ehrbase-status-api-openapi.json

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/ehrbase/refs/heads/main/overlays/ehrbase-status-overlay.yaml

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/status-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

ehrbase-status-api-openapi.json Raw ↑ 
{"openapi":"3.1.0","info":{"title":"EHRbase API","description":"EHRbase implements the [official openEHR REST API](https://specifications.openehr.org/releases/ITS-REST/latest/). Additionally, EHRbase provides a custom `status` heartbeat endpoint, an [Admin API](https://docs.ehrbase.org/docs/EHRbase/Explore/Admin-REST) (if activated) and a [Status and Metrics API](https://docs.ehrbase.org/docs/EHRbase/Explore/Status-And-Metrics) (if activated) for monitoring and maintenance.  Note: The openEHR REST API is documented in their official documentation, not here. Please refer to their separate documentation.","license":{"name":"Apache 2.0","url":"https://github.com/ehrbase/ehrbase/blob/develop/LICENSE.md"},"version":"v1"},"externalDocs":{"description":"EHRbase Documentation","url":"https://docs.ehrbase.org/"},"servers":[{"url":"https://sandkiste.ehrbase.org/ehrbase","description":"Generated server url"}],"tags":[{"name":"Status","description":"Heartbeat, Version info, Status"}],"paths":{"/rest/status":{"get":{"tags":["Status"],"summary":"Get status information on running EHRbase server instance","operationId":"getEhrbaseStatus","parameters":[{"name":"Accept","in":"header","description":"Client desired response data format","required":false,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"EHRbase is available. Basic information on runtime and build is returned in body.","headers":{"Content-Type":{"description":"Format of response","style":"simple"}},"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/StatusResponseData"}},"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponseData"}}}}}}}},"components":{"schemas":{"StatusResponseData":{"type":"object","properties":{"ehrbase_version":{"type":"string"},"openehr_sdk_version":{"type":"string"},"archie_version":{"type":"string"},"jvm_version":{"type":"string"},"os_version":{"type":"string"},"postgres_version":{"type":"string"}}}}}}