> For the complete documentation index see https://domscan.net/llms.txt. Markdown versions of every docs page are available by appending .md to the page URL.

Source: https://domscan.net/ru/docs/versioning

# Версионирование и устаревание

Версия API входит в путь, например /v1/status . В пределах одной версии существующие запросы продолжают работать.

Версия API входит в путь, например `/v1/status`. В пределах одной версии существующие запросы продолжают работать. На этой странице объясняется, что может измениться, за какой срок вас предупредят и как найти запросы, которые нужно обновить.

### Изменения без предупреждения

Новые эндпоинты, необязательные параметры, поля ответа, значения в существующих списках вариантов, заголовки ответа и коды ошибок могут добавляться в любое время. Пишите клиенты так, чтобы они игнорировали неизвестные поля и корректно обрабатывали новые значения.

### Критические изменения

Удаление или переименование эндпоинта, параметра или поля, а также изменение их смысла происходят только после уведомления не менее чем за 12 месяцев. В течение этого срока прежняя форма продолжает работать, ответы на запросы, которые её используют, содержат заголовки `Deprecation` и `Sunset`, а изменение указывается в журнале изменений.

### Именование ключей ответа

Большинство ключей ответа записаны в snake_case. Чтобы получить все ключи в snake_case, добавьте `naming=snake` или отправьте заголовок `DomScan-Naming: snake`. Это включается по желанию, поэтому ответы по умолчанию не меняются. См. [ключи snake_case](https://domscan.net/ru/docs/response-format#naming).

### Устаревшие псевдонимы

Эти прежние параметры по-прежнему работают. Каждый из них продолжает работать как минимум до даты sunset. Перейдите на замену до этой даты.

| Параметр | Эндпоинт | Что использовать вместо него | Объявлен устаревшим | Sunset |
| --- | --- | --- | --- | --- |
| `prefer_cache` | `GET /v1/status` | `max_age=2592000` | 2026-10-10 | 2027-10-10 |
| `skip_cache` | `GET /v1/status` | `max_age=0` | 2026-10-10 | 2027-10-10 |
| `cache_skip` | `GET /v1/status` | `max_age=0` | 2026-10-10 | 2027-10-10 |
| `cache-skip` | `GET /v1/status` | `max_age=0` | 2026-10-10 | 2027-10-10 |
| `options.prefer_cache` (Тело JSON) | `POST /v1/status/bulk` | `max_age=2592000` | 2026-10-10 | 2027-10-10 |
| `prefer_cache` (Тело JSON) | `POST /v1/status/bulk` | `max_age=2592000` | 2026-10-10 | 2027-10-10 |
| `options.skip_cache` (Тело JSON) | `POST /v1/status/bulk` | `max_age=0` | 2026-10-10 | 2027-10-10 |
| `options.cache_skip` (Тело JSON) | `POST /v1/status/bulk` | `max_age=0` | 2026-10-10 | 2027-10-10 |
| `options.cache-skip` (Тело JSON) | `POST /v1/status/bulk` | `max_age=0` | 2026-10-10 | 2027-10-10 |
| `prefer_cache` | `GET /v1/subdomains` | `max_age=2592000` | 2026-10-10 | 2027-10-10 |
| `skip_cache` | `GET /v1/tech` | `max_age=0` | 2026-10-10 | 2027-10-10 |
| `skip_cache` | `GET /v1/categorize` | `max_age=0` | 2026-10-10 | 2027-10-10 |
| `skip_cache` | `GET /v1/identity-assets` | `max_age=0` | 2026-10-10 | 2027-10-10 |
| `skip_cache` | `GET /v1/identity-resolution` | `max_age=0` | 2026-10-10 | 2027-10-10 |
| `skip_cache` | `GET /v1/url-intelligence` | `max_age=0` | 2026-10-10 | 2027-10-10 |
| `skip_cache` | `GET /v1/agent-readiness` | `max_age=0` | 2026-10-10 | 2027-10-10 |
| `skip_cache` | `GET /v1/robots` | `max_age=0` | 2026-10-10 | 2027-10-10 |
| `refresh` | `GET /v1/ssl/deep-scan` | `max_age=0` | 2026-10-10 | 2027-10-10 |
| `cursor` (числовое значение) | `GET /v1/certificates` | `cursor=<next_cursor>` | 2026-10-10 | 2027-10-10 |
| `offset` | `GET /v1/email/blacklist` | `cursor=<next_cursor>` | 2026-10-10 | 2027-10-10 |

### Как обнаружить устаревшие элементы

Запрос, использующий устаревший псевдоним, получает эти заголовки ответа. Тело ответа остаётся прежним.

- `Deprecation`: дата, когда псевдоним был объявлен устаревшим, в виде `@` и числа секунд Unix (RFC 9745).

- `Sunset`: самая ранняя дата, когда псевдоним может перестать работать (RFC 8594).

- `Link`: ссылка на эту страницу с `rel="deprecation"`.

```bash
curl -i -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/status?name=example&tlds=com&skip_cache=true"

Deprecation: @1791590400
Sunset: Sun, 10 Oct 2027 00:00:00 GMT
Link: <https://domscan.net/docs/versioning#deprecated-aliases>; rel="deprecation"; type="text/html"
```

Браузеры могут читать все три заголовка. Записывайте их в журнал или настройте оповещение по `Deprecation`, чтобы найти код, который нужно обновить до даты sunset.

О каждом устаревании также сообщается в [журнале изменений API](https://domscan.net/ru/changelog).