V1
- Account
- Admin
- AdminUpload
- Analysis
- ApiResource
- ApiScope
- Assets
- AuditLog
- Auth
- AuthToken
- Avatar
- BatchDownloadDocuments
- CacheMeta
- Caching
- CheckUpdate
- ClaimMapping
- Client
- Collections
- Config
- CustomizeProperties
- Dashboard
- DashboardView
- DataMonitoring
- DataProvider
- DataSource
- DataSourceAPI
- DataSourceFile
- DataSourcePreview
- Dataset
- DatasetExport
- DatasetPreview
- Design
- DesignApi
- DesignTemplates
- DocumentBinder
- Documents
- EmbededReport
- Export
- ExportTemplate
- ExternalLoginProvider
- ExternalUser
- FloorPlanView
- GraphQl
- Group
- HealthCheck
- Heartbeat
- Hierarchy
- Home
- IdentityResource
- Import
- Integration
- InternalDocuments
- LanguagePackage
- LanguageResource
- License
- LocalDeployment
- ModelDrafts
- ModelEditor
- Node
- Notification
- Permission
- Pivot
- PluginAssets
- Preview
- PushDataset
- QueryEndpoint
- QueueMonitor
- ReferenceResolving
- Reports
- Resource
- Resources
- Role
- RoleDocumentColumns
- SceneView
- Schedule
- ScheduleTemplate
- SchedulesApi
- SecurityProvider
- Semantic
- Session
- Settings
- SharedResources
- StreamingDatasetApi
- SystemConfig
- SystemConfigs
- Tenant
- TenantModification
- Theme
- ThemeFiles
- Token
- Upload
- UploadTheme
- User
- UserFunctions
- View
- VisualSandbox
- WebPages
- WorkerJob
- WorkersRegistrar
V2

Settings

[GET] /admin/api/settings

Response

Status Code: 200

Success

[GET] /admin/api/settings/{pluginKey}/{settingsGroupKey}

Parameters

Name	Type	Located In
pluginKeyRequired	string	path
settingsGroupKeyRequired	string	path
organizationId	string	query

Response

Status Code: 200

Success

SettingsModel

[POST] /admin/api/settings/{pluginKey}/{settingsGroupKey}

Parameters

Name	Type	Located In
pluginKeyRequired	string	path
settingsGroupKeyRequired	string	path
organizationId	string	query

Request Schema

SettingsSetModel

Response

Status Code: 200

Success

SettingsSetModel

[GET] /admin/api/settings/smtp/domain

Response

Status Code: 200

Success

SettingsModel

[GET] /admin/api/settings/scheduleSettings

Response

Status Code: 200

Success

SettingsModel

[GET] /admin/api/settings/data/dataProviders

Response

Status Code: 200

Success

SettingsModel

[GET] /admin/api/settings/Versions

Response

Status Code: 200

Success

[GET] /admin/api/settings/values/{pluginKey}/{settingsGroupKey}/{valuePath}

Parameters

Name	Type	Located In
pluginKeyRequired	string	path
settingsGroupKeyRequired	string	path
valuePathRequired	string	path
organizationId	string	query

Response

Status Code: 200

Success

Models

Ƭ SettingsModel

Name	Type	Description	Example
pluginKeyNullable	string
settingsGroupKeyNullable	string
useParentSettings	Boolean
dataNullable	any

Ƭ SettingsSetModel

Name	Type	Description	Example
useParentSettings	Boolean
dataNullable	any