Zum Inhalt springen

Verbundene Agents auflisten

Rufen Sie die CloudPrint Agents des Kontos ab und prüfen Sie Verbindung, Version und verfügbares Update.

GET/api/v1/agentsAPI-Version: v1operationId: listAgentsAls Markdown anzeigen

Funktion dieser Methode

Rufen Sie die CloudPrint Agents des Kontos ab und prüfen Sie Verbindung, Version und verfügbares Update.

Authentifizierung

Senden Sie ein kurzlebiges Token in Authorization: Bearer <access_token>.

Erforderliche Scopes: agents:read

Anfrage

Produktions-URL: https://public-api.cloudprint.me/api/v1/agents

Parameter

NamePositionTypErforderlichBeschreibungEinschränkungen
limitqueryintegerneinHöchstzahl der Ressourcen auf einer Ergebnisseite.min: 1; max: 100; default: 50
cursorquerystring | nullneinOpaker Cursor der angefragten Ergebnisseite; senden Sie ihn unverändert zurück.
X-Request-IdheaderstringneinOptionale Kennung zur Anfrageverfolgung; CloudPrint gibt einen sicheren Wert im Antwort-Header zurück.maxLength: 128; example: "order-100045-attempt-1"

Anfrageinhalt

Die Methode hat keinen Anfrageinhalt.

Anfragebeispiele

cURL

bash
curl -sS 'https://public-api.cloudprint.me/api/v1/agents?limit=50' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Antwort

HTTP-Status: 200 — Anfrage erfolgreich.

Antwortfelder

NameTypErforderlichBeschreibungEinschränkungen
agentsarrayjaIm aktuellen CloudPrint-Konto registrierte Agents.
next_cursorstring | nulljaOpaker Cursor für die nächste Ergebnisseite; senden Sie ihn unverändert zurück.

Beispielantwort

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"
}

Fehler

HTTP-StatusBeschreibung
401Authentifizierung fehlt oder ist ungültig.
403Das Token hat nicht die erforderlichen Berechtigungen.
422Mindestens ein Feld ist ungültig.
429Anfragelimit überschritten; beachten Sie Retry-After.
500Interner CloudPrint-Fehler.

Hinweise zur Integration

  • Behandeln Sie den Agent-Status als Betriebsinformation, nicht als Routing-Schlüssel.
  • Prüfen Sie den Aktualisierungsstatus vor der Diagnose von Drucker- oder Dokumentfehlern.

Verwandte Dokumentation

Anleitungen zur CloudPrint-Integration, zur Verbindung des lokalen Agenten und zum zuverlässigen Betrieb von Druckabläufen.