Vai al contenuto principale
PUT
/
scheduled
/
{scheduledScriptId}
Aggiorna uno Script Pianificato
curl --request PUT \
  --url https://api.altostrat.io/scheduled/{scheduledScriptId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "test_site_id": "site_2Al5z3gXyY5f6Z7h8j9k0l1m",
  "make_backup": true,
  "description": "Manutenzione notturna peer BGP (Aggiornato)",
  "script": "/routing bgp peer enable [find name=peer1]",
  "sites": [
    "site_1AbCdEfGhIjKlMnOpQrStUv"
  ],
  "notify": [
    "auth0|5f9d4b3c2e1a0b006f8b4c5d",
    "auth0|6a0e5c4d3f2b1c007g9c5d6e"
  ]
}'
{
  "id": "018f5bda-4690-4432-8472-358b2734f19b",
  "created_by": "auth0|642b7f3b8b3b3e3e3e3e3e3e",
  "test_site_id": "site_2Al5z3gXyY5f6Z7h8j9k0l1m",
  "make_backup": true,
  "abort_if_offline": false,
  "description": "Aggiornamento settimanale regole firewall",
  "summary": "Questo script aggiunge una regola al firewall filter per bloccare l'input da una specifica address list chiamata \"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": "tra 2 giorni",
  "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

L'API SDX di Altostrat utilizza token Bearer JWT per l'autenticazione. Ottieni un token tramite l'API di autenticazione e includilo nell'header Authorization come 'Bearer {token}'.

Path Parameters

​
scheduledScriptId
string<uuid>
required

L'identificativo univoco dello script pianificato da aggiornare.

Example:

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

Body

application/json
​
make_backup
boolean
required

Se vero, crea un backup della configurazione prima di eseguire lo script.

Example:

true

​
description
string
required

Un nome leggibile per lo script pianificato.

Example:

"Manutenzione notturna peer BGP (Aggiornato)"

​
script
string
required

Il contenuto completo dello script MikroTik RouterOS.

Example:

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

​
sites
string<uuid>[]
required

Un array di ID di siti da targettizzare.

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

Un array di ID utente che riceveranno notifiche.

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

L'identificativo univoco del sito designato per le esecuzioni di test.

Example:

"site_2Al5z3gXyY5f6Z7h8j9k0l1m"

Response

Lo script pianificato è stato aggiornato con successo.

​
id
string<uuid>

L'identificativo univoco per lo script pianificato.

Example:

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

​
created_by
string<uuid>

L'ID utente della persona che ha creato la pianificazione dello script.

Example:

"auth0|642b7f3b8b3b3e3e3e3e3e3e"

​
test_site_id
string<uuid> | null

L'identificativo univoco del sito designato per le esecuzioni di test.

Example:

"site_2Al5z3gXyY5f6Z7h8j9k0l1m"

​
make_backup
boolean

Se vero, verrà creato un backup della configurazione su ciascun dispositivo di destinazione prima dell'esecuzione dello script.

Example:

true

​
abort_if_offline
boolean

Se vero, l'esecuzione dello script verrà interrotta per un sito se questo è offline al momento dell'avvio.

Example:

false

​
description
string

Un nome o una descrizione leggibile per la pianificazione dello script.

Example:

"Aggiornamento settimanale regole firewall"

​
summary
string | null

Un riassunto dello scopo dello script generato dall'IA.

Example:

"Questo script aggiunge una regola al firewall filter per bloccare l'input da una specifica address list chiamata \"blacklist\"."

​
script
string

Il contenuto completo dello script MikroTik RouterOS da eseguire.

Example:

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

​
status
enum<string>

Lo stato attuale dello script pianificato.

Opzioni disponibili:
unauthorized,
scheduled,
launched,
cancelled
Example:

"scheduled"

​
authorized_at
string<date-time> | null

Il timestamp di quando l'esecuzione dello script è stata autorizzata. Nullo se non ancora autorizzato.

Example:

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

​
cancelled_at
string<date-time> | null

Il timestamp di quando lo script è stato annullato.

Example:

null

​
launch_at
string<date-time>

La data e l'ora UTC pianificate per l'esecuzione dello script.

Example:

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

​
t_minus
string | null

Un conto alla rovescia leggibile fino all'orario di avvio.

Example:

"tra 2 giorni"

​
started_at
string<date-time> | null

Il timestamp di quando l'esecuzione dello script è effettivamente iniziata.

Example:

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

​
sites
string<uuid>[]

Un elenco di ID di siti where verrà eseguito lo script.

​
notify
string<uuid>[]

Un elenco di ID utente da notificare sull'avanzamento dello script e sulle richieste di autorizzazione.

​
progress
object

Rappresenta l'avanzamento dell'esecuzione di uno script avviato sui suoi siti di destinazione.

​
created_at
string<date-time>

Il timestamp di quando è stato creato lo script pianificato.

Example:

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

​
updated_at
string<date-time>

Il timestamp dell'ultimo aggiornamento dello script pianificato.

Example:

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