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.
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 authentication System 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: system
paths:
/management/v1/recovery/cluster/migrate:
post:
tags:
- system
description: Migrates nodes from old cluster to new (repaired) cluster.
operationId: migrate
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MigrateRequest'
required: true
responses:
'200':
description: Migration initiated.
'500':
description: Internal error.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'400':
description: Bad request.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
/management/v1/recovery/cluster/reset:
post:
tags:
- system
description: Initiates cluster reset to repair CMG/Metastorage group/both.
operationId: resetCluster
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResetClusterRequest'
required: true
responses:
'200':
description: Cluster reset initiated.
'500':
description: Internal error.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'400':
description: Bad request.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
components:
schemas:
ResetClusterRequest:
type: object
properties:
cmgNodeNames:
type:
- array
- 'null'
description: Names of the proposed CMG nodes. Optional if the MG group is being repaired. If not specified, the current CMG nodes are used.
items:
type: string
metastorageReplicationFactor:
type:
- integer
- 'null'
description: Number of nodes in the voting member set of the Metastorage RAFT group.
format: int32
description: Reset cluster.
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.
MigrateRequest:
type: object
properties:
cmgNodes:
type: array
description: Names of the CMG node names.
items:
type: string
metaStorageNodes:
type: array
description: Names of the Metastorage node names.
items:
type: string
version:
type: string
description: Ignite version.
clusterId:
type: string
description: ID of the cluster.
format: uuid
clusterName:
type: string
description: Name of the cluster.
formerClusterIds:
type:
- array
- 'null'
description: IDs the cluster had before. If CMG/Metastorage group were never repaired, this is null.
items:
type: string
format: uuid
description: Migrate nodes to new cluster.
securitySchemes:
basicAuth:
type: http
scheme: basic
bearerToken:
type: http
scheme: bearer