Прямые запросы
Команда pachca api делает две вещи:
- прямой HTTP-запрос к любому методу API — для нестандартных вызовов, отладки или метода без удобной обёртки
- встроенный справочник по API — список методов и справку по каждому (параметры, тело, схема, пример) можно получить прямо в терминале, не открывая сайт документации
Для типовых задач удобнее типизированные команды — так написаны все примеры в документации и интеграции. Команда pachca api дополняет их.
Прямой HTTP-запрос
Имена полей с квадратными скобками берите в кавычки: zsh считает [...] шаблоном имён файлов и без кавычек обрывает команду ошибкой no matches found.
-F превращает true, false, null и числа в значения JSON, а @файл подставляет содержимое файла строкой. -f всегда передаёт строку. Тело задают одним способом: полями -f и -F, файлом --input или строкой --data. Вместе их передать нельзя, команда ответит ошибкой PACHCA_USAGE_ERROR.
Чтобы передать несколько значений одного параметра, повторите --query с тем же именем: CLI отправит все значения по порядку. Так передают параметр-массив, например company_roles[]:
Команда pachca api DELETE удаляет сразу, без подтверждения, подробнее — в разделе Деструктивные операции.
pachca api выводит сырой ответ API без извлечения данных из обёртки dataВстроенный справочник по API
Не нужно искать путь и параметры на сайте документации — список методов и справку по каждому CLI показывает прямо в терминале. Данные генерируются из той же OpenAPI-спецификации, из которой собран сам CLI, поэтому совпадают с командами установленной версии.
api ls, --describe, --spec и --docs читают встроенную спецификацию и работают до pachca auth login: токен и сеть им не нужны.
Эквивалентная команда в --describe повторяет пример запроса из справки метода: её можно скопировать и запустить, подставив свои значения.
Метод указывается позиционно, поэтому --describe/--spec/--docs всегда однозначны — отдельный -X не нужен.
Полезно и агентам: они в основном работают типизированными командами, а когда нужного метода нет под рукой — api ls/--describe дают точечную справку, не загружая всю документацию в контекст.