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

Wherobots Health API

The Health API from Wherobots — 1 operation(s) for health.

Wherobots Health API is one of 34 APIs that Wherobots 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 and API documentation.

This API exposes 1 operation across 1 path, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 0.0.1.

Requests are made against a single base URL, https://api.cloud.wherobots.com.

1 operations 1 paths 5 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.0.1
Base URL
https://api.cloud.wherobots.com
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Wherobots Health API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerToken). An API key is passed in the header as X-API-Key (wherobotsApiKey).

  • wherobotsApiKey — A Wherobots-generated API key

Paths & Operations 1

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

Health 1
GET
/health
Health check
healthCheck → 200400401403404409422500

Schemas 5

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

HealthResponse
object
Health check response with optional detailed component checks.
2 properties 1 required
ErrorInfo
object
7 properties 4 required
HealthCheckDetail
object
Detail for an individual health check component.
2 properties 1 required
ErrorClass
string
ErrorBody
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wherobots-health-api-openapi.yml Raw ↑

Other APIs Wherobots publishes across the network.

Wherobots apikey API
Wherobots audit-log API
Wherobots catalogs API
Wherobots cloud-connections API
Wherobots coupon API
Wherobots environment-override--preset API
Wherobots environment-preset API
Wherobots files API
Wherobots Flags API
Wherobots foreign-catalog API
Wherobots Is Super User API
Wherobots jupyter_lab API