Перейти до змісту

REST API

Платформа надає REST API для інтеграції з вашими системами — automation, SIEM, ticketing, custom dashboards.

Базовий URL

https://bcp.bytecode.team/api/v1/

Автентифікація

Усі запити вимагають Bearer-токен у заголовку:

http Authorization: Bearer YOUR_API_TOKEN

Як отримати токен: див. Профіль користувача → API tokens.

Формат

  • Request/response — JSON.
  • Дати — ISO 8601 UTC (2026-06-29T10:23:45Z).
  • Pagination — cursor-based через next_cursor параметр.
  • Errors — стандартні HTTP коди + JSON body з error.code і error.message.

Основні endpoints

Findings

Метод Endpoint Опис
GET /findings Список findings з фільтрами
GET /findings/{id} Деталі finding
PATCH /findings/{id} Оновити (status, tags, assignee)
POST /findings/{id}/comment Додати коментар

Параметри фільтрації: severity, source, status, from, to, data_source.

Detection Sources

Метод Endpoint Опис
GET /detection-sources Список підключених сервісів
POST /detection-sources/{type}/scan Тригернути ad-hoc скан

Scan Schedules

Метод Endpoint Опис
GET /scan-schedules Список розкладів
POST /scan-schedules Створити
PATCH /scan-schedules/{id} Оновити
DELETE /scan-schedules/{id} Видалити

Reports

Метод Endpoint Опис
GET /reports Список звітів
POST /reports Згенерувати ad-hoc
GET /reports/{id}/export?format={pdf\|docx\|csv} Експорт
GET /scheduled-reports Заплановані звіти
POST /scheduled-reports Створити

DataSources

Метод Endpoint Опис
GET /data-sources Список
POST /data-sources Додати
DELETE /data-sources/{id} Видалити

Organization

Метод Endpoint Опис
GET /organization Інфо про поточну організацію
GET /organization/members Список членів команди
POST /organization/invitations Запросити

Rate limits

  • Default: 100 запитів/хв на токен.
  • Burst: до 200/хв short-term.
  • Enterprise: вищі ліміти за домовленістю.

При перевищенні — HTTP 429 з заголовком Retry-After.

Приклади

Отримати останні critical findings

bash curl -H "Authorization: Bearer $TOKEN" \ "https://bcp.bytecode.team/api/v1/findings?severity=critical&status=new"

Закрити finding як false positive

bash curl -X PATCH \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{"status": "false_positive", "comment": "Тестовий ключ, не активний"}' \ "https://bcp.bytecode.team/api/v1/findings/find_xyz789"

Тригернути HIBP-скан

bash curl -X POST \ -H "Authorization: Bearer $TOKEN" \ "https://bcp.bytecode.team/api/v1/detection-sources/hibp/scan"

SDK

Офіційно підтримувані SDK:

OpenAPI spec

Повна специфікація доступна:

Підтримка

api-support@bytecode.team — для технічних запитань.