Manage Mail Server Settings Using REST APIs

You can use Oracle Analytics Cloud REST APIs to programmatically configure, delete, and get mail server settings. For example, you might create a script to update or delete mail server settings in your production environment.

Note:

Mail server settings that you configure using the REST API display on the Mail Settings page in the Console.

Here are some common tasks using REST APIs.

Task	Description	REST API Documentation
Understand prerequisites	Understand and complete several prerequisite tasks. You must have administrator permissions in Oracle Analytics Cloud to manage mail server settings using REST APIs (BI Service Administrator).	Prerequisites
Understand OAuth 2.0 token authentication	Authentication and authorization in Oracle Analytics Cloud is managed by Oracle Identity Cloud Service. To access the Oracle Analytics Cloud REST APIs, you need an OAuth 2.0 access token to use for authorization.	OAuth 2.0 Token Authentication
Configure a mail server or update settings	Configure an email server to deliver reports and visualizations.	Configure a mail server
Delete mail server settings	Delete unwanted mail settings.	Delete mail server settings
Get mail server details	Get mail server details, including the authentication type, security options, host name, port number, and email sender.	Get mail server settings