stop_deployment

Stop a running deployment, taking it offline.

Stops a running deployment, taking it offline. Marked destructive: clients may ask for confirmation before running it.

To bring the server back up afterwards, call redeploy to trigger a new deployment.

Parameters

ParameterTypeRequiredDescription
organizationIdstringYesOrganization that owns the deployment. From list_organizations.
deploymentIdstringYesThe deployment to stop. From list_deployments.

Returns

The deployment's updated state.

On this page