Skip to main content
GET
/
community-scripts
/
{communityScriptId}
Retrieve a Community Script
curl --request GET \
  --url https://api.altostrat.io/community-scripts/{communityScriptId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "01H8XGJWBWBAQ1Z3G1B6X2Q8P5",
  "name": "add-dns-static.rsc",
  "description": "This script adds a static DNS entry for a given name to a specified IP address.",
  "size": 128,
  "readme_url": "https://raw.githubusercontent.com/mikrotik-scripts/main/scripts/add-dns-static/README.md",
  "github_url": "https://github.com/mikrotik-scripts/main/blob/main/scripts/add-dns-static.rsc",
  "raw_url": "https://raw.githubusercontent.com/mikrotik-scripts/main/scripts/add-dns-static.rsc",
  "content": ":local name \"example.com\"; :local address 192.168.88.254; /ip dns static add name=$name address=$address;",
  "sha": "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391",
  "repository": {
    "name": "mikrotik-scripts",
    "url": "https://github.com/user/mikrotik-scripts",
    "stars": 42,
    "created_at": "2024-01-15T12:00:00Z"
  },
  "user": {
    "name": "John Doe",
    "url": "https://github.com/johndoe",
    "avatar": "https://avatars.githubusercontent.com/u/12345?v=4",
    "followers": 100,
    "created_at": "2020-05-20T10:00:00Z"
  }
}

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