When retrieving services through the Render REST API, many returned fields will be the same regardless of service type. However, there are some fields that are only returned for certain types of services. This page can be used as reference for what fields to expect from different service types.
Static Site | Web Service | Private Service | Background Worker | Cron Job | |
---|---|---|---|---|---|
id | ✅ | ✅ | ✅ | ✅ | ✅ |
type | ✅ | ✅ | ✅ | ✅ | ✅ |
repo | ✅ | ✅ | ✅ | ✅ | ✅ |
name | ✅ | ✅ | ✅ | ✅ | ✅ |
autoDeploy | ✅ | ✅ | ✅ | ✅ | ✅ |
branch | ✅ | ✅ | ✅ | ✅ | ✅ |
createdAt | ✅ | ✅ | ✅ | ✅ | ✅ |
notifyOnFail | ✅ | ✅ | ✅ | ✅ | ✅ |
ownerId | ✅ | ✅ | ✅ | ✅ | ✅ |
slug | ✅ | ✅ | ✅ | ✅ | ✅ |
state | ✅ | ✅ | ✅ | ✅ | ✅ |
suspenders | ✅ | ✅ | ✅ | ✅ | ✅ |
updatedAt | ✅ | ✅ | ✅ | ✅ | ✅ |
buildCommand | ✅ | yes if non-docker | yes if non-docker | yes if non-docker | yes if non-docker |
dockerCommand | ❌ | yes if docker | yes if docker | yes if docker | yes if docker |
dockerContext | ❌ | yes if docker | yes if docker | yes if docker | yes if docker |
dockerfilePath | ❌ | yes if docker | yes if docker | yes if docker | yes if docker |
env | ❌ | ✅ | ✅ | ✅ | ✅ |
plan | ❌ | ✅ | ✅ | ✅ | ✅ |
region | ❌ | ✅ | ✅ | ✅ | ✅ |
healthCheckPath | ❌ | ✅ | ❌ | ❌ | ❌ |
publishPath | ✅ | ❌ | ❌ | ❌ | ❌ |
numInstances | ❌ | ✅ | ✅ | ✅ | ❌ |
pullRequestPreviewsEnabled | ✅ | ✅ | ✅ | ✅ | ❌ |
openPorts | ❌ | ✅ | ✅ | ❌ | ❌ |
parentServer | yes if parentServer exists | yes if parentServer exists | yes if parentServer exists | yes if parentServer exists | ❌ |
url | ✅ | ✅ | ✅ | ❌ | ❌ |
disk | ❌ | ✅ | ✅ | ✅ | ❌ |
schedule | ❌ | ❌ | ❌ | ❌ | ✅ |
lastSuccessfulRunAt | ❌ | ❌ | ❌ | ❌ | ✅ |