Skip to main content
A production app is the deployed instance of an entity. It represents the running application with a subdomain, database, and deployment history.

​
List production apps

GET /api/production-apps
ParameterTypeDescription
entityIdqueryFilter by entity
pagequeryPage number (default: 1)
pageSizequeryItems per page (default: 20)
Authentication: User authentication required.

​
Create production app

POST /api/production-apps
ParameterTypeRequiredDescription
entityIdbodyYesEntity to create a production app for
subdomainbodyYesSubdomain for the app (e.g., my-app → my-app.synthetiq.link)
Creates the production app record and assigns a cloud identifier for deployment infrastructure. Authentication: Organization member + entities:deploy scope + entity publisher.

​
Get production app

GET /api/production-apps/{id}
Returns production app details including recent deployments. Authentication: User authentication required.

​
Update production app

PATCH /api/production-apps/{id}
ParameterTypeDescription
subdomainbodyUpdated subdomain
workerConfigbodyWorker service configuration
Authentication: Organization member + entities:deploy scope + entity publisher.

​
Delete production app

DELETE /api/production-apps/{id}
Deletes the production app and tears down all associated cloud resources (compute, CDN, database connections). Authentication: Organization member + entities:deploy scope + entity publisher.

​
Subdomain availability

GET /api/subdomains/check
ParameterTypeRequiredDescription
valuequeryYesSubdomain to check
excludeIdqueryNoProduction app ID to exclude (for updates)
Returns whether the subdomain is available and the normalized form. Authentication: User authentication required.