Hazelcast REST API

naftiko: 1.0.0-alpha2
info:
  label: Hazelcast REST API
  description: OpenAPI definition for the Hazelcast REST API exposed by cluster members. The REST service is disabled by default
    and must be enabled in member configuration. Endpoint groups (CLUSTER_READ, CLUSTER_WRITE, DATA, HEALTH_CHECK, PERSISTENCE,
    WAN, CP) gate access to specific operations.
  tags:
  - Hazelcast
  - API
  created: '2026-05-06'
  modified: '2026-05-06'
capability:
  consumes:
  - type: http
    namespace: hazelcast
    baseUri: http://localhost:5701
    description: Hazelcast REST API HTTP API.
    resources:
    - name: hazelcast-rest-maps-mapname-key
      path: /hazelcast/rest/maps/{mapName}/{key}
      operations:
      - name: getmapentry
        method: GET
        description: Get map entry
        inputParameters:
        - name: mapName
          in: path
          type: string
          required: true
        - name: key
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: putmapentry
        method: POST
        description: Put map entry
        inputParameters:
        - name: mapName
          in: path
          type: string
          required: true
        - name: key
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletemapentry
        method: DELETE
        description: Delete map entry
        inputParameters:
        - name: mapName
          in: path
          type: string
          required: true
        - name: key
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: hazelcast-rest-maps-mapname
      path: /hazelcast/rest/maps/{mapName}
      operations:
      - name: clearmap
        method: DELETE
        description: Clear map
        inputParameters:
        - name: mapName
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: hazelcast-rest-queues-queuename
      path: /hazelcast/rest/queues/{queueName}
      operations:
      - name: offerqueueitem
        method: POST
        description: Offer item to queue
        inputParameters:
        - name: queueName
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: pollqueueitem
        method: DELETE
        description: Poll item from queue
        inputParameters:
        - name: queueName
          in: path
          type: string
          required: true
        - name: timeout
          in: query
          type: integer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: hazelcast-rest-queues-queuename-size
      path: /hazelcast/rest/queues/{queueName}/size
      operations:
      - name: getqueuesize
        method: GET
        description: Get queue size
        inputParameters:
        - name: queueName
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: hazelcast-rest-cluster
      path: /hazelcast/rest/cluster
      operations:
      - name: getclusterinfo
        method: GET
        description: Get cluster info
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: hazelcast-rest-instance
      path: /hazelcast/rest/instance
      operations:
      - name: getinstancename
        method: GET
        description: Get instance name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: hazelcast-rest-management-cluster-state
      path: /hazelcast/rest/management/cluster/state
      operations:
      - name: getclusterstate
        method: GET
        description: Get cluster state
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: changeclusterstate
        method: POST
        description: Change cluster state
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: hazelcast-rest-management-cluster-version
      path: /hazelcast/rest/management/cluster/version
      operations:
      - name: getclusterversion
        method: GET
        description: Get cluster version
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: hazelcast-health-ready
      path: /hazelcast/health/ready
      operations:
      - name: healthready
        method: GET
        description: Readiness probe
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: hazelcast-health-node-state
      path: /hazelcast/health/node-state
      operations:
      - name: healthnodestate
        method: GET
        description: Node state
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: hazelcast-health-cluster-state
      path: /hazelcast/health/cluster-state
      operations:
      - name: healthclusterstate
        method: GET
        description: Cluster state health
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: hazelcast-health-cluster-safe
      path: /hazelcast/health/cluster-safe
      operations:
      - name: healthclustersafe
        method: GET
        description: Cluster safe
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: hazelcast-rest-config-reload
      path: /hazelcast/rest/config/reload
      operations:
      - name: reloadconfig
        method: POST
        description: Reload member configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: hazelcast-rest-config-tcp-ip-member-list
      path: /hazelcast/rest/config/tcp-ip/member-list
      operations:
      - name: gettcpipmemberlist
        method: GET
        description: Get TCP-IP member list
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatetcpipmemberlist
        method: POST
        description: Update TCP-IP member list
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    port: 8080
    namespace: hazelcast-rest
    description: REST adapter for Hazelcast REST API.
    resources:
    - path: /hazelcast/rest/maps/{mapName}/{key}
      name: getmapentry
      operations:
      - method: GET
        name: getmapentry
        description: Get map entry
        call: hazelcast.getmapentry
        with:
          mapName: rest.mapName
          key: rest.key
        outputParameters:
        - type: object
          mapping: $.
    - path: /hazelcast/rest/maps/{mapName}/{key}
      name: putmapentry
      operations:
      - method: POST
        name: putmapentry
        description: Put map entry
        call: hazelcast.putmapentry
        with:
          mapName: rest.mapName
          key: rest.key
        outputParameters:
        - type: object
          mapping: $.
    - path: /hazelcast/rest/maps/{mapName}/{key}
      name: deletemapentry
      operations:
      - method: DELETE
        name: deletemapentry
        description: Delete map entry
        call: hazelcast.deletemapentry
        with:
          mapName: rest.mapName
          key: rest.key
        outputParameters:
        - type: object
          mapping: $.
    - path: /hazelcast/rest/maps/{mapName}
      name: clearmap
      operations:
      - method: DELETE
        name: clearmap
        description: Clear map
        call: hazelcast.clearmap
        with:
          mapName: rest.mapName
        outputParameters:
        - type: object
          mapping: $.
    - path: /hazelcast/rest/queues/{queueName}
      name: offerqueueitem
      operations:
      - method: POST
        name: offerqueueitem
        description: Offer item to queue
        call: hazelcast.offerqueueitem
        with:
          queueName: rest.queueName
        outputParameters:
        - type: object
          mapping: $.
    - path: /hazelcast/rest/queues/{queueName}
      name: pollqueueitem
      operations:
      - method: DELETE
        name: pollqueueitem
        description: Poll item from queue
        call: hazelcast.pollqueueitem
        with:
          queueName: rest.queueName
        outputParameters:
        - type: object
          mapping: $.
    - path: /hazelcast/rest/queues/{queueName}/size
      name: getqueuesize
      operations:
      - method: GET
        name: getqueuesize
        description: Get queue size
        call: hazelcast.getqueuesize
        with:
          queueName: rest.queueName
        outputParameters:
        - type: object
          mapping: $.
    - path: /hazelcast/rest/cluster
      name: getclusterinfo
      operations:
      - method: GET
        name: getclusterinfo
        description: Get cluster info
        call: hazelcast.getclusterinfo
        outputParameters:
        - type: object
          mapping: $.
    - path: /hazelcast/rest/instance
      name: getinstancename
      operations:
      - method: GET
        name: getinstancename
        description: Get instance name
        call: hazelcast.getinstancename
        outputParameters:
        - type: object
          mapping: $.
    - path: /hazelcast/rest/management/cluster/state
      name: getclusterstate
      operations:
      - method: GET
        name: getclusterstate
        description: Get cluster state
        call: hazelcast.getclusterstate
        outputParameters:
        - type: object
          mapping: $.
    - path: /hazelcast/rest/management/cluster/state
      name: changeclusterstate
      operations:
      - method: POST
        name: changeclusterstate
        description: Change cluster state
        call: hazelcast.changeclusterstate
        outputParameters:
        - type: object
          mapping: $.
    - path: /hazelcast/rest/management/cluster/version
      name: getclusterversion
      operations:
      - method: GET
        name: getclusterversion
        description: Get cluster version
        call: hazelcast.getclusterversion
        outputParameters:
        - type: object
          mapping: $.
    - path: /hazelcast/health/ready
      name: healthready
      operations:
      - method: GET
        name: healthready
        description: Readiness probe
        call: hazelcast.healthready
        outputParameters:
        - type: object
          mapping: $.
    - path: /hazelcast/health/node-state
      name: healthnodestate
      operations:
      - method: GET
        name: healthnodestate
        description: Node state
        call: hazelcast.healthnodestate
        outputParameters:
        - type: object
          mapping: $.
    - path: /hazelcast/health/cluster-state
      name: healthclusterstate
      operations:
      - method: GET
        name: healthclusterstate
        description: Cluster state health
        call: hazelcast.healthclusterstate
        outputParameters:
        - type: object
          mapping: $.
    - path: /hazelcast/health/cluster-safe
      name: healthclustersafe
      operations:
      - method: GET
        name: healthclustersafe
        description: Cluster safe
        call: hazelcast.healthclustersafe
        outputParameters:
        - type: object
          mapping: $.
    - path: /hazelcast/rest/config/reload
      name: reloadconfig
      operations:
      - method: POST
        name: reloadconfig
        description: Reload member configuration
        call: hazelcast.reloadconfig
        outputParameters:
        - type: object
          mapping: $.
    - path: /hazelcast/rest/config/tcp-ip/member-list
      name: gettcpipmemberlist
      operations:
      - method: GET
        name: gettcpipmemberlist
        description: Get TCP-IP member list
        call: hazelcast.gettcpipmemberlist
        outputParameters:
        - type: object
          mapping: $.
    - path: /hazelcast/rest/config/tcp-ip/member-list
      name: updatetcpipmemberlist
      operations:
      - method: POST
        name: updatetcpipmemberlist
        description: Update TCP-IP member list
        call: hazelcast.updatetcpipmemberlist
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    port: 9090
    namespace: hazelcast-mcp
    transport: http
    description: MCP adapter for Hazelcast REST API for AI agent use.
    tools:
    - name: getmapentry
      description: Get map entry
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: hazelcast.getmapentry
      with:
        mapName: tools.mapName
        key: tools.key
      inputParameters:
      - name: mapName
        type: string
        description: mapName
        required: true
      - name: key
        type: string
        description: key
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: putmapentry
      description: Put map entry
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: hazelcast.putmapentry
      with:
        mapName: tools.mapName
        key: tools.key
      inputParameters:
      - name: mapName
        type: string
        description: mapName
        required: true
      - name: key
        type: string
        description: key
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: deletemapentry
      description: Delete map entry
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: hazelcast.deletemapentry
      with:
        mapName: tools.mapName
        key: tools.key
      inputParameters:
      - name: mapName
        type: string
        description: mapName
        required: true
      - name: key
        type: string
        description: key
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: clearmap
      description: Clear map
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: hazelcast.clearmap
      with:
        mapName: tools.mapName
      inputParameters:
      - name: mapName
        type: string
        description: mapName
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: offerqueueitem
      description: Offer item to queue
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: hazelcast.offerqueueitem
      with:
        queueName: tools.queueName
      inputParameters:
      - name: queueName
        type: string
        description: queueName
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: pollqueueitem
      description: Poll item from queue
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: hazelcast.pollqueueitem
      with:
        queueName: tools.queueName
        timeout: tools.timeout
      inputParameters:
      - name: queueName
        type: string
        description: queueName
        required: true
      - name: timeout
        type: integer
        description: timeout
      outputParameters:
      - type: object
        mapping: $.
    - name: getqueuesize
      description: Get queue size
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: hazelcast.getqueuesize
      with:
        queueName: tools.queueName
      inputParameters:
      - name: queueName
        type: string
        description: queueName
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: getclusterinfo
      description: Get cluster info
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: hazelcast.getclusterinfo
      outputParameters:
      - type: object
        mapping: $.
    - name: getinstancename
      description: Get instance name
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: hazelcast.getinstancename
      outputParameters:
      - type: object
        mapping: $.
    - name: getclusterstate
      description: Get cluster state
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: hazelcast.getclusterstate
      outputParameters:
      - type: object
        mapping: $.
    - name: changeclusterstate
      description: Change cluster state
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: hazelcast.changeclusterstate
      outputParameters:
      - type: object
        mapping: $.
    - name: getclusterversion
      description: Get cluster version
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: hazelcast.getclusterversion
      outputParameters:
      - type: object
        mapping: $.
    - name: healthready
      description: Readiness probe
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: hazelcast.healthready
      outputParameters:
      - type: object
        mapping: $.
    - name: healthnodestate
      description: Node state
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: hazelcast.healthnodestate
      outputParameters:
      - type: object
        mapping: $.
    - name: healthclusterstate
      description: Cluster state health
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: hazelcast.healthclusterstate
      outputParameters:
      - type: object
        mapping: $.
    - name: healthclustersafe
      description: Cluster safe
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: hazelcast.healthclustersafe
      outputParameters:
      - type: object
        mapping: $.
    - name: reloadconfig
      description: Reload member configuration
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: hazelcast.reloadconfig
      outputParameters:
      - type: object
        mapping: $.
    - name: gettcpipmemberlist
      description: Get TCP-IP member list
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: hazelcast.gettcpipmemberlist
      outputParameters:
      - type: object
        mapping: $.
    - name: updatetcpipmemberlist
      description: Update TCP-IP member list
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: hazelcast.updatetcpipmemberlist
      outputParameters:
      - type: object
        mapping: $.