---
title: "New request"
method: POST
path: "/requests"
tags: ["Requests"]
---

# New request

`POST /requests`

## Request

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

Registers a new batch request for the given domains. You can use the
returned id in a status request to track progress.

_A note on the domain list_: After the initial validation of the
domains' name, domains are used as-is. No extra logic is used to
produce more test targets e.g, web testing the bare and the www
version of a domain requires both domain names to be present in the
domain list.

## Request body

- RegisterRequest
  - `type` 'web' | 'mail', required
  - `name` string: A free form string that only serves as a reference for the requester. Does not need to be unique.
  - `domains` string[], required: List of domains to test.

## Response `200`

Success

- RegisterResponse
  - `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
- `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)