Vai al contenuto principale
POST
/
sites
/
{siteId}
/
jobs
Crea un Job per un Site
curl --request POST \
  --url https://api.altostrat.io/sites/{siteId}/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: text/plain' \
  --header 'X-Description: <x-description>' \
  --header 'X-Idempotency-Key: <x-idempotency-key>' \
  --data '/ip address add address=192.168.99.1/24 interface=ether2'
{
  "id": "8b8b2e5e-1a19-4a19-8b19-1e1919191919",
  "token": "2jP5kLqWnZ",
  "site_id": "9a9a3e6f-1b1a-4b1a-8c1a-1e1a1a1a1a1a",
  "idempotency_key": "7c7c1e4e-1918-4918-8a18-1e1818181818",
  "description": "Aggiungi nuova regola firewall per la rete ospiti",
  "express_execute": false,
  "needs_acknowledgement": true,
  "should_backup": true,
  "associated_backup": "9a9a3e6f-1b1a-4b1a-8c1a-1e1a1a1a1a1a/1667888400.rsc",
  "started_at": "2025-10-29T12:05:10Z",
  "completed_at": null,
  "failed_at": null,
  "created_at": "2025-10-29T12:00:00Z",
  "log_url": "logs?group=sites&streams=9a9a...&start=...&end=...&filter={$.message=*2jP5kLqWnZ*}",
  "script": "/ip firewall filter add chain=forward action=accept src-address-list=guests"
}

Authorizations

​
Authorization
string
header
required

Autentica le richieste fornendo un JSON Web Token (JWT) nell'header Authorization. Esempio: Authorization: Bearer <TUO_JWT>

Headers

​
X-Idempotency-Key
string<uuid>
required

Un UUID univoco fornito dal client per garantire che la richiesta venga elaborata una sola volta.

​
X-Description
string
required

Una descrizione leggibile dello scopo del job.

Required string length: 3 - 100
​
X-Needs-Ack
boolean

(Predefinito: true) Impostare su false se il job deve essere considerato completato non appena viene inviato al dispositivo, senza attendere una risposta di successo/fallimento.

​
X-Backup
boolean

(Predefinito: false) Impostare su true per creare automaticamente un backup della configurazione del site prima di eseguire questo job.

​
X-Express-Execute
boolean

(Predefinito: false) Impostare su true per tentare di attivare un check-in immediato del dispositivo per un'esecuzione più rapida del job.

Path Parameters

​
siteId
string<uuid>
required

L'UUID del site di destinazione.

Body

text/plain · string

Lo script RouterOS grezzo da eseguire sul dispositivo.

The body is of type string.

Example:

"/ip address add address=192.168.99.1/24 interface=ether2"

Response

Il job è stato creato con successo.

Un comando o script asincrono da eseguire su un Site.

​
id
string<uuid>

L'identificatore univoco (UUID) per il job.

Example:

"8b8b2e5e-1a19-4a19-8b19-1e1919191919"

​
token
string

Un token breve, univoco e leggibile per il job, spesso usato nel filtraggio dei log.

Example:

"2jP5kLqWnZ"

​
site_id
string<uuid>

L'ID del site a cui è destinato questo job.

Example:

"9a9a3e6f-1b1a-4b1a-8c1a-1e1a1a1a1a1a"

​
idempotency_key
string<uuid>

Una chiave univoca fornita dal client per prevenire la creazione di job duplicati.

Example:

"7c7c1e4e-1918-4918-8a18-1e1818181818"

​
description
string

Una descrizione leggibile dello scopo del job.

Example:

"Aggiungi nuova regola firewall per la rete ospiti"

​
express_execute
boolean

Se true, la piattaforma tenterà di attivare un check-in immediato dal dispositivo per eseguire questo job più rapidamente.

Example:

false

​
needs_acknowledgement
boolean

Se true, il job richiede una notifica esplicita di successo/fallimento dal dispositivo per essere contrassegnato come completato.

Example:

true

​
should_backup
boolean

Se true, è stato creato automaticamente un backup della configurazione prima che questo job fosse messo in coda.

Example:

true

​
associated_backup
string | null

Il percorso del file di backup della configurazione associato a questo job, se ne è stato creato uno.

Example:

"9a9a3e6f-1b1a-4b1a-8c1a-1e1a1a1a1a1a/1667888400.rsc"

​
started_at
string<date-time> | null

Il timestamp in cui il dispositivo ha iniziato l'esecuzione del job.

Example:

"2025-10-29T12:05:10Z"

​
completed_at
string<date-time> | null

Il timestamp in cui il dispositivo ha riportato il completamento con successo del job.

Example:

null

​
failed_at
string<date-time> | null

Il timestamp in cui il dispositivo ha riportato un fallimento durante l'esecuzione del job.

Example:

null

​
created_at
string<date-time>

Il timestamp di creazione del job.

Example:

"2025-10-29T12:00:00Z"

​
log_url
string

Un URL relativo all'interfaccia utente di Altostrat SDX per visualizzare i log relativi all'esecuzione di questo job.

Example:

"logs?group=sites&streams=9a9a...&start=...&end=...&filter={$.message=*2jP5kLqWnZ*}"

​
script
string

Il payload dello script RouterOS grezzo del job.

Example:

"/ip firewall filter add chain=forward action=accept src-address-list=guests"