openapi: 3.1.0
info:
  title: Axon Server REST API
  description: >-
    The Axon Server REST API provides HTTP endpoints for managing the Axon Server
    event store, command routing, query handling, application contexts, users,
    and cluster configuration.
  version: 4.9.0
  contact:
    name: AxonIQ
    url: https://www.axoniq.io/
  license:
    name: AxonIQ Open Source License
    url: https://www.axoniq.io/
servers:
- url: '{baseUrl}/v1'
  description: Axon Server
  variables:
    baseUrl:
      default: http://localhost:8024
paths:
  /events:
    get:
      operationId: listEvents
      summary: Axon Framework - List Events
      description: Returns events from the event store with optional filtering.
      tags:
      - Events
      parameters:
      - name: context
        in: query
        schema:
          type: string
      - name: trackingToken
        in: query
        schema:
          type: integer
          format: int64
      - name: numberOfEvents
        in: query
        schema:
          type: integer
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Event'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: appendEvent
      summary: Axon Framework - Append an Event
      description: Appends a new event to the event store.
      tags:
      - Events
      parameters:
      - name: context
        in: query
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Event'
      responses:
        '200':
          description: Event appended
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /events/aggregates/{aggregateId}:
    get:
      operationId: getAggregateEvents
      summary: Axon Framework - Get Events for an Aggregate
      description: Returns all events for a specific aggregate.
      tags:
      - Events
      parameters:
      - name: aggregateId
        in: path
        required: true
        schema:
          type: string
      - name: context
        in: query
        schema:
          type: string
      - name: initialSequence
        in: query
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Event'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /snapshots/{aggregateId}:
    get:
      operationId: getSnapshots
      summary: Axon Framework - Get Snapshots for an Aggregate
      description: Returns snapshots for a specific aggregate.
      tags:
      - Snapshots
      parameters:
      - name: aggregateId
        in: path
        required: true
        schema:
          type: string
      - name: context
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Event'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: appendSnapshot
      summary: Axon Framework - Append a Snapshot
      description: Appends a new snapshot for an aggregate.
      tags:
      - Snapshots
      parameters:
      - name: aggregateId
        in: path
        required: true
        schema:
          type: string
      - name: context
        in: query
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Event'
      responses:
        '200':
          description: Snapshot appended
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /commands:
    get:
      operationId: listCommandHandlers
      summary: Axon Framework - List Command Handlers
      description: Returns registered command handlers and their routing information.
      tags:
      - Commands
      parameters:
      - name: context
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CommandHandler'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /queries:
    get:
      operationId: listQueryHandlers
      summary: Axon Framework - List Query Handlers
      description: Returns registered query handlers.
      tags:
      - Queries
      parameters:
      - name: context
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/QueryHandler'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /context:
    get:
      operationId: listContexts
      summary: Axon Framework - List Contexts
      description: Returns all application contexts.
      tags:
      - Contexts
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Context'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createContext
      summary: Axon Framework - Create a Context
      description: Creates a new application context.
      tags:
      - Contexts
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateContextRequest'
      responses:
        '200':
          description: Context created
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /context/{contextName}:
    get:
      operationId: getContext
      summary: Axon Framework - Get a Context
      description: Returns details of a specific context.
      tags:
      - Contexts
      parameters:
      - name: contextName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Context'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteContext
      summary: Axon Framework - Delete a Context
      description: Deletes an application context.
      tags:
      - Contexts
      parameters:
      - name: contextName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Context deleted
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /applications:
    get:
      operationId: listApplications
      summary: Axon Framework - List Applications
      description: Returns all registered applications (connected clients).
      tags:
      - Applications
      parameters:
      - name: context
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Application'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /users:
    get:
      operationId: listUsers
      summary: Axon Framework - List Users
      description: Returns all Axon Server users.
      tags:
      - Users
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createUser
      summary: Axon Framework - Create a User
      description: Creates a new Axon Server user.
      tags:
      - Users
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUserRequest'
      responses:
        '200':
          description: User created
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /users/{username}:
    delete:
      operationId: deleteUser
      summary: Axon Framework - Delete a User
      description: Deletes an Axon Server user.
      tags:
      - Users
      parameters:
      - name: username
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: User deleted
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /cluster:
    get:
      operationId: getClusterInfo
      summary: Axon Framework - Get Cluster Information
      description: Returns information about the Axon Server cluster.
      tags:
      - Cluster
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClusterNode'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /cluster/{nodeName}:
    delete:
      operationId: removeNode
      summary: Axon Framework - Remove a Node from the Cluster
      description: Removes a node from the Axon Server cluster.
      tags:
      - Cluster
      parameters:
      - name: nodeName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Node removed
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /processors:
    get:
      operationId: listEventProcessors
      summary: Axon Framework - List Event Processors
      description: Returns all tracking event processors and their status.
      tags:
      - Event Processors
      parameters:
      - name: context
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EventProcessor'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /processors/{processorName}/pause:
    patch:
      operationId: pauseEventProcessor
      summary: Axon Framework - Pause an Event Processor
      description: Pauses a tracking event processor.
      tags:
      - Event Processors
      parameters:
      - name: processorName
        in: path
        required: true
        schema:
          type: string
      - name: context
        in: query
        schema:
          type: string
      - name: tokenStoreIdentifier
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Event processor paused
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /processors/{processorName}/start:
    patch:
      operationId: startEventProcessor
      summary: Axon Framework - Start an Event Processor
      description: Starts a paused tracking event processor.
      tags:
      - Event Processors
      parameters:
      - name: processorName
        in: path
        required: true
        schema:
          type: string
      - name: context
        in: query
        schema:
          type: string
      - name: tokenStoreIdentifier
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Event processor started
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Event:
      type: object
      properties:
        messageIdentifier:
          type: string
        aggregateIdentifier:
          type: string
        aggregateSequenceNumber:
          type: integer
          format: int64
        aggregateType:
          type: string
        timestamp:
          type: integer
          format: int64
        payloadType:
          type: string
        payloadRevision:
          type: string
        payloadData:
          type: string
        metaData:
          type: object
    CommandHandler:
      type: object
      properties:
        command:
          type: string
        clientId:
          type: string
        componentName:
          type: string
    QueryHandler:
      type: object
      properties:
        query:
          type: string
        clientId:
          type: string
        componentName:
          type: string
        resultName:
          type: string
    Context:
      type: object
      properties:
        context:
          type: string
        leader:
          type: string
        roles:
          type: array
          items:
            type: object
            properties:
              node:
                type: string
              role:
                type: string
    CreateContextRequest:
      type: object
      required:
      - context
      properties:
        context:
          type: string
        replicationGroup:
          type: string
        nodes:
          type: array
          items:
            type: object
    Application:
      type: object
      properties:
        name:
          type: string
        context:
          type: string
        componentName:
          type: string
        connectedFrom:
          type: string
    User:
      type: object
      properties:
        userName:
          type: string
        roles:
          type: array
          items:
            type: object
            properties:
              context:
                type: string
              roles:
                type: array
                items:
                  type: string
    CreateUserRequest:
      type: object
      required:
      - userName
      - password
      properties:
        userName:
          type: string
        password:
          type: string
        roles:
          type: array
          items:
            type: object
            properties:
              context:
                type: string
              roles:
                type: array
                items:
                  type: string
    ClusterNode:
      type: object
      properties:
        name:
          type: string
        hostName:
          type: string
        grpcPort:
          type: integer
        httpPort:
          type: integer
        internalHostName:
          type: string
        internalGrpcPort:
          type: integer
        connected:
          type: boolean
    EventProcessor:
      type: object
      properties:
        name:
          type: string
        mode:
          type: string
        isStreaming:
          type: boolean
        fullName:
          type: string
        tokenStoreIdentifier:
          type: string
        activeThreads:
          type: integer
        canPause:
          type: boolean
        isRunning:
          type: boolean
        isError:
          type: boolean