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