Начало работы с API токенами
Этот раздел описывает процесс создания API токена для доступа к Teleport API.
1. Создание API токена
Шаг 1. Авторизация в Dashboard
Перейдите в панель управления Teleport и откройте раздел:
Integration → API Tokens
Или используйте прямую ссылку:
https://vuedashboard.tlprt.cloud/apiKey
Шаг 2. Генерация токена
Нажмите кнопку Generate new API Token и заполните форму создания.
При создании токена указываются:
| Поле | Описание | Обязательность |
|---|---|---|
| Name | Имя токена для идентификации | Необязательно |
| Expiration date | Срок действия токена | Необязательно |
| Select permissions | Разрешение доступа | Обязательно |
Обязательное требование
Необходимо выбрать одно из разрешений — peering-level или external-stat.
Без выбора разрешения токен создан не будет.
2. Создание токена для External Statistics API
Для использования External Statistics API необходимо выбрать разрешение: external-stat
После создания токена его можно использовать в заголовке запроса:
| Параметр | Описание |
|---|---|
| Teleport-Token | API токен для доступа к External Statistics API |
3. Создание токена для Peering Level API
Для использования Peering Level API необходимо выбрать разрешение: peering-level
При создании такого токена дополнительно требуется указать Key Hash.
| Поле | Описание | Обязательность |
|---|---|---|
| Key Hash | API ключи, для которых будет применяться токен | Обязательно |
Key Hash — это уникальный идентификатор ключа Teleport.
Токен должен быть привязан минимум к одному ключу.
Можно выбрать один или несколько ключей.
Все операции Peering Level API будут применяться только к указанным ключам.
4. Сохранение токена
После нажатия кнопки Create API Token сгенерированный токен отобразится на экране.
Важно
Токен отображается только один раз — сразу после создания.
Сохраните его в безопасном месте.
При утере потребуется создать новый токен.
5. Восстановление доступа к токену
Если токен был утерян, определить пользователя, создавшего токен, можно по полю: Creator's email и обратиться к нему для восстановления. Либо создайте новый токен
Этот пользователь может удалить существующий токен и создать новый.
6. Срок действия и статус токена
API токены могут иметь ограниченный срок действия.
В Dashboard отображается текущий статус токена:
- Active — токен активен и может использоваться
- Expired — срок действия истёк
- Locked — токен заблокирован