Services

Create service preview (image-backed)

Changed on

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

  • Base URL
    https://api.render.com/v1
  • Auth
    HTTP bearer

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' | '0.5c-512mb' | '1c-2g' | '2c-4g' | '2c-8g' | '2c-16g' | '4c-8g' | '4c-16g' | '4c-32g' | '8c-16g' | '8c-32g' | '8c-64g' | '12c-24g' | '12c-48g' | '12c-96g'

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

Example request

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

Response

Created

deployIdstring

Changes

    • breaking

      the /////// response's property type changed from no type to string for status

    • breaking

      the /////// response's property type changed from no type to string for status

    • breaking

      the /////// response's property type changed from no type to string for status

    • warning

      added the new 0.5c-512mb enum value to the ////// response property for the response status

    • warning

      added the new 0.5c-512mb enum value to the ////// response property for the response status

    • warning

      added the new 0.5c-512mb enum value to the ////// response property for the response status

    • warning

      added the new 0.5c-512mb enum value to the ////// response property for the response status

    • warning

      added the new 12c-24g enum value to the ////// response property for the response status

    • warning

      added the new 12c-24g enum value to the ////// response property for the response status

    • warning

      added the new 12c-24g enum value to the ////// response property for the response status

    • warning

      added the new 12c-24g enum value to the ////// response property for the response status

    • warning

      added the new 12c-48g enum value to the ////// response property for the response status

    • warning

      added the new 12c-48g enum value to the ////// response property for the response status

    • warning

      added the new 12c-48g enum value to the ////// response property for the response status

    • warning

      added the new 12c-48g enum value to the ////// response property for the response status

    • warning

      added the new 12c-96g enum value to the ////// response property for the response status

    • warning

      added the new 12c-96g enum value to the ////// response property for the response status

    • warning

      added the new 12c-96g enum value to the ////// response property for the response status

    • warning

      added the new 12c-96g enum value to the ////// response property for the response status

    • warning

      added the new 1c-2g enum value to the ////// response property for the response status

    • warning

      added the new 1c-2g enum value to the ////// response property for the response status

    • warning

      added the new 1c-2g enum value to the ////// response property for the response status

    • warning

      added the new 1c-2g enum value to the ////// response property for the response status

    • warning

      added the new 2c-16g enum value to the ////// response property for the response status

    • warning

      added the new 2c-16g enum value to the ////// response property for the response status

    • warning

      added the new 2c-16g enum value to the ////// response property for the response status

    • warning

      added the new 2c-16g enum value to the ////// response property for the response status

    • warning

      added the new 2c-4g enum value to the ////// response property for the response status

    • warning

      added the new 2c-4g enum value to the ////// response property for the response status

    • warning

      added the new 2c-4g enum value to the ////// response property for the response status

    • warning

      added the new 2c-4g enum value to the ////// response property for the response status

    • warning

      added the new 2c-8g enum value to the ////// response property for the response status

    • warning

      added the new 2c-8g enum value to the ////// response property for the response status

    • warning

      added the new 2c-8g enum value to the ////// response property for the response status

    • warning

      added the new 2c-8g enum value to the ////// response property for the response status

    • warning

      added the new 4c-16g enum value to the ////// response property for the response status

    • warning

      added the new 4c-16g enum value to the ////// response property for the response status

    • warning

      added the new 4c-16g enum value to the ////// response property for the response status

    • warning

      added the new 4c-16g enum value to the ////// response property for the response status

    • warning

      added the new 4c-32g enum value to the ////// response property for the response status

    • warning

      added the new 4c-32g enum value to the ////// response property for the response status

    • warning

      added the new 4c-32g enum value to the ////// response property for the response status

    • warning

      added the new 4c-32g enum value to the ////// response property for the response status

    • warning

      added the new 4c-8g enum value to the ////// response property for the response status

    • warning

      added the new 4c-8g enum value to the ////// response property for the response status

    • warning

      added the new 4c-8g enum value to the ////// response property for the response status

    • warning

      added the new 4c-8g enum value to the ////// response property for the response status

    • warning

      added the new 8c-16g enum value to the ////// response property for the response status

    • warning

      added the new 8c-16g enum value to the ////// response property for the response status

    • warning

      added the new 8c-16g enum value to the ////// response property for the response status

    • warning

      added the new 8c-16g enum value to the ////// response property for the response status

    • warning

      added the new 8c-32g enum value to the ////// response property for the response status

    • warning

      added the new 8c-32g enum value to the ////// response property for the response status

    • warning

      added the new 8c-32g enum value to the ////// response property for the response status

    • warning

      added the new 8c-32g enum value to the ////// response property for the response status

    • warning

      added the new 8c-64g enum value to the ////// response property for the response status

    • warning

      added the new 8c-64g enum value to the ////// response property for the response status

    • warning

      added the new 8c-64g enum value to the ////// response property for the response status

    • warning

      added the new 8c-64g enum value to the ////// response property for the response status

    • info

      added the new 0.5c-512mb enum value to the request property

    • info

      added the new 12c-24g enum value to the request property

    • info

      added the new 12c-48g enum value to the request property

    • info

      added the new 12c-96g enum value to the request property

    • info

      added the new 1c-2g enum value to the request property

    • info

      added the new 2c-16g enum value to the request property

    • info

      added the new 2c-4g enum value to the request property

    • info

      added the new 2c-8g enum value to the request property

    • info

      added the new 4c-16g enum value to the request property

    • info

      added the new 4c-32g enum value to the request property

    • info

      added the new 4c-8g enum value to the request property

    • info

      added the new 8c-16g enum value to the request property

    • info

      added the new 8c-32g enum value to the request property

    • info

      added the new 8c-64g enum value to the request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      response property service/autoDeploy deprecated

    • info

      the /////// response's property pattern ^dsk-[0-9a-z]{20}$ was added for the status

    • info

      the /////// response's property pattern ^dsk-[0-9a-z]{20}$ was added for the status

    • info

      the /////// response's property pattern ^dsk-[0-9a-z]{20}$ was added for the status