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 and start in that same request. 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

Terminal
curl -H "X-Api-Key: YOUR_API_KEY" \
  https://vibecode.bitrix24.com/v1/infra/runtimes

curl — OAuth application

Terminal
curl -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  https://vibecode.bitrix24.com/v1/infra/runtimes

JavaScript — personal key

javascript
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

javascript
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
success boolean Always true on success
data array Array of runtimes
data[].id string The runtime ID, passed as runtime on deploy (POST /v1/infra/servers/:id/deploy)
data[].name string Display name for the user
data[].packages array<string> List of packages installed on a dedicated virtual machine (for reference)
data[].estimatedSetupTime number Estimated installation time in seconds
data[].supportedPlacements array<string> Where 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

Response example

JSON
{
  "success": true,
  "data": [
    {
      "id": "node20",
      "name": "Node.js 20",
      "packages": ["nodejs-20", "npm", "pm2"],
      "estimatedSetupTime": 120,
      "supportedPlacements": ["standalone", "galaxy"]
    },
    {
      "id": "node20-pg",
      "name": "Node.js 20 + PostgreSQL",
      "packages": ["nodejs-20", "npm", "pm2", "postgresql-16"],
      "estimatedSetupTime": 180,
      "supportedPlacements": ["standalone"]
    },
    {
      "id": "python311-rag",
      "name": "Python 3.11 + RAG (pgvector + Redis)",
      "packages": ["python3.11", "pip", "postgresql-16", "pgvector", "redis"],
      "estimatedSetupTime": 240,
      "supportedPlacements": ["standalone"]
    }
  ]
}

Error response example

401 — no API key provided:

JSON
{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "API key required. Pass via X-Api-Key header."
  }
}

Errors

HTTP Code Description
401 MISSING_API_KEY The X-Api-Key header was not provided
401 INVALID_API_KEY Invalid or expired API key
429 RATE_LIMITED The platform's overall request limit was exceeded

Full list of common API errors — Errors.

Known specifics

  • As of 2026-04-22 the platform offers 15 runtimes: six Node.js 20 variants (plain, with PostgreSQL, MySQL, Redis, combinations, the RAG stack), five Python 3.11 variants (similarly), two PHP 8.3 variants (plain and with MySQL), and static for SPA static content. The current snapshot is always in the endpoint's response.

  • The start command depends on the runtime — pass it in the deploy start field. On a dedicated virtual machine the runtime installs a versioned command: node20*node, python311*python3.11, php83*php8.3, staticnginx. There is no python command on such a machine, and python3 stays the Ubuntu 24.04 system interpreter — that is version 3.12. The python3.11 command works in Galaxy too, so such a start fits both placement models. The runtime binds pip to 3.11, so pip install in the install field puts dependencies into the same interpreter that runs the app.

  • Where pip fetches packages from. The platform sets a default package index — a mirror reachable from our cloud (pypi.org itself does not respond from there: the install would hang and report "no matching version" for an existing version). The setting is machine-wide, so it covers the automatic requirements.txt install, your own command in the install field, and any pip you run by hand through exec. Your choice wins over ours: an --index-url in requirements.txt or in the install command overrides the default. A PIP_INDEX_URL from the deploy env does NOT affect a Galaxy build — the environment reaches the container at runtime, while dependencies are installed earlier, during the image build; on a dedicated virtual machine it does work. If package immutability matters to you, use --require-hashes with pinned hashes — that is the only mechanism protecting you from substitution on the index side. poetry and uv do not read our setting; point them at an index using their own configuration mechanism.

  • RAG runtimes (node20-rag, python311-rag) — a ready-made environment for the RAG pattern (retrieval-augmented generation — an LLM response enriched with context from external sources): PostgreSQL with the pgvector extension for embeddings and Redis for caching. Right after installation you can connect LlamaIndex / LangChain.

  • Nginx in static, php83, and php83-mysql. On a dedicated virtual machine the runtime installs the package before stopping the previous application, but it does not start the system nginx.service or leave it newly enabled. An existing enabled/disabled state is preserved. The platform starts the required listener later from the start field inside app.service.

  • static — a runtime for single-page applications and static sites: it installs nginx, but does not activate the system service itself and therefore creates no new listener on port 80. To serve the build from /opt/app on port 3000 with a fallback to index.html for client-side routes, set a preStart that creates an nginx server block, defends against a legacy/manual system service, and validates the configuration, then run nginx in the foreground via start:

    Terminal
    # preStart: nginx server block on port 3000 + guard against legacy/manual system nginx
    cat >/etc/nginx/conf.d/app.conf <<'NGINX'
    server {
      listen 3000 default_server;
      listen [::]:3000 default_server;
      root /opt/app;
      index index.html;
      location / { try_files $uri $uri/ /index.html; }
    }
    NGINX
    rm -f /etc/nginx/sites-enabled/default
    systemctl disable --now nginx
    nginx -t

    In the deploy body: preStart is the command above, start is nginx -g 'daemon off;', port is 3000, and hardening is "off". The recipe targets a dedicated virtual machine: for a Galaxy application the preStart and hardening fields do not apply. The start field is required: the platform runs the app as the app.service systemd unit and the runtime does not create a separate unit for nginx. Suitable for React/Vue/Svelte builds — put dist/ into the archive.

    The "hardening": "off" value is required here. By default the platform starts the app under an unprivileged account, and nginx in this recipe writes its service files and logs outside the application directory — under such an account it does not start. The platform restores the previous mode on its own, but the failed attempt and its health check cost about a minute on every deploy. The field is described on Full deploy.

  • The php83 and php83-mysql runtimes, and the MySQL variants (node20-mysql, node20-mysql-redis, python311-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 / -rag suffixes 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: a 400 with code GALAXY_RUNTIME_DB_UNSUPPORTED, a details.suggestedRuntime field (the language replacement — node20 instead of node20-pg, for example) and a hint. Which runtime fits which placement is machine-readable in the catalog GET /v1/infra/runtimes: every entry carries supportedPlacements["standalone"] or ["standalone","galaxy"]. The name and packages fields 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 through env, 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:20-slim, python:3.11-slim, php:8.3-cli, nginx:alpine) — the version follows the image tag. On a dedicated virtual machine the major version is pinned and matches what is advertised (Node.js 20, Python 3.11, PHP 8.3, PostgreSQL 16); the patch version follows the install source. If the exact version is critical, check it inside the app on the target placement rather than relying on the runtime ID alone.

  • estimatedSetupTime is an estimate, not a guarantee. It depends on the load of the apt mirrors, the network speed of the virtual machine, and the specific Ubuntu image build. Budget 2× the stated value when automating.

  • If the stack you need is not in the list — use preStart on a dedicated virtual machine. The server is a clean Ubuntu 24.04 with root access. In the deploy's preStart field you can run any apt-get install, download binaries, set up the environment. The result is preserved between deploys (except for the extractTo directory, which cleanDeploy: true cleans). For one-off operations — POST /exec.

See also