Saltar al contenido principal
POST
/
scheduled
Programar un Nuevo Script
curl --request POST \
  --url https://api.altostrat.io/scheduled \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "test_site_id": "site_2Al5z3gXyY5f6Z7h8j9k0l1m",
  "make_backup": true,
  "abort_if_offline": true,
  "description": "Mantenimiento nocturno de par BGP",
  "script": "/routing bgp peer disable [find name=peer1]",
  "launch_at": "2025-12-01T04:00:00Z",
  "sites": [
    "site_1AbCdEfGhIjKlMnOpQrStUv",
    "site_2BcDeFgHiJkLmNoPqRsTuVw"
  ],
  "notify": [
    "auth0|5f9d4b3c2e1a0b006f8b4c5d"
  ]
}'
{
  "id": "018f5bda-4690-4432-8472-358b2734f19b",
  "created_by": "auth0|642b7f3b8b3b3e3e3e3e3e3e",
  "test_site_id": "site_2Al5z3gXyY5f6Z7h8j9k0l1m",
  "make_backup": true,
  "abort_if_offline": false,
  "description": "Actualización semanal de reglas de firewall",
  "summary": "Este script añade una regla de filtro de firewall para descartar la entrada desde una lista de direcciones específica llamada \"blacklist\".",
  "script": "/ip firewall filter add action=drop chain=input src-address-list=blacklist",
  "status": "scheduled",
  "authorized_at": "2025-10-30T10:00:00.000000Z",
  "cancelled_at": null,
  "launch_at": "2025-11-01T02:00:00.000000Z",
  "t_minus": "en 2 días",
  "started_at": "2025-11-01T02:00:05.000000Z",
  "sites": [
    "site_1AbCdEfGhIjKlMnOpQrStUv"
  ],
  "notify": [
    "auth0|5f9d4b3c2e1a0b006f8b4c5d"
  ],
  "progress": {
    "completed": [
      "site_1AbCdEfGhIjKlMnOpQrStUv"
    ],
    "failed": [
      "site_2BcDeFgHiJkLmNoPqRsTuVw"
    ],
    "pending": [
      "site_3CdEfGhIjKlMnOpQrStUvWx"
    ]
  },
  "created_at": "2025-10-29T12:44:27.000000Z",
  "updated_at": "2025-10-29T13:05:00.000000Z"
}

Authorizations

​
Authorization
string
header
required

La API de Altostrat SDX utiliza tokens Bearer JWT para la autenticación. Obtenga un token a través de la API de Autenticación e inclúyalo en el encabezado de Autorización como 'Bearer {token}'.

Body

application/json
​
make_backup
boolean
required

Si es verdadero, crear una copia de seguridad de la configuración antes de ejecutar el script.

Example:

true

​
abort_if_offline
boolean
required

Si es verdadero, no intentar ejecutar el script en sitios que están fuera de línea.

Example:

true

​
description
string
required

Un nombre legible para el script programado.

Example:

"Mantenimiento nocturno de par BGP"

​
script
string
required

El contenido completo del script de MikroTik RouterOS.

Example:

"/routing bgp peer disable [find name=peer1]"

​
launch_at
string<date-time>
required

La fecha y hora UTC programada para la ejecución. Debe ser en el futuro.

Example:

"2025-12-01T04:00:00Z"

​
sites
string<uuid>[]
required

Un arreglo de IDs de sitios a los que apuntar.

Example:
[
  "site_1AbCdEfGhIjKlMnOpQrStUv",
  "site_2BcDeFgHiJkLmNoPqRsTuVw"
]
​
notify
string<uuid>[]
required

Un arreglo de IDs de usuarios para recibir notificaciones.

Example:
["auth0|5f9d4b3c2e1a0b006f8b4c5d"]
​
test_site_id
string<uuid> | null

El identificador único del sitio designado para ejecuciones de prueba.

Example:

"site_2Al5z3gXyY5f6Z7h8j9k0l1m"

Response

El script programado se creó correctamente.

​
id
string<uuid>

El identificador único para el script programado.

Example:

"018f5bda-4690-4432-8472-358b2734f19b"

​
created_by
string<uuid>

El ID del usuario que creó la programación del script.

Example:

"auth0|642b7f3b8b3b3e3e3e3e3e3e"

​
test_site_id
string<uuid> | null

El identificador único del sitio designado para ejecuciones de prueba.

Example:

"site_2Al5z3gXyY5f6Z7h8j9k0l1m"

​
make_backup
boolean

Si es verdadero, se creará una copia de seguridad de la configuración en cada dispositivo de destino antes de que se ejecute el script.

Example:

true

​
abort_if_offline
boolean

Si es verdadero, la ejecución del script se abortará para un sitio si está fuera de línea en el momento del lanzamiento.

Example:

false

​
description
string

Un nombre o descripción legible para la programación del script.

Example:

"Actualización semanal de reglas de firewall"

​
summary
string | null

Un resumen del propósito del script generado por IA.

Example:

"Este script añade una regla de filtro de firewall para descartar la entrada desde una lista de direcciones específica llamada \"blacklist\"."

​
script
string

El contenido completo del script de MikroTik RouterOS que se ejecutará.

Example:

"/ip firewall filter add action=drop chain=input src-address-list=blacklist"

​
status
enum<string>

El estado actual del script programado.

Opciones disponibles:
unauthorized,
scheduled,
launched,
cancelled
Example:

"scheduled"

​
authorized_at
string<date-time> | null

La marca de tiempo de cuándo se autorizó la ejecución del script. Nulo si aún no está autorizado.

Example:

"2025-10-30T10:00:00.000000Z"

​
cancelled_at
string<date-time> | null

La marca de tiempo de cuándo se canceló el script.

Example:

null

​
launch_at
string<date-time>

La fecha y hora UTC programada para la ejecución del script.

Example:

"2025-11-01T02:00:00.000000Z"

​
t_minus
string | null

Una cuenta regresiva legible para el tiempo de lanzamiento.

Example:

"en 2 días"

​
started_at
string<date-time> | null

La marca de tiempo de cuándo comenzó realmente la ejecución del script.

Example:

"2025-11-01T02:00:05.000000Z"

​
sites
string<uuid>[]

Una lista de IDs de sitios donde se ejecutará el script.

​
notify
string<uuid>[]

Una lista de IDs de usuarios a notificar sobre el progreso y las solicitudes de autorización del script.

​
progress
object

Representa el progreso de ejecución de un script lanzado a través de sus sitios de destino.

​
created_at
string<date-time>

La marca de tiempo de cuándo se creó el script programado.

Example:

"2025-10-29T12:44:27.000000Z"

​
updated_at
string<date-time>

La marca de tiempo de la última actualización del script programado.

Example:

"2025-10-29T13:05:00.000000Z"