Получить агентов клиента
Получите всех агентов управляемого клиента, включая отозванных.
GET
/partner-api/v1/accounts/{relationshipId}/agentsВерсия API: v1operationId: listPartnerManagedAgentsОткрыть в MarkdownНазначение метода
Получите всех агентов управляемого клиента, включая отозванных.
Авторизация
Передавайте одноразовое JWT-подтверждение Developer Application, подписанное RS256, в Authorization: Bearer <application_assertion>. Это не токен доступа к Public API.
Запрос
Основной адрес API: https://public-api.cloudprint.me/partner-api/v1/accounts/{relationshipId}/agents
Параметры
| Имя | Расположение | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|---|
relationshipId | path | string (uuid) | да | Стабильный UUID связи партнёра с управляемым клиентом. | — |
limit | query | integer | нет | Максимальное количество ресурсов на одной странице. | min: 1; max: 100; default: 50 |
cursor | query | string | нет | Непрозрачный курсор страницы результатов; передавайте его без изменений. | — |
X-Request-Id | header | string | нет | Необязательный идентификатор для трассировки запроса; CloudPrint вернёт безопасное значение в заголовке ответа. | maxLength: 128; example: "order-100045-attempt-1" |
Тело запроса
У метода нет тела запроса.
Примеры запросов
cURL
bash
curl -sS "https://public-api.cloudprint.me/partner-api/v1/accounts/$RELATIONSHIP_ID/agents" \
-H "Authorization: Bearer $APPLICATION_ASSERTION"Ответ
HTTP-статус: 200 — Запрос выполнен.
Поля ответа
| Имя | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
data | array | да | Ресурсы на текущей странице результатов. | — |
next_cursor | string | null | да | Непрозрачный cursor следующей страницы; передавайте его без изменений. | — |
Пример ответа
json
{
"data": [
{
"agent_id": "11111111-1111-4111-8111-111111111111",
"name": "string",
"status": "online",
"agent_instance_id": "string",
"hostname": "string",
"version": "string",
"last_seen_at": "2026-08-06T12:00:00Z",
"created_at": "2026-08-06T12:00:00Z",
"revoked_at": "2026-08-06T12:00:00Z"
}
],
"next_cursor": "string"
}Ошибки
| HTTP-статус | Описание |
|---|---|
401 | Авторизация отсутствует или недействительна. |
403 | Для операции недостаточно разрешений. |
404 | Запрошенный ресурс не найден. |
422 | Поля запроса не прошли проверку. |
429 | Превышен лимит запросов; учитывайте Retry-After. |
500 | Внутренняя ошибка CloudPrint. |
Связанная документация
Отозвать агента клиентаОтзовите потерянный или заменённый агент; его принтеры перейдут в статус `offline`.Получить управляемый аккаунт клиентаПолучите аккаунт клиента по постоянному `relationship_id`.Настройка агента для управляемого аккаунтаСоздайте одноразовую ссылку и подключите CloudPrint Agent к нужному аккаунту клиента без входа в кабинет.