API Reference

Create service preview (image-backed)

post
https://api.render.com/v1/services//preview

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.

Path Params
string
required

The ID of the service

Body Params
string
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).

string

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.

string
enum

The instance type to use. Note that base services on any paid instance type can't create preview instances with the free instance type.

Responses

Updated 6 months ago

Language
Credentials
Bearer
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 6 months ago