Deployments

#Deploy to Production

Build and deploy your project to a production URL. This endpoint is asynchronous — it returns immediately with status "deploying" and the deployment continues in the background for 2 to 5 minutes.

Poll GET /projects/:projectId/deployments/status every 10–15 seconds until status is "success", then read the public URL from GET /projects/:projectId → productionProjectUrl. If the server is not active, it auto-starts (charging extra START_SERVER credits) and returns SERVER_NOT_READY; poll GET /projects/:projectId until agentServerStatus is "Active", then retry.

Path parameters

Response fields

Example request

curl -X POST -H "api-key: tlm_sk_your_key" \
  https://api-accounts.totalum.app/api/v1/vcaas/projects/my-app/deployments/deploy

{
  "errors": null,
  "data": {
    "projectId": "my-app",
    "status": "deploying",
    "message": "Deployment started. It will take from 2 to 5 minutes. Fetch GET .../deployments/status every 10-15 seconds to track progress."
  }
}

{
  "errors": {
    "errorCode": "DEPLOYMENT_RUNNING",
    "errorMessage": "A deployment is already in progress"
  },
  "data": null
}

Error codes

#Unpublish

Take the project fully offline. This removes, in one call:

• the published site at the production URL,
• the preview snapshot served while the project's server is asleep,
• every custom domain attached to the project.

The call is synchronous: when it answers "unpublished", the project is offline. If the site or the preview snapshot cannot be removed, the call fails. A custom domain that cannot be removed is only a warning: the call still succeeds, the domain is listed in data.customDomainsFailed and explained in data.warnings, and it serves nothing because the site behind it is gone. Calling unpublish again is safe and retries anything left over, because anything already removed counts as done. Unpublishing a project that was never published also succeeds.

To publish again, call POST /projects/:projectId/deployments/deploy. Custom domains are removed, not paused, so you have to add them again with PUT /projects/:projectId/domain. Your DNS records at your registrar are not touched.

This endpoint is free and works even when your credit balance is zero. It is refused while a deployment is running, because that deployment would publish the site again when it finished.

Path parameters

Response fields

Example request

curl -X POST -H "api-key: tlm_sk_your_key" \
  https://api-accounts.totalum.app/api/v1/vcaas/projects/my-app/deployments/unpublish

{
  "errors": null,
  "data": {
    "projectId": "my-app",
    "status": "unpublished",
    "customDomainsRemoved": ["app.example.com"],
    "customDomainsFailed": [],
    "warnings": [],
    "message": "The project is offline: its published site, preview snapshot and custom domains were removed. Deploy again to publish it; custom domains have to be added again."
  }
}

{
  "errors": {
    "errorCode": "DEPLOYMENT_RUNNING",
    "errorMessage": "A deployment is in progress and would publish the site again when it finishes. Wait for GET /api/v1/vcaas/projects/my-app/deployments/status to leave \"deploying\", then retry."
  },
  "data": null
}

Error codes

#Get Deployment Status

Check the current deployment status. Poll until status is "success".

Path parameters

Response fields

Example request

curl -H "api-key: tlm_sk_your_key" \
  https://api-accounts.totalum.app/api/v1/vcaas/projects/my-app/deployments/status

{
  "errors": null,
  "data": {
    "status": "success",
    "createdAt": "2026-03-11T11:00:00.000Z",
    "versionId": "v_abc123"
  }
}

{
  "errors": {
    "errorCode": "PROJECT_NOT_FOUND",
    "errorMessage": "Project does not exist or you don't own it"
  },
  "data": null
}

Error codes