Get Organization Notification Settings
You can get a resource representation of notification settings of an organization with the specified UID.
Required Privileges
To perform this task, a user must have one of the following roles assigned: Portal Administrator, Service Provider Global Administrator, Service Provider Administrator.
Request
To get a representation of notification settings of an organization, send the GET HTTP request to the URL of the /organizations/{organizationUid}/configuration/notification resource.
HTTP Request
GET https://<hostname>:1280/api/v3/organizations/{organizationUid}/configuration/notification |
Request Headers
The request contains the following headers.
Header | Required/Optional | Value | Description |
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Accept | Optional | application/json | Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Request parameters
A list of parameters that are applicable for this operation:
Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
organizationUid | Path | String (uuid) | Yes | — | Organization UID |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Description |
Content-length | The length of the response body. |
Content-type | The media type and syntax of the request body message: application/json; charset=utf-8 |
Response Body
In the response body, Veeam Service Provider Console returns a resource representation based on the NotificationSettings schema.
Example 
The following request returns a representation of notification settings of an organization with UID debcdb55-afbd-4772-bf99-5ea6a3249f43.
Request: GET https://localhost:1280/api/v3/organizations/debcdb55-afbd-4772-bf99-5ea6a3249f43/configuration/notification
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "data": { "smtp": { "host": "smtp.alpha.com", "port": 25, "timeoutMs": 300000, "useSSL": false, "useCredentials": true, "username": "a.smith@alpha.com", "password": null }, "billing": { "from": "invoice@alpha.com", "subject": "Billing" }, "discovery": { "from": "discovery@alpha.com", "to": "administrator@alpha.com", "subject": "Discovery", "isDailyNotificationEnabled": true, "dailyTime": "2020-03-07T21:00:00+03:00" }, "alarms": { "from": "alarms@alpha.com", "to": "administrator@alpha.com", "dailySubject": "Alarms", "isDailyNotificationEnabled": true, "dailyTime": "2020-03-07T21:00:00+03:00" }, "license": { "from": "license@alpha.com", "to": "administrator@alpha.com" }, "level": "summary" } } |
