Service Fields

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 `string`	✅	✅	✅	✅	✅
type `string`	✅	✅	✅	✅	✅
repo `string`	✅	✅	✅	✅	✅
name `string`	✅	✅	✅	✅	✅
autoDeploy `boolean`	✅	✅	✅	✅	✅
branch `string`	✅	✅	✅	✅	✅
createdAt `date-time`	✅	✅	✅	✅	✅
notifyOnFail `string`	✅	✅	✅	✅	✅
ownerId `string`	✅	✅	✅	✅	✅
slug `string`	✅	✅	✅	✅	✅
suspended `string`	✅	✅	✅	✅	✅
suspenders `array of strings`	✅	✅	✅	✅	✅
updatedAt `date-time`	✅	✅	✅	✅	✅
buildCommand `string`	✅	yes if non-docker	yes if non-docker	yes if non-docker	yes if non-docker
dockerCommand `string`	❌	yes if docker	yes if docker	yes if docker	yes if docker
dockerContext `string`	❌	yes if docker	yes if docker	yes if docker	yes if docker
dockerfilePath `string`	❌	yes if docker	yes if docker	yes if docker	yes if docker
env `string`	❌	✅	✅	✅	✅
plan `string`	❌	✅	✅	✅	✅
region `string`	❌	✅	✅	✅	✅
healthCheckPath `string`	❌	✅	❌	❌	❌
publishPath `string`	✅	❌	❌	❌	❌
numInstances `integer`	❌	✅	✅	✅	❌
pullRequestPreviewsEnabled `boolean`	✅	✅	✅	✅	❌
openPorts `array of objects`	❌	✅	✅	❌	❌
parentServer `object`	yes if parentServer exists	yes if parentServer exists	yes if parentServer exists	yes if parentServer exists	❌
url `string`	✅	✅	✅	❌	❌
disk `object`	❌	✅	✅	✅	❌
schedule `string`	❌	❌	❌	❌	✅
lastSuccessfulRunAt `date-time`	❌	❌	❌	❌	✅