Restate

Restate Cluster Health API

Cluster health

GitHub OpenAPI

Operations 1

GET /cluster-health Cluster Health #

Documentation

📖
Documentation
https://docs.restate.dev/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/restate/refs/heads/main/openapi/restate-cluster-health-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/restatedev/restate

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/restate/refs/heads/main/json-schema/restate-deployment-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/restate/refs/heads/main/json-schema/restate-invocation-schema.json

Other Resources

🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/restate/refs/heads/main/vocabulary/restate-vocabulary.yml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/restate/refs/heads/main/crd/restateclusters.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/restate/refs/heads/main/crd/restatedeployments.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/restate/refs/heads/main/crd/restatecloudenvironments.yaml
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/restate/refs/heads/main/apis.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/restate-cluster-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

restate-cluster-health-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Admin Cluster Health API
  description: This API exposes the admin operations of a Restate cluster, such as registering new service deployments, interacting with running invocations, register Kafka subscriptions, retrieve service metadata. For an overview, check out the Operate documentation. If you're looking for how to call your services, check out the Ingress HTTP API instead.
  version: 1.4.0
tags:
- name: cluster_health
  description: Cluster health
paths:
  /cluster-health:
    get:
      tags:
      - cluster_health
      summary: Cluster Health
      description: Get the cluster health.
      operationId: cluster_health
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterHealthResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDescriptionResponse'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDescriptionResponse'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDescriptionResponse'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDescriptionResponse'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDescriptionResponse'
        '503':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDescriptionResponse'
components:
  schemas:
    ClusterHealthResponse:
      type: object
      required:
      - cluster_name
      properties:
        cluster_name:
          description: Cluster name
          type: string
        metadata_cluster_health:
          description: Embedded metadata cluster health if it was enabled
          allOf:
          - $ref: '#/components/schemas/EmbeddedMetadataClusterHealth'
    EmbeddedMetadataClusterHealth:
      type: object
      required:
      - members
      properties:
        members:
          description: Current members of the embedded metadata cluster
          type: array
          items:
            type: integer
            format: uint32
            minimum: 0.0
    ErrorDescriptionResponse:
      title: Error description response
      description: Error details of the response
      type: object
      required:
      - message
      properties:
        message:
          type: string
        restate_code:
          title: Restate code
          description: Restate error code describing this error
          type:
          - string
          - 'null'
externalDocs:
  url: https://docs.restate.dev/operate/