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 creditsStart 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
| Parameter | Type | Description |
|---|---|---|
projectId | string | The project ID |
Response fields
| Field | Type | Description |
|---|---|---|
data.message | string | Status message |
data.status | string | Always "starting" |
Example request
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-restartSuccess · 200 OK
{
"errors": null,
"data": {
"message": "Server start/restart initiated",
"status": "starting"
}
}Error · 409
{
"errors": {
"errorCode": "AGENT_RUNNING",
"errorMessage": "Cannot restart server while agent is running"
},
"data": null
}Error codes
| Code | HTTP | Meaning |
|---|---|---|
MISSING_PROJECT_ID | 400 | projectId is required |
PROJECT_NOT_FOUND | 404 | Project does not exist or you don't own it |
AGENT_RUNNING | 409 | Cannot restart server while agent is running |
DEPLOYMENT_RUNNING | 409 | Cannot restart server while deployment is in progress |
RECOVERY_RUNNING | 409 | Cannot restart server while version recovery is in progress |
INSUFFICIENT_CREDITS | 402 | Not enough credits for server start |
#Get Dev Server Logs
GET
/api/v1/vcaas/projects/:projectId/backend/dev/logsFreeRetrieve backend development server stdout/stderr output.
Path parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The project ID |
Response fields
| Field | Type | Description |
|---|---|---|
data.logs | string | Development server stdout/stderr output |
Example request
curl -H "api-key: tlm_sk_your_key" \
https://api-accounts.totalum.app/api/v1/vcaas/projects/my-app/backend/dev/logsSuccess · 200 OK
{
"errors": null,
"data": { "logs": "Server running on port 3000\n..." }
}Error · 404
{
"errors": {
"errorCode": "PROJECT_NOT_FOUND",
"errorMessage": "Project does not exist or you don't own it"
},
"data": null
}Error codes
| Code | HTTP | Meaning |
|---|---|---|
MISSING_PROJECT_ID | 400 | projectId is required |
PROJECT_NOT_FOUND | 404 | Project does not exist or you don't own it |
