Pular para o conteúdo principal
POST
/
sites
/
{siteId}
/
jobs
Criar uma Tarefa para um 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": "Adicionar nova regra de firewall para a rede de visitantes",
  "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

Autentique as requisições fornecendo um JSON Web Token (JWT) no cabeçalho Authorization. Exemplo: Authorization: Bearer <SEU_JWT>

Headers

​
X-Idempotency-Key
string<uuid>
required

Um UUID único fornecido pelo cliente para garantir que a requisição seja processada apenas uma vez.

​
X-Description
string
required

Uma descrição legível do propósito da tarefa.

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

(Padrão: true) Defina como false se a tarefa deve ser considerada concluída assim que for enviada ao dispositivo, sem aguardar uma resposta de sucesso/falha.

​
X-Backup
boolean

(Padrão: false) Defina como true para criar automaticamente um backup de configuração do site antes de executar esta tarefa.

​
X-Express-Execute
boolean

(Padrão: false) Defina como true para tentar acionar um check-in imediato do dispositivo para uma execução mais rápida da tarefa.

Path Parameters

​
siteId
string<uuid>
required

O UUID do site a ser visado.

Body

text/plain · string

O script RouterOS bruto a ser executado no dispositivo.

The body is of type string.

Example:

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

Response

A tarefa foi criada com sucesso.

Um comando ou script assíncrono a ser executado em um Site.

​
id
string<uuid>

O identificador único (UUID) para a tarefa.

Example:

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

​
token
string

Um token curto, único e legível para a tarefa, frequentemente usado em filtros de log.

Example:

"2jP5kLqWnZ"

​
site_id
string<uuid>

O ID do site para o qual esta tarefa é destinada.

Example:

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

​
idempotency_key
string<uuid>

Uma chave única fornecida pelo cliente para evitar a criação de tarefas duplicadas.

Example:

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

​
description
string

Uma descrição legível do propósito da tarefa.

Example:

"Adicionar nova regra de firewall para a rede de visitantes"

​
express_execute
boolean

Se true, a plataforma tentará acionar um check-in imediato do dispositivo para executar esta tarefa mais rapidamente.

Example:

false

​
needs_acknowledgement
boolean

Se true, a tarefa requer uma notificação explícita de sucesso/falha do dispositivo para ser marcada como concluída.

Example:

true

​
should_backup
boolean

Se true, um backup de configuração foi criado automaticamente antes que esta tarefa fosse enfileirada.

Example:

true

​
associated_backup
string | null

O caminho para o arquivo de backup de configuração associado a esta tarefa, se um foi criado.

Example:

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

​
started_at
string<date-time> | null

O timestamp de quando o dispositivo começou a executar a tarefa.

Example:

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

​
completed_at
string<date-time> | null

O timestamp de quando o dispositivo relatou a conclusão bem-sucedida da tarefa.

Example:

null

​
failed_at
string<date-time> | null

O timestamp de quando o dispositivo relatou uma falha durante a execução da tarefa.

Example:

null

​
created_at
string<date-time>

O timestamp de quando a tarefa foi criada.

Example:

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

​
log_url
string

Uma URL relativa para a UI da Altostrat SDX para visualizar logs relacionados à execução desta tarefa.

Example:

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

​
script
string

O conteúdo (payload) do script RouterOS bruto da tarefa.

Example:

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