Create preview for image-backed service

POST {{baseUrl}}/services/:serviceId/preview

Creates a build preview instance for an image-backed service. The preview uses the settings of the base service (referenced by serviceId), except settings overridden via provided parameters. You can view all active previews from your service's Previews tab on the Render Dashboard. Note that you can't create previews for Git-backed services using the Render API.

Request Body

{"imagePath"=>"<string>", "name"=>"<string>", "plan"=>"free"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;service&quot;:{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;autoDeploy&quot;:&quot;no&quot;,&quot;branch&quot;:&quot;\u003cstring\u003e&quot;,&quot;buildFilter&quot;:{&quot;paths&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;ignoredPaths&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;]},&quot;createdAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;image&quot;:{&quot;imagePath&quot;:&quot;\u003cstring\u003e&quot;,&quot;ownerId&quot;:&quot;\u003cstring\u003e&quot;,&quot;registryCredentialId&quot;:&quot;\u003cstring\u003e&quot;},&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;notifyOnFail&quot;:&quot;notify&quot;,&quot;ownerId&quot;:&quot;\u003cstring\u003e&quot;,&quot;repo&quot;:&quot;\u003cstring\u003e&quot;,&quot;rootDir&quot;:&quot;\u003cstring\u003e&quot;,&quot;slug&quot;:&quot;\u003cstring\u003e&quot;,&quot;suspended&quot;:&quot;not_suspended&quot;,&quot;suspenders&quot;:[&quot;unknown&quot;,&quot;parent_service&quot;],&quot;type&quot;:&quot;private_service&quot;,&quot;updatedAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;serviceDetails&quot;:{&quot;buildCommand&quot;:&quot;\u003cstring\u003e&quot;,&quot;parentServer&quot;:{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;},&quot;publishPath&quot;:&quot;\u003cstring\u003e&quot;,&quot;pullRequestPreviewsEnabled&quot;:&quot;yes&quot;,&quot;url&quot;:&quot;\u003cstring\u003e&quot;}},&quot;deployId&quot;:&quot;\u003cstring\u003e&quot;}