Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Quarkus Health API

The Health API from Quarkus — 4 operation(s) for health.

Quarkus Health API is one of 5 APIs that Quarkus publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Health. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and 1 JSON Schema.

This API exposes 4 operations across 4 paths, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version 3.17.0.

Requests are made against a single base URL, http://localhost:8080.

4 operations 4 paths 2 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
3.17.0
Server
http://localhost:8080
License
Resource Areas
1

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

Health 4
GET
/q/health
Quarkus Overall health check
getHealth → 200503
GET
/q/health/live
Quarkus Liveness health check
getLiveness → 200503
GET
/q/health/ready
Quarkus Readiness health check
getReadiness → 200503
GET
/q/health/started
Quarkus Startup health check
getStartup → 200503

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are HealthCheck (3 properties), HealthResponse (2 properties). Each schema is shown below with its type and property counts.

HealthCheck
object
3 properties
HealthResponse
object
MicroProfile Health response format
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

quarkus-health-api-openapi.yml Raw ↑

Other APIs Quarkus publishes across the network.

Quarkus Dev UI API
Quarkus Info API
Quarkus Metrics API
Quarkus OpenAPI API