Skripte für die Caryvane-API
Alles, was die MCP-Tools tun, gibt es auch als einfaches JSON über HTTPS unter /mcp/…, mit demselben Zugriffsschlüssel als Bearer-Token. Diese Seite ist für alle, die Caryvane an ein RMM, ein Dashboard oder einen nächtlichen Bericht anbinden.
Grundlagen #
# Jeder Aufruf: der Schlüssel als Bearer-Token; JSON hinein, JSON heraus.
curl -s https://console.caryvane.com/mcp/dashboard \
-H "Authorization: Bearer <key>"
GET-Endpunkte nehmen Parameter im Query-String, POST-Endpunkte einen JSON-Body. Listen werden mit skip und take seitenweise abgerufen (take bis 200 bei Jobs und Protokollen, standardmäßig 20–50) und liefern total und hasMore. Fehler sind HTTP-Statuscodes mit einer JSON-Meldung: 401 falscher Schlüssel, 403 Stufe zu niedrig oder außerhalb Ihrer Sichtbarkeit, 404 nicht gefunden, 400 mit dem Grund für ein abgelehntes Anlegen.
Beispiele #
Jobs, die letzte Nacht fehlgeschlagen sind (PowerShell)
$h = @{ Authorization = "Bearer $env:CARYVANE_KEY" }
$jobs = Invoke-RestMethod "https://console.caryvane.com/mcp/jobs?take=200" -Headers $h
$jobs.jobs | Where-Object { $_.lastStatus -in 'Failed','Warning' } |
Select-Object id, name, tenantName, lastStatus, lastRunUtc, lastErrorMessage |
Format-Table -AutoSize
Ausführungsverlauf eines Jobs, mit den fehlgeschlagenen Dateien
curl -s "https://console.caryvane.com/mcp/jobs/14/runs?take=5" -H "Authorization: Bearer $KEY" \
| jq '.runs[] | {id, status, startedUtc, filesUploaded, filesFailed, failedFiles}'
Einen Rechner aus einem RMM registrieren
# 1. Ein Token für den Kunden erstellen (Schlüssel mit Vollzugriff)
$tok = Invoke-RestMethod -Method Post "https://console.caryvane.com/mcp/enrollment-tokens" -Headers $h `
-ContentType 'application/json' -Body (@{ name = "RMM $env:COMPUTERNAME"; expiryHours = 1; tenantId = 11 } | ConvertTo-Json)
# 2. Den zurückgegebenen Installationsbefehl ausführen
Invoke-Expression $tok.installCommand
Einen nächtlichen Datei-Job anlegen
curl -s -X POST https://console.caryvane.com/mcp/jobs -H "Authorization: Bearer $KEY" \
-H "Content-Type: application/json" -d '{
"name": "HHSRV1 shares nightly",
"agentId": 7, "storageTargetId": 11,
"sourcePaths": ["D:\\Shares"], "backupPathPrefix": "hhsrv1",
"cronSchedule": "0 2 * * *", "backupMode": "Incremental",
"useVss": true, "keepVersions": 5
}'
Das Protokoll eines Agenten
curl -s "https://console.caryvane.com/mcp/agents/3/logs?level=warn&take=50" -H "Authorization: Bearer $KEY"
Endpunkte #
Die vollständige Routentabelle mit dem jeweils zugehörigen Tool und der nötigen Stufe steht unter KI-Assistenten und API. Die MCP-Tool-Beschreibungen sind die maßgebliche Feldreferenz für Request-Bodies; ein OpenAPI-Dokument ist geplant, aber noch nicht veröffentlicht.
Schlüssel für Skripte #
Stellen Sie pro Integration einen eigenen, nach ihr benannten Schlüssel aus, mit der niedrigsten Stufe, die funktioniert (ein Berichtsskript braucht Nur lesen). Bewahren Sie ihn im Geheimnisspeicher des RMM oder in einer Umgebungsvariablen auf, nie im Skript. Widerrufen Sie ihn im selben Dialog, wenn die Integration außer Betrieb geht; jeder Aufruf, den er gemacht hat, steht im Audit-Protokoll unter dem Namen des Inhabers.