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

# Cancel Running Incremental Update

> Cancels a currently running incremental sync workflow for the specified cache. This sends a cancellation signal to the underlying Temporal workflow.

The cancellation is best-effort: if the workflow has already completed or is in its final stages, the cancel request may have no effect. Only workflows with a RUNNING status can be cancelled.

After successful cancellation, the cache status transitions to CANCELLED. Data that was already synced before the cancellation remains in the cache. A new incremental sync or full refresh can be triggered after cancellation.

This endpoint only affects the incremental sync workflow. To cancel a full refresh, use the Cancel Full Refresh Update endpoint instead.

<span style={{display: "flex", gap: "10px", flexDirection: "row", alignItems: "center"}}>
  <img src="https://cdn.peaka.com/badges/partner-api-key-badge.png" />

  <img src="https://cdn.peaka.com/badges/project-api-key-badge.png" />
</span>


## OpenAPI

````yaml post /data/projects/{projectId}/cache/{cacheId}/cancelIncrementalUpdate
openapi: 3.0.1
info:
  title: Peaka Gateway API
  description: Peaka Gateway API Documentation
  version: '1.0'
servers:
  - url: https://partner.peaka.studio/api/v1
    description: Default Server URL (US Zone)
  - url: https://partner.eu.peaka.studio/api/v1
    description: EU Zone
security:
  - bearerAuth: []
paths:
  /data/projects/{projectId}/cache/{cacheId}/cancelIncrementalUpdate:
    post:
      tags:
        - Data -- Cache
      summary: Cancel Running Incremental Update
      description: >-
        Cancels a currently running incremental sync workflow for the specified
        cache. This sends a cancellation signal to the underlying Temporal
        workflow.


        The cancellation is best-effort: if the workflow has already completed
        or is in its final stages, the cancel request may have no effect. Only
        workflows with a RUNNING status can be cancelled.


        After successful cancellation, the cache status transitions to
        CANCELLED. Data that was already synced before the cancellation remains
        in the cache. A new incremental sync or full refresh can be triggered
        after cancellation.


        This endpoint only affects the incremental sync workflow. To cancel a
        full refresh, use the Cancel Full Refresh Update endpoint instead.
      operationId: cancelIncrementalCache
      parameters:
        - name: projectId
          in: path
          description: The unique identifier of the project that owns the cache
          required: true
          schema:
            type: string
          example: mtKDhe1U
        - name: cacheId
          in: path
          description: >-
            The unique identifier of the cache whose incremental sync should be
            cancelled (UUID format)
          required: true
          schema:
            type: string
          example: 960bd651-7b3c-4511-9a88-18e14ac7742a
      responses:
        '200':
          description: >-
            Cancellation signal sent successfully. Check cache status to confirm
            the workflow was cancelled.
        '404':
          description: >-
            Cache not found or no running incremental sync workflow exists for
            this cache.
components:
  securitySchemes:
    bearerAuth:
      type: http
      description: >-
        Use the Authorization header with the value 'Bearer <apiKey>' to
        authenticate. Partner API Keys have full access; Project API Keys are
        limited to their project scope. Learn more:
        https://docs.peaka.com/api-reference/authentication
      scheme: bearer
      bearerFormat: Api Key

````