Skip to main content
GET
Retrieve a Community Script

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

communityScriptId
string<ulid>
required

The unique identifier for the community script.

Example:

"01H8XGJWBWBAQ1Z3G1B6X2Q8P5"

Response

Detailed information about the community script.

id
string<ulid>

The unique identifier for the community script.

Example:

"01H8XGJWBWBAQ1Z3G1B6X2Q8P5"

name
string

The filename of the script.

Example:

"add-dns-static.rsc"

description
string | null

An AI-generated summary of the script.

Example:

"This script adds a static DNS entry for a given name to a specified IP address."

size
integer

The size of the script file in bytes.

Example:

128

readme_url
string<uri> | null

A URL to the raw markdown README file.

Example:

"https://raw.githubusercontent.com/mikrotik-scripts/main/scripts/add-dns-static/README.md"

github_url
string<uri>

A URL to the script file on GitHub's web interface.

Example:

"https://github.com/mikrotik-scripts/main/blob/main/scripts/add-dns-static.rsc"

raw_url
string<uri>

The direct raw URL for downloading the script content.

Example:

"https://raw.githubusercontent.com/mikrotik-scripts/main/scripts/add-dns-static.rsc"

content
string

The script content, included when retrieving a single script.

Example:

":local name \"example.com\"; :local address 192.168.88.254; /ip dns static add name=$name address=$address;"

sha
string

The git SHA hash of the file content.

Example:

"e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"

repository
object
user
object