Skip to main content
POST
Queue an asynchronous RouterOS script

Authorizations

Authorization
string
header
required

Authenticate requests by providing a JSON Web Token (JWT) in the Authorization header. Example: Authorization: Bearer <YOUR_JWT>

Path Parameters

siteId
string<uuid>
required

The target site/router UUID.

Example:

"9c69345c-8d39-4786-9f17-8153c988c89a"

Body

application/json
description
string
required
Example:

"Add guest network address"

script
string
required
Example:

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

make_backup
boolean
default:false

Create a configuration backup before running the script.

express_execute
boolean
default:false

Ask SDX to trigger a faster device check-in where possible.

needs_acknowledgement
boolean
default:false

Require the device job to acknowledge completion.

notify_url
string<uri> | null

Optional HTTPS callback URL for job status notification.

Example:

"https://example.com/sdx/job-complete"

Response

The script was accepted for asynchronous execution.

status
string
Example:

"success"

data
object