Skip to content
Check

OpenAPI 3.1.0

NexIP REST API

A live API reference generated from the same OpenAPI contract used by integrations and future AI clients.

API v1 NexIP 2.9.0 64 operations 30 scopes
OpenAPI JSON MCP Server API keys

Authentication

Use an API key

Bearer authentication is preferred. X-API-Key remains supported for compatibility.

Preferred Authorization: Bearer nxp_live_...
Compatible X-API-Key: nxp_live_... 
curl -X POST https://nexip.ru/api/v1/tools/dns \
  -H "Authorization: Bearer nxp_live_..." \
  -H "Content-Type: application/json" \
  -d '{"input":"example.com"}'

The full API key is shown only once when it is created.

System

Состояние REST API.

1
GET /api/v1/status Состояние API
PUBLIC
operationId
getApiStatus

curl 

curl -X GET https://nexip.ru/api/v1/status

Tools

Диагностические инструменты NexIP.

1
POST /api/v1/tools/{slug} Запустить диагностический инструмент
API KEY / GUEST tools.run api_access
operationId
runTool
Scope
Запуск инструментов

curl 

curl -X POST https://nexip.ru/api/v1/tools/{slug} \
  -H "Content-Type: application/json" \
  -d '{}'

The exact JSON body depends on the operation schema in OpenAPI.

Monitoring

Мониторы, проверки и инциденты.

8
GET /api/v1/monitors Список мониторов
API KEY monitors.read monitor_api
operationId
listMonitors
Scope
Просмотр мониторов

curl 

curl -X GET https://nexip.ru/api/v1/monitors \
  -H "Authorization: Bearer nxp_live_..."
POST /api/v1/monitors Создать монитор
API KEY monitors.create monitor_api
operationId
createMonitor
Scope
Создание мониторов

curl 

curl -X POST https://nexip.ru/api/v1/monitors \
  -H "Authorization: Bearer nxp_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'

The exact JSON body depends on the operation schema in OpenAPI.

GET /api/v1/monitors/{id} Получить монитор
API KEY monitors.read monitor_api
operationId
getMonitor
Scope
Просмотр мониторов

curl 

curl -X GET https://nexip.ru/api/v1/monitors/{id} \
  -H "Authorization: Bearer nxp_live_..."
PATCH /api/v1/monitors/{id} Изменить монитор
API KEY monitors.update monitor_api
operationId
updateMonitor
Scope
Изменение мониторов

curl 

curl -X PATCH https://nexip.ru/api/v1/monitors/{id} \
  -H "Authorization: Bearer nxp_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'

The exact JSON body depends on the operation schema in OpenAPI.

DELETE /api/v1/monitors/{id} Удалить монитор
API KEY monitors.delete monitor_api
operationId
deleteMonitor
Scope
Удаление мониторов

curl 

curl -X DELETE https://nexip.ru/api/v1/monitors/{id} \
  -H "Authorization: Bearer nxp_live_..."
POST /api/v1/monitors/{id}/check Запустить ручную проверку
API KEY monitors.check monitor_api
operationId
runMonitorCheck
Scope
Ручная проверка монитора

curl 

curl -X POST https://nexip.ru/api/v1/monitors/{id}/check \
  -H "Authorization: Bearer nxp_live_..."
GET /api/v1/monitors/{id}/checks История проверок
API KEY monitors.read monitor_api
operationId
listMonitorChecks
Scope
Просмотр мониторов

curl 

curl -X GET https://nexip.ru/api/v1/monitors/{id}/checks \
  -H "Authorization: Bearer nxp_live_..."
GET /api/v1/monitors/{id}/incidents Инциденты монитора
API KEY monitors.read monitor_api
operationId
listMonitorIncidents
Scope
Просмотр мониторов

curl 

curl -X GET https://nexip.ru/api/v1/monitors/{id}/incidents \
  -H "Authorization: Bearer nxp_live_..."

Notifications

Уведомления и настройки доставки.

7
GET /api/v1/notification-channels Каналы уведомлений
API KEY notifications.read notifications
operationId
listNotificationChannels
Scope
Просмотр уведомлений

curl 

curl -X GET https://nexip.ru/api/v1/notification-channels \
  -H "Authorization: Bearer nxp_live_..."
GET /api/v1/notification-deliveries История доставки уведомлений
API KEY notifications.read notifications
operationId
listNotificationDeliveries
Scope
Просмотр уведомлений

curl 

curl -X GET https://nexip.ru/api/v1/notification-deliveries \
  -H "Authorization: Bearer nxp_live_..."
PATCH /api/v1/notification-preferences Изменить настройки уведомлений
API KEY notifications.write notifications
operationId
updateNotificationPreferences
Scope
Управление уведомлениями

curl 

curl -X PATCH https://nexip.ru/api/v1/notification-preferences \
  -H "Authorization: Bearer nxp_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'

The exact JSON body depends on the operation schema in OpenAPI.

GET /api/v1/notifications Список уведомлений
API KEY notifications.read notifications
operationId
listNotifications
Scope
Просмотр уведомлений

curl 

curl -X GET https://nexip.ru/api/v1/notifications \
  -H "Authorization: Bearer nxp_live_..."
POST /api/v1/notifications/read-all Отметить все уведомления прочитанными
API KEY notifications.write notifications
operationId
markAllNotificationsRead
Scope
Управление уведомлениями

curl 

curl -X POST https://nexip.ru/api/v1/notifications/read-all \
  -H "Authorization: Bearer nxp_live_..."
GET /api/v1/notifications/{id} Получить уведомление
API KEY notifications.read notifications
operationId
getNotification
Scope
Просмотр уведомлений

curl 

curl -X GET https://nexip.ru/api/v1/notifications/{id} \
  -H "Authorization: Bearer nxp_live_..."
POST /api/v1/notifications/{id}/read Отметить уведомление прочитанным
API KEY notifications.write notifications
operationId
markNotificationRead
Scope
Управление уведомлениями

curl 

curl -X POST https://nexip.ru/api/v1/notifications/{id}/read \
  -H "Authorization: Bearer nxp_live_..."

Billing

Тариф, подписка и платежи пользователя.

9
POST /api/v1/billing/checkout Создать оплату
API KEY billing.write billing
operationId
createCheckout
Scope
Управление биллингом

curl 

curl -X POST https://nexip.ru/api/v1/billing/checkout \
  -H "Authorization: Bearer nxp_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'

The exact JSON body depends on the operation schema in OpenAPI.

GET /api/v1/billing/orders Заказы пользователя
API KEY billing.read billing
operationId
listBillingOrders
Scope
Просмотр биллинга

curl 

curl -X GET https://nexip.ru/api/v1/billing/orders \
  -H "Authorization: Bearer nxp_live_..."
GET /api/v1/billing/orders/{publicId} Получить заказ
API KEY billing.read billing
operationId
getBillingOrder
Scope
Просмотр биллинга

curl 

curl -X GET https://nexip.ru/api/v1/billing/orders/{publicId} \
  -H "Authorization: Bearer nxp_live_..."
GET /api/v1/billing/payment-methods Способы оплаты
API KEY billing.read billing
operationId
getPaymentMethods
Scope
Просмотр биллинга

curl 

curl -X GET https://nexip.ru/api/v1/billing/payment-methods \
  -H "Authorization: Bearer nxp_live_..."
GET /api/v1/billing/plans Тарифы
API KEY billing.read billing
operationId
getBillingPlans
Scope
Просмотр биллинга

curl 

curl -X GET https://nexip.ru/api/v1/billing/plans \
  -H "Authorization: Bearer nxp_live_..."
GET /api/v1/billing/providers Платёжные провайдеры
API KEY billing.read billing
operationId
getBillingProviders
Scope
Просмотр биллинга

curl 

curl -X GET https://nexip.ru/api/v1/billing/providers \
  -H "Authorization: Bearer nxp_live_..."
GET /api/v1/billing/subscription Текущая подписка
API KEY billing.read billing
operationId
getSubscription
Scope
Просмотр биллинга

curl 

curl -X GET https://nexip.ru/api/v1/billing/subscription \
  -H "Authorization: Bearer nxp_live_..."
POST /api/v1/billing/subscription/cancel Отключить автопродление подписки
API KEY billing.write billing
operationId
cancelSubscription
Scope
Управление биллингом

curl 

curl -X POST https://nexip.ru/api/v1/billing/subscription/cancel \
  -H "Authorization: Bearer nxp_live_..."
POST /api/v1/billing/subscription/resume Возобновить подписку
API KEY billing.write billing
operationId
resumeSubscription
Scope
Управление биллингом

curl 

curl -X POST https://nexip.ru/api/v1/billing/subscription/resume \
  -H "Authorization: Bearer nxp_live_..."

Reports

Создание и управление отчётами.

11
GET /api/v1/report-schedules Расписания отчётов
API KEY reports.read reports
operationId
listReportSchedules
Scope
Просмотр отчётов

curl 

curl -X GET https://nexip.ru/api/v1/report-schedules \
  -H "Authorization: Bearer nxp_live_..."
POST /api/v1/report-schedules Создать расписание отчёта
API KEY reports.create reports
operationId
createReportSchedule
Scope
Создание отчётов

curl 

curl -X POST https://nexip.ru/api/v1/report-schedules \
  -H "Authorization: Bearer nxp_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'

The exact JSON body depends on the operation schema in OpenAPI.

GET /api/v1/report-templates Шаблоны отчётов
API KEY reports.read reports
operationId
listReportTemplates
Scope
Просмотр отчётов

curl 

curl -X GET https://nexip.ru/api/v1/report-templates \
  -H "Authorization: Bearer nxp_live_..."
GET /api/v1/reports Список отчётов
API KEY reports.read reports
operationId
listReports
Scope
Просмотр отчётов

curl 

curl -X GET https://nexip.ru/api/v1/reports \
  -H "Authorization: Bearer nxp_live_..."
POST /api/v1/reports Создать отчёт
API KEY reports.create reports
operationId
createReport
Scope
Создание отчётов

curl 

curl -X POST https://nexip.ru/api/v1/reports \
  -H "Authorization: Bearer nxp_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'

The exact JSON body depends on the operation schema in OpenAPI.

GET /api/v1/reports/{publicId} Получить отчёт
API KEY reports.read reports
operationId
getReport
Scope
Просмотр отчётов

curl 

curl -X GET https://nexip.ru/api/v1/reports/{publicId} \
  -H "Authorization: Bearer nxp_live_..."
DELETE /api/v1/reports/{publicId} Удалить отчёт
API KEY reports.delete reports
operationId
deleteReport
Scope
Удаление отчётов

curl 

curl -X DELETE https://nexip.ru/api/v1/reports/{publicId} \
  -H "Authorization: Bearer nxp_live_..."
GET /api/v1/reports/{publicId}/download/{format} Скачать готовый файл отчёта
API KEY reports.read reports
operationId
downloadReport
Scope
Просмотр отчётов

curl 

curl -X GET https://nexip.ru/api/v1/reports/{publicId}/download/{format} \
  -H "Authorization: Bearer nxp_live_..."
POST /api/v1/reports/{publicId}/retry Повторить создание отчёта
API KEY reports.create reports
operationId
retryReport
Scope
Создание отчётов

curl 

curl -X POST https://nexip.ru/api/v1/reports/{publicId}/retry \
  -H "Authorization: Bearer nxp_live_..."
POST /api/v1/reports/{publicId}/send Отправить отчёт
API KEY reports.send reports
operationId
sendReport
Scope
Отправка отчётов

curl 

curl -X POST https://nexip.ru/api/v1/reports/{publicId}/send \
  -H "Authorization: Bearer nxp_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'

The exact JSON body depends on the operation schema in OpenAPI.

POST /api/v1/reports/{publicId}/share Опубликовать отчёт
API KEY reports.share reports
operationId
shareReport
Scope
Публикация отчётов

curl 

curl -X POST https://nexip.ru/api/v1/reports/{publicId}/share \
  -H "Authorization: Bearer nxp_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'

The exact JSON body depends on the operation schema in OpenAPI.

SEO Audit

Полные SEO-аудиты сайтов.

11
GET /api/v1/seo-audits Список SEO-аудитов
API KEY seo-audits.read seo_audits
operationId
listSeoAudits
Scope
Просмотр SEO-аудитов

curl 

curl -X GET https://nexip.ru/api/v1/seo-audits \
  -H "Authorization: Bearer nxp_live_..."
POST /api/v1/seo-audits Создать SEO-аудит
API KEY seo-audits.create seo_audits
operationId
createSeoAudit
Scope
Запуск SEO-аудитов

curl 

curl -X POST https://nexip.ru/api/v1/seo-audits \
  -H "Authorization: Bearer nxp_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'

The exact JSON body depends on the operation schema in OpenAPI.

GET /api/v1/seo-audits/{publicId} Получить SEO-аудит
API KEY seo-audits.read seo_audits
operationId
getSeoAudit
Scope
Просмотр SEO-аудитов

curl 

curl -X GET https://nexip.ru/api/v1/seo-audits/{publicId} \
  -H "Authorization: Bearer nxp_live_..."
DELETE /api/v1/seo-audits/{publicId} Удалить SEO-аудит
API KEY seo-audits.delete seo_audits
operationId
deleteSeoAudit
Scope
Удаление SEO-аудитов

curl 

curl -X DELETE https://nexip.ru/api/v1/seo-audits/{publicId} \
  -H "Authorization: Bearer nxp_live_..."
POST /api/v1/seo-audits/{publicId}/cancel Отменить SEO-аудит
API KEY seo-audits.update seo_audits
operationId
cancelSeoAudit
Scope
Управление SEO-аудитами

curl 

curl -X POST https://nexip.ru/api/v1/seo-audits/{publicId}/cancel \
  -H "Authorization: Bearer nxp_live_..."
POST /api/v1/seo-audits/{publicId}/compare Сравнить два SEO-аудита
API KEY seo-audits.read seo_audits
operationId
compareSeoAudits
Scope
Просмотр SEO-аудитов

curl 

curl -X POST https://nexip.ru/api/v1/seo-audits/{publicId}/compare \
  -H "Authorization: Bearer nxp_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'

The exact JSON body depends on the operation schema in OpenAPI.

GET /api/v1/seo-audits/{publicId}/export/{format} Экспортировать SEO-аудит
API KEY seo-audits.export seo_audits
operationId
exportSeoAudit
Scope
Экспорт SEO-аудитов

curl 

curl -X GET https://nexip.ru/api/v1/seo-audits/{publicId}/export/{format} \
  -H "Authorization: Bearer nxp_live_..."
GET /api/v1/seo-audits/{publicId}/issues Проблемы SEO-аудита
API KEY seo-audits.read seo_audits
operationId
listSeoAuditIssues
Scope
Просмотр SEO-аудитов

curl 

curl -X GET https://nexip.ru/api/v1/seo-audits/{publicId}/issues \
  -H "Authorization: Bearer nxp_live_..."
GET /api/v1/seo-audits/{publicId}/links Ссылки SEO-аудита
API KEY seo-audits.read seo_audits
operationId
listSeoAuditLinks
Scope
Просмотр SEO-аудитов

curl 

curl -X GET https://nexip.ru/api/v1/seo-audits/{publicId}/links \
  -H "Authorization: Bearer nxp_live_..."
GET /api/v1/seo-audits/{publicId}/pages Страницы SEO-аудита
API KEY seo-audits.read seo_audits
operationId
listSeoAuditPages
Scope
Просмотр SEO-аудитов

curl 

curl -X GET https://nexip.ru/api/v1/seo-audits/{publicId}/pages \
  -H "Authorization: Bearer nxp_live_..."
POST /api/v1/seo-audits/{publicId}/retry Повторить SEO-аудит
API KEY seo-audits.update seo_audits
operationId
retrySeoAudit
Scope
Управление SEO-аудитами

curl 

curl -X POST https://nexip.ru/api/v1/seo-audits/{publicId}/retry \
  -H "Authorization: Bearer nxp_live_..."

Comparisons

Сравнение сайтов и метрик.

11
GET /api/v1/comparisons Список сравнений
API KEY comparisons.read comparisons
operationId
listComparisons
Scope
Просмотр сравнений

curl 

curl -X GET https://nexip.ru/api/v1/comparisons \
  -H "Authorization: Bearer nxp_live_..."
POST /api/v1/comparisons Создать сравнение
API KEY comparisons.create comparisons
operationId
createComparison
Scope
Создание сравнений

curl 

curl -X POST https://nexip.ru/api/v1/comparisons \
  -H "Authorization: Bearer nxp_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'

The exact JSON body depends on the operation schema in OpenAPI.

GET /api/v1/comparisons/{id} Получить сравнение
API KEY comparisons.read comparisons
operationId
getComparison
Scope
Просмотр сравнений

curl 

curl -X GET https://nexip.ru/api/v1/comparisons/{id} \
  -H "Authorization: Bearer nxp_live_..."
DELETE /api/v1/comparisons/{id} Удалить сравнение
API KEY comparisons.delete comparisons
operationId
deleteComparison
Scope
Удаление сравнений

curl 

curl -X DELETE https://nexip.ru/api/v1/comparisons/{id} \
  -H "Authorization: Bearer nxp_live_..."
GET /api/v1/comparisons/{id}/export/{format} Экспортировать сравнение
API KEY comparisons.export comparisons
operationId
exportComparison
Scope
Экспорт сравнений

curl 

curl -X GET https://nexip.ru/api/v1/comparisons/{id}/export/{format} \
  -H "Authorization: Bearer nxp_live_..."
GET /api/v1/comparisons/{id}/history History сравнения
API KEY comparisons.read comparisons
operationId
getComparisonHistory
Scope
Просмотр сравнений

curl 

curl -X GET https://nexip.ru/api/v1/comparisons/{id}/history \
  -H "Authorization: Bearer nxp_live_..."
GET /api/v1/comparisons/{id}/insights Insights сравнения
API KEY comparisons.read comparisons
operationId
getComparisonInsights
Scope
Просмотр сравнений

curl 

curl -X GET https://nexip.ru/api/v1/comparisons/{id}/insights \
  -H "Authorization: Bearer nxp_live_..."
GET /api/v1/comparisons/{id}/metrics Metrics сравнения
API KEY comparisons.read comparisons
operationId
getComparisonMetrics
Scope
Просмотр сравнений

curl 

curl -X GET https://nexip.ru/api/v1/comparisons/{id}/metrics \
  -H "Authorization: Bearer nxp_live_..."
POST /api/v1/comparisons/{id}/retry Повторить сравнение
API KEY comparisons.update comparisons
operationId
retryComparison
Scope
Управление сравнениями

curl 

curl -X POST https://nexip.ru/api/v1/comparisons/{id}/retry \
  -H "Authorization: Bearer nxp_live_..."
POST /api/v1/comparisons/{id}/run Запустить сравнение
API KEY comparisons.update comparisons
operationId
runComparison
Scope
Управление сравнениями

curl 

curl -X POST https://nexip.ru/api/v1/comparisons/{id}/run \
  -H "Authorization: Bearer nxp_live_..."
POST /api/v1/comparisons/{id}/share Создать отчёт по сравнению
API KEY comparisons.share comparisons
operationId
shareComparison
Scope
Публикация сравнений

curl 

curl -X POST https://nexip.ru/api/v1/comparisons/{id}/share \
  -H "Authorization: Bearer nxp_live_..."

Public Entities

Публичные данные IP, доменов и сайтов.

5
GET /api/v1/public/domain/{value} Публичные данные: domain
PUBLIC
operationId
getPublicDomain

curl 

curl -X GET https://nexip.ru/api/v1/public/domain/{value}
POST /api/v1/public/entities/refresh Поставить публичную сущность на обновление
API KEY public-entities.write public_entities
operationId
refreshPublicEntity
Scope
Управление публичными сущностями

curl 

curl -X POST https://nexip.ru/api/v1/public/entities/refresh \
  -H "Authorization: Bearer nxp_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'

The exact JSON body depends on the operation schema in OpenAPI.

GET /api/v1/public/entities/{id}/status Статус публичной сущности
PUBLIC
operationId
getPublicEntityStatus

curl 

curl -X GET https://nexip.ru/api/v1/public/entities/{id}/status
GET /api/v1/public/ip/{value} Публичные данные: ip
PUBLIC
operationId
getPublicIp

curl 

curl -X GET https://nexip.ru/api/v1/public/ip/{value}
GET /api/v1/public/site/{value} Публичные данные: site
PUBLIC
operationId
getPublicSite

curl 

curl -X GET https://nexip.ru/api/v1/public/site/{value}

Contract

Standard errors

400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
409 Conflict
422 Validation
429 Rate Limit
503 Unavailable 
{
  "ok": false,
  "error": {
    "code": "scope_denied",
    "message": "..."
  },
  "meta": {
    "request_id": "req_...",
    "api_version": "v1"
  }
}