Manual Cloud Register

Prev Next
Post
/api/v1/cloud.manualRegister

Manually register a workspace on Rocket.Chat Cloud. Permission required: register-on-cloud.

Header parameters
X-User-Id
stringRequired

The user ID.

ExampleCkCPNctrgCDfmWLqC
X-Auth-Token
stringRequired

The authentication token.

Example1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE
Body parameters
Example
{
  "cloudBlob": "jfiscsm38urc3ujd"
}
object
cloudBlob
string Required

Enter the workspace deployment ID.

Responses
200

OK

Success
{
  "success": true
}
object
success
boolean
400

Bad Request

Example
{
  "success": false,
  "error": "Workspace is already registered"
}
Example 2
{
  "success": false,
  "error": "Match error: Missing key 'cloudBlob'"
}
object
success
boolean
error
string
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string