Список шаблонов
Возвращает список всех доступных шаблонов.
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>"import requests
url = "https://api.yougpu.ru/templates"headers = { "X-API-KEY": "<YOUR_API_KEY>"}
response = requests.get(url, headers=headers)print(response.json())const response = await fetch('https://api.yougpu.ru/templates', { "method": "GET", "headers": { "X-API-KEY": "<YOUR_API_KEY>" }});const data = await response.json();console.log(data); 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" } ]}Структура ответа
Заголовок раздела «Структура ответа»Параметр
Тип
Описание
statusstringСтатус выполнения запроса (например, success).
status
codenumberHTTP код ответа.
code
dataarrayДанные ответа:
data
idstringУникальный внутренний идентификатор шаблона.
id
slugstringСимвольный код (слаг) шаблона.
slug
namestringПубличное название шаблона.
name
descriptionstringКраткое описание шаблона и его назначения.
description
readmestringПодробная инструкция по использованию в формате Markdown.
readme
tagsarray of stringsМассив тегов, связанных с шаблоном (например, ML Frameworks, Jupyter).
tags
logo_urlstringПрямая ссылка на логотип шаблона.
logo_url
image_namestringПолное название Docker-образа в реестре.
image_name
run_commandstringКоманда, выполняемая при запуске контейнера.
run_command
shm_sizestring | nullРазмер выделяемой разделяемой памяти (shm) для контейнера.
shm_size
endpointsarrayКонфигурация сетевых доступов и портов контейнера:
endpoints
authobjectНастройки авторизации для эндпоинта:
auth
typestringТип авторизации (например, token).
type
token_keystringКлюч переменной окружения, содержащей токен.
token_key
namestringНазвание эндпоинта (например, Jupyter Lab).
name
portnumberВнутренний порт, который слушает приложение в контейнере.
port
is_mainbooleanЯвляется ли этот эндпоинт основным маршрутом по умолчанию.
is_main
protocolstringСетевой протокол подключения (например, TCP).
protocol
url_templatestringШаблон URL для формирования итоговой ссылки подключения.
url_template
volumesarrayКонфигурация монтируемых томов (дисков):
volumes
host_pathstringПуть на хост-машине (сервере).
host_path
container_pathstringТочка монтирования внутри контейнера.
container_path
env_varsobjectСписок дополнительных статических переменных окружения в формате ключ-значение.
env_vars
post_start_scriptstring | nullBash-скрипт, который выполняется сразу после старта контейнера.
post_start_script
min_disk_gbnumberМинимальный требуемый объем диска в гигабайтах для данного шаблона.
min_disk_gb
min_cuda_versionstringМинимально необходимая версия CUDA на хосте.
min_cuda_version
is_activebooleanДоступен ли шаблон для выбора и использования.
is_active
sort_ordernumberПорядок сортировки шаблона при выводе списком (чем меньше, тем выше).
sort_order
variables_schemaarrayСхема динамических переменных (секретов), необходимых шаблону:
variables_schema
keystringКлюч переменной (например, JUPYTER_TOKEN).
key
typestringТип переменной (например, generated).
type
labelstringОтображаемое название в интерфейсе.
label
lengthnumberДлина генерируемого значения (если применимо).
length
generatorstringАлгоритм генерации значения (например, hex).
generator
created_atstringДата добавления шаблона в базу (ISO 8601).
created_at
updated_atstringДата последнего обновления настроек шаблона (ISO 8601).
updated_at