Pular para o conteúdo principal
POST
/
scheduled
Agendar um Novo 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": "Manutenção noturna de peer 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": "Atualização semanal da regra de firewall",
  "summary": "Este script adiciona uma regra de filtro de firewall para descartar a entrada de uma lista de endereços específica chamada \"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": "em 2 dias",
  "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

A API Altostrat SDX usa tokens JWT Bearer para autenticação. Obtenha um token através da API de Autenticação e inclua-o no cabeçalho de Autorização como 'Bearer {token}'.

Body

application/json
​
make_backup
boolean
required

Se verdadeiro, criar um backup de configuração antes de executar o script.

Example:

true

​
abort_if_offline
boolean
required

Se verdadeiro, não tentar executar o script em sites que estão offline.

Example:

true

​
description
string
required

Um nome legível por humanos para o script agendado.

Example:

"Manutenção noturna de peer BGP"

​
script
string
required

O conteúdo completo do script MikroTik RouterOS.

Example:

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

​
launch_at
string<date-time>
required

A data e hora UTC agendadas para a execução. Deve ser no futuro.

Example:

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

​
sites
string<uuid>[]
required

Um array de IDs de sites a serem direcionados.

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

Um array de IDs de usuários para receberem notificações.

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

O identificador único do site designado para execuções de teste.

Example:

"site_2Al5z3gXyY5f6Z7h8j9k0l1m"

Response

O script agendado foi criado com sucesso.

​
id
string<uuid>

O identificador único para o script agendado.

Example:

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

​
created_by
string<uuid>

O ID do usuário que criou o agendamento do script.

Example:

"auth0|642b7f3b8b3b3e3e3e3e3e3e"

​
test_site_id
string<uuid> | null

O identificador único do site designado para execuções de teste.

Example:

"site_2Al5z3gXyY5f6Z7h8j9k0l1m"

​
make_backup
boolean

Se verdadeiro, um backup de configuração será criado em cada dispositivo de destino antes da execução do script.

Example:

true

​
abort_if_offline
boolean

Se verdadeiro, a execução do script será abortada para um site se ele estiver offline no momento do lançamento.

Example:

false

​
description
string

Um nome ou descrição legível por humanos para o agendamento do script.

Example:

"Atualização semanal da regra de firewall"

​
summary
string | null

Um resumo gerado por IA do propósito do script.

Example:

"Este script adiciona uma regra de filtro de firewall para descartar a entrada de uma lista de endereços específica chamada \"blacklist\"."

​
script
string

O conteúdo completo do script MikroTik RouterOS a ser executado.

Example:

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

​
status
enum<string>

O status atual do script agendado.

Opções disponíveis:
unauthorized,
scheduled,
launched,
cancelled
Example:

"scheduled"

​
authorized_at
string<date-time> | null

O timestamp de quando a execução do script foi autorizada. Nulo se ainda não autorizado.

Example:

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

​
cancelled_at
string<date-time> | null

O timestamp de quando o script foi cancelado.

Example:

null

​
launch_at
string<date-time>

A data e hora UTC agendadas para a execução do script.

Example:

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

​
t_minus
string | null

Uma contagem regressiva legível para o horário de lançamento.

Example:

"em 2 dias"

​
started_at
string<date-time> | null

O timestamp de quando a execução do script realmente começou.

Example:

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

​
sites
string<uuid>[]

Uma lista de IDs de sites onde o script será executado.

​
notify
string<uuid>[]

Uma lista de IDs de usuários a serem notificados sobre o progresso do script e solicitações de autorização.

​
progress
object

Representa o progresso da execução de um script lançado em seus sites de destino.

​
created_at
string<date-time>

O timestamp de quando o script agendado foi criado.

Example:

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

​
updated_at
string<date-time>

O timestamp da última atualização do script agendado.

Example:

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