Restart Application
Restart an application with POST /v2/apps//restart, stopping and starting it again. Call it after a commit so the new files take effect.
POST
Restart Application
string
required
The API key for your account. You can find this in your account settings.
apps:control scope.
Restarts a running application: it stops the application and then starts it again. This is the endpoint to call after Commit Application so newly pushed files take effect, since committing on its own does not restart the application.
On workspace-shared applications, the caller needs the manager, maintain or admin role. The request is rate limited to 1 restart per 3 seconds per application, and to 20 lifecycle actions per 15 seconds per user across all applications, with a short block once that cap is hit. A restart can fail, for example when the application doesn’t come back up: check Get Application Status and the logs, and start it again if needed.
Parameters
string
required
The ID of the application. You can find this in the URL of your application’s dashboard.
Response
string
Indicates whether the call was successful:
success if it was, error if not.Common errors
Related
- CLI:
squarecloud app restart - SDKs:
api.apps.restart()(JavaScript),client.apps.restart()(Python),c.Apps.Restart()(Go)

