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

Actor Model Health API

System health and diagnostics

This API exposes 2 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.example.com/actor-system/v1.

2 operations 2 paths 1 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Server
https://api.example.com/actor-system/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Actor Model Health API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — Bearer token for actor system management API access

Paths & Operations 2

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

Health 2

System health and diagnostics

GET
/health
Actor Model Get System Health
getHealth → 200
GET
/health/ready
Actor Model Get Readiness
getReadiness → 200503

Schemas 1

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

SystemHealth
object
Overall health status of the actor system
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

actor-model-health-api-openapi.yml Raw ↑