Docs
BlogHomeStart building

Server

Control the development server and inspect its logs.


These endpoints manage your project's development server. Starting the server is asynchronous. All endpoints require the api-key header.

#Start or Restart Server

POST/api/v1/vcaas/projects/:projectId/agent/server/start-or-restartUses credits

Start or restart the development server for your project. This endpoint is asynchronous — it returns immediately with status "starting" and the server startup continues in the background for 2 to 4 minutes.

Poll GET /projects/:projectId every 10–15 seconds until agentServerStatus is "Active".

Path parameters

ParameterTypeDescription
projectIdstringThe project ID

Response fields

FieldTypeDescription
data.messagestringStatus message
data.statusstringAlways "starting"

Example request

bash
curl -X POST -H "api-key: tlm_sk_your_key" \
  https://api-accounts.totalum.app/api/v1/vcaas/projects/my-app/agent/server/start-or-restart
Success · 200 OK
json
{
  "errors": null,
  "data": {
    "message": "Server start/restart initiated",
    "status": "starting"
  }
}
Error · 409
json
{
  "errors": {
    "errorCode": "AGENT_RUNNING",
    "errorMessage": "Cannot restart server while agent is running"
  },
  "data": null
}

Error codes

CodeHTTPMeaning
MISSING_PROJECT_ID400projectId is required
PROJECT_NOT_FOUND404Project does not exist or you don't own it
AGENT_RUNNING409Cannot restart server while agent is running
DEPLOYMENT_RUNNING409Cannot restart server while deployment is in progress
RECOVERY_RUNNING409Cannot restart server while version recovery is in progress
INSUFFICIENT_CREDITS402Not enough credits for server start

#Get Dev Server Logs

GET/api/v1/vcaas/projects/:projectId/backend/dev/logsFree

Retrieve backend development server stdout/stderr output.

Path parameters

ParameterTypeDescription
projectIdstringThe project ID

Response fields

FieldTypeDescription
data.logsstringDevelopment server stdout/stderr output

Example request

bash
curl -H "api-key: tlm_sk_your_key" \
  https://api-accounts.totalum.app/api/v1/vcaas/projects/my-app/backend/dev/logs
Success · 200 OK
json
{
  "errors": null,
  "data": { "logs": "Server running on port 3000\n..." }
}
Error · 404
json
{
  "errors": {
    "errorCode": "PROJECT_NOT_FOUND",
    "errorMessage": "Project does not exist or you don't own it"
  },
  "data": null
}

Error codes

CodeHTTPMeaning
MISSING_PROJECT_ID400projectId is required
PROJECT_NOT_FOUND404Project does not exist or you don't own it