Перейти к содержимому
TG

Список шаблонов

Возвращает список всех доступных шаблонов.

GET https://api.yougpu.ru/templates

Заголовки (Headers)

Заголовок Значение Описание
X-API-KEY <YOUR_API_KEY> Ваш API ключ
Content-Type application/json Формат данных
Окно терминала
curl -X GET "https://api.yougpu.ru/templates" \
-H "X-API-KEY: <YOUR_API_KEY>"
200 OK
{
"status": "success",
"code": 200,
"data": [
{
"id": "template-pytorch-2-2-jupyter",
"slug": "pytorch-2-2-jupyter",
"name": "PyTorch 2.2 + Jupyter Lab",
"description": "Универсальная среда для ML/DL. Включает Python 3.11.8, CUDA 12.1 и Jupyter Lab.",
"readme": "\n# PyTorch 2.2 Environment\n\n### Как подключиться:\n1. Нажмите кнопку **\"Open Jupyter Lab\"** в панели управления.\n2. Ваши файлы сохраняются в папке `/workspace`. Данные вне этой папки могут быть утеряны при пересоздании контейнера.\n\n### Установленные пакеты:\n- PyTorch 2.2\n- CUDA 12.1\n- Python 3.11.8\n ",
"tags": [
"ML Frameworks",
"Development",
"Jupyter"
],
"logo_url": "https://console.yougpu.ru/assets/pytorch-logo.webp",
"image_name": "quay.io/jupyter/pytorch-notebook:cuda12-python-3.11.8",
"run_command": "start-notebook.sh --NotebookApp.ip=0.0.0.0 --NotebookApp.port=8888",
"shm_size": null,
"endpoints": [
{
"auth": {
"type": "token",
"token_key": "JUPYTER_TOKEN"
},
"name": "Jupyter Lab",
"port": 8888,
"is_main": true,
"protocol": "TCP",
"url_template": "http://{{ip}}:{{port}}/lab?token={{secrets.JUPYTER_TOKEN}}"
}
],
"volumes": [
{
"host_path": "/root/workspace",
"container_path": "/home/jovyan"
}
],
"env_vars": {},
"post_start_script": null,
"min_disk_gb": 20,
"min_cuda_version": "12.0",
"is_active": true,
"sort_order": 10,
"variables_schema": [
{
"key": "JUPYTER_TOKEN",
"type": "generated",
"label": "Token",
"length": 24,
"generator": "hex"
}
],
"created_at": "2026-02-15T18:03:39.348Z",
"updated_at": "2026-02-15T18:03:39.348Z"
}
]
}

Параметр
Тип
Описание
status
string
Статус выполнения запроса (например, success).
code
number
HTTP код ответа.
data
array
Данные ответа:
id
string
Уникальный внутренний идентификатор шаблона.
slug
string
Символьный код (слаг) шаблона.
name
string
Публичное название шаблона.
description
string
Краткое описание шаблона и его назначения.
readme
string
Подробная инструкция по использованию в формате Markdown.
tags
array of strings
Массив тегов, связанных с шаблоном (например, ML Frameworks, Jupyter).
logo_url
string
Прямая ссылка на логотип шаблона.
image_name
string
Полное название Docker-образа в реестре.
run_command
string
Команда, выполняемая при запуске контейнера.
shm_size
string | null
Размер выделяемой разделяемой памяти (shm) для контейнера.
endpoints
array
Конфигурация сетевых доступов и портов контейнера:
auth
object
Настройки авторизации для эндпоинта:
type
string
Тип авторизации (например, token).
token_key
string
Ключ переменной окружения, содержащей токен.
name
string
Название эндпоинта (например, Jupyter Lab).
port
number
Внутренний порт, который слушает приложение в контейнере.
is_main
boolean
Является ли этот эндпоинт основным маршрутом по умолчанию.
protocol
string
Сетевой протокол подключения (например, TCP).
url_template
string
Шаблон URL для формирования итоговой ссылки подключения.
volumes
array
Конфигурация монтируемых томов (дисков):
host_path
string
Путь на хост-машине (сервере).
container_path
string
Точка монтирования внутри контейнера.
env_vars
object
Список дополнительных статических переменных окружения в формате ключ-значение.
post_start_script
string | null
Bash-скрипт, который выполняется сразу после старта контейнера.
min_disk_gb
number
Минимальный требуемый объем диска в гигабайтах для данного шаблона.
min_cuda_version
string
Минимально необходимая версия CUDA на хосте.
is_active
boolean
Доступен ли шаблон для выбора и использования.
sort_order
number
Порядок сортировки шаблона при выводе списком (чем меньше, тем выше).
variables_schema
array
Схема динамических переменных (секретов), необходимых шаблону:
key
string
Ключ переменной (например, JUPYTER_TOKEN).
type
string
Тип переменной (например, generated).
label
string
Отображаемое название в интерфейсе.
length
number
Длина генерируемого значения (если применимо).
generator
string
Алгоритм генерации значения (например, hex).
created_at
string
Дата добавления шаблона в базу (ISO 8601).
updated_at
string
Дата последнего обновления настроек шаблона (ISO 8601).
Есть вопросы?
Нашли ошибку? Сообщить