Get
/api/v1/setupWizard.parameters
Returns the settings used by the setup wizard and whether the workspace is already registered with Rocket.Chat Cloud.
This endpoint does not require authentication, because the setup wizard runs before the first administrator account exists.
If the setup wizard is completed, the endpoint returns a 403 response.
This endpoint replaces the deprecated getSetupWizardParameters Realtime API method.
Changelog
| Version | Description |
|---|---|
| 8.9.0 | Added |
Responses
200
OK
Success Example
{
"settings": [
{
"_id": "Organization_Name",
"type": "string",
"value": "",
"wizard": {
"step": 2,
"order": 1
}
},
{
"_id": "Organization_Type",
"type": "select",
"value": "",
"values": [
{
"key": "community",
"i18nLabel": "Community"
},
{
"key": "government",
"i18nLabel": "Government"
},
{
"key": "nonprofit",
"i18nLabel": "Nonprofit"
}
],
"wizard": {
"step": 2,
"order": 0
}
}
],
"serverAlreadyRegistered": false,
"success": true
}object
settings
Array of object
The settings shown in the setup wizard.
object
_id
string
type
string
value
values
Array of object
object
key
string
i18nLabel
string
wizard
object
step
integer
order
integer
serverAlreadyRegistered
boolean
Whether the workspace is already registered with Rocket.Chat Cloud.
success
boolean
403
Forbidden. The setup wizard is already completed.
Permission Error
{
"success": false,
"error": "unauthorized"
}object
success
boolean
error
string