Lifecycle

Stop an application

Changed on Nov 13, 2026

Stops a running application. An application that is already stopped answers 409 CONTAINER_ALREADY_STOPPED.

Requires the workspace Manager, Maintainer, or Administrator role (or ownership) when called against a workspace-shared application. Rate limited to 1 stop per 3s per app and to 20 actions per 15s per user.

post/v2/apps/{appId}/stop

Request

Base URL
https://api.squarecloud.app
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/squarecloud/apis/square-cloud-api/docs/v2/apps/:appId/stop/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

appIdstring required

Application identifier. Optionally suffixed with -<workspaceId> to act on a workspace-shared application.

Response

Action dispatched. Payload reflects the underlying operation result.

status'success' required

Changes

Nov 13, 2026e363e004303c Revision changes
- warning
  added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status
- warning
  added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status
- warning
  added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status
- warning
  added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status
- warning
  added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status
- warning
  added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status
- warning
  added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status
Nov 2, 20264cf53a0d5577 Revision changes
- warning
  added the new WRITE_FAILED enum value to the //// response property for the response status
- warning
  added the new WRITE_FAILED enum value to the //// response property for the response status
- warning
  added the new WRITE_FAILED enum value to the //// response property for the response status
- warning
  added the new WRITE_FAILED enum value to the //// response property for the response status
- warning
  added the new WRITE_FAILED enum value to the //// response property for the response status
- warning
  added the new WRITE_FAILED enum value to the //// response property for the response status
- warning
  added the new WRITE_FAILED enum value to the //// response property for the response status
- warning
  added the new WRONG_HOST enum value to the //// response property for the response status
- warning
  added the new WRONG_HOST enum value to the //// response property for the response status
- warning
  added the new WRONG_HOST enum value to the //// response property for the response status
- warning
  added the new WRONG_HOST enum value to the //// response property for the response status
- warning
  added the new WRONG_HOST enum value to the //// response property for the response status
- warning
  added the new WRONG_HOST enum value to the //// response property for the response status
- warning
  added the new WRONG_HOST enum value to the //// response property for the response status

Operation history (8 revisions)

Stop an application

Request

Path parameters

Response 200OK

Changes

Response