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

Helidon Health API

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

Helidon Health API is one of 4 APIs that Helidon 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 1 schema. It is described by OpenAPI 3.0.3, at version 4.1.0.

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

4 operations 4 paths 1 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
4.1.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
/observe/health
Helidon Overall health status
getHealth → 200503
GET
/observe/health/live
Helidon Liveness check
getLiveness → 200503
GET
/observe/health/ready
Helidon Readiness check
getReadiness → 200503
GET
/observe/health/started
Helidon Startup check
getStartup → 200503

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is HealthCheckResponse (2 properties). Each schema is shown below with its type and property counts.

HealthCheckResponse
object
MicroProfile Health response
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

helidon-health-api-openapi.yml Raw ↑

Other APIs Helidon publishes across the network.

Helidon Info API
Helidon Metrics API
Helidon OpenAPI API