GridGain Cluster Management API
The Cluster Management API from GridGain — 3 operation(s) for cluster management.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/gridgain-cluster-management-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
openapi: 3.2.0
info:
x-logo:
url: https://www.gridgain.com/assets/web/images/gridgain-logo-2021.svg
backgroundColor: '#FFFFFF'
altText: Example logo
title: GridGain REST module Cluster Management API
contact:
email: user@ignite.apache.org
license:
name: Apache 2.0
url: https://ignite.apache.org
version: 9.1.22
servers:
- url: http://localhost:10300
description: Default GridGain 9 management API
- url: http://localhost:8080/ignite
description: GridGain 8 / Ignite REST API
security:
- bearerToken: []
- basicAuth: []
tags:
- name: Cluster Management
paths:
/management/v1/cluster/init:
post:
tags:
- Cluster Management
summary: Initialize cluster
description: Initialize a new cluster.
operationId: init
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InitCommand'
required: true
responses:
'200':
description: Cluster initialized.
'500':
description: Internal error.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'400':
description: Incorrect configuration.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
/management/v1/cluster/rename:
post:
tags:
- Cluster Management
summary: Rename cluster
description: Assigns a new name to the cluster.
operationId: rename
requestBody:
description: the new name of the cluster.
content:
text/plain:
schema:
type: string
required: true
responses:
'200':
description: Cluster renamed.
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterTag'
application/problem+json:
schema:
$ref: '#/components/schemas/ClusterTag'
'500':
description: Internal error.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'400':
description: Invalid name.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
/management/v1/cluster/state:
get:
tags:
- Cluster Management
summary: Get cluster state
description: Returns current cluster status.
operationId: clusterState
responses:
'200':
description: Cluster status returned.
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterState'
'404':
description: Cluster status not found. Most likely, the cluster is not initialized.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'500':
description: Internal error.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
components:
schemas:
InvalidParam:
type: object
properties:
name:
type: string
description: Parameter name.
reason:
type: string
description: The issue with the parameter.
description: Information about invalid request parameter.
Problem:
type: object
properties:
title:
type: string
description: Short summary of the issue.
status:
type: integer
description: Returned HTTP status code.
format: int32
code:
type: string
description: Ignite 3 error code.
type:
type: string
description: URI to documentation regarding the issue.
detail:
type: string
description: Extended explanation of the issue.
node:
type: string
description: Name of the node the issue happened on.
traceId:
type: string
description: Unique issue identifier. This identifier can be used to find logs related to the issue.
format: uuid
invalidParams:
type: array
description: A list of parameters that did not pass validation and the reason for it.
items:
$ref: '#/components/schemas/InvalidParam'
description: Extended description of the problem with the request.
ClusterState:
type: object
properties:
cmgNodes:
type: array
description: List of cluster management group nodes. These nodes are responsible for maintaining RAFT cluster topology.
items:
type: string
msNodes:
type: array
description: List of metastorage nodes. These nodes are responsible for storing RAFT cluster metadata.
items:
type: string
igniteVersion:
type: string
description: Version of Apache Ignite that the cluster was created on.
clusterTag:
allOf:
- $ref: '#/components/schemas/ClusterTag'
- description: Unique tag that identifies the cluster.
formerClusterIds:
type:
- array
- 'null'
description: IDs the cluster had before.
items:
type: string
format: uuid
description: Information about current cluster state.
InitCommand:
required:
- license
type: object
properties:
metaStorageNodes:
type: array
description: A list of RAFT metastorage nodes.
items:
type: string
cmgNodes:
type: array
description: A list of RAFT cluster management nodes.
items:
type: string
clusterName:
type: string
description: The name of the cluster.
clusterConfiguration:
type: string
description: Cluster configuration in HOCON format.
license:
type: string
description: Cluster license.
description: Cluster initialization configuration.
ClusterTag:
type: object
properties:
clusterId:
type: string
description: Unique cluster UUID. Generated automatically.
format: uuid
clusterName:
type: string
description: Unique cluster name.
description: Unique tag that identifies the cluster.
securitySchemes:
basicAuth:
type: http
scheme: basic
bearerToken:
type: http
scheme: bearer