Langsung ke konten utama
POST
/
sites
/
{siteId}
/
jobs
Buat Tugas untuk Situs
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": "Tambahkan aturan firewall baru untuk jaringan tamu",
  "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

Autentikasi permintaan dengan menyediakan JSON Web Token (JWT) di header Authorization. Contoh: Authorization: Bearer <JWT_ANDA>

Headers

โ€‹
X-Idempotency-Key
string<uuid>
required

UUID unik yang disediakan oleh klien untuk memastikan bahwa permintaan hanya diproses sekali.

โ€‹
X-Description
string
required

Deskripsi yang dapat dibaca manusia tentang tujuan tugas.

Required string length: 3 - 100
โ€‹
X-Needs-Ack
boolean

(Default: true) Atur ke false jika tugas harus dianggap selesai segera setelah dikirim ke perangkat, tanpa menunggu respons keberhasilan/kegagalan.

โ€‹
X-Backup
boolean

(Default: false) Atur ke true untuk secara otomatis membuat cadangan konfigurasi situs sebelum menjalankan tugas ini.

โ€‹
X-Express-Execute
boolean

(Default: false) Atur ke true untuk mencoba memicu check-in perangkat segera untuk eksekusi tugas yang lebih cepat.

Path Parameters

โ€‹
siteId
string<uuid>
required

UUID dari situs yang dituju.

Body

text/plain ยท string

Skrip RouterOS mentah yang akan dieksekusi pada perangkat.

The body is of type string.

Example:

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

Response

Tugas berhasil dibuat.

Perintah atau skrip asinkron untuk dieksekusi di sebuah Situs.

โ€‹
id
string<uuid>

Pengidentifikasi unik (UUID) untuk tugas.

Example:

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

โ€‹
token
string

Token unik pendek yang dapat dibaca manusia untuk tugas, sering digunakan dalam pemfilteran log.

Example:

"2jP5kLqWnZ"

โ€‹
site_id
string<uuid>

ID dari situs yang menjadi target tugas ini.

Example:

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

โ€‹
idempotency_key
string<uuid>

Kunci unik yang disediakan oleh klien untuk mencegah pembuatan tugas ganda.

Example:

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

โ€‹
description
string

Deskripsi yang dapat dibaca manusia tentang tujuan tugas.

Example:

"Tambahkan aturan firewall baru untuk jaringan tamu"

โ€‹
express_execute
boolean

Jika true, platform akan mencoba memicu check-in segera dari perangkat untuk menjalankan tugas ini lebih cepat.

Example:

false

โ€‹
needs_acknowledgement
boolean

Jika true, tugas memerlukan notifikasi keberhasilan/kegagalan eksplisit dari perangkat untuk ditandai sebagai selesai.

Example:

true

โ€‹
should_backup
boolean

Jika true, cadangan konfigurasi dibuat secara otomatis sebelum tugas ini dimasukkan ke dalam antrean.

Example:

true

โ€‹
associated_backup
string | null

Jalur ke file cadangan konfigurasi yang terkait dengan tugas ini, jika ada yang dibuat.

Example:

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

โ€‹
started_at
string<date-time> | null

Stempel waktu saat perangkat mulai menjalankan tugas.

Example:

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

โ€‹
completed_at
string<date-time> | null

Stempel waktu saat perangkat melaporkan keberhasilan penyelesaian tugas.

Example:

null

โ€‹
failed_at
string<date-time> | null

Stempel waktu saat perangkat melaporkan kegagalan selama eksekusi tugas.

Example:

null

โ€‹
created_at
string<date-time>

Stempel waktu saat tugas dibuat.

Example:

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

โ€‹
log_url
string

URL relatif ke UI Altostrat SDX untuk melihat log yang terkait dengan eksekusi tugas ini.

Example:

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

โ€‹
script
string

Payload skrip RouterOS mentah dari tugas.

Example:

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