Apache Helix

Apache Helix is a generic cluster management framework for partitioned and replicated distributed resources. It automates partition management, replication, fault tolerance, and cluster expansion for distributed systems, providing a REST API for cluster administration and a Java API for participant, spectator, and controller roles.

Apache Helix publishes 4 APIs on the APIs.io network, including Clusters API, Instances API, Resources API, and 1 more. Tagged areas include Apache, Cluster Management, Distributed Systems, Open Source, and Partitioning.

The Apache Helix catalog on APIs.io includes 1 JSON-LD context and 2 Spectral governance rulesets.

Apache Helix’s developer surface includes documentation, getting-started guide, and 7 more developer resources.

🌐 Visit website 📡 Source on GitHub

46.0/100 developing ▼ -5.9 Agent 22/100 agent aware Full breakdown ↓
scored 2026-07-28 · rubric v0.6

AccessFreemium

5 APIs 8 Features 5 Use Cases

ApacheCluster ManagementDistributed SystemsOpen SourcePartitioningReplication

Kin Score

Kin Score How this is scored →
scored 2026-07-28 · rubric v0.6

Composite quality — 46.0/100 · developing

Contract Quality 14.6 / 25

Developer Ergonomics 3.9 / 20

Commercial Clarity 7.9 / 20

Operational Transparency 4.8 / 13

Governance 8.3 / 12

Discoverability 6.5 / 10

Agent readiness — 22/100 · agent aware

Machine-Readable Contract 18 / 18

Agentic Access Contract 10 / 10

MCP Server 0 / 12

Machine-Readable Auth 0 / 10

Idempotency 0 / 9

Stable Error Semantics 0 / 8

Request/Response Examples 0 / 7

Rate-Limit Signaling 7 / 7

Typed Event Surface 0 / 6

Agent Skills 0 / 5

Well-Known Catalog 0 / 4

Consent & Bot Identity 0 / 3

A2A Agent Card 0 / 8

Dry-Run / Simulate Mode 0 / 4

Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/apache-helix: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 5

Individual APIs this provider publishes, each with its own machine-readable definition.

Apache Helix Java API

Java API for implementing Helix participant, spectator, and controller roles, with APIs for resource management, task execution, and state machine definitions.

Apache Helix Clusters API

Cluster management operations

Apache Helix Instances API

Instance management operations

Apache Helix Resources API

Resource management operations

Apache Helix State API

Partition state operations

Open Collections 1

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

Apache Helix REST API

OPEN COLLECTION

Pricing Plans 1

Published pricing tiers and plan structures.

Apache Helix Plans Pricing

3 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Apache Helix Rate Limits

5 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Apache Helix Finops

FINOPS

Features 8

Notable capabilities this provider offers.

Automatic Partition Management

Automatically assign and balance partitions across cluster nodes using pluggable rebalancer algorithms.

State Machine Framework

Define custom resource state machines (e.g., Master-Slave, Leader-Standby) for any distributed service.

Fault Tolerance

Detect node failures and automatically reassign partitions to maintain replication targets.

REST API

HTTP REST API for cluster administration, resource management, and state inspection.

Task Framework

Distributed task scheduling framework for batch jobs and recurring workflows with failure handling.

ZooKeeper Integration

Uses Apache ZooKeeper as the distributed coordination backend for cluster state storage.

Spectator API

Read-only API for external services to observe resource state and routing decisions.

Cloud-Aware Rebalancing

Rack and zone-aware partition placement for fault-domain isolation in cloud environments.

Scroll for all 8

JSON Schema 6

Standalone JSON Schema definitions for this provider's data models.

Examples 6

Example request and response payloads for these APIs.

Use Cases 5

What developers build with this provider.

Distributed Database Cluster Management

Manage shard assignment and replication for distributed databases like DistributedLog or Espresso.

Search Index Partition Management

Automatically balance and assign search index shards across a cluster of query servers.

Distributed Task Scheduling

Schedule and execute distributed batch tasks with automatic retry and failure recovery.

Microservices Load Balancing

Use Helix spectator API to implement client-side load balancing based on partition state.

Stateful Service Migration

Perform rolling upgrades and partition migrations without service downtime.

Integrations 4

Pre-built integrations with other platforms and tools.

Apache ZooKeeper

ZooKeeper is the required coordination backend for Helix cluster state management.

Apache Kafka

Helix is used internally by some Kafka ecosystem projects for partition management.

LinkedIn Pinot

Apache Pinot uses Helix for real-time OLAP cluster partition and segment management.

LinkedIn Venice

Venice feature store uses Helix for managing data store partition assignments.

Resources

Get Started 1

Portal, sign-up, and the first successful call

GettingStarted

GettingStarted

Documentation 1

Reference material describing how the API behaves

Documentation

Documentation

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess

AgenticAccess

Design & Contract 2

Pagination, idempotency, versioning, errors, and events

SpectralRules

SpectralRules

Vocabulary

Vocabulary

Build 2

SDKs, sample code, and the tooling you integrate with

GitHubOrganization

GitHubOrganization

GitHubRepository

GitHubRepository

Access & Security 2

Authentication, authorization, and security posture

VulnerabilityDisclosure

VulnerabilityDisclosure

DomainSecurity

DomainSecurity

Source (apis.yml)

aid: apache-helix
name: Apache Helix
description: Apache Helix is a generic cluster management framework for partitioned and replicated distributed resources.
  It automates partition management, replication, fault tolerance, and cluster expansion for distributed systems, providing
  a REST API for cluster administration and a Java API for participant, spectator, and controller roles.
type: Index
accessModel:
  pricing: freemium
  onboarding: unknown
  trial: false
  try_now: false
  public: false
  label: Freemium
  confidence: medium
  source:
  - plans
  generated: '2026-07-22'
  method: derived
position: Consumer
access: 3rd-Party
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/apache-helix.png
tags:
- Apache
- Cluster Management
- Distributed Systems
- Open Source
- Partitioning
- Replication
created: '2026-03-16'
modified: '2026-05-19'
url: https://raw.githubusercontent.com/api-evangelist/apache-helix/refs/heads/main/apis.yml
specificationVersion: '0.19'
apis:
- aid: apache-helix:apache-helix-java-api
  name: Apache Helix Java API
  description: Java API for implementing Helix participant, spectator, and controller roles, with APIs for resource management,
    task execution, and state machine definitions.
  humanURL: https://helix.apache.org/0.9.9-docs/tutorial_participant.html
  tags:
  - Java
  - SDK
  - State Machine
  properties:
  - type: Documentation
    url: https://helix.apache.org/0.9.9-docs/tutorial_participant.html
  - type: SDKs
    url: https://search.maven.org/artifact/org.apache.helix/helix-core
    title: Java SDK (Maven Central)
- aid: apache-helix:apache-helix-clusters-api
  name: Apache Helix Clusters API
  description: Cluster management operations
  humanURL: https://helix.apache.org/0.9.9-docs/tutorial_admin.html
  baseURL: http://localhost:9100
  tags:
  - Clusters
  properties:
  - type: OpenAPI
    url: openapi/apache-helix-clusters-api-openapi.yml
  - type: Documentation
    url: https://helix.apache.org/0.9.9-docs/tutorial_admin.html
  - type: JSONSchema
    url: json-schema/helix-rest-cluster-schema.json
  - type: JSONLD
    url: json-ld/apache-helix-rest-context.jsonld
- aid: apache-helix:apache-helix-instances-api
  name: Apache Helix Instances API
  description: Instance management operations
  humanURL: https://helix.apache.org/0.9.9-docs/tutorial_admin.html
  baseURL: http://localhost:9100
  tags:
  - Instances
  properties:
  - type: OpenAPI
    url: openapi/apache-helix-instances-api-openapi.yml
  - type: Documentation
    url: https://helix.apache.org/0.9.9-docs/tutorial_admin.html
  - type: JSONSchema
    url: json-schema/helix-rest-cluster-schema.json
  - type: JSONLD
    url: json-ld/apache-helix-rest-context.jsonld
- aid: apache-helix:apache-helix-resources-api
  name: Apache Helix Resources API
  description: Resource management operations
  humanURL: https://helix.apache.org/0.9.9-docs/tutorial_admin.html
  baseURL: http://localhost:9100
  tags:
  - Resources
  properties:
  - type: OpenAPI
    url: openapi/apache-helix-resources-api-openapi.yml
  - type: Documentation
    url: https://helix.apache.org/0.9.9-docs/tutorial_admin.html
  - type: JSONSchema
    url: json-schema/helix-rest-cluster-schema.json
  - type: JSONLD
    url: json-ld/apache-helix-rest-context.jsonld
- aid: apache-helix:apache-helix-state-api
  name: Apache Helix State API
  description: Partition state operations
  humanURL: https://helix.apache.org/0.9.9-docs/tutorial_admin.html
  baseURL: http://localhost:9100
  tags:
  - State
  properties:
  - type: OpenAPI
    url: openapi/apache-helix-state-api-openapi.yml
  - type: Documentation
    url: https://helix.apache.org/0.9.9-docs/tutorial_admin.html
  - type: JSONSchema
    url: json-schema/helix-rest-cluster-schema.json
  - type: JSONLD
    url: json-ld/apache-helix-rest-context.jsonld
common:
- type: AgenticAccess
  url: agentic-access/apache-helix-agentic-access.yml
- type: VulnerabilityDisclosure
  url: security/apache-helix-vulnerability-disclosure.yml
- type: DomainSecurity
  url: security/apache-helix-domain-security.yml
- type: Documentation
  url: https://helix.apache.org/
- type: GettingStarted
  url: https://helix.apache.org/0.9.9-docs/Quickstart.html
- type: GitHubOrganization
  url: https://github.com/apache
- type: GitHubRepository
  url: https://github.com/apache/helix
- type: SpectralRules
  url: rules/apache-helix-spectral-rules.yml
- type: Vocabulary
  url: vocabulary/apache-helix-vocabulary.yaml
- type: Features
  data:
  - name: Automatic Partition Management
    description: Automatically assign and balance partitions across cluster nodes using pluggable rebalancer algorithms.
  - name: State Machine Framework
    description: Define custom resource state machines (e.g., Master-Slave, Leader-Standby) for any distributed service.
  - name: Fault Tolerance
    description: Detect node failures and automatically reassign partitions to maintain replication targets.
  - name: REST API
    description: HTTP REST API for cluster administration, resource management, and state inspection.
  - name: Task Framework
    description: Distributed task scheduling framework for batch jobs and recurring workflows with failure handling.
  - name: ZooKeeper Integration
    description: Uses Apache ZooKeeper as the distributed coordination backend for cluster state storage.
  - name: Spectator API
    description: Read-only API for external services to observe resource state and routing decisions.
  - name: Cloud-Aware Rebalancing
    description: Rack and zone-aware partition placement for fault-domain isolation in cloud environments.
- type: UseCases
  data:
  - name: Distributed Database Cluster Management
    description: Manage shard assignment and replication for distributed databases like DistributedLog or Espresso.
  - name: Search Index Partition Management
    description: Automatically balance and assign search index shards across a cluster of query servers.
  - name: Distributed Task Scheduling
    description: Schedule and execute distributed batch tasks with automatic retry and failure recovery.
  - name: Microservices Load Balancing
    description: Use Helix spectator API to implement client-side load balancing based on partition state.
  - name: Stateful Service Migration
    description: Perform rolling upgrades and partition migrations without service downtime.
- type: Integrations
  data:
  - name: Apache ZooKeeper
    description: ZooKeeper is the required coordination backend for Helix cluster state management.
  - name: Apache Kafka
    description: Helix is used internally by some Kafka ecosystem projects for partition management.
  - name: LinkedIn Pinot
    description: Apache Pinot uses Helix for real-time OLAP cluster partition and segment management.
  - name: LinkedIn Venice
    description: Venice feature store uses Helix for managing data store partition assignments.
maintainers:
- FN: Kin Lane
  email: info@apievangelist.com