Sign in

v1

latestOpenAPI 3.0.22026-07-26207170320.9 KB
Services

Create service preview (image-backed)

Create a 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.

View all active previews from your service's Previews tab in the Render Dashboard.

Note that you can't create previews for Git-backed services using the Render API.

post/services/{serviceId}/preview

Request body

imagePathstring required

Must be either a full URL or the relative path to an image. If a relative path, Render uses the base service's image URL as its root. For example, if the base service's image URL is docker.io/library/nginx:latest, then valid values are: docker.io/library/nginx:<any tag or SHA>, library/nginx:<any tag or SHA>, or nginx:<any tag or SHA>. Note that the path must match (only the tag or SHA can vary).

namestring

A name for the service preview instance. If not specified, Render generates the name using the base service's name and the specified tag or SHA.

plan'starter' | 'starter_plus' | 'standard' | 'standard_plus' | 'pro' | 'pro_plus' | 'pro_max' | 'pro_ultra' | 'free' | 'custom' | 'starter_legacy' | 'standard_legacy' | 'standard_plus_legacy' | 'pro_legacy' | 'pro_plus_legacy'

The instance type to use. Legacy variants (*_legacy) identify grandfathered plans no longer offered for new services. Note that base services on any paid instance type can't create preview instances with the free instance type.

Example request

{
  "imagePath": "docker.io/library/nginx:latest",
  "name": "preview",
  "plan": "starter"
}

Response

Created

deployIdstring