Redocly

Redocly Health API

Operations related to health checks.

GitHub OpenAPI

Operations 1

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /health Check the Scout worker's health · Get health status #
Ask an LLM
“Is the Redocly Scout worker up and healthy?”
“Can I ping Scout to confirm it is responding?”
Tell an agent
Check the Scout worker health status.
Ping the Scout health endpoint and tell me if it's up.

Documentation

📖
Documentation
https://redocly.com/docs/realm/customization/search-api/openapi
📖
Documentation
https://redocly.com/docs/realm/customization/mcp-server
📖
Documentation
https://redocly.com/docs/realm/scout
📖
Authentication
https://artifacts.apis.io/redocly/authentication/redocly-authentication.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/redocly/openapi/redocly-health-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/redocly/json-schema/redocly-health-schema.json

Other Resources

🔗
ErrorCatalog
https://artifacts.apis.io/redocly/errors/redocly-problem-types.yml
🔗
ToolCrosswalk
https://artifacts.apis.io/redocly/mcp/redocly-tool-crosswalk.yml
🔗
Reference
https://redocly.com/docs/realm/customization/mcp-server/openapi
🔗
DataModel
https://artifacts.apis.io/redocly/data-model/redocly-data-model.yml
🔗
Webhooks
https://artifacts.apis.io/redocly/asyncapi/redocly-webhooks.yml

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/redocly:redocly-health-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

redocly-health-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: '1.0'
  title: Redocly Scout agent Health API
  description: Scout Worker API.
  termsOfService: https://redocly.com/subscription-agreement
  contact:
    name: Redocly Support
    email: team@redocly.com
    url: https://github.com/Redocly/redocly
  license:
    name: Redocly
    url: https://redocly.com/subscription-agreement
servers:
- url: '{host}'
  variables:
    host:
      default: http://localhost
      description: Server host.
tags:
- name: Health
  description: Operations related to health checks.
paths:
  /health:
    get:
      tags:
      - Health
      security: []
      summary: Get health status
      operationId: health
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Health'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  responses:
    BadRequest:
      description: Bad Request.
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                description: Error type.
                example: about:blank
              title:
                type: string
                description: Error title.
                example: Unauthorized
              status:
                type: integer
                description: HTTP status code generated by the origin server for this occurrence of the problem.
                example: 401
              detail:
                type: string
                description: A human-readable message with more details.
                example: The request doesn't contain a GitHub signature
            required:
            - detail
    InternalServerError:
      description: Internal Server Error.
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                description: Error type.
                example: about:blank
              title:
                type: string
                description: Error title.
                example: Internal server error
              status:
                type: integer
                description: HTTP status code generated by the origin server for this occurrence of the problem.
                example: 500
              detail:
                type: string
                description: A human-readable message with more details.
                example: Disk space is full
              event:
                type: string
                description: Type of incoming webhook event.
                example: push
            required:
            - detail
  schemas:
    Health:
      type: object
      properties:
        scout:
          type: string
          const: ok
          readOnly: true
          description: Scout health status.
      required:
      - scout
  securitySchemes:
    GithubApiKey:
      type: apiKey
      in: header
      name: x-hub-signature-256
    GitlabApiKey:
      type: apiKey
      in: header
      name: x-gitlab-token
x-pagination: none