Enable or Disable Email Notifications for a Project

Email notifications is a feature on Coverity on Polaris for sending emails when events occur in the system. You can configure Coverity on Polaris to turn the notifications on or off for an entire project.

About Email Notifications

Currently, there are two email notification types:

Successful scan. When a project is scanned successfully and has the latest results available to view on Coverity on Polaris.
Job failure. When an attempt to run a tool either doesn't complete or doesn't produce the intended output.

About Configuration Scopes

Notifications can be enabled or disabled at three scope levels.

Organization: Enables or disables the notifications feature across all projects owned by the organization. If enabled, project level configuration is applied.
Project: Enables or disables notifications for this project. Only applied if organization level notifications are enabled. If enabled, user-project level configuration is applied.
User-Project: Enables or disables notifications for a particular user and only for one project. Only applied if organization and project notifications are enabled.

When notifications are disabled at a higher level of scope, it applies to all scope levels below. For example, disabling at the organization level disables all projects and their users; disabling a single project disables notifications for users within that project, but not other projects.

Email notifications at the organization and project levels are enabled by default. The user-project level is disabled by default.

To enable or disable notifications for the project:

Request:


                        
    POST https://subdomain.cop.blackduck.com/api/notifications/v0/project-configs
    
    {
       "data": {
       "id": "50640e83-6b5b-4dba-982d-c6b461227580",
       "type": "project-config",
       "attributes": {
            "enabled": false
         }
       }
    }

This example updates data.attributes.enabled to false, disabling email notifications for the project specified. The project is identified by data.id.

Response:


    {
       "data": {
       "id": "50640e83-6b5b-4dba-982d-c6b461227580",
       "type": "project-config",
       "attributes": {
           "parent-scope-enabled": false,
           "enabled": false
            },
            "links": {
          "self": "https://subdomain.cop.blackduck.com/api/notifications/v0/project-configs/50640e83-6b5b-4dba-982d-c6b461227580"
          }
       }
    }