Skip to main content
POST
Stop Application
string
required
The API key for your account. You can find this in your account settings.
Shuts down a running application without deleting it: the container stops, but the application’s files, environment variables, and configuration are kept, so it can be started again at any time with Start Application. It is a no-op if the application is already stopped. This is the endpoint to reach for when you want to free up an application’s resources temporarily, for example pausing a background worker outside business hours, without giving up the application slot the way Delete Application would. On workspace-shared applications, the caller needs the Manager, Maintainer, or Administrator role. The request is rate limited to 1 stop per 3 seconds per application, and to 20 lifecycle actions per 15 seconds per user across all applications, with a 60-second block once that cap is hit.

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 successful, error if not.

Common errors