Apache Helix Instances API

Instance management operations

Operations 2

GET /clusters/{clusterId}/instances Apache Helix List Instances #
GET /clusters/{clusterId}/instances/{instanceName} Apache Helix Get Instance #

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/apache-helix-instances-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.

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

OpenAPI Specification

apache-helix-instances-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Apache Helix REST Clusters Instances API
  version: 1.0.0
  description: REST API for managing Apache Helix clusters, instances, resources, and partition state assignments in distributed systems.
  contact:
    email: dev@helix.apache.org
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:9100
  description: Helix REST Service
tags:
- name: Instances
  description: Instance management operations
paths:
  /clusters/{clusterId}/instances:
    get:
      operationId: listInstances
      summary: Apache Helix List Instances
      description: List all instances (participants) registered in a Helix cluster.
      tags:
      - Instances
      parameters:
      - name: clusterId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Instances listed
          content:
            application/json:
              schema:
                type: object
                properties:
                  instances:
                    type: array
                    items:
                      $ref: '#/components/schemas/Instance'
  /clusters/{clusterId}/instances/{instanceName}:
    get:
      operationId: getInstance
      summary: Apache Helix Get Instance
      description: Get configuration and state of a specific Helix instance.
      tags:
      - Instances
      parameters:
      - name: clusterId
        in: path
        required: true
        schema:
          type: string
      - name: instanceName
        in: path
        required: true
        schema:
          type: string
        description: Instance name (e.g. localhost_12913)
      responses:
        '200':
          description: Instance retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Instance'
        '404':
          description: Instance not found
components:
  schemas:
    Instance:
      type: object
      description: Helix cluster instance (participant) configuration
      properties:
        id:
          type: string
          description: Instance name
          example: localhost_12913
        hostName:
          type: string
          description: Hostname of the instance
          example: localhost
        port:
          type: integer
          description: Port number
          example: 12913
        enabled:
          type: boolean
          description: Whether the instance is enabled
          example: true
        tags:
          type: array
          items:
            type: string
          description: Instance tags