curl -X POST https://api.vertracloud.app/v1/templates/validate \
-H "Authorization: Bearer $VERTRA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"manifest": {
"id": "my-bot",
"version": "1.0.0",
"name": { "pt-br": "Meu bot" },
"description": { "pt-br": "Um bot de exemplo." },
"category": "bots",
"services": {
"app": {
"source": { "type": "code", "path": "src" },
"language": "javascript",
"main": "index.js",
"ram": { "min": 128, "recommended": 256 },
"web": "none"
}
}
}
}'
{
"response": {
"valid": true,
"issues": [],
"required_plan": "economy",
"ram_min_total": 128,
"services": [
{
"id": "app",
"kind": "app",
"source_type": "code",
"database": null,
"blob_visibility": null,
"ram": { "min": 128, "recommended": 256 },
"web": "none",
"conditional": false
}
]
}
}
{
"response": {
"valid": false,
"issues": [
{ "path": "category", "code": "invalid_category", "message": "category must be one of the template categories" },
{ "path": "services.app.env.LD_PRELOAD", "code": "forbidden_env", "message": "This variable is controlled by the platform" }
],
"required_plan": null,
"ram_min_total": null,
"services": []
}
}
Templates
Validate Template Manifest
Checks a template manifest against the rules of private templates and returns the findings, the required plan and the memory it needs, creating nothing.
POST
/
v1
/
templates
/
validate
curl -X POST https://api.vertracloud.app/v1/templates/validate \
-H "Authorization: Bearer $VERTRA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"manifest": {
"id": "my-bot",
"version": "1.0.0",
"name": { "pt-br": "Meu bot" },
"description": { "pt-br": "Um bot de exemplo." },
"category": "bots",
"services": {
"app": {
"source": { "type": "code", "path": "src" },
"language": "javascript",
"main": "index.js",
"ram": { "min": 128, "recommended": 256 },
"web": "none"
}
}
}
}'
{
"response": {
"valid": true,
"issues": [],
"required_plan": "economy",
"ram_min_total": 128,
"services": [
{
"id": "app",
"kind": "app",
"source_type": "code",
"database": null,
"blob_visibility": null,
"ram": { "min": 128, "recommended": 256 },
"web": "none",
"conditional": false
}
]
}
}
{
"response": {
"valid": false,
"issues": [
{ "path": "category", "code": "invalid_category", "message": "category must be one of the template categories" },
{ "path": "services.app.env.LD_PRELOAD", "code": "forbidden_env", "message": "This variable is controlled by the platform" }
],
"required_plan": null,
"ram_min_total": null,
"services": []
}
}
Checks a manifest and reports every problem it finds, without creating anything. The call needs authentication and, with an API key, the
templates:read scope. It always answers 200: whether the manifest is valid is in the valid field, so a manifest that is not even an object comes back as findings, not as a malformed request. The checks are the ones applied to a private template. For the manifest fields and examples, see the manifest reference and Validate and test a template.
object | string
required
The manifest. Send it as a JSON object, or as a string with the YAML of the
vertracloud.template.yaml file. A string that is not valid YAML is reported as a finding.Response
object
The result of the validation.
Show Toggle object
Show Toggle object
boolean
true when the manifest has no findings.object[]
The findings. Empty when
valid is true.Show Toggle object
Show Toggle object
string
The path of the field in the manifest, such as
services.app.ram.min. Empty when the problem is the manifest as a whole.string
The kind of finding:
invalid_type, required, unknown_field, invalid_slug, invalid_version, invalid_category, invalid_text, invalid_ram, invalid_plan, unknown_placeholder, unknown_service, unknown_input, invalid_when, invalid_option, invalid_source, invalid_permissions, forbidden_env, forbidden_in_public, secret_in_manifest, invalid_deploy, invalid_connection, duplicate_id or too_many_services.string
A readable explanation, in English.
string | null
The lowest plan that can use the template, calculated from the manifest.
null when the manifest is not valid enough to calculate it.integer | null
The sum of the minimum memory of every service, in MB, or
null.object[]
The services the manifest creates, in the same shape as in List Templates. Empty when the manifest is not valid.
curl -X POST https://api.vertracloud.app/v1/templates/validate \
-H "Authorization: Bearer $VERTRA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"manifest": {
"id": "my-bot",
"version": "1.0.0",
"name": { "pt-br": "Meu bot" },
"description": { "pt-br": "Um bot de exemplo." },
"category": "bots",
"services": {
"app": {
"source": { "type": "code", "path": "src" },
"language": "javascript",
"main": "index.js",
"ram": { "min": 128, "recommended": 256 },
"web": "none"
}
}
}
}'
{
"response": {
"valid": true,
"issues": [],
"required_plan": "economy",
"ram_min_total": 128,
"services": [
{
"id": "app",
"kind": "app",
"source_type": "code",
"database": null,
"blob_visibility": null,
"ram": { "min": 128, "recommended": 256 },
"web": "none",
"conditional": false
}
]
}
}
{
"response": {
"valid": false,
"issues": [
{ "path": "category", "code": "invalid_category", "message": "category must be one of the template categories" },
{ "path": "services.app.env.LD_PRELOAD", "code": "forbidden_env", "message": "This variable is controlled by the platform" }
],
"required_plan": null,
"ram_min_total": null,
"services": []
}
}
Error Responses
string
The error code indicating the reason for the failure. Possible values:
VALIDATION_ERROR: The body has nomanifestfield (400).API_KEY_SCOPE_DENIED: The API key does not have thetemplates:readscope (403).RATE_LIMIT_EXCEEDED: Too many requests (429).INTERNAL_SERVER_ERROR: Unexpected failure (500).
{
"code": "VALIDATION_ERROR"
}
Last modified on October 28, 2026