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
[email protected]
smtp_default_sender
email_settings
String
[email protected]
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
Body format
Setting create requires a Body in json format, to provide the requested information.
1
{
2
   "settings":[
3
      {
4
         "category":null,
5
         "name":<String Setting_name>,
6
         "is_public":false,
7
         "is_hidden":false,
8
         "metadata":{
9
            
10
         },
11
         "type":<String Setting type>,
12
         "value":<String Setting Value>,
13
         "description":null
14
      }
15
   ]
16
}
Copied!
get
https://$(tvm_address):8780/v1/$(tenant_id)
/settings/<setting_name>
Show Setting
put
https://$(tvm_address):8780/v1/$(tenant_id)
/settings
Modify Setting
Body format
Workload modify requires a Body in json format, to provide the information about the values to modify.
1
{
2
   "settings":[
3
      {
4
         "category":null,
5
         "name":<String Setting_name>,
6
         "is_public":false,
7
         "is_hidden":false,
8
         "metadata":{
9
            
10
         },
11
         "type":<String Setting type>,
12
         "value":<String Setting Value>,
13
         "description":null
14
      }
15
   ]
16
}
Copied!
delete
https://$(tvm_address):8780/v1/$(tenant_id)
/settings/<setting_name>
Delete Setting

API GUIDE - Previous

Schedulers

Next - API GUIDE

Workload Policies

Last modified 11mo ago

Export as PDF

Copy link

Contents