Режим API (api)

Описание

Режим api позволяет выполнять прямые вызовы к API Пассворка с получением ответов в формате JSON.

Синтаксис

shell

passwork-cli api [опции]

Параметры API

Команде api необходимы следующие параметры:

Параметр	Описание
--method	HTTP-метод (GET, POST, PUT, DELETE, PATCH)
--endpoint	Путь API (например, v1/vaults)
--params	JSON-строка с параметрами (необязательно)
--field	Имя поля для извлечения из ответа (необязательно)

Как это работает

1. Аутентификация: Подключение к серверу Пассворка;
2. Формирование запроса: Создание HTTP-запроса по указанному пути и методу;
3. Отправка запроса: Отправка запроса с нужными заголовками авторизации;
4. Обработка ответа: Получение и разбор ответа от API;
5. Фильтрация (опционально): Извлечение указанного поля с помощью --field;
6. Вывод: Результат выводится в формате JSON.

Примеры использования

Получение списка всех сейфов:

shell

passwork-cli api --method GET --endpoint "v1/vaults"

Получение элемента и извлечение только имени:

shell

passwork-cli api --method GET --endpoint "v1/items/password_id" --field "name"

Поиск элементов по тегам и получение имён из элементов:

shell

passwork-cli api \
  --method GET \
  --endpoint "v1/items/search" \
  --params '{"tags":["api","production"]}' \
  --field "name"

Ротация accessToken-а и refreshToken-а:

shell

passwork-cli api \
  --host "https://passwork.example.com" \
  --token "your_expired_token" \
  --refresh-token "your_refresh_token" \
  --method POST \
  --endpoint "v1/sessions/refresh" \
  --field "token"

Использование с самоподписанным сертификатом:

shell

passwork-cli api --no-ssl-verify --method GET --endpoint "v1/user/profile"

Примечания

• Все ответы возвращаются в формате JSON;
• Параметр --field позволяет извлечь конкретное поле из ответа;
• Параметр --params используется для передачи данных в запросах POST, PUT, PATCH;
• Для самоподписанных сертификатов необходимо использовать --no-ssl-verify.