Saltar al contenido

Listar agentes de impresión conectados

Consulta los agentes CloudPrint de la cuenta y revisa su conexión, versión y estado de actualización.

GET/api/v1/agentsVersión de la API: v1operationId: listAgentsVer como Markdown

Qué hace este método

Consulta los agentes CloudPrint de la cuenta y revisa su conexión, versión y estado de actualización.

Autenticación

Envía un token de corta duración en Authorization: Bearer <access_token>.

Permisos necesarios: agents:read

Solicitud

URL de producción: https://public-api.cloudprint.me/api/v1/agents

Parámetros

NombreUbicaciónTipoObligatorioDescripciónRestricciones
limitqueryintegernoNúmero máximo de recursos que se devuelven en una página.min: 1; max: 100; default: 50
cursorquerystring | nullnoCursor opaco de la página solicitada; envíalo de nuevo sin modificarlo.
X-Request-IdheaderstringnoIdentificador 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/api/v1/agents?limit=50' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Respuesta

Estado HTTP: 200 — Solicitud completada.

Campos de respuesta

NombreTipoObligatorioDescripciónRestricciones
agentsarrayAgentes registrados en la cuenta CloudPrint actual.
next_cursorstring | nullCursor opaco de la página siguiente; envíalo de nuevo sin modificarlo.

Ejemplo de respuesta

json
{
  "agents": [
    {
      "agent_id": "11111111-1111-4111-8111-111111111111",
      "name": "Warehouse PC agent",
      "status": "online",
      "agent_instance_id": "string",
      "hostname": "string",
      "version": "string",
      "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"
}

Errores

Estado HTTPDescripción
401Falta la autenticación o no es válida.
403El token no tiene permisos suficientes.
422Uno o varios campos no son válidos.
429Se superó el límite de solicitudes; respeta Retry-After.
500Error interno de CloudPrint.

Recomendaciones de integración

  • Trata el estado del agente como información operativa, no como clave de enrutamiento.
  • Revisa su actualización antes de investigar fallos de impresora o documento.

Documentación relacionada

Guías para integrar CloudPrint, conectar el agente local y operar flujos de impresión.