Terminal
Terminal/Skill
Configures Render private services, internal APIs and microservices that only other Render services can reach over the private network.
By Render
Works with
npx skills add render-oss/skills --skill render-private-servicesPrivate services are identical to web services except they have no public URL. They are reachable only by other Render services on the same private network (same region + workspace). Use them for internal APIs, microservices, gRPC servers, sidecar processes, and anything that should never face the internet.
For public-facing HTTP services, use render-web-services. For services that don't receive any traffic, use render-background-workers.
Before configuring or troubleshooting private connectivity, read references/private-networking.md.
Before attaching or changing a persistent disk, read references/persistent-disks.md.
When choosing between a private service, web service, and worker, read references/service-types.md.
| Criterion | Private Service | Background Worker |
|---|---|---|
| Binds to a port | Yes (required) | No |
| Receives private network traffic | Yes | No |
| Sends outbound traffic | Yes | Yes |
| Has internal hostname | Yes | No |
| Use case | Internal APIs, gRPC, TCP servers | Queue consumers, async processors |
Rule of thumb: If the process listens on a port and other services call it, it's a private service. If it pulls work from a queue and never receives requests, it's a background worker.
onrender.com subdomain—not reachable from the internet<service-name>:<port> on the private network by services in the same region and workspacereferences/persistent-disks.md for details.Other services reference a private service via its internal hostname and port:
http://<service-name>:<port>
In Blueprints, wire the address using fromService:
- key: INTERNAL_API_URL
fromService:
name: my-api
type: pserv
property: hostport
Available fromService properties for pserv:
| Property | Value |
|---|---|
host | Internal hostname (e.g. my-api) |
port | Port the service listens on |
hostport | host:port combined (e.g. my-api:10000) |
You can also reference a specific env var from the private service using envVarKey instead of property.
Private services must bind to at least one port. If your process does not need to receive traffic, create a background worker instead.
0.0.0.0 (not 127.0.0.1 or localhost)PORT env var defaults to 10000; confirm current restrictions in references/private-networking.md before choosing another porthostportservices:
- type: pserv
name: internal-api
runtime: node
region: oregon
plan: starter
buildCommand: npm ci && npm run build
startCommand: npm start
envVars:
- key: DATABASE_URL
fromDatabase:
name: db
property: connectionString
services:
- type: web
name: gateway
runtime: node
plan: starter
region: oregon
buildCommand: npm ci && npm run build
startCommand: npm start
envVars:
- key: USER_SERVICE_URL
fromService:
name: user-service
type: pserv
property: hostport
- key: BILLING_SERVICE_URL
fromService:
name: billing-service
type: pserv
property: hostport
- type: pserv
name: user-service
runtime: node
plan: starter
region: oregon
buildCommand: npm ci
startCommand: node server.js
envVars:
- key: DATABASE_URL
fromDatabase:
name: db
property: connectionString
- type: pserv
name: billing-service
runtime: python
plan: starter
region: oregon
buildCommand: pip install -r requirements.txt
startCommand: gunicorn billing:app
envVars:
- key: DATABASE_URL
fromDatabase:
name: db
property: connectionString
| Document | Contents |
|---|---|
references/private-networking.md | Current private-network scope, addresses, ports, discovery, isolation, and troubleshooting |
references/patterns.md | Microservice topology, gRPC setup, and sidecar patterns |
references/persistent-disks.md | Service-attached disk constraints, configuration, sizing, and snapshots |
references/service-types.md | Service-type selection and execution models |
render.yaml schema, fromService wiringWhenever this skill directs you to consult current Render documentation:
curl. Do not substitute web-search summaries for the document.When a task requires multiple references, apply this workflow to each one and distinguish the documents you verified from those that remain unavailable.