Product SiteDocumentation Site

⁠44.2.2. API-токены

API-токены позволяют внешним системам и программам аутентифицироваться при обращении к API PVE без использования билета веб-сеанса. Токены создаются для отдельных пользователей. Для каждого токена можно задать собственные разрешения и срок действия, ограничив объём и продолжительность доступа (подробнее см. раздел API-токены). Если токен скомпрометирован, его можно отозвать без блокировки учётной записи пользователя.
Примеры запросов с использованием API-токена:
  • получить список пользователей:
    $ curl -H 'Authorization: PVEAPIToken=root@pam!test=373007e1-4ecb-4e56-b843-d0fbed543375' \
    https://192.168.0.186:8006/api2/json/access/users
    
  • добавить пользователя testuser@pve:
    $ curl -k -X 'POST' \
    'https://pve01:8006/api2/json/access/users' \
    --data-urlencode 'userid=testuser@pve' \
    -H 'Authorization: PVEAPIToken=root@pam!test=373007e1-4ecb-4e56-b843-d0fbed543375'
    
  • удалить пользователя testuser@pve:
    $ curl -k -X 'DELETE' \
    'https://pve01:8006/api2/json/access/users/testuser@pve' \
    -H 'Authorization: PVEAPIToken=root@pam!test=373007e1-4ecb-4e56-b843-d0fbed543375'
    

Примечание

Если запрос завершается ошибкой вида:
curl: (60) SSL certificate problem: unable to get local issuer certificate
можно дополнить запрос опцией --insecure (-k), чтобы отключить проверку сертификата сервера:
$ curl -k -H 'Authorization: PVEAPIToken=root@pam!test=373007e1-4ecb-4e56-b843-d0fbed543375' \
https://192.168.0.186:8006/api2/json/

Примечание

При использовании API-токена заголовок CSRFPreventionToken для запросов POST, PUT и DELETE не требуется. Это связано с тем, что аутентификация выполняется посредством заголовка Authorization, а не с использованием cookie веб-сеанса.