Service object fields

When you retrieve a service's details with the Render API, many of the returned object's fields are the same regardless of the service's type (static site, web service, etc.). However, certain fields are returned only for certain service types. See the table below for details.

Legend

SymbolMeaning
🟒Field is present
❌Field is not present
🟨Field is conditionally present (details vary by field)
Field Name /
Type
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
🟒🟨
non-Docker only
🟨
non-Docker only
🟨
non-Docker only
🟨
non-Docker only
dockerCommand
string
❌🟨
Docker only
🟨
Docker only
🟨
Docker only
🟨
Docker only
dockerContext
string
❌🟨
Docker only
🟨
Docker only
🟨
Docker only
🟨
Docker only
dockerfilePath
string
❌🟨
Docker only
🟨
Docker only
🟨
Docker only
🟨
Docker only
env
string
❌🟒🟒🟒🟒
plan
string
❌🟒🟒🟒🟒
region
string
❌🟒🟒🟒🟒
healthCheckPath
string
❌🟒❌❌❌
publishPath
string
🟒❌❌❌❌
numInstances
integer
❌🟨
Invalid if autoscaling is enabled
🟨
Invalid if autoscaling is enabled
🟨
Invalid if autoscaling is enabled
❌
pullRequestPreviewsEnabled
boolean
🟒🟒🟒🟒❌
openPorts
array of objects
❌🟒🟒❌❌
parentServer
object
🟨
Only if parent server exists
🟨
Only if parent server exists
🟨
Only if parent server exists
🟨
Only if parent server exists
❌
url
string
🟒🟒🟒❌❌
disk
object
❌🟒🟒🟒❌
schedule
string
❌❌❌❌🟒
lastSuccessfulRunAt
date-time
❌❌❌❌🟒