All pages
Powered by GitBook
1 of 1

Loading...

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

Create Setting

POST https://$(tvm_address):8780/v1/$(tenant_id)/settings

Creates a Trilio setting.

Path Parameters

Name
Type
Description

Headers

Name
Type
Description

Body format

Setting create requires a Body in json format, to provide the requested information.

Show Setting

GET https://$(tvm_address):8780/v1/$(tenant_id)/settings/<setting_name>

Shows all details of a specified setting

Path Parameters

Name
Type
Description

Headers

Name
Type
Description

Modify Setting

PUT https://$(tvm_address):8780/v1/$(tenant_id)/settings

Modifies the provided setting with the given details.

Path Parameters

Name
Type
Description

Headers

Name
Type
Description

Body format

Workload modify requires a Body in json format, to provide the information about the values to modify.

Delete Setting

DELETE https://$(tvm_address):8780/v1/$(tenant_id)/settings/<setting_name>

Deletes the specified Workload.

Path Parameters

Name
Type
Description

Headers

Name
Type
Description

User-Agent

string

python-workloadmgrclient

User-Agent

string

python-workloadmgrclient

[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

tvm_address

string

IP or FQDN of Trilio Service

tenant_id

string

ID of the Tenant/Project to work with

X-Auth-Project-Id

string

Project to run the authentication against

X-Auth-Token

string

Authentication token to use

Content-Type

string

application/json

Accept

string

application/json

tvm_address

string

IP or FQDN of Trilio Service

tenant_id

string

ID of the Project/Tenant where to find the Workload

setting_name

string

Name of the setting to show

X-Auth-Project-Id

string

Project to run the authentication against

X-Auth-Token

string

Authentication token to use

Accept

string

application/json

User-Agent

string

python-workloadmgrclient

tvm_address

string

IP or FQDN of Trilio Service

tenant_id

string

ID of the Tenant/Project to work with w

X-Auth-Project-Id

string

Project to run the authentication against

X-Auth-Token

string

Authentication token to use

Content-Type

string

application/json

Accept

string

application/json

tvm_address

string

IP or FQDN of Trilio Service

tenant_id

string

ID of the Tenant where to find the Workload in

setting_name

string

Name of the setting to delete

X-Auth-Project-Id

string

Project to run the authentication against

X-Auth-Token

string

Authentication Token to use

Accept

string

application/json

User-Agent

string

python-workloadmgrclient

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
      }
   ]
}
{
   "settings":[
      {
         "category":null,
         "name":<String Setting_name>,
         "is_public":false,
         "is_hidden":false,
         "metadata":{
            
         },
         "type":<String Setting type>,
         "value":<String Setting Value>,
         "description":null
      }
   ]
}
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":[
         
      ]
   }
}
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
      }
   ]
}
{
   "settings":[
      {
         "category":null,
         "name":<String Setting_name>,
         "is_public":false,
         "is_hidden":false,
         "metadata":{
            
         },
         "type":<String Setting type>,
         "value":<String Setting Value>,
         "description":null
      }
   ]
}
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