List available workspace templates.
curl --request GET \
--url https://api.rigbox.dev/api/v1/templatesimport requests
url = "https://api.rigbox.dev/api/v1/templates"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.rigbox.dev/api/v1/templates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.rigbox.dev/api/v1/templates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.rigbox.dev/api/v1/templates"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.rigbox.dev/api/v1/templates")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rigbox.dev/api/v1/templates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"templates": [
{
"category": "<string>",
"default_log_sources": [
{
"source_ref": "<string>",
"source_type": "<string>",
"display_name": "<string>",
"is_primary": true
}
],
"description": "<string>",
"disk_size_mb": 1,
"icon": "<string>",
"id": "<string>",
"image": "<string>",
"name": "<string>",
"ram_mb": 1,
"vcpu_count": 1,
"coming_soon": true,
"env_file_copies": [
"<string>"
],
"expected_apps": [
{
"managed": true,
"name": "<string>",
"port": 1,
"protocol": "<string>",
"system_tags": [
"<string>"
],
"configurable_params": [
{
"key": "<string>",
"label": "<string>",
"default": "<string>",
"description": "<string>",
"group": "<string>",
"help_url": "<string>",
"options": [
{
"label": "<string>",
"value": "<string>"
}
],
"order": 123,
"required": true,
"sensitive": true,
"validation_pattern": "<string>"
}
],
"depends_on": [
"<string>"
],
"usage_examples": [
{
"code": "<string>",
"label": "<string>",
"language": "<string>",
"description": "<string>"
}
]
}
],
"has_tools": true,
"image_bound": true,
"service_patches": [
{
"env_file_path": "<string>",
"unit_name": "<string>",
"remove_env_patterns": [
"<string>"
]
}
],
"verify_binaries": [
"<string>"
],
"workspace_services": [
{
"exposed": true,
"health_cmd": "<string>",
"kind": "<string>",
"name": "<string>",
"unit_name": "<string>",
"log_sources": [
{
"source_ref": "<string>",
"source_type": "<string>",
"display_name": "<string>",
"is_primary": true
}
],
"port": 1
}
]
}
]
}Templates
List Templates
List available workspace templates. This endpoint is public — no auth required.
GET
/
api
/
v1
/
templates
List available workspace templates.
curl --request GET \
--url https://api.rigbox.dev/api/v1/templatesimport requests
url = "https://api.rigbox.dev/api/v1/templates"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.rigbox.dev/api/v1/templates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.rigbox.dev/api/v1/templates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.rigbox.dev/api/v1/templates"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.rigbox.dev/api/v1/templates")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rigbox.dev/api/v1/templates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"templates": [
{
"category": "<string>",
"default_log_sources": [
{
"source_ref": "<string>",
"source_type": "<string>",
"display_name": "<string>",
"is_primary": true
}
],
"description": "<string>",
"disk_size_mb": 1,
"icon": "<string>",
"id": "<string>",
"image": "<string>",
"name": "<string>",
"ram_mb": 1,
"vcpu_count": 1,
"coming_soon": true,
"env_file_copies": [
"<string>"
],
"expected_apps": [
{
"managed": true,
"name": "<string>",
"port": 1,
"protocol": "<string>",
"system_tags": [
"<string>"
],
"configurable_params": [
{
"key": "<string>",
"label": "<string>",
"default": "<string>",
"description": "<string>",
"group": "<string>",
"help_url": "<string>",
"options": [
{
"label": "<string>",
"value": "<string>"
}
],
"order": 123,
"required": true,
"sensitive": true,
"validation_pattern": "<string>"
}
],
"depends_on": [
"<string>"
],
"usage_examples": [
{
"code": "<string>",
"label": "<string>",
"language": "<string>",
"description": "<string>"
}
]
}
],
"has_tools": true,
"image_bound": true,
"service_patches": [
{
"env_file_path": "<string>",
"unit_name": "<string>",
"remove_env_patterns": [
"<string>"
]
}
],
"verify_binaries": [
"<string>"
],
"workspace_services": [
{
"exposed": true,
"health_cmd": "<string>",
"kind": "<string>",
"name": "<string>",
"unit_name": "<string>",
"log_sources": [
{
"source_ref": "<string>",
"source_type": "<string>",
"display_name": "<string>",
"is_primary": true
}
],
"port": 1
}
]
}
]
}Response
200 - application/json
List of available workspace templates
Show child attributes
Show child attributes
⌘I