Example logo
API docs by Redocly

GridGain REST module (9.1.0)

Download OpenAPI specification:

E-mail: user@ignite.apache.org License: Apache 2.0

authentication

Revoke all JWTs

Revoke all issued JWTs.

Authorizations:
bearerTokenbasicAuth
query Parameters
username
required
string

Username to revoke all issued JWTs from.

Responses

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

Revoke JWT

Revoke a specific JWT.

Authorizations:
bearerTokenbasicAuth
path Parameters
token
required
string

JWT to revoke.

Responses

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

Get JWT

Get JWT for the user.

Authorizations:
bearerTokenbasicAuth
Request Body schema: application/json
required
username
string

Username

password
string

Password

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

clusterManagement

Initialize cluster

Initialize a new cluster.

Authorizations:
bearerTokenbasicAuth
Request Body schema: application/json
required
metaStorageNodes
Array of strings

A list of RAFT metastorage nodes.

cmgNodes
Array of strings

A list of RAFT cluster management nodes.

clusterName
string

The name of the cluster.

clusterConfiguration
string

Cluster configuration in HOCON format.

license
required
string

Cluster license.

Responses

Request samples

Content type
application/json
{
  • "metaStorageNodes": [
    ],
  • "cmgNodes": [
    ],
  • "clusterName": "string",
  • "clusterConfiguration": "string",
  • "license": "string"
}

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

Get cluster state

Returns current cluster status.

Authorizations:
bearerTokenbasicAuth

Responses

Response samples

Content type
application/json
{
  • "cmgNodes": [
    ],
  • "msNodes": [
    ],
  • "igniteVersion": "string",
  • "clusterTag": {
    },
  • "formerClusterIds": [
    ]
}

topology

Get logical topology

Gets information about logical cluster topology.

Authorizations:
bearerTokenbasicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get physical topology

Gets information about physical cluster topology.

Authorizations:
bearerTokenbasicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

compute

Retrieve all job states

Fetches the current states of all compute jobs.

Authorizations:
bearerTokenbasicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve job state

Fetches the current state of a specific compute job identified by jobId.

Authorizations:
bearerTokenbasicAuth
path Parameters
jobId
required
string <uuid>

The unique identifier of the compute job.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "QUEUED",
  • "createTime": "2019-08-24T14:15:22Z",
  • "startTime": "2019-08-24T14:15:22Z",
  • "finishTime": "2019-08-24T14:15:22Z"
}

Cancel job

Cancels a specific compute job identified by jobId.

Authorizations:
bearerTokenbasicAuth
path Parameters
jobId
required
string <uuid>

The unique identifier of the compute job.

Responses

Response samples

Content type
application/json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

Update job priority

Updates the priority of a specific compute job identified by jobId.

Authorizations:
bearerTokenbasicAuth
path Parameters
jobId
required
string <uuid>

The unique identifier of the compute job.

Request Body schema: application/json
required

The new priority data for the job.

priority
required
integer <int32>

Priority.

Responses

Request samples

Content type
application/json
{
  • "priority": 0
}

Response samples

Content type
application/json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

clusterConfiguration

Get cluster configuration

Gets the current configuration of the cluster. The configuration is returned in HOCON format.

Authorizations:
bearerTokenbasicAuth

Responses

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

Update cluster configuration

Updates cluster configuration. New configuration should be provided in HOCON format.

Authorizations:
bearerTokenbasicAuth
Request Body schema: text/plain
required

The cluster configuration to update.

string

Responses

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

Get configuration represented by path

Gets the configuration on the specific path. Configuration is in HOCON format

Authorizations:
bearerTokenbasicAuth
path Parameters
path
required
string

Configuration tree address. For example: element.subelement.

Responses

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

nodeConfiguration

Get node configuration

Gets node configuration in HOCON format.

Authorizations:
bearerTokenbasicAuth

Responses

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

Update node configuration

Updates node configuration. New configuration should be provided in HOCON format.

Authorizations:
bearerTokenbasicAuth
Request Body schema: text/plain
required

The node configuration to update.

string

Responses

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

Get configuration represented by path

Gets a configuration of a specific node, in HOCON format.

Authorizations:
bearerTokenbasicAuth
path Parameters
path
required
string

Configuration tree address. For example: element.subelement.

Responses

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

dcr

Retrieve a list of replications for connected clusters

Retrieves a list of replications for connected clusters.

Authorizations:
bearerTokenbasicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new replication for a cluster

Creates a new replication for a cluster.

Authorizations:
bearerTokenbasicAuth
Request Body schema: application/json
required

Details of the replication to create.

name
string

Replication name.

sourceClusterAddresses
Array of strings

List of node addresses of the source cluster.

object or null

Auth config of the connection to the source cluster.

object or null

SSL config of the connection to the source cluster.

replicationNodes
Array of strings

List of replication nodes names on target cluster.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "sourceClusterAddresses": [
    ],
  • "authConfig": {
    },
  • "sslConfig": {
    },
  • "replicationNodes": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "sourceClusterAddresses": [
    ],
  • "authConfig": {
    },
  • "sslConfig": {
    },
  • "sourceClusterName": "string",
  • "targetClusterName": "string",
  • "workerNodeName": "string",
  • "schemaName": "string",
  • "status": "REPLICATING",
  • "tableStatuses": [
    ],
  • "errors": [
    ],
  • "fstProgress": 0
}

Get information about specific replication

Retrieves detailed information about a specific replication.

Authorizations:
bearerTokenbasicAuth
path Parameters
name
required
string

The unique identifier of the replication to show.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "sourceClusterAddresses": [
    ],
  • "authConfig": {
    },
  • "sslConfig": {
    },
  • "sourceClusterName": "string",
  • "targetClusterName": "string",
  • "workerNodeName": "string",
  • "schemaName": "string",
  • "status": "REPLICATING",
  • "tableStatuses": [
    ],
  • "errors": [
    ],
  • "fstProgress": 0
}

Delete replication

Deletes the specified replication.

Authorizations:
bearerTokenbasicAuth
path Parameters
name
required
string

The name of the replication to delete.

Responses

Response samples

Content type
application/json
true

Specifies timestamp for replication which will be used as flush point.

.

Authorizations:
bearerTokenbasicAuth
path Parameters
name
required
string

The name of the replication to flush.

Request Body schema: application/json
required
flushPoint
string <date-time>

Flush point timestamp.

Responses

Request samples

Content type
application/json
{
  • "flushPoint": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
true

Start replication

Starts the specified replication.

Authorizations:
bearerTokenbasicAuth
path Parameters
name
required
string

The unique identifier of the replication to start.

Request Body schema: application/json
required
schemaName
string
Default: "PUBLIC"

Schema name for replication.

allTables
boolean or null

If true, all tables will be replicated.

tables
Array of strings or null

List of table names to be replicated.

Responses

Request samples

Content type
application/json
{
  • "schemaName": "PUBLIC",
  • "allTables": true,
  • "tables": [
    ]
}

Response samples

Content type
application/json
true

Stop replication

Stops the specified replication.

Authorizations:
bearerTokenbasicAuth
path Parameters
name
required
string

The id of the replication to stop.

Request Body schema: application/json
required
schemaName
string
Default: "PUBLIC"

Schema name for replication.

allTables
boolean or null

If true, all tables will be replicated.

tables
Array of strings or null

List of table names to be replicated.

Responses

Request samples

Content type
application/json
{
  • "schemaName": "PUBLIC",
  • "allTables": true,
  • "tables": [
    ]
}

Response samples

Content type
application/json
true

deployment

Get cluster unit statuses

Cluster unit statuses.

Authorizations:
bearerTokenbasicAuth
query Parameters
statuses
Array of strings or null (DeploymentStatus)
Enum: "UPLOADING" "DEPLOYED" "OBSOLETE" "REMOVING"

Deployment status filter.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get specific cluster unit statuses

Cluster unit statuses by unit.

Authorizations:
bearerTokenbasicAuth
path Parameters
unitId
required
string

The ID of the deployment unit.

query Parameters
version
string or null

Unit version filter.

statuses
Array of strings or null (DeploymentStatus)
Enum: "UPLOADING" "DEPLOYED" "OBSOLETE" "REMOVING"

Deployment status filter.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get node unit statuses

Returns a list of unit statuses per node.

Authorizations:
bearerTokenbasicAuth
query Parameters
statuses
Array of strings or null (DeploymentStatus)
Enum: "UPLOADING" "DEPLOYED" "OBSOLETE" "REMOVING"

Deployment status filter.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get specific node unit statuses

Returns a list of node unit statuses by unit.

Authorizations:
bearerTokenbasicAuth
path Parameters
unitId
required
string

The ID of the deployment unit.

query Parameters
version
string or null

Unit version filter.

statuses
Array of strings or null (DeploymentStatus)
Enum: "UPLOADING" "DEPLOYED" "OBSOLETE" "REMOVING"

Deployment status filter.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Deploy unit

Deploys provided unit to the cluster.

Authorizations:
bearerTokenbasicAuth
path Parameters
unitId
required
string

The ID of the deployment unit.

unitVersion
required
string

The version of the deployment unit.

query Parameters
deployMode
string or null
Enum: "MAJORITY" "ALL"

Initial set of nodes to deploy.

initialNodes
Array of strings or null

List of node identifiers to deploy to.

Request Body schema: multipart/form-data
required
unitContent
required
Array of strings <binary> [ items <binary > ]

The code to deploy.

Responses

Response samples

Content type
application/json
true

Undeploy unit

Undeploys the unit with provided unitId and unitVersion.

Authorizations:
bearerTokenbasicAuth
path Parameters
unitId
required
string

The ID of the deployment unit.

unitVersion
required
string

The version of the deployment unit.

Responses

Response samples

Content type
application/json
true

distribution

Reset distribution

Recalculates distribution for all tables in the provided zones.

Authorizations:
bearerTokenbasicAuth
Request Body schema: application/json
required
zoneNames
required
Array of strings

List of zone names to reset distribution in.

Responses

Request samples

Content type
application/json
{
  • "zoneNames": [
    ]
}

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

licenseManagement

Get license

Get current license.

Authorizations:
bearerTokenbasicAuth

Responses

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

Apply new License

Applies provided license.

Authorizations:
bearerTokenbasicAuth
Request Body schema: application/json
required
edition
string

Edition

features
Array of strings

List of enabled features

object

DTO for license signatures.

releaseType
string

Release type

id
string

Unique identifier of the license

object

License information fields

object

License limitations

Responses

Request samples

Content type
application/json
{
  • "edition": "string",
  • "features": [
    ],
  • "signatures": {
    },
  • "releaseType": "string",
  • "id": "string",
  • "infos": {
    },
  • "limits": {
    }
}

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

Get license features

Get license features available to user.

Authorizations:
bearerTokenbasicAuth

Responses

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

Get license id

Get id of the current license.

Authorizations:
bearerTokenbasicAuth

Responses

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

Get license info

Get info fields of the current license.

Authorizations:
bearerTokenbasicAuth

Responses

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

Get license limits

Get limits of the current license.

Authorizations:
bearerTokenbasicAuth

Responses

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

clusterMetric

Disable metric source

Disables the specified metric source.

Authorizations:
bearerTokenbasicAuth
Request Body schema: text/plain
required
string

Responses

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

Enable metric source

Enables the specified metric source.

Authorizations:
bearerTokenbasicAuth
Request Body schema: text/plain
required
string

Responses

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

List metric sources

Gets a list of all available metric sources.

Authorizations:
bearerTokenbasicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

nodeMetric

Disable metric source

Disables the specified metric source.

Authorizations:
bearerTokenbasicAuth
Request Body schema: text/plain
required
string

Responses

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

Enable metric source

Enables the specified metric source.

Authorizations:
bearerTokenbasicAuth
Request Body schema: text/plain
required
string

Responses

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

List metric sets

Gets a list of all enabled metric sets.

Authorizations:
bearerTokenbasicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List metric sources

Gets a list of all available metric sources.

Authorizations:
bearerTokenbasicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

nodeManagement

Get node information

Gets information about the node.

Authorizations:
bearerTokenbasicAuth

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "jdbcPort": 0
}

Get node state

Gets node state.

Authorizations:
bearerTokenbasicAuth

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "state": "STARTING"
}

Get application version on node

Gets the version of Apache Ignite the node uses.

Authorizations:
bearerTokenbasicAuth

Responses

Response samples

Content type
application/problem+json
{
  • "version": "string",
  • "product": "string"
}

privilegesGrants

Grant privileges

Grants privileges to roles.

Authorizations:
bearerTokenbasicAuth
Request Body schema: application/json
required

Role assignment.

roleNames
Array of strings

Role names

Array of objects (Privilege)

Privileges

Responses

Request samples

Content type
application/json
{
  • "roleNames": [
    ],
  • "privileges": [
    ]
}

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

Revoke privileges

Revokes privileges from roles.

Authorizations:
bearerTokenbasicAuth
Request Body schema: application/json
required

Role assignment.

roleNames
Array of strings

Role names

Array of objects (Privilege)

Privileges

Responses

Request samples

Content type
application/json
{
  • "roleNames": [
    ],
  • "privileges": [
    ]
}

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

Get all roles with privilege

Returns the list of all roles with granted privileges.

Authorizations:
bearerTokenbasicAuth

Responses

Response samples

Content type
application/problem+json
[
  • {
    }
]

Get granted privileges

Returns the list of all granted privileges to role.

Authorizations:
bearerTokenbasicAuth
path Parameters
roleName
required
string

Role name.

Responses

Response samples

Content type
application/problem+json
[
  • {
    }
]

roleAssignments

Assign roles to users

Assigns roles to users.

Authorizations:
bearerTokenbasicAuth
Request Body schema: application/json
required

Role assignment.

roleNames
Array of strings

Role names

usernames
Array of strings

Usernames

Responses

Request samples

Content type
application/json
{
  • "roleNames": [
    ],
  • "usernames": [
    ]
}

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

Revoke roles from users

Revokes roles from users.

Authorizations:
bearerTokenbasicAuth
Request Body schema: application/json
required

Role assignment.

roleNames
Array of strings

Role names

usernames
Array of strings

Usernames

Responses

Request samples

Content type
application/json
{
  • "roleNames": [
    ],
  • "usernames": [
    ]
}

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

Get roles with users and privileges

Returns the list of all roles with associated users and assigned privileges.

Authorizations:
bearerTokenbasicAuth

Responses

Response samples

Content type
application/problem+json
[
  • {
    }
]

Get user roles

Returns the list of all roles assigned to user.

Authorizations:
bearerTokenbasicAuth
path Parameters
username
required
string

Username.

Responses

Response samples

Content type
application/problem+json
[
  • {
    }
]

Get users who have all specified roles

Returns the list of all users with assigned roles.

Authorizations:
bearerTokenbasicAuth

Responses

Response samples

Content type
application/problem+json
[
  • {
    }
]

Get users who have role

Returns the list of all users assigned to role.

Authorizations:
bearerTokenbasicAuth
path Parameters
roleName
required
string

Role name.

Responses

Response samples

Content type
application/problem+json
[
  • {
    }
]

roleManagement

Get the list of roles

Returns the list of all roles.

Authorizations:
bearerTokenbasicAuth

Responses

Response samples

Content type
application/problem+json
[
  • {
    }
]

Create role

Create role.

Authorizations:
bearerTokenbasicAuth
Request Body schema: application/json
required

Role body.

roleName
string

Role name

Responses

Request samples

Content type
application/json
{
  • "roleName": "string"
}

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

Get role by name

Returns a role.

Authorizations:
bearerTokenbasicAuth
path Parameters
roleName
required
string

Role name.

Responses

Response samples

Content type
application/problem+json
{
  • "roleName": "string"
}

Delete role by name

Delete a role.

Authorizations:
bearerTokenbasicAuth
path Parameters
roleName
required
string

Role name.

query Parameters
revoke
required
boolean
Default: false

Revoke role from all users.

Responses

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

userManagement

Get the list of users

Returns the list of all users.

Authorizations:
bearerTokenbasicAuth

Responses

Response samples

Content type
application/problem+json
[
  • {
    }
]

Create user

Creates a user.

Authorizations:
bearerTokenbasicAuth
Request Body schema: application/json
required

User body.

username
string

Username

plainPassword
string

Plain password

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "plainPassword": "string"
}

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

Get user by username

Returns a user.

Authorizations:
bearerTokenbasicAuth
path Parameters
username
required
string

Username.

Responses

Response samples

Content type
application/problem+json
{
  • "username": "string"
}

Update user

Updates a user.

Authorizations:
bearerTokenbasicAuth
path Parameters
username
required
string

Username.

Request Body schema: application/json
required

User body.

username
string

Username

plainPassword
string

Plain password

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "plainPassword": "string"
}

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

Delete user by username

Deletes a user by username.

Authorizations:
bearerTokenbasicAuth
path Parameters
username
required
string

Username.

Responses

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

recovery

migrate

Migrates nodes from old cluster to new (repaired) cluster.

Authorizations:
bearerTokenbasicAuth
Request Body schema: application/json
required
cmgNodes
Array of strings

Names of the CMG node names.

metaStorageNodes
Array of strings

Names of the Metastorage node names.

version
string

Ignite version.

clusterId
string <uuid>

ID of the cluster.

clusterName
string

Name of the cluster.

formerClusterIds
Array of strings or null <uuid> [ items <uuid > ]

IDs the cluster had before. If CMG/Metastorage group were never repaired, this is null.

Responses

Request samples

Content type
application/json
{
  • "cmgNodes": [
    ],
  • "metaStorageNodes": [
    ],
  • "version": "string",
  • "clusterId": "a3d24843-7014-4490-bdd3-b7cb39b400c8",
  • "clusterName": "string",
  • "formerClusterIds": [
    ]
}

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

resetCluster

Initiates cluster reset to repair CMG/Metastorage group/both.

Authorizations:
bearerTokenbasicAuth
Request Body schema: application/json
required
cmgNodeNames
Array of strings or null

Names of the proposed CMG nodes. Optional if the MG group is being repaired. If not specified, the current CMG nodes are used.

metastorageReplicationFactor
integer or null <int32>

Number of nodes in the voting member set of the Metastorage RAFT group.

Responses

Request samples

Content type
application/json
{
  • "cmgNodeNames": [
    ],
  • "metastorageReplicationFactor": 0
}

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

resetPartitions

Updates assignments of partitions in a forced manner, allowing for the recovery of raft groups with lost majorities.

Authorizations:
bearerTokenbasicAuth
Request Body schema: application/json
required
zoneName
string

Name of the zone to reset partitions of. Without quotes, case-sensitive.

partitionIds
Array of integers <int32> [ items <int32 > ]

IDs of partitions to reset. All if empty.

tableName
string

Fully-qualified name of the table to reset partitions of. Without quotes, case-sensitive.

Responses

Request samples

Content type
application/json
{
  • "zoneName": "string",
  • "partitionIds": [
    ],
  • "tableName": "string"
}

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

restartPartitions

Restarts replica service and raft group of passed partitions.

Authorizations:
bearerTokenbasicAuth
Request Body schema: application/json
required
nodeNames
Array of strings

Names specifying nodes to restart partitions. Case-sensitive. If empty/omitted, partitions on all nodes are restarted.

zoneName
string

Name of the zone to restart partitions of. Without quotes, case-sensitive.

partitionIds
Array of integers <int32> [ items <int32 > ]

IDs of partitions to restart. If empty/omitted, all partitions will be restarted.

tableName
string

Fully-qualified name of the table to restart partitions of.

Responses

Request samples

Content type
application/json
{
  • "nodeNames": [
    ],
  • "zoneName": "string",
  • "partitionIds": [
    ],
  • "tableName": "string"
}

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

getGlobalPartitionStates

Returns global partition states.

Authorizations:
bearerTokenbasicAuth
query Parameters
zoneNames
Array of strings or null

Names specifying zones to get partition states from. Case-sensitive, all zones if empty.

partitionIds
Array of integers or null <int32> [ items <int32 > ]

IDs of partitions to get states of. All partitions if empty.

Responses

Response samples

Content type
application/json
{
  • "states": [
    ]
}

getLocalPartitionStates

Returns local partition states.

Authorizations:
bearerTokenbasicAuth
query Parameters
zoneNames
Array of strings or null

Names specifying zones to get partition states from. Case-sensitive, all zones if empty.

nodeNames
Array of strings or null

Names specifying nodes to get partition states from. Case-sensitive, all nodes if empty.

partitionIds
Array of integers or null <int32> [ items <int32 > ]

IDs of partitions to get states. All partitions if empty.

Responses

Response samples

Content type
application/json
{
  • "states": [
    ]
}

recoverTables

Start a recovery process for tables.

Authorizations:
bearerTokenbasicAuth
Request Body schema: application/json
required
tables
required
Array of strings

List of fully-qualified names of the tables to recover. Without quotes, case-sensitive.

timestamp
required
string <date-time>

Point-in-Time recovery timestamp.

Responses

Request samples

Content type
application/json
{
  • "tables": [
    ],
  • "timestamp": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/problem+json
{
  • "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969"
}

getTablesRecoveryState

Get a state of recovery process for tables.

Authorizations:
bearerTokenbasicAuth
path Parameters
operationId
required
string <uuid>

Operation ID.

Responses

Response samples

Content type
application/problem+json
{
  • "recoveryProgress": {
    }
}

system

migrate

Migrates nodes from old cluster to new (repaired) cluster.

Authorizations:
bearerTokenbasicAuth
Request Body schema: application/json
required
cmgNodes
Array of strings

Names of the CMG node names.

metaStorageNodes
Array of strings

Names of the Metastorage node names.

version
string

Ignite version.

clusterId
string <uuid>

ID of the cluster.

clusterName
string

Name of the cluster.

formerClusterIds
Array of strings or null <uuid> [ items <uuid > ]

IDs the cluster had before. If CMG/Metastorage group were never repaired, this is null.

Responses

Request samples

Content type
application/json
{
  • "cmgNodes": [
    ],
  • "metaStorageNodes": [
    ],
  • "version": "string",
  • "clusterId": "a3d24843-7014-4490-bdd3-b7cb39b400c8",
  • "clusterName": "string",
  • "formerClusterIds": [
    ]
}

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

resetCluster

Initiates cluster reset to repair CMG/Metastorage group/both.

Authorizations:
bearerTokenbasicAuth
Request Body schema: application/json
required
cmgNodeNames
Array of strings or null

Names of the proposed CMG nodes. Optional if the MG group is being repaired. If not specified, the current CMG nodes are used.

metastorageReplicationFactor
integer or null <int32>

Number of nodes in the voting member set of the Metastorage RAFT group.

Responses

Request samples

Content type
application/json
{
  • "cmgNodeNames": [
    ],
  • "metastorageReplicationFactor": 0
}

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

snapshotManagement

Create snapshot

Creates a new snapshot.

Authorizations:
bearerTokenbasicAuth
Request Body schema: application/json
required

configuration for the snapshot.

snapshotType
string
Enum: "NOT_SPECIFIED" "FULL" "INCREMENTAL"

Type of the snapshot, FULL or INCREMENTAL.

tableNames
Array of strings

Set of fully-qualified table names that will be parts of the snapshot.

timestampEpochMilli
integer <int64>

Time for which the Snapshot should be taken in milliseconds since Unix Epoch format. If null, current time will be used

destination
string

The name of the snapshot path to the snapshot; null to use the default path.

encryptionProvider
string

The encryption provider name.

Responses

Request samples

Content type
application/json
{
  • "snapshotType": "NOT_SPECIFIED",
  • "tableNames": [
    ],
  • "timestampEpochMilli": 0,
  • "destination": "string",
  • "encryptionProvider": "string"
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Delete snapshot

Deletes a snapshot.

Authorizations:
bearerTokenbasicAuth
Request Body schema: application/json
required

Delete command configuration.

snapshotId
string <uuid>

ID of the snapshot to delete

Responses

Request samples

Content type
application/json
{
  • "snapshotId": "09520abc-01e6-4da1-8fa5-f10e3883c861"
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Get all snapshot operations

Returns all snapshot operations.

Authorizations:
bearerTokenbasicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get operation by ID

Returns operation by its ID.

Authorizations:
bearerTokenbasicAuth
path Parameters
operationId
required
string <uuid>

ID of the operation.

query Parameters
allNodes
required
boolean

if operation status for every node should be retrieved.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Restore snapshot

Restores a snapshot.

Authorizations:
bearerTokenbasicAuth
Request Body schema: application/json
required

Restore command configuration.

snapshotId
string <uuid>

ID of the snapshot to restore

tableNames
Array of strings

Set of fully-qualified table names to restore.

source
string

The name of the snapshot path to restore the snapshot from; null to use the default path.

decryptionProvider
string

The decription provider name.

Responses

Request samples

Content type
application/json
{
  • "snapshotId": "09520abc-01e6-4da1-8fa5-f10e3883c861",
  • "tableNames": [
    ],
  • "source": "string",
  • "decryptionProvider": "string"
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

sql

Retrieve all running sql queries.

Fetches all running sql queries.

Authorizations:
bearerTokenbasicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve sql query.

Fetches the current state of a specific sql query.

Authorizations:
bearerTokenbasicAuth
path Parameters
queryId
required
string <uuid>

The unique identifier of the sql query.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "node": "string",
  • "phase": "string",
  • "type": "string",
  • "schema": "string",
  • "sql": "string",
  • "startTime": "2019-08-24T14:15:22Z"
}

Kill sql query.

Kills a specific sql query identified by query id.

Authorizations:
bearerTokenbasicAuth
path Parameters
queryId
required
string <uuid>

The unique identifier of the sql query.

Responses

Response samples

Content type
application/json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

transactions

Retrieve all in progress transactions

Fetches all in progress transactions.

Authorizations:
bearerTokenbasicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve transaction state

Fetches the current state of a specific transaction identified by transactionId.

Authorizations:
bearerTokenbasicAuth
path Parameters
transactionId
required
string <uuid>

The unique identifier of the transaction.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "node": "string",
  • "state": "string",
  • "type": "string",
  • "priority": "string",
  • "startTime": "2019-08-24T14:15:22Z"
}

Kill transaction.

Kills a specific transaction identified by transactionId.

Authorizations:
bearerTokenbasicAuth
path Parameters
transactionId
required
string <uuid>

The unique identifier of the transaction.

Responses

Response samples

Content type
application/json
{
  • "title": "string",
  • "status": 0,
  • "code": "string",
  • "type": "string",
  • "detail": "string",
  • "node": "string",
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  • "invalidParams": [
    ]
}

upgrade

Commit upgrade

Commit the rolling upgrade

Authorizations:
bearerTokenbasicAuth

Responses

Response samples

Content type
application/json
true

Start upgrade

Starts the rolling upgrade

Authorizations:
bearerTokenbasicAuth
Request Body schema: application/json
required
version
required
string

The version to upgrade.

Responses

Request samples

Content type
application/json
{
  • "version": "string"
}

Response samples

Content type
application/json
true