Red Hat 3scale

Red Hat 3scale Health API

Health check and liveness/readiness probes

Documentation GitHub OpenAPI

Operations 3

GET /status/ready Check Readiness #

GET /status/live Check Liveness #

GET /status/info Get Status Information #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/red-hat-3scale-health-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Red Hat 3scale APIcast Management Health API
  description: The APIcast Management API is an HTTP REST interface exposed by the APIcast API gateway on port 8090 for debugging and runtime configuration management. It provides endpoints to retrieve and update the gateway configuration, inspect DNS cache state, trigger boot/initialization sequences, and check readiness and liveness health status. Access level is controlled via the APICAST_MANAGEMENT_API environment variable (debug, status, or disabled). This API is intended for debugging and is not production-hardened.
  version: '1'
  contact:
    name: Red Hat 3scale Support
    url: https://access.redhat.com/support
  termsOfService: https://www.redhat.com/en/about/agreements
servers:
- url: http://localhost:8090
  description: APIcast Management API (local)
tags:
- name: Health
  description: Health check and liveness/readiness probes
paths:
  /status/ready:
    get:
      operationId: getReadiness
      summary: Check Readiness
      description: Returns the readiness status of the APIcast gateway. Used as a Kubernetes readiness probe. Returns 200 when the gateway is ready to accept traffic, non-200 when not ready.
      tags:
      - Health
      responses:
        '200':
          description: Gateway is ready
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadinessStatus'
        '503':
          description: Gateway is not ready
  /status/live:
    get:
      operationId: getLiveness
      summary: Check Liveness
      description: Returns the liveness status of the APIcast gateway. Used as a Kubernetes liveness probe. Returns 200 if the process is alive.
      tags:
      - Health
      responses:
        '200':
          description: Gateway is alive
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LivenessStatus'
  /status/info:
    get:
      operationId: getStatusInfo
      summary: Get Status Information
      description: Returns internal information about the APIcast gateway including timer states, worker process counts, and internal configuration parameters useful for debugging.
      tags:
      - Health
      responses:
        '200':
          description: Status information returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusInfo'
components:
  schemas:
    LivenessStatus:
      type: object
      properties:
        success:
          type: boolean
    StatusInfo:
      type: object
      properties:
        timers:
          type: object
          additionalProperties: true
        workers:
          type: integer
          description: Number of worker processes
    ReadinessStatus:
      type: object
      properties:
        success:
          type: boolean
        status:
          type: string
          enum:
          - ready
          - not_ready
externalDocs:
  description: APIcast Management API Documentation
  url: https://github.com/3scale/APIcast/blob/master/doc/management-api.md