CaryvaneAyuda
/
ES

Automatizar la API de Caryvane con scripts

Todo lo que hacen las herramientas MCP está también disponible como JSON sencillo sobre HTTPS bajo /mcp/…, con la misma clave de acceso como token bearer. Esta es la página para quien conecta Caryvane con un RMM, un panel o un informe nocturno.

Conceptos básicos #

# En cada llamada: la clave como token bearer; JSON de entrada, JSON de salida.
curl -s https://console.caryvane.com/mcp/dashboard \
  -H "Authorization: Bearer <key>"

Los endpoints GET reciben los parámetros en la cadena de consulta; los POST, un cuerpo JSON. Las listas se paginan con skip y take (take hasta 200 en tareas y registros, 20–50 por defecto) y devuelven total y hasMore. Los errores son códigos de estado HTTP con un mensaje JSON: 401 clave incorrecta, 403 nivel insuficiente o fuera de su visibilidad, 404 no encontrado, 400 con el motivo de una creación rechazada.

Ejemplos #

Tareas que fallaron anoche (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

El historial de ejecuciones de una tarea, con los archivos con error

curl -s "https://console.caryvane.com/mcp/jobs/14/runs?take=5" -H "Authorization: Bearer $KEY" \
  | jq '.runs[] | {id, status, startedUtc, filesUploaded, filesFailed, failedFiles}'

Registrar un equipo desde un RMM

# 1. Crear un token para el cliente (clave de acceso completo)
$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. Ejecutar el comando de instalación que devuelve
Invoke-Expression $tok.installCommand

Crear una tarea nocturna de archivos

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

El registro propio de un agente

curl -s "https://console.caryvane.com/mcp/agents/3/logs?level=warn&take=50" -H "Authorization: Bearer $KEY"

Endpoints #

La tabla completa de rutas, con la herramienta a la que corresponde cada una y el nivel que necesita, está en Asistentes de IA y API. Las descripciones de las herramientas MCP son la referencia de campos que manda para los cuerpos de las peticiones; hay previsto un documento OpenAPI, pero aún no se ha publicado.

Claves para scripts #

Emita una clave por integración, con su nombre, y con el nivel más bajo que funcione (un script de informes necesita Solo lectura). Guárdela en el almacén de secretos del RMM o en una variable de entorno, nunca en el script. Revóquela en el mismo cuadro de diálogo cuando retire la integración; cada llamada que hizo figura en el registro de auditoría con el nombre del propietario.