Получить список агентов печати
Получите список агентов CloudPrint в аккаунте и проверьте их статус, версию и состояние обновления.
Назначение метода
Получите список агентов CloudPrint в аккаунте и проверьте их статус, версию и состояние обновления.
Авторизация
Передавайте короткоживущий токен в Authorization: Bearer <access_token>.
Обязательные разрешения: agents:read
Запрос
Основной адрес API: https://public-api.cloudprint.me/api/v1/agents
Параметры
| Имя | Расположение | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|---|
limit | query | integer | нет | Максимальное количество ресурсов на одной странице. | min: 1; max: 100; default: 50 |
cursor | query | string | null | нет | Непрозрачный курсор страницы результатов; передавайте его без изменений. | — |
X-Request-Id | header | string | нет | Необязательный идентификатор для трассировки запроса; CloudPrint вернёт безопасное значение в заголовке ответа. | maxLength: 128; example: "order-100045-attempt-1" |
Тело запроса
У метода нет тела запроса.
Примеры запросов
cURL
bash
curl -sS 'https://public-api.cloudprint.me/api/v1/agents?limit=50' \
-H "Authorization: Bearer $ACCESS_TOKEN"Ответ
HTTP-статус: 200 — Запрос выполнен.
Поля ответа
| Имя | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
agents | array | да | Агенты, зарегистрированные в текущем аккаунте CloudPrint. | — |
next_cursor | string | null | да | Непрозрачный cursor следующей страницы; передавайте его без изменений. | — |
Пример ответа
json
{
"agents": [
{
"agent_id": "11111111-1111-4111-8111-111111111111",
"name": "Warehouse PC agent",
"status": "online",
"agent_instance_id": "string",
"hostname": "string",
"version": "string",
"build_flavor": "standard",
"update": {
"status": "available",
"current_version": "0.1.0",
"latest_version": "0.1.1",
"minimum_supported_version": "0.1.0",
"channel": "stable",
"required": false
},
"last_seen_at": "2026-08-06T12:00:00Z"
}
],
"next_cursor": "string"
}Ошибки
| HTTP-статус | Описание |
|---|---|
401 | Авторизация отсутствует или недействительна. |
403 | Для операции недостаточно разрешений. |
422 | Поля запроса не прошли проверку. |
429 | Превышен лимит запросов; учитывайте Retry-After. |
500 | Внутренняя ошибка CloudPrint. |
Рекомендации по интеграции
- Статус агента — диагностическая информация, а не ключ маршрутизации на принтер.
- Проверяйте состояние обновления агента до диагностики принтера или документа.
Связанная документация
Local Printer API для веб-приложений и SaaSПодключите сервер веб-приложения к локальным принтерам через CloudPrint Agent, получите очереди через API и маршрутизируйте по стабильному printer_id.Получить список доступных принтеровПолучите принтеры подключённых агентов CloudPrint и выберите стабильный printer_id для сценария печати.Диагностика агентов, принтеров и заданийНаходите причину ошибок CloudPrint по идентификатору запроса, статусу задания, подключению агента, возможностям принтера и коду API.