Apache Ignite REST API

openapi: 3.0.1
info:
  title: Apache Ignite REST module
  contact:
    email: user@ignite.apache.org
  license:
    name: Apache 2.0
    url: https://ignite.apache.org
  version: 3.1.0
servers:
- url: http://localhost:10300
security:
- basicAuth: []
paths:
  /management/v1/cluster/init:
    post:
      tags:
      - clusterManagement
      summary: Apache Ignite Initialize Cluster
      description: Initialize a new cluster.
      operationId: init
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InitCommand'
            examples:
              initRequestExample:
                summary: Default init request
                x-microcks-default: true
                value:
                  metaStorageNodes: []
                  cmgNodes: []
                  clusterName: example-name
                  clusterConfiguration: example-value
        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'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /management/v1/cluster/state:
    get:
      tags:
      - clusterManagement
      summary: Apache Ignite Get Cluster State
      description: Returns current cluster status.
      operationId: clusterState
      responses:
        "200":
          description: Cluster status returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterState'
              examples:
                clusterState200Example:
                  summary: Default clusterState 200 response
                  x-microcks-default: true
                  value:
                    cmgNodes: []
                    msNodes: []
                    igniteVersion: example-value
                    clusterTag: example-value
                    formerClusterIds: []
        "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'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /management/v1/cluster/topology/logical:
    get:
      tags:
      - topology
      summary: Apache Ignite Get Logical Topology
      description: Gets information about logical cluster topology.
      operationId: logical
      responses:
        "200":
          description: Logical topology returned.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClusterNode'
              examples:
                logical200Example:
                  summary: Default logical 200 response
                  x-microcks-default: true
                  value: {}
        "404":
          description: "Logical topology 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'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /management/v1/cluster/topology/physical:
    get:
      tags:
      - topology
      summary: Apache Ignite Get Physical Topology
      description: Gets information about physical cluster topology.
      operationId: physical
      responses:
        "200":
          description: Physical topology returned.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClusterNode'
              examples:
                physical200Example:
                  summary: Default physical 200 response
                  x-microcks-default: true
                  value: {}
        "500":
          description: Internal error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /management/v1/compute/jobs:
    get:
      tags:
      - compute
      summary: Apache Ignite Retrieve All Job States
      description: Fetches the current states of all compute jobs.
      operationId: jobStates
      responses:
        "200":
          description: Successfully retrieved job states.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/JobState'
              examples:
                jobStates200Example:
                  summary: Default jobStates 200 response
                  x-microcks-default: true
                  value: {}
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /management/v1/compute/jobs/{jobId}:
    get:
      tags:
      - compute
      summary: Apache Ignite Retrieve Job State
      description: Fetches the current state of a specific compute job identified by jobId.
      operationId: jobState
      parameters:
      - name: jobId
        in: path
        description: The unique identifier of the compute job.
        required: true
        schema:
          type: string
          description: The unique identifier of the compute job.
          format: uuid
        example: item-8344
      responses:
        "200":
          description: Successfully retrieved the job state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobState'
              examples:
                jobState200Example:
                  summary: Default jobState 200 response
                  x-microcks-default: true
                  value:
                    id: item-1654
                    status: example-value
                    createTime: '2025-03-15T14:30:00Z'
                    startTime: '2025-03-15T14:30:00Z'
                    finishTime: '2025-03-15T14:30:00Z'
        "404":
          description: Compute job not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                jobState404Example:
                  summary: Default jobState 404 response
                  x-microcks-default: true
                  value:
                    title: example-value
                    status: 37
                    code: example-value
                    type: example-value
                    detail: example-value
                    node: example-value
                    traceId: item-5113
                    invalidParams: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      tags:
      - compute
      summary: Apache Ignite Cancel Job
      description: Cancels a specific compute job identified by jobId.
      operationId: cancelJob
      parameters:
      - name: jobId
        in: path
        description: The unique identifier of the compute job.
        required: true
        schema:
          type: string
          description: The unique identifier of the compute job.
          format: uuid
        example: item-2396
      responses:
        "200":
          description: Successfully cancelled the job.
          content:
            application/json:
              examples:
                cancelJob200Example:
                  summary: Default cancelJob 200 response
                  x-microcks-default: true
                  value: {}
        "404":
          description: Compute job not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                cancelJob404Example:
                  summary: Default cancelJob 404 response
                  x-microcks-default: true
                  value:
                    title: example-value
                    status: 48
                    code: example-value
                    type: example-value
                    detail: example-value
                    node: example-value
                    traceId: item-9166
                    invalidParams: []
        "409":
          description: Compute job is in an illegal state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                cancelJob409Example:
                  summary: Default cancelJob 409 response
                  x-microcks-default: true
                  value:
                    title: example-value
                    status: 3
                    code: example-value
                    type: example-value
                    detail: example-value
                    node: example-value
                    traceId: item-5374
                    invalidParams: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /management/v1/compute/jobs/{jobId}/priority:
    put:
      tags:
      - compute
      summary: Apache Ignite Update Job Priority
      description: Updates the priority of a specific compute job identified by jobId.
      operationId: updatePriority
      parameters:
      - name: jobId
        in: path
        description: The unique identifier of the compute job.
        required: true
        schema:
          type: string
          description: The unique identifier of the compute job.
          format: uuid
        example: item-9378
      requestBody:
        description: The new priority data for the job.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateJobPriorityBody'
            examples:
              updatePriorityRequestExample:
                summary: Default updatePriority request
                x-microcks-default: true
                value:
                  priority: 96
        required: true
      responses:
        "200":
          description: Successfully updated job priority.
          content:
            application/json:
              examples:
                updatePriority200Example:
                  summary: Default updatePriority 200 response
                  x-microcks-default: true
                  value: {}
        "404":
          description: Compute job not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                updatePriority404Example:
                  summary: Default updatePriority 404 response
                  x-microcks-default: true
                  value:
                    title: example-value
                    status: 61
                    code: example-value
                    type: example-value
                    detail: example-value
                    node: example-value
                    traceId: item-1323
                    invalidParams: []
        "409":
          description: Compute job is in an illegal state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                updatePriority409Example:
                  summary: Default updatePriority 409 response
                  x-microcks-default: true
                  value:
                    title: example-value
                    status: 63
                    code: example-value
                    type: example-value
                    detail: example-value
                    node: example-value
                    traceId: item-3315
                    invalidParams: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /management/v1/configuration/cluster:
    get:
      tags:
      - clusterConfiguration
      summary: Apache Ignite Get Cluster Configuration
      description: Gets the current configuration of the cluster. The configuration is returned in HOCON format.
      operationId: getClusterConfiguration
      responses:
        "200":
          description: Received cluster configuration.
          content:
            text/plain:
              schema:
                type: string
        "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'
        "404":
          description: "Configuration not found. Most likely, the cluster is not initialized."
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      tags:
      - clusterConfiguration
      summary: Apache Ignite Update Cluster Configuration
      description: Updates cluster configuration. New configuration should be provided in HOCON format.
      operationId: updateClusterConfiguration
      requestBody:
        description: The cluster configuration to update.
        content:
          text/plain:
            schema:
              type: string
        required: true
      responses:
        "200":
          description: Configuration updated.
        "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'
        "404":
          description: "Configuration not found. Most likely, the cluster is not initialized."
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        "422":
          description: Configuration parse error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /management/v1/configuration/cluster/{path}:
    get:
      tags:
      - clusterConfiguration
      summary: Apache Ignite Get Configuration Represented by Path
      description: Gets the configuration on the specific path. Configuration is in HOCON format
      operationId: getClusterConfigurationByPath
      parameters:
      - name: path
        in: path
        description: "Configuration tree address. For example: `element.subelement`."
        required: true
        schema:
          type: string
        example: example-value
      responses:
        "200":
          description: Configuration of the cluster on the specified path.
          content:
            text/plain:
              schema:
                type: string
        "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'
        "404":
          description: "Configuration not found. Most likely, the cluster is not initialized."
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /management/v1/configuration/node:
    get:
      tags:
      - nodeConfiguration
      summary: Apache Ignite Get Node Configuration
      description: Gets node configuration in HOCON format.
      operationId: getNodeConfiguration
      responses:
        "200":
          description: Full node configuration.
          content:
            text/plain:
              schema:
                type: string
        "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'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      tags:
      - nodeConfiguration
      summary: Apache Ignite Update Node Configuration
      description: Updates node configuration. New configuration should be provided in HOCON format.
      operationId: updateNodeConfiguration
      requestBody:
        description: The node configuration to update.
        content:
          text/plain:
            schema:
              type: string
        required: true
      responses:
        "200":
          description: Configuration successfully updated.
        "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'
        "405":
          description: Configuration is read-only.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        "422":
          description: Configuration parse/apply error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /management/v1/configuration/node/{path}:
    get:
      tags:
      - nodeConfiguration
      summary: Apache Ignite Get Configuration Represented by Path
      description: "Gets a configuration of a specific node, in HOCON format."
      operationId: getNodeConfigurationByPath
      parameters:
      - name: path
        in: path
        description: "Configuration tree address. For example: `element.subelement`."
        required: true
        schema:
          type: string
        example: example-value
      responses:
        "200":
          description: Returned node configuration.
          content:
            text/plain:
              schema:
                type: string
        "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'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /management/v1/deployment/cluster/units:
    get:
      tags:
      - deployment
      summary: Apache Ignite Get Cluster Unit Statuses
      description: Cluster unit statuses.
      operationId: listClusterStatuses
      parameters:
      - name: statuses
        in: query
        schema:
          type: array
          description: Deployment status filter.
          nullable: true
          items:
            $ref: '#/components/schemas/DeploymentStatus'
        example: []
      responses:
        "200":
          description: All statuses returned successfully.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UnitStatus'
              examples:
                listClusterStatuses200Example:
                  summary: Default listClusterStatuses 200 response
                  x-microcks-default: true
                  value: {}
        "500":
          description: Internal error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /management/v1/deployment/cluster/units/{unitId}:
    get:
      tags:
      - deployment
      summary: Apache Ignite Get Specific Cluster Unit Statuses
      description: Cluster unit statuses by unit.
      operationId: listClusterStatusesByUnit
      parameters:
      - name: unitId
        in: path
        required: true
        schema:
          type: string
          description: The ID of the deployment unit.
        example: item-6019
      - name: version
        in: query
        schema:
          type: string
          description: Unit version filter.
          nullable: true
        example: example-value
      - name: statuses
        in: query
        schema:
          type: array
          description: Deployment status filter.
          nullable: true
          items:
            $ref: '#/components/schemas/DeploymentStatus'
        example: []
      responses:
        "200":
          description: All statuses returned successfully.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UnitStatus'
              examples:
                listClusterStatusesByUnit200Example:
                  summary: Default listClusterStatusesByUnit 200 response
                  x-microcks-default: true
                  value: {}
        "500":
          description: Internal error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /management/v1/deployment/node/units:
    get:
      tags:
      - deployment
      summary: Apache Ignite Get Node Unit Statuses
      description: Returns a list of unit statuses per node.
      operationId: listNodeStatuses
      parameters:
      - name: statuses
        in: query
        schema:
          type: array
          description: Deployment status filter.
          nullable: true
          items:
            $ref: '#/components/schemas/DeploymentStatus'
        example: []
      responses:
        "200":
          description: All statuses were returned successfully.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UnitStatus'
              examples:
                listNodeStatuses200Example:
                  summary: Default listNodeStatuses 200 response
                  x-microcks-default: true
                  value: {}
        "500":
          description: Internal error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /management/v1/deployment/node/units/{unitId}:
    get:
      tags:
      - deployment
      summary: Apache Ignite Get Specific Node Unit Statuses
      description: Returns a list of node unit statuses by unit.
      operationId: listNodeStatusesByUnit
      parameters:
      - name: unitId
        in: path
        required: true
        schema:
          type: string
          description: The ID of the deployment unit.
        example: item-8168
      - name: version
        in: query
        schema:
          type: string
          description: Unit version filter.
          nullable: true
        example: example-value
      - name: statuses
        in: query
        schema:
          type: array
          description: Deployment status filter.
          nullable: true
          items:
            $ref: '#/components/schemas/DeploymentStatus'
        example: []
      responses:
        "200":
          description: All statuses returned successfully.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UnitStatus'
              examples:
                listNodeStatusesByUnit200Example:
                  summary: Default listNodeStatusesByUnit 200 response
                  x-microcks-default: true
                  value: {}
        "500":
          description: Internal error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /management/v1/deployment/units/zip/{unitId}/{unitVersion}:
    post:
      tags:
      - deployment
      summary: Apache Ignite Deploy Unit with Folders Structure in Zip.
      description: Deploys provided unit in zip file to the cluster with folders structure.
      operationId: deployZipUnit
      parameters:
      - name: unitId
        in: path
        required: true
        schema:
          type: string
          description: The ID of the deployment unit.
        example: item-1689
      - name: unitVersion
        in: path
        required: true
        schema:
          type: string
          description: The version of the deployment unit.
        example: example-value
      - name: deployMode
        in: query
        schema:
          nullable: true
          allOf:
          - $ref: '#/components/schemas/deployMode'
          - description: ALL or MAJORITY.
        example: example-value
      - name: initialNodes
        in: query
        schema:
          type: array
          description: List of node identifiers to deploy to.
          nullable: true
          items:
            type: string
        example: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
              - unitContent
              type: object
              properties:
                unitContent:
                  type: array
                  description: The zip file with unit content to deploy.
                  items:
                    type: string
                    format: binary
            encoding: {}
        required: true
      responses:
        "200":
          description: Unit deployed successfully.
          content:
            application/json:
              schema:
                type: boolean
              examples:
                deployZipUnit200Example:
                  summary: Default deployZipUnit 200 response
                  x-microcks-default: true
                  value: {}
        "409":
          description: Unit with same identifier and version is already deployed.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        "400":
          description: Deployment unit with unzip supports only single zip file.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        "500":
          description: Internal error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /management/v1/deployment/units/{unitId}/{unitVersion}:
    post:
      tags:
      - deployment
      summary: Apache Ignite Deploy Unit
      description: Deploys provided unit to the cluster.
      operationId: deployUnit
      parameters:
      - name: unitId
        in: path
        required: true
        schema:
          type: string
          description: The ID of the deployment unit.
        example: item-3830
      - name: unitVersion
        in: path
        required: true
        schema:
          type: string
          description: The version of the deployment unit.
        example: example-value
      - name: deployMode
        in: query
        schema:
          nullable: true
          allOf:
          - $ref: '#/components/schemas/deployMode'
          - description: ALL or MAJORITY.
        example: example-value
      - name: initialNodes
        in: query
        schema:
          type: array
          description: List of node identifiers to deploy to.
          nullable: true
          items:
            type: string
        example: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
              - unitContent
              type: object
              properties:
                unitContent:
                  type: array
                  description: The code to deploy.
                  items:
                    type: string
                    format: binary
            encoding: {}
        required: true
      responses:
        "200":
          description: Unit deployed successfully.
          content:
            application/json:
              schema:
                type: boolean
              examples:
                deployUnit200Example:
                  summary: Default deployUnit 200 response
                  x-microcks-default: true
                  value: {}
        "409":
          description: Unit with same identifier and version is already deployed.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        "500":
          description: Internal error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      tags:
      - deployment
      summary: Apache Ignite Undeploy Unit
      description: Undeploys the unit with provided unitId and unitVersion.
      operationId: undeployUnit
      parameters:
      - name: unitId
        in: path
        required: true
        schema:
          type: string
          description: The ID of the deployment unit.
        example: item-8579
      - name: unitVersion
        in: path
        required: true
        schema:
          type: string
          description: The version of the deployment unit.
        example: example-value
      responses:
        "200":
          description: Unit undeployed successfully.
          content:
            application/json:
              schema:
                type: boolean
              examples:
                undeployUnit200Example:
                  summary: Default undeployUnit 200 response
                  x-microcks-default: true
                  value: {}
        "404":
          description: Unit with provided identifier and version does not exist.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        "500":
          description: Internal error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /management/v1/metric/cluster/disable:
    post:
      tags:
      - clusterMetric
      summary: Apache Ignite Disable Metric Source
      description: Disables the specified metric source.
      operationId: disableClusterMetric
      requestBody:
        content:
          text/plain:
            schema:
              type: string
        required: true
      responses:
        "200":
 

# --- truncated at 32 KB (85 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/apache-ignite/refs/heads/main/openapi/apache-ignite-rest-api.yaml