---
title: "Cancel a batch recovery request"
method: PATCH
path: "/api/v2/rum/recover/requests/{request_id}"
tags: ["RUM Recovery"]
---

# Cancel a batch recovery request

`PATCH /api/v2/rum/recover/requests/{request_id}`

## Request

- Base URL: `https://api.datadoghq.com`
- URL: `https://api.datadoghq.com/api/v2/rum/recover/requests/{request_id}`
- Auth: API key in header `DD-API-KEY` and API key in header `DD-APPLICATION-KEY`
- TypeScript: <https://skmtc.dev/datadog/apis/datadog-api-v2-collection/docs/api/v2/rum/recover/requests/:request_id/patch.ts> (a function with typed inputs; its response is checked against the schema)

Cancel pending work for a batch recovery request. Work already in progress can finish, and recovered data is not removed. Requests in a terminal state return `409`.

## Path parameters

- `request_id` string, uuid, required: Request identifier.

## Request body

- RumRecoveryCancelRequest: JSON:API document.
  - `data` RumRecoveryCancelData, required: JSON:API resource.
    - `attributes` RumRecoveryCancelAttributes, required: Batch cancellation.
      - `status` 'cancelled', required: Requested cancellation state.
    - `id` string: Optional resource identifier.
    - `type` string: JSON:API resource type.

## Response `200`

OK

- RumRecoveryCancelResponse: JSON:API document.
  - `data` RumRecoveryCancelResponseData, required: JSON:API resource.
    - `attributes` RumRecoveryCancelResponseAttributes, required: Batch cancellation acknowledgment.
      - `cancelled_at` string, date-time, required: Cancellation time.
      - `cancelled_by` string, required: Handle of the user who canceled the batch.
      - `discovery_status` 'QUEUED' | 'PENDING' | 'SLICING' | 'DISCOVERED' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'CANCELLED', required: Batch discovery state. QUEUED indicates that the request is waiting for processing capacity.
    - `id` string, required: Resource identifier.
    - `type` 'rum_recovery_request', required: JSON:API resource type.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `409`: Conflict
- `429`: Too Many Requests

---

[API](https://skmtc.dev/datadog/apis/datadog-api-v2-collection.md) - [All operations](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/llms.txt) - [OpenAPI document](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/revisions/3f70db624329?raw)
