Apache Helix State API

Partition state operations

Operations 2

GET /clusters/{clusterId}/resources/{resourceName}/externalView Apache Helix Get External View #
GET /clusters/{clusterId}/resources/{resourceName}/idealState Apache Helix Get Ideal State #

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-state-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-state-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Apache Helix REST Clusters State 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: State
  description: Partition state operations
paths:
  /clusters/{clusterId}/resources/{resourceName}/externalView:
    get:
      operationId: getExternalView
      summary: Apache Helix Get External View
      description: Get the current external view showing actual partition state assignments across instances.
      tags:
      - State
      parameters:
      - name: clusterId
        in: path
        required: true
        schema:
          type: string
      - name: resourceName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: External view retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalView'
  /clusters/{clusterId}/resources/{resourceName}/idealState:
    get:
      operationId: getIdealState
      summary: Apache Helix Get Ideal State
      description: Get the ideal state (desired partition placement) for a Helix resource.
      tags:
      - State
      parameters:
      - name: clusterId
        in: path
        required: true
        schema:
          type: string
      - name: resourceName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Ideal state retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdealState'
components:
  schemas:
    IdealState:
      type: object
      description: Desired ideal state for resource partition placement
      properties:
        id:
          type: string
          description: Resource name
          example: my-resource
        stateModelDefRef:
          type: string
          description: State model reference
          example: MasterSlave
        mapFields:
          type: object
          description: Map of partition to desired instance state map
    ExternalView:
      type: object
      description: Current external view showing actual partition states across instances
      properties:
        id:
          type: string
          description: Resource name
          example: my-resource
        mapFields:
          type: object
          description: Map of partition to instance state map