> ## Documentation Index
> Fetch the complete documentation index at: https://docs.activeviam.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Cancel a running query.

> Cancels the running query with the given ID.

This operation will attempt to stop the query execution and update its status to CANCELLED.
If the query is not currently running, the operation may fail.




## OpenAPI

````yaml patch /activeviam/query-history/rest/v1/query/{id}
openapi: 3.1.0
info:
  title: Atoti REST services
  version: 6.1.19-SNAPSHOT
servers:
  - description: Generated server url
    url: http://localhost:9090
security: []
tags:
  - description: Implementation of the REST API controller for an ActivePivot database.
    name: Database REST API
  - description: >
      XML for Analysis (XMLA) endpoint for executing MDX queries and OLAP
      discovery operations.


      This endpoint implements the XMLA protocol which is used by:

      - Microsoft Excel and other OLAP clients

      - Custom BI tools that support XMLA connectivity


      The endpoint supports both text XML and binary XML formats for improved
      performance.
    name: XMLA API
  - description: Definition of REST API to query data from ActivePivot (V10).
    name: Query REST API (V10)
  - description: Definition of REST API to query data from ActivePivot (V9).
    name: Query REST API (V9)
  - description: Implementation of the REST Bulk API of the content server (version 8).
    name: Bulk REST API
  - description: Implementation of the REST API of the content server.
    name: Content Server REST API
  - description: Implementation of the REST API controller for an ActivePivot database.
    name: Database REST API v9
  - description: ' Definition of the REST service returning the list of services exposed by an application.'
    name: Version REST API
  - description: Rest Service providing the discovery information.
    name: Discovery REST API
  - description: JSON Web Token (JWT) endpoint.
    name: JWT API
  - description: >
      Endpoints to retrieve and manage query history.


      **Note:** This API is experimental and may change in future versions
      without notice.
    name: Query History REST API (Experimental)
  - description: Description of REST API to configure an ActivePivot application.
    name: Configuration REST API
  - description: API to export the result of MDX queries
    name: Data Export
  - description: >
      GetAggregatesQuery (GAQ) REST API for executing OLAP queries.


      This API provides a programmatic way to execute GetAggregatesQuery
      operations

      against Atoti cubes. Results and updates are streamed in Apache Arrow
      format for efficient

      data transfer and processing.
    name: Continuous GAQ Query REST API (Experimental)
  - description: Endpoints for AI-based optimization of Atoti cubes
    name: AI Optimizer
  - description: >
      GetAggregatesQuery (GAQ) REST API for executing OLAP queries.


      This API provides a programmatic way to execute GetAggregatesQuery
      operations

      against Atoti cubes. Results are returned in Apache Arrow format for
      efficient

      data transfer and processing.


      **Note:** This API is experimental and may change in future versions
      without notice.
    name: GAQ Query REST API (Experimental)
  - description: Implementation of the REST Bulk API of the content server.
    name: Bulk REST API
paths:
  /activeviam/query-history/rest/v1/query/{id}:
    patch:
      tags:
        - Query History REST API (Experimental)
      summary: Cancel a running query.
      description: >
        Cancels the running query with the given ID.


        This operation will attempt to stop the query execution and update its
        status to CANCELLED.

        If the query is not currently running, the operation may fail.
      operationId: cancelQueryById
      parameters:
        - description: ID of the query to cancel.
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryHistoryStatusUpdateDto'
        required: true
      responses:
        '204':
          content:
            '*/*':
              schema:
                type: string
          description: Query cancelled successfully.
        '400':
          content:
            '*/*':
              schema:
                type: string
          description: Invalid status update. Status must be CANCELLED.
        '404':
          content:
            '*/*':
              schema:
                type: string
          description: The query could not be found.
        '500':
          content:
            '*/*':
              schema:
                type: string
          description: Query could not be cancelled due to an internal error.
components:
  schemas:
    QueryHistoryStatusUpdateDto:
      properties:
        status:
          enum:
            - CANCELLED
            - FAILED
            - RUNNING
            - SUCCESSFUL
          type: string
      required:
        - status
      type: object

````