RUM Recovery

Cancel a batch recovery request

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.

patch/api/v2/rum/recover/requests/{request_id}

Request

Path parameters

request_idstring uuid required

Request identifier.

Example:11111111-1111-4111-8111-111111111111

Recovery request UUID.

Request body

Example request

{
  "data": {
    "attributes": {
      "status": "cancelled"
    },
    "id": "11111111-1111-4111-8111-111111111111",
    "type": "rum_recovery_request"
  }
}

Response

OK

Example response

{
  "data": {
    "attributes": {
      "cancelled_at": "2026-09-21T12:00:00Z",
      "cancelled_by": "user@example.com",
      "discovery_status": "QUEUED"
    },
    "id": "11111111-1111-4111-8111-111111111111",
    "type": "rum_recovery_request"
  }
}

Changes

Changes to this operation have not been checked yet.