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
admin@example.net
smtp_default_sender
email_settings
String
admin@example.net
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
Create Setting
https://$(tvm_address):8780/v1/$(tenant_id)/settings
Creates a TrilioVault setting.
Request
Response
Request
Path Parameters
tvm_address
required
string
IP or FQDN of TrilioVault Service
tenant_id
required
string
ID of the Tenant/Project to work with
Headers
X-Auth-Project-Id
required
string
Project to run the authentication against
X-Auth-Token
required
string
Authentication token to use
Content-Type
required
string
application/json
Accept
required
string
application/json
User-Agent
optional
string
python-workloadmgrclient
Response
200: OK
Response upon successfully starting the workload creation process.
HTTP/1.1 200 OK
Server: nginx/1.16.1
Date: Thu, 04 Feb 2021 11:55:43 GMT
Content-Type: application/json
Content-Length: 403
Connection: keep-alive
X-Compute-Request-Id: req-ac16c258-7890-4ae7-b7f4-015b5aa4eb99
​
{
   "settings":[
      {
         "created_at":"2021-02-04T11:55:43.890855",
         "updated_at":null,
         "deleted_at":null,
         "deleted":false,
         "version":"4.0.115",
         "name":"smtp_port",
         "project_id":"4dfe98a43bfa404785a812020066b4d6",
         "user_id":null,
         "value":"8080",
         "description":null,
         "category":null,
         "type":"email_settings",
         "public":false,
         "hidden":0,
         "status":"available",
         "is_public":false,
         "is_hidden":false
      }
   ]
}
Body format
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
Show Setting
https://$(tvm_address):8780/v1/$(tenant_id)/settings/<setting_name>
Shows all details of a specified setting
Request
Response
Request
Path Parameters
tvm_address
required
string
IP or FQDN of TrilioVault Service
tenant_id
required
string
ID of the Project/Tenant where to find the Workload
setting_name
required
string
Name of the setting to show
Headers
X-Auth-Project-Id
required
string
Project to run the authentication against
X-Auth-Token
required
string
Authentication token to use
Accept
required
string
application/json
User-Agent
optional
string
python-workloadmgrclient
Response
200: OK
HTTP/1.1 200 OK
Server: nginx/1.16.1
Date: Thu, 04 Feb 2021 12:01:27 GMT
Content-Type: application/json
Content-Length: 380
Connection: keep-alive
X-Compute-Request-Id: req-404f2808-7276-4c2b-8870-8368a048c28c
​
{
   "setting":{
      "created_at":"2021-02-04T11:55:43.000000",
      "updated_at":null,
      "deleted_at":null,
      "deleted":false,
      "version":"4.0.115",
      "name":"smtp_port",
      "project_id":"4dfe98a43bfa404785a812020066b4d6",
      "user_id":null,
      "value":"8080",
      "description":null,
      "category":null,
      "type":"email_settings",
      "public":false,
      "hidden":false,
      "status":"available",
      "metadata":[
         
      ]
   }
}
put
Modify Setting
https://$(tvm_address):8780/v1/$(tenant_id)/settings
Modifies the provided setting with the given details.
Request
Response
Request
Path Parameters
tvm_address
required
string
IP or FQDN of TrilioVault Service
tenant_id
required
string
ID of the Tenant/Project to work with w
Headers
X-Auth-Project-Id
required
string
Project to run the authentication against
X-Auth-Token
required
string
Authentication token to use
Content-Type
required
string
application/json
Accept
required
string
application/json
User-Agent
optional
string
python-workloadmgrclient
Response
200: OK
Setting modify request has been done
HTTP/1.1 200 OK
Server: nginx/1.16.1
Date: Thu, 04 Feb 2021 12:05:59 GMT
Content-Type: application/json
Content-Length: 403
Connection: keep-alive
X-Compute-Request-Id: req-e92e2c38-b43a-4046-984e-64cea3a0281f
​
{
   "settings":[
      {
         "created_at":"2021-02-04T11:55:43.000000",
         "updated_at":null,
         "deleted_at":null,
         "deleted":false,
         "version":"4.0.115",
         "name":"smtp_port",
         "project_id":"4dfe98a43bfa404785a812020066b4d6",
         "user_id":null,
         "value":"8080",
         "description":null,
         "category":null,
         "type":"email_settings",
         "public":false,
         "hidden":0,
         "status":"available",
         "is_public":false,
         "is_hidden":false
      }
   ]
}
Body format
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
Delete Setting
https://$(tvm_address):8780/v1/$(tenant_id)/settings/<setting_name>
Deletes the specified Workload.
Request
Response
Request
Path Parameters
tvm_address
required
string
IP or FQDN of TrilioVault Service
tenant_id
required
string
ID of the Tenant where to find the Workload in
setting_name
required
string
Name of the setting to delete
Headers
X-Auth-Project-Id
required
string
Project to run the authentication against
X-Auth-Token
required
string
Authentication Token to use
Accept
required
string
application/json
User-Agent
optional
string
python-workloadmgrclient
Response
200: OK
HTTP/1.1 200 OK
Server: nginx/1.16.1
Date: Thu, 04 Feb 2021 11:49:17 GMT
Content-Type: application/json
Content-Length: 1223
Connection: keep-alive
X-Compute-Request-Id: req-5a8303aa-6c90-4cd9-9b6a-8c200f9c2473

API GUIDE - Previous

Schedulers

Next - API GUIDE

Workload Policies

Last updated 4 weeks ago

Setting name	Settings Type	Value type	example
smtp_default_recipient	email_settings	String	admin@example.net
smtp_default_sender	email_settings	String	admin@example.net
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

E-Mail Notification Settings

postCreate Setting

Body format

getShow Setting

putModify Setting

Body format

deleteDelete Setting

post
Create Setting

get
Show Setting

put
Modify Setting

delete
Delete Setting