Get
/api/v1/cloud.workspaceRegisterData
Returns the workspace registration payload used to register the workspace with Rocket.Chat Cloud offline. The registerData value is a base64-encoded JSON string.
Permission required: manage-cloud.
This endpoint replaces the deprecated cloud:getWorkspaceRegisterData Realtime API method, which remains available until 9.0.0.
Changelog
| Version | Description |
|---|---|
| 8.9.0 | Added |
Header parameters
X-User-Id
stringRequired
The user ID.
ExampleCkCPNctrgCDfmWLqC
X-Auth-Token
stringRequired
The authentication token.
Example1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE
Responses
200
OK
Success Example
{
"registerData": "eyJ1bmlxdWVJZCI6Ilp4N3FXbTNLcDlSdlQ0eUxiIiwid29ya3NwYWNlSWQiOiIiLCJhZGRyZXNzIjoiaHR0cHM6Ly9jaGF0LmV4YW1wbGUuY29tIn0=",
"success": true
}object
registerData
string
The base64-encoded workspace registration payload.
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
403
Forbidden
Permission Error
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}object
success
boolean
error
string