---
title: "Cancel request"
method: PATCH
path: "/requests/{request_id}"
tags: ["Requests"]
---

# Cancel request

`PATCH /requests/{request_id}`

## Request

- The document declares no server URL.
- Auth: HTTP basic

Cancels the request. No resuming is possible. Allows to cancel a request that was incorrectly submitted in order to give way to subsequent requests to start testing.

## Request body

- object
  - `status` 'cancelled', required

## Response `200`

Success

- CancelResponse
  - `api_version` string, required
  - `request` Request, required
    - `request_id` string, required: UUID of the request.
    - `name` string, required: A free form string that only serves as a reference for the requester. Does not need to be unique.
    - `request_type` 'web' | 'mail', required
    - `status` 'registering' | 'running' | 'generating' | 'done' | 'cancelled' | 'error', required: * `registering` - Registering domains. * `running` - Domains are being tested. * `generating` - Report is being generated. * `done` - Results ready. * `cancelled` - Cancelled by the user. * `error` - Error registering domains.
    - `submit_date` string, date-time, required
    - `finished_date` string, date-time, required: Only set when the tests are completed.

## Other responses

- `400`: Bad request
- `401`: Unauthorised
- `404`: Unknown request
- `500`: General server error

---

[API](https://skmtc.dev/internetstandards/apis/override-this-value-in-internetnl-batch-api-doc-conf-py.md) - [All operations](https://skmtc.dev/internetstandards/apis/override-this-value-in-internetnl-batch-api-doc-conf-py/llms.txt) - [OpenAPI document](https://skmtc.dev/internetstandards/apis/override-this-value-in-internetnl-batch-api-doc-conf-py/revisions/04dfb2002730?raw)