E-Mail Notification Settings
E-Mail Notification Settings are done through the settings API. Use the values from the following table to set Email Notifications up through API.
Setting name | Settings Type | Value type | example |
smtp_default_recipient | email_settings | String | |
smtp_default_sender | email_settings | String | |
smtp_port | email_settings | Integer | 587 |
smtp_server_name | email_settings | String | Mailserver_A |
smtp_server_username | email_settings | String | admin |
smtp_server_password | email_settings | String | password |
smtp_timeout | email_settings | Integer | 10 |
smtp_email_enable | email_settings | Boolean | True |
post
https://$(tvm_address):8780/v1/$(tenant_id)
/settings
Create Setting
Setting create requires a Body in json format, to provide the requested information.
{
"settings":[
{
"category":null,
"name":<String Setting_name>,
"is_public":false,
"is_hidden":false,
"metadata":{
},
"type":<String Setting type>,
"value":<String Setting Value>,
"description":null
}
]
}
get
https://$(tvm_address):8780/v1/$(tenant_id)
/settings/<setting_name>
Show Setting
put
https://$(tvm_address):8780/v1/$(tenant_id)
/settings
Modify Setting
Workload modify requires a Body in json format, to provide the information about the values to modify.
{
"settings":[
{
"category":null,
"name":<String Setting_name>,
"is_public":false,
"is_hidden":false,
"metadata":{
},
"type":<String Setting type>,
"value":<String Setting Value>,
"description":null
}
]
}
delete
https://$(tvm_address):8780/v1/$(tenant_id)
/settings/<setting_name>
Delete Setting
Last modified 1yr ago