For AI agents: markdown of this page — /docs-content-en/infra/deploy/runtimes.md documentation index — /llms.txt
List of runtimes
GET /v1/infra/runtimes
Returns the IDs of ready-made runtimes to pass into POST /v1/infra/servers/:id/deploy (the runtime parameter). The runtime parameter is optional: if the stack you need is in the list, pass its ID and the platform will install the packages automatically. If not, a deploy without runtime on a dedicated virtual machine still works fully — install the software you need via preStart in the request body. For a Galaxy application runtime is required and preStart does not apply. On POST /v1/infra/servers a runtime without source has NOT been accepted since 2026-04-25 — see RUNTIME_PARAM_REMOVED. When a Galaxy application is created in one step, runtime is passed together with source; start is also required unless the runtime is static, where it is optional and ignored. Each runtime is a set of system packages (nodejs, python, nginx, databases) installed on the server. The estimated installation time is 2–4 minutes for the basic ones, up to 4+ minutes for combinations with several packages.
Examples
curl — personal key
curl -H "X-Api-Key: YOUR_API_KEY" \
https://vibecode.bitrix24.com/v1/infra/runtimes
curl — OAuth application
curl -H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN" \
https://vibecode.bitrix24.com/v1/infra/runtimes
JavaScript — personal key
const res = await fetch('https://vibecode.bitrix24.com/v1/infra/runtimes', {
headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data: runtimes } = await res.json()
runtimes.forEach(r => console.log(`${r.id}: ${r.name} (${r.estimatedSetupTime}s)`))
JavaScript — OAuth application
const res = await fetch('https://vibecode.bitrix24.com/v1/infra/runtimes', {
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
},
})
Response fields
| Field | Type | Description |
|---|---|---|
Fieldsuccess |
Typeboolean | DescriptionAlways true on success |
Fielddata |
Typearray | DescriptionArray of runtimes |
Fielddata[].id |
Typestring | DescriptionThe runtime ID, passed as runtime on deploy (POST /v1/infra/servers/:id/deploy) |
Fielddata[].name |
Typestring | DescriptionDisplay name for the user |
Fielddata[].packages |
Typearray<string> | DescriptionList of packages installed on a dedicated virtual machine (for reference) |
Fielddata[].estimatedSetupTime |
Typenumber | DescriptionEstimated installation time in seconds |
Fielddata[].supportedPlacements |
Typearray<string> | DescriptionWhere the runtime is available: ["standalone"] — dedicated virtual machine only, ["standalone","galaxy"] — Galaxy too. Check this field before a Galaxy deploy: a runtime with a database cannot be installed there |
Fielddata[].deprecated |
Typeboolean | Descriptiontrue — the language line is no longer supported: deploys still work, but use the runtime in replacement for a new app |
Fielddata[].replacement |
Typestring | null | DescriptionID of the runtime that replaces a deprecated one with the same package set, for example node24-pg instead of node20-pg. null for a supported runtime |
Response example
{
"success": true,
"data": [
{
"id": "node24",
"name": "Node.js 24",
"packages": ["nodejs-24", "npm", "pm2"],
"estimatedSetupTime": 150,
"supportedPlacements": ["standalone", "galaxy"],
"deprecated": false,
"replacement": null
},
{
"id": "node24-pg",
"name": "Node.js 24 + PostgreSQL",
"packages": ["nodejs-24", "npm", "pm2", "postgresql-16"],
"estimatedSetupTime": 210,
"supportedPlacements": ["standalone"],
"deprecated": false,
"replacement": null
},
{
"id": "node20",
"name": "Node.js 20",
"packages": ["nodejs-20", "npm", "pm2"],
"estimatedSetupTime": 120,
"supportedPlacements": ["standalone", "galaxy"],
"deprecated": true,
"replacement": "node24"
}
]
}
Error response example
401 — no API key provided:
{
"success": false,
"error": {
"code": "MISSING_API_KEY",
"message": "API key required. Pass via X-Api-Key header."
}
}
Errors
| HTTP | Code | Description |
|---|---|---|
| HTTP401 | CodeMISSING_API_KEY |
DescriptionThe X-Api-Key header was not provided |
| HTTP401 | CodeINVALID_API_KEY |
DescriptionThe key is not recognized — no such key exists on the platform |
| HTTP429 | CodeRATE_LIMITED |
DescriptionThe platform's overall request limit was exceeded |
Full list of common API errors — Errors.
Known specifics
- For a new Node.js app, use
node24or one of its variants. Node.js 20 reached end of life on 2026-04-30 and no longer receives security fixes. Thenode20*runtimes stay in the list for apps already deployed on them and are markeddeprecated: truewith the successor inreplacement. Moving tonode24is a new deploy withruntime: "node24". npm modules with C/C++ code are rebuilt for Node.js 24 during that deploy, so do not ship anode_modulesdirectory built under Node.js 20 in the archive. - Deploying
node20*to a dedicated virtual machine can overwrite the NodeSourceaptsettings made on the machine by hand. When thenodecommand on the machine does not report version 20 — on the runtime's first install, or when moving fromnode24*back tonode20*— the platform installs Node.js 20 with the NodeSource repository installer. The installer replaces the/usr/share/keyrings/nodesource.gpgkey and rewrites the/etc/apt/preferences.d/nodejsand/etc/apt/preferences.d/nsolidfiles in full, leaving priority 600 for packages fromdeb.nodesource.com. The platform neither saves nor restores their previous contents. If the NodeSource install fails and Node.js 20 comes from the archive instead, these files may still end up overwritten or deleted. Keep a copy of your ownnodejsversion pin or key and put it back after the deploy.node20*deploys leave these files alone while thenodecommand reports version 20 andnpmworks, and thenode24*installer never touches them. - The start command depends on the runtime — pass it in the deploy
startfield, except forstatic. Forstatic, the field is optional and ignored: the platform starts nginx itself. Other runtimes use these commands on a dedicated virtual machine:node24*andnode20*—node,python311*—python3.11,python312*—python, andphp83*—php8.3. Thepython3.11andpythoncommands work in Galaxy too, so such astartfits both placement models. A machine withpython311*has nopythoncommand, andpython3stays the Ubuntu 24.04 system interpreter — that is version 3.12. Thepython311*runtime bindspipto 3.11, sopip installin theinstallfield puts dependencies into the same interpreter that runs the app. - With
python312*, the app's packages live in a separate platform Python environment. On a dedicated virtual machine Python 3.12 comes from the Ubuntu 24.04 archive, and thepython,pipandpip3commands run in an environment the platform creates next to it and keeps between deploys. Sopip install -r requirements.txtin theinstallfield andpython app.pyin thestartfield see the same packages. Thepython3andpython3.12commands stay the Ubuntu system interpreter without the app's packages: astartlikepython3 app.pyworks in Galaxy, but on a dedicated machine the app stops at its first package import. A package's console command, such asuvicornorgunicorn, is callable by name afterpip installif the machine has no command with that name yet. If the machine previously ranpython311*, the earlier runtime's command of the same name stays in place — run it as a module:python -m uvicorn main:app. Pinnednumpyversions below 1.26 andpandasversions below 2.1 do not build under Python 3.12 — raise them inrequirements.txt. - The
pm2package in a runtime's list is a tool installed on the machine, not a way to start the application. Thenode24andnode20runtimes and their variants installpm2alongside Node.js, but thestartfield requires a command that stays in the foreground and holds the listener itself. A command such aspm2 start server.js --name app && pm2 savelaunches a daemon and exits, and once it exits the platform stops the application service too. The full rule, both outcomes of such a command and what tells them apart in the deploy result — Full deploy, "Known specifics". - The
php83andphp83-mysqlruntimes, and the MySQL variants (node24-mysql,node24-mysql-redis,node20-mysql,node20-mysql-redis,python311-mysql,python312-mysql), need"hardening": "off". After installation MySQL allows only the administrator to connect over the local socket, and PHP-FPM runs as a separate system service — under an unprivileged account the app cannot reach the database. The platform restores the previous mode on its own, but the attempt and its health check cost time on every deploy. Pass"hardening": "off"in the deploy body to skip it. Apps that reach MySQL over TCP with a password do not need this. - Combo runtimes run on a dedicated virtual machine only. The
-pg/-mysql/-redis/-ragsuffixes describe the dedicated-machine template: there, PostgreSQL / MySQL / Redis really is installed alongside the language. A Galaxy app is a single language container on a shared host — no database is started there and no connection variables (DATABASE_URL,PG*, etc.) are injected, so deploying such a runtime into Galaxy is refused: a400with codeGALAXY_RUNTIME_DB_UNSUPPORTED, adetails.suggestedRuntimefield (the language replacement —node24instead ofnode24-pg, for example) and a hint. Which runtime fits which placement is machine-readable in the catalog GET /v1/infra/runtimes: every entry carriessupportedPlacements—["standalone"]or["standalone","galaxy"]. Thenameandpackagesfields describe the dedicated-machine install and do not change. If a Galaxy app needs a database, take a language runtime and pass the connection string of an external (managed) DB throughenv, or deploy the app to a dedicated virtual machine with the original runtime. - The same runtime ID can mean different patch versions in Galaxy versus on a dedicated virtual machine. In Galaxy the runtime is built from an official Docker image (
node:24-slim,node:20-slim,python:3.11-slim,python:3.12-slim,php:8.3-cli,nginx:alpine) — the version follows the image tag, and the platform requests the latest version of that tag before every build. On a dedicated virtual machine the major version is pinned and matches what is advertised (Node.js 24, Node.js 20, Python 3.11, Python 3.12, PHP 8.3, PostgreSQL 16); the patch version follows the install source: every deploy updates Node.js 24 to the latest 24.x release from the official archive and verifies the Node.js release team's signature. If the exact version is critical, check it inside the app on the target placement rather than relying on the runtime ID alone. estimatedSetupTimeis an estimate, not a guarantee: budget twice the stated value when automating.- If the stack you need is not in the list — use
preStarton a dedicated virtual machine. The server is a clean Ubuntu 24.04 with root access. In the deploy'spreStartfield you can run anyapt-get install, download binaries, or set up the environment. The result is preserved between deploys (except for theextractTodirectory, whichcleanDeploy: trueclears). For one-off operations —POST /exec.