API de Scheduled Scans

Mantenido por: Aether365 Team Audiencia: Desarrolladores Alcance: Endpoints de la API de Scheduled Scans - crear y gestionar programaciones de análisis

Los análisis programados definen trabajos de análisis recurrentes. Cada análisis programado define un disparador recurrente que se ejecuta en el intervalo configurado.

Listar análisis programados

Devuelve todos los análisis programados del tenant autenticado, incluyendo el análisis automático del plan.

GET /tenants/me/scheduled-scans

Solicitud de ejemplo

curl https://api.aether365.io/tenants/me/scheduled-scans \
  -H "Authorization: Bearer <token>"

Respuesta de ejemplo

{
  "success": true,
  "data": [
    {
      "id": "plan",
      "isPlanSchedule": true,
      "name": "Automatic plan scan",
      "frequency": "weekly",
      "hour": 0,
      "minute": 0,
      "dayOfWeek": 0,
      "dayOfMonth": 1,
      "timezone": "UTC",
      "enabled": true,
      "scanType": "compliance",
      "lastTriggeredAt": "2026-04-07T00:00:00Z"
    },
    {
      "id": "sched_abc123",
      "isPlanSchedule": false,
      "name": "Weekly exposure scan",
      "frequency": "weekly",
      "hour": 6,
      "minute": 0,
      "dayOfWeek": 3,
      "dayOfMonth": null,
      "timezone": "Europe/London",
      "enabled": true,
      "scanType": "exposure",
      "lastTriggeredAt": "2026-04-09T06:00:00Z"
    }
  ]
}

Campos de respuesta

Campo	Tipo	Descripción
id	string	Identificador de la programación ("plan" para la del plan automático)
isPlanSchedule	boolean	true si es el análisis automático del plan
name	string	Nombre para mostrar
frequency	string	daily, weekly o monthly
hour	integer	Hora del día para la ejecución (0-23)
minute	integer	Minuto de la hora para la ejecución (0-59)
dayOfWeek	integer	Dia de la semana para programaciones semanales (0=Lun, 6=Dom)
dayOfMonth	integer	Dia del mes para programaciones mensuales (1-31)
timezone	string	Cadena de zona horaria IANA
enabled	boolean	Si la programación está activa
scanType	string	compliance o exposure
lastTriggeredAt	string o null	Marca de tiempo ISO 8601 de la última ejecución

---

Crear análisis programado

Crea un nuevo análisis programado.

POST /tenants/me/scheduled-scans

Cuerpo de la solicitud

{
  "name": "Monthly exposure scan",
  "frequency": "monthly",
  "hour": 3,
  "minute": 0,
  "dayOfMonth": 1,
  "timezone": "UTC",
  "scanType": "exposure",
  "enabled": true
}

Campo	Tipo	Obligatorio	Descripción
name	string	Si	Nombre para mostrar
frequency	string	Si	daily, weekly o monthly
hour	integer	Si	0-23
minute	integer	Si	0-59
dayOfWeek	integer	Para weekly	0=Lun, 6=Dom
dayOfMonth	integer	Para monthly	1-31
timezone	string	Si	Zona horaria IANA (por ejemplo, UTC, Europe/Berlin)
scanType	string	Si	compliance o exposure
enabled	boolean	No	Por defecto true

Solicitud de ejemplo

curl -X POST https://api.aether365.io/tenants/me/scheduled-scans \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Monthly exposure scan",
    "frequency": "monthly",
    "hour": 3,
    "minute": 0,
    "dayOfMonth": 1,
    "timezone": "UTC",
    "scanType": "exposure",
    "enabled": true
  }'

Errores

Código	HTTP	Descripción
SCAN_PLAN_LIMIT_REACHED	429	Límite de programaciones personalizadas alcanzado para tu plan
VALIDATION_ERROR	400	Campos ausentes o no válidos

---

Actualizar análisis programado

Actualiza un análisis programado existente. Solo se actualizan los campos que incluyas.

PATCH /tenants/me/scheduled-scans/{scheduledScanId}

Ejemplo: Pausar una programación

curl -X PATCH https://api.aether365.io/tenants/me/scheduled-scans/sched_abc123 \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"enabled": false}'

Ejemplo: Cambiar la hora

curl -X PATCH https://api.aether365.io/tenants/me/scheduled-scans/sched_abc123 \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"hour": 8}'

---

Eliminar análisis programado

Elimina permanentemente un análisis programado y su programación subyacente.

DELETE /tenants/me/scheduled-scans/{scheduledScanId}

WARNING

El análisis automático del plan (id: "plan") no se puede eliminar a través de la API.

Solicitud de ejemplo

curl -X DELETE https://api.aether365.io/tenants/me/scheduled-scans/sched_abc123 \
  -H "Authorization: Bearer <token>"

Respuesta de ejemplo

{
  "success": true,
  "data": null
}