Saltar al contenido principal
POST
/
sites
/
{siteId}
/
jobs
Crear una Tarea para un Sitio
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": "Añadir nueva regla de firewall para la red de invitados",
  "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

Autenticar las solicitudes proporcionando un JSON Web Token (JWT) en la cabecera Authorization. Ejemplo: Authorization: Bearer <SU_JWT>

Headers

​
X-Idempotency-Key
string<uuid>
required

Un UUID único proporcionado por el cliente para asegurar que la solicitud se procese solo una vez.

​
X-Description
string
required

Una descripción legible del propósito de la tarea.

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

(Predeterminado: true) Establecer en false si la tarea debe considerarse completada tan pronto como se envíe al dispositivo, sin esperar una respuesta de éxito/fallo.

​
X-Backup
boolean

(Predeterminado: false) Establecer en true para crear automáticamente una copia de seguridad de la configuración del sitio antes de ejecutar esta tarea.

​
X-Express-Execute
boolean

(Predeterminado: false) Establecer en true para intentar forzar una conexión inmediata del dispositivo para una ejecución más rápida de la tarea.

Path Parameters

​
siteId
string<uuid>
required

El UUID del sitio de destino.

Body

text/plain · string

El script de RouterOS en crudo que se ejecutará en el dispositivo.

The body is of type string.

Example:

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

Response

La tarea se creó correctamente.

Un comando o script asíncrono para ser ejecutado en un Sitio.

​
id
string<uuid>

El identificador único (UUID) para la tarea.

Example:

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

​
token
string

Un token corto, único y legible para la tarea, a menudo utilizado en el filtrado de registros.

Example:

"2jP5kLqWnZ"

​
site_id
string<uuid>

El ID del sitio al que se dirige esta tarea.

Example:

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

​
idempotency_key
string<uuid>

Una clave única proporcionada por el cliente para evitar la creación de tareas duplicadas.

Example:

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

​
description
string

Una descripción legible del propósito de la tarea.

Example:

"Añadir nueva regla de firewall para la red de invitados"

​
express_execute
boolean

Si es true, la plataforma intentará forzar una conexión inmediata del dispositivo para ejecutar esta tarea antes.

Example:

false

​
needs_acknowledgement
boolean

Si es true, la tarea requiere una notificación explícita de éxito/fallo del dispositivo para ser marcada como completada.

Example:

true

​
should_backup
boolean

Si es true, se creó automáticamente una copia de seguridad de la configuración antes de que esta tarea fuera encolada.

Example:

true

​
associated_backup
string | null

La ruta al archivo de copia de seguridad de la configuración asociado a esta tarea, si se creó uno.

Example:

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

​
started_at
string<date-time> | null

La marca de tiempo cuando el dispositivo comenzó a ejecutar la tarea.

Example:

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

​
completed_at
string<date-time> | null

La marca de tiempo cuando el dispositivo informó de la finalización exitosa de la tarea.

Example:

null

​
failed_at
string<date-time> | null

La marca de tiempo cuando el dispositivo informó de un fallo durante la ejecución de la tarea.

Example:

null

​
created_at
string<date-time>

La marca de tiempo cuando se creó la tarea.

Example:

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

​
log_url
string

Una URL relativa a la interfaz de usuario de Altostrat SDX para ver los registros relacionados con la ejecución de esta tarea.

Example:

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

​
script
string

La carga útil (payload) del script de RouterOS en crudo de la tarea.

Example:

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