Skip to main content
GET
/
templates
/
{templateId}
Retrieve a Script Template
curl --request GET \
  --url https://api.altostrat.io/templates/{templateId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "d9e5b5e3-3e8a-4c2f-8d2a-7e6e5a4b1c0d",
  "name": "Standard Firewall Setup",
  "description": "Applies the standard set of corporate firewall rules to a device.",
  "content": "/ip firewall filter add chain=input action=accept connection-state=established,related",
  "metadata": {
    "version": "1.2",
    "compliance": "PCI-DSS"
  },
  "author": "auth0|642b7f3b8b3b3e3e3e3e3e3e",
  "read_only": false,
  "created_at": "2025-10-29T10:30:00.000000Z",
  "updated_at": "2025-10-29T11:00:00.000000Z"
}

Authorizations

โ€‹
Authorization
string
header
required

Altostrat SDX API uses JWT Bearer tokens for authentication. Obtain a token via the Authentication API and include it in the Authorization header as 'Bearer {token}'.

Path Parameters

โ€‹
templateId
string<uuid>
required

The unique identifier for the script template.

Example:

"d9e5b5e3-3e8a-4c2f-8d2a-7e6e5a4b1c0d"

Response

Detailed information about the script template.

โ€‹
id
string<uuid>

The unique identifier for the script template.

Example:

"d9e5b5e3-3e8a-4c2f-8d2a-7e6e5a4b1c0d"

โ€‹
name
string

The name of the script template.

Example:

"Standard Firewall Setup"

โ€‹
description
string

A brief description of what the template does.

Example:

"Applies the standard set of corporate firewall rules to a device."

โ€‹
content
string

The full script content of the template.

Example:

"/ip firewall filter add chain=input action=accept connection-state=established,related"

โ€‹
metadata
object | null

A key-value map for storing arbitrary metadata.

Example:
{ "version": "1.2", "compliance": "PCI-DSS" }
โ€‹
author
string<uuid> | null

The user ID of the template's author. Null for global templates.

Example:

"auth0|642b7f3b8b3b3e3e3e3e3e3e"

โ€‹
read_only
boolean

True if the template is global and cannot be edited by the user.

Example:

false

โ€‹
created_at
string<date-time>

The timestamp when the template was created.

Example:

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

โ€‹
updated_at
string<date-time>

The timestamp when the template was last updated.

Example:

"2025-10-29T11:00:00.000000Z"