Listar agentes de un cliente gestionado
Consulta todos los agentes conectados a un cliente gestionado, incluidos los revocados.
GET
/partner-api/v1/accounts/{relationshipId}/agentsVersión de la API: v1operationId: listPartnerManagedAgentsVer como MarkdownQué hace este método
Consulta todos los agentes conectados a un cliente gestionado, incluidos los revocados.
Autenticación
Envía una aserción RS256 de un solo uso de la Developer Application en Authorization: Bearer <application_assertion>. No es un token de acceso de Public API.
Solicitud
URL de producción: https://public-api.cloudprint.me/partner-api/v1/accounts/{relationshipId}/agents
Parámetros
| Nombre | Ubicación | Tipo | Obligatorio | Descripción | Restricciones |
|---|---|---|---|---|---|
relationshipId | path | string (uuid) | sí | UUID estable de la relación del partner con el cliente gestionado. | — |
limit | query | integer | no | Número máximo de recursos que se devuelven en una página. | min: 1; max: 100; default: 50 |
cursor | query | string | no | Cursor opaco de la página solicitada; envíalo de nuevo sin modificarlo. | — |
X-Request-Id | header | string | no | Identificador opcional para rastrear la solicitud; CloudPrint devuelve un valor seguro en la cabecera de respuesta. | maxLength: 128; example: "order-100045-attempt-1" |
Cuerpo de la solicitud
El método no tiene cuerpo de solicitud.
Ejemplos de solicitud
cURL
bash
curl -sS "https://public-api.cloudprint.me/partner-api/v1/accounts/$RELATIONSHIP_ID/agents" \
-H "Authorization: Bearer $APPLICATION_ASSERTION"Respuesta
Estado HTTP: 200 — Solicitud completada.
Campos de respuesta
| Nombre | Tipo | Obligatorio | Descripción | Restricciones |
|---|---|---|---|---|
data | array | sí | Recursos devueltos en la página actual de resultados. | — |
next_cursor | string | null | sí | Cursor opaco de la página siguiente; envíalo de nuevo sin modificarlo. | — |
Ejemplo de respuesta
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"
}Errores
| Estado HTTP | Descripción |
|---|---|
401 | Falta la autenticación o no es válida. |
403 | El token no tiene permisos suficientes. |
404 | No se encontró el recurso. |
422 | Uno o varios campos no son válidos. |
429 | Se superó el límite de solicitudes; respeta Retry-After. |
500 | Error interno de CloudPrint. |
Documentación relacionada
Revocar el agente de un cliente gestionadoRevoca un agente perdido o sustituido y marca sus impresoras como desconectadas.Obtener una cuenta de cliente gestionadaRecupera directamente un cliente gestionado mediante el ID estable de la relación.Conectar un agente de clienteVincula CloudPrint Agent con la cuenta administrada correcta sin iniciar sesión en el panel del cliente.