Получить Agents клиента

Получите все Agents управляемого клиента, включая отозванные.

GET/partner-api/v1/accounts/{relationshipId}/agentsВерсия API: v1operationId: listPartnerManagedAgentsОткрыть в Markdown

Назначение метода

Получите все Agents управляемого клиента, включая отозванные.

Авторизация

Передавайте одноразовый RS256 assertion Developer Application в Authorization: Bearer <application_assertion>. Это не токен доступа к Public API.

Запрос

Основной адрес API: https://public-api.cloudprint.me/partner-api/v1/accounts/{relationshipId}/agents

Параметры

Имя	Расположение	Тип	Обязательно	Описание	Ограничения
`relationshipId`	path	`string (uuid)`	да	Поле контракта API; учитывайте указанные тип и ограничения.	—
`limit`	query	`integer`	нет	Поле контракта API; учитывайте указанные тип и ограничения.	min: 1; max: 100; default: `50`
`cursor`	query	`string`	нет	Поле контракта API; учитывайте указанные тип и ограничения.	—

Тело запроса

У метода нет тела запроса.

Примеры запросов

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`	да	Поле контракта API; учитывайте указанные тип и ограничения.	—
`next_cursor`	`string \| null`	да	Непрозрачный cursor следующей страницы; передавайте его без изменений.	—

Пример ответа

json

{
  "data": [
    {
      "agent_id": "11111111-1111-4111-8111-111111111111",
      "name": "string",
      "status": "online",
      "agent_instance_id": null,
      "hostname": null,
      "version": null,
      "last_seen_at": null,
      "created_at": null,
      "revoked_at": null
    }
  ],
  "next_cursor": null
}

Ошибки

HTTP-статус	Описание
`401`	Авторизация отсутствует или недействительна.
`403`	Для операции недостаточно разрешений.
`404`	Запрошенный ресурс не найден.
`422`	Поля запроса не прошли проверку.
`429`	Превышен лимит запросов; учитывайте Retry-After.
`500`	Внутренняя ошибка CloudPrint.

Связанная документация

Отозвать Agent клиентаОтзовите потерянный или заменённый Agent и переведите его принтеры offline.Получить управляемый аккаунт клиентаПолучите одного управляемого клиента по стабильному relationship ID.Подключение агента клиентаПодключите локальный CloudPrint Agent к правильному управляемому аккаунту без входа клиента в кабинет CloudPrint.

Получить Agents клиента ​

Назначение метода ​

Авторизация ​

Запрос ​

Параметры ​

Тело запроса ​

Примеры запросов ​

cURL ​

Ответ ​

Поля ответа ​

Пример ответа ​

Ошибки ​

Рекомендации по интеграции ​

Связанная документация ​