Skip to main content
GET
/
runbooks
/
{runbookId}
Retrieve a Runbook
curl --request GET \
  --url https://api.altostrat.io/runbooks/{runbookId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "6d6d0e3d-1817-4817-8917-1e1717171717",
  "bootstrap_command": "/tool fetch url=\"https://api.ostrat.io/2kLqWnX...\" keep-result=no; ",
  "name": "Standard Branch Office Policy"
}

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

โ€‹
runbookId
string<uuid>
required

The UUID of the runbook to retrieve.

Response

The requested runbook object.

A configuration profile used for onboarding new devices.

โ€‹
id
string<uuid>

The unique identifier (UUID) for the runbook.

Example:

"6d6d0e3d-1817-4817-8917-1e1717171717"

โ€‹
bootstrap_command
string

The full RouterOS command to be run on a new device to adopt it into the Altostrat SDX platform using this runbook.

Example:

"/tool fetch url=\"https://api.ostrat.io/2kLqWnX...\" keep-result=no; "

โ€‹
name
string

The user-defined name of the runbook.

Example:

"Standard Branch Office Policy"