Confirms how the workspace deployment should be handled after Rocket.Chat detects a change to its deployment fingerprint.
On startup, Rocket.Chat generates a deployment fingerprint based on the configured Site_Url and MongoDB connection string. If the generated fingerprint differs from the stored value, Rocket.Chat assumes the workspace may have been duplicated, migrated, or reconfigured.
Use this endpoint to confirm how the deployment should be treated:
new-workspace: Treats the deployment as a new workspace. This clears the existing Rocket.Chat Cloud registration data and related credentials so the workspace can register again as a new instance. Use this option for cloned environments, staging instances created from production backups, or other duplicated deployments.updated-configuration: Confirms that the deployment is the same workspace and that only its configuration has changed. This preserves the existing Rocket.Chat Cloud registration and is intended for legitimate migrations, infrastructure changes, or Site_Url updates.
After processing either option, Rocket.Chat marks the deployment fingerprint as verified and dismisses the fingerprint verification prompt.
Permission required: manage-cloud
Changelog
| Version | Description |
|---|---|
| 8.6.0 | Added an authorization check. Callers without the manage-cloud permission now receive a 403 error instead of a successful response. |
The authToken of the authenticated user.
The userId of the authenticated user.
{
"setDeploymentAs": "new-workspace"
}Specifies how Rocket.Chat should handle a detected deployment fingerprint change. Use new-workspace to reset the current workspace registration and register the deployment as a new workspace, or updated-configuration to preserve the existing workspace registration and confirm that only the deployment configuration has changed. Either new-workspace or updated-configuration.
OK
{
"success": true
}Bad Request
{
"success": false,
"error": "Invalid body params",
"errorType": "error-invalid-body-params"
}Unauthorized
{
"status": "error",
"message": "You must be logged in to do this."
}Forbidden
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]",
"errorType": "error-unauthorized"
}