Генерация API токена
Токен API - это ваш личный ключ для программного доступа к ePulz.io. Он пригодится, когда вы хотите обращаться к сервису из скриптов, собственных инструментов или из CI/CD-конвейера. Через API можно создавать и изменять мониторы, скачивать данные о доступности или встраивать результаты измерений в собственные системы. Это руководство показывает, где сгенерировать токен, как он выглядит, где безопасно его хранить и как его отозвать.
Где сгенерировать токен
Токены привязаны к конкретному пользователю - у каждого участника команды свои токены со своими правами.
- В панели управления откройте раздел Токены API (путь
/dashboard/api-tokens). - Нажмите + Новый токен.
- Введите понятное название, по которому вы узнаете токен (например CI/CD-конвейер или Внутренняя панель).
- Токен действует, пока вы его не отзовёте - у него нет фиксированной даты истечения.
- После нажатия Создать отобразится полное значение токена. Скопируйте его сразу - из соображений безопасности вы больше его не увидите.
Как выглядит токен
Каждый токен начинается с префикса epulzio_ и насчитывает в общей сложности более 40 символов. Пример (сокращённый):
epulzio_2bF7nQ9k4Lm8XzR0pT3vYw5sH1cJ6dE...
Префикс нужен для того, чтобы вы сразу узнавали токен среди других строк - например при поиске по логам или сканировании репозиториев на предмет утёкшего ключа.
Как использовать токен
Токен передаётся в HTTP-заголовке Authorization в виде:
Authorization: Bearer epulzio_xxxxxxxxxxxxxxxx
Пример вызова в терминале:
curl -H "Authorization: Bearer epulzio_..." https://epulz.io/api/v1/monitors
Где безопасно хранить токен
Обращайтесь с токеном как с паролем. Никогда не размещайте его в общедоступном коде, документации или сообщениях в чате.
- Локально во время разработки: в переменной окружения, например
EPULZIO_TOKENв файле.env(который указан в.gitignore). - В CI/CD: через секреты, которые предлагает ваша платформа (GitHub Actions secrets, GitLab CI variables, Bitbucket repository variables и тому подобное).
- На серверах: через системные переменные окружения или менеджер секретов (HashiCorp Vault, AWS Secrets Manager).
Как отозвать токен
- В списке токенов найдите тот, который хотите отозвать, и нажмите Отозвать.
- Отзыв вступает в силу немедленно - последующие вызовы с этим токеном получат ответ
401 Unauthorized(токен недействителен). - Отозванный токен восстановить нельзя. Если он снова понадобится, сгенерируйте новый.
Время от времени просматривайте список активных токенов и удаляйте те, которые уже не используете. Чем меньше активных токенов, тем меньше поверхность для атаки.