Blueprints

Validate Blueprint

Changed on

Validate a render.yaml Blueprint file without creating or modifying any resources. This endpoint checks the syntax and structure of the Blueprint, validates that all required fields are present, and returns a plan indicating the resources that would be created.

Requests to this endpoint use Content-Type: multipart/form-data. The request body (including the Blueprint file) cannot exceed 10MB in size.

post/blueprints/validate

Request

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

Request body multipart/form-data

ownerIdstring required

The ID of the workspace to validate against. Obtain your workspace ID from its Settings page in the Render Dashboard.

filestring binary required

The render.yaml file to validate, as a binary file.

Example request

{
  "ownerId": "tea-cjnxpkdhshc73d12t9i0"
}

Response

Validation complete

validboolean required

If true, the Blueprint validated successfully. If false, at least one validation error occurred.

Changes

    • info

      added the non-success 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