OrgsUI Settings
updateOrgUiSetting
Org UI settings/databoard
Authorization<token>
Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.
Format:
Authorization: Token {apitoken}
Notes:
- An API token generated for a specific admin has the same privileges as that admin
- An API token is automatically removed if it is not used for more than 90 days
- SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.
In: header
Path Parameters
org_id*string
Format
uuiduisetting_id*string
Format
uuidRequest Body
application/json
Request Body
Organization UI settings databoard
description?string
Text describing the databoard
isCustomDataboard?boolean
Whether this is a custom databoard or not
name?string
Display name of the databoard
purpose?"marvisdashboard"
UI surface or purpose for this databoard. enum: marvisdashboard.
Value in
- "marvisdashboard"
tiles?array<>
Configured tiles for the databoard
Response Body
curl -X POST "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/uisettings/000000ab-00ab-00ab-00ab-0000000000ab" \ -H "Content-Type: application/json" \ -d '{ "description": "AP related stats", "isCustomDataboard": true, "name": "AP Stats", "purpose": "marvisdashboard", "tiles": [ { "description": "User typed tile descr", "isAutoTitle": true, "name": "List top 10 APs by bandwidth", "nl_query": "List top 10 APs by bandwidth", "position": { "col": 1, "colSpan": 2, "row": 1, "rowSpan": 1 } } ] }'{ "created_time": 1749083436, "description": "AP related stats", "for_site": false, "id": "9a702097-0dd3-48af-909b-2be4ff94d139", "isCustomDataboard": true, "modified_time": 1749083436, "name": "AP Stats", "org_id": "2818e386-8dec-2562-9ede-5b8a0fbbdc71", "purpose": "marvisdashboard", "site_id": "00000000-0000-0000-0000-000000000000", "tiles": [ { "description": "User typed tile descr", "id": "3eef7c83-3d33-417a-a729-4772d4a1013a", "isAutoTitle": true, "name": "List top 10 APs by bandwidth", "nl_query": "List top 10 APs by bandwidth", "position": { "col": 1, "colSpan": 2, "row": 1, "rowSpan": 1 } } ]}