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

NaviStone Health API

Health checks

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

Tagged areas include Health. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 3 paths. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against the base URL https://docs.navistone.com.

3 operations 3 paths 0 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://docs.navistone.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

NaviStone Health API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-Key (api-key).

  • api-key — API Key for authentication

Paths & Operations 3

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

Health 3

Health checks

GET
/api/health
Health check endpoint with database connectivity
HealthController_check → 200503
GET
/api/health/live
Liveness probe - checks if app is running
HealthController_liveness → 200
GET
/api/health/ready
Readiness probe - checks if app is ready to serve traffic including database
HealthController_readiness → 200503

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

navistone-health-api-openapi.yml Raw ↑

Other APIs NaviStone publishes across the network.

NaviStone API Info API
NaviStone Campaigns API
NaviStone Clients API
NaviStone Domains API
NaviStone Geo Targeting API
NaviStone Output API
NaviStone Segments API