-
Versions
Concepts
Resources
- Attachment
- Bulk-Export
- Bulk-Import
- Comment
- Countries
- Heartbeat
- Notification
- Question
- Question Follow
- Question Forward
- Question Updates
- Search
- Share content
- Settings
- Solution
- Tag
- User
Workspaces settings Resources
When enabled, the workspaces switch is enabled in menu.
Get workspaces settings
GET /settings/workspaces
Response
{
"workspaces_enabled": false,
"listed_workspaces": [
{
"domain": "foo.starmind.com"
},
{
"domain": "bar.starmind.com"
}
]
}
Update workspaces settings
PUT /settings/workspaces
Note:
If a parameter is omitted in the request, the setting is ignored and its value remains unchanged.
If a parameter is set to null
, the default behaviour for this setting applies.
Parameter | Type | default | Description |
---|---|---|---|
enabled |
boolean |
false | if enabled, the workspace swich will be enabled in the menu. This setting has no further impact on the application logic. |
workspaces |
Array<{domain: string}> |
[ ] | If non-empty, the workspaces domains will be validated to the application base domain and replace the current configured workspaces. |
Payload
{
"workspaces_enabled": true,
"listed_workspaces": [
{
"domain": "foo.starmind.com"
},
{
"domain": "bar.starmind.com"
}
]
}
Response
If successful, HTTP 200 OK
is returned with body:
{
"workspaces_enabled": true,
"listed_workspaces": [
{
"domain": "foo.starmind.com"
},
{
"domain": "bar.starmind.com"
}
]
}
If no workspace resolution is possible HTTP 422 UNPROCESSABLE ENTITY
is returned.
This happens if the API user does not provide a valid workspaces domain.