Skip to main content
Use this endpoint to start an application that is currently stopped. Virtus Cloud launches the process using the existing files and configuration already on the server — no new deployment is required. If the application is already running, the API still returns a success response without restarting the process.
Starting an application that has not yet had files uploaded will fail. Use the Upload endpoint to deploy files before issuing a start command.

Endpoint

POST https://api.virtuscloud.app/v2/apps/{app_id}/start

Path parameters

app_id
string
required
The unique ID of the application. You can find this in the URL of your application’s dashboard page on Virtus Cloud.

Request headers

Authorization
string
required
Your Virtus Cloud API key. See Authentication for details.

Response

status
string
Indicates whether the request succeeded. Returns "success" when the start command is accepted and the application is being brought online.

Code example

curl --request POST \
  --url https://api.virtuscloud.app/v2/apps/<app_id>/start \
  --header "Authorization: <your_api_key>"

Response example

{
  "status": "success"
}