POST
/
api
/
asynchronous
/
{router_id}
curl --request POST \
  --url https://api.altostrat.io/api/asynchronous/{router_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "<string>",
  "script": "<string>",
  "make_backup": true,
  "express_execute": true,
  "needs_acknowledgement": true,
  "notify_url": "<string>"
}'
{
  "status": "<string>",
  "data": {
    "idempotency_key": "<string>",
    "request_id": "<string>",
    "target": "<string>",
    "notify_url": "<string>",
    "date": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Use the Authorization: Bearer <token> header format

Path Parameters

​
router_id
string
required

The UUID of the router for asynchronous commands.

Body

application/json
Asynchronous job specification including script, backup preference, etc.
​
description
string
required

A short description for the orchestration log.

Maximum length: 100
​
script
string
required

RouterOS script commands separated by semicolons. Max 2000 characters.

​
make_backup
boolean
required

If true, a backup is created before execution.

​
express_execute
boolean
required

If true, the job tries to run immediately.

​
needs_acknowledgement
boolean
required

If false, the job is marked completed without waiting for confirmation.

​
notify_url
string

Optional. URL to receive job status updates.

Response

200 - application/json
Job creation success
​
status
string
​
data
object

Was this page helpful?