Skip to content

Resource Reference

The render lexicon ships 14 top-level resources. Each maps to a Public API create body; follow the reference link for the underlying API shape.

ResourceTypeGroupCreateReconciled byMarkerAPI reference
WebServiceRender::Services::WebServiceServicesPOST /servicesnameyesreference
StaticSiteRender::Services::StaticSiteServicesPOST /servicesnameyesreference
PrivateServiceRender::Services::PrivateServiceServicesPOST /servicesnameyesreference
BackgroundWorkerRender::Services::BackgroundWorkerServicesPOST /servicesnameyesreference
CronJobRender::Services::CronJobServicesPOST /servicesnameyesreference
PostgresRender::Datastores::PostgresDatastoresPOST /postgresnamereference
KeyValueRender::Datastores::KeyValueDatastoresPOST /key-valuenamereference
EnvGroupRender::Config::EnvGroupConfigPOST /env-groupsnameyesreference
ProjectRender::Projects::ProjectProjectsPOST /projectsnamereference
EnvironmentRender::Projects::EnvironmentProjectsPOST /environmentsname + projectreference
DiskRender::Services::DiskServicesPOST /disksname + servicevia servicereference
CustomDomainRender::Services::CustomDomainServicesPOST /services/{serviceId}/custom-domainsnamevia servicereference
RegistryCredentialRender::Config::RegistryCredentialConfigPOST /registrycredentialsnamereference
WebhookRender::Config::WebhookConfigPOST /webhooksnamereference

Property types such as WebServiceDetails, StaticSiteDetails, CronJobDetails, NativeEnvironmentDetails, DockerDetails, Image, ServiceDisk, Route, Header, ReadReplica, and CidrBlockAndDescription are authored inline on a resource and are documented alongside the resources they belong to.

Render assigns ids on create, so id-valued fields accept the declared resource in place of a string: Disk.serviceId, CustomDomain.serviceId, Environment.projectId, *.environmentId, EnvGroup.serviceIds, Image.registryCredentialId. Attribute reads on datastores (internalConnectionString, externalConnectionString, psqlCommand / cliCommand) resolve from the live /connection-info endpoint; id, dashboardUrl, and the other response fields resolve from the live resource.

Services and env groups carry chant’s marker in their env vars. Disks and custom domains have no marker but hang off a service and inherit its verdict (the service boundary), so an undeclared disk or domain under a chant-owned service is pruned too. Datastores, projects, environments, registry credentials, and webhooks have no marker channel and no boundary: their ownership verdict is unknown, and they are removed only by an explicit renderDelete of a plan that names them.