Create user preferences for the current user

post/compute-ops-mgmt/v1/user-preferences

Purpose

When a server is added to Compute Ops Management, these attributes will be used to set the initial email notification subscription choices for event and daily health email notifications.

Event notification selections are made such that each selection increases the scope of the set of events that will be included. The order of event selections from minimum to maximum scope are

  • criticalNotification - Events that are marked as service events. These events may have severity levels of 'warning' or 'critical'
  • criticalNonServiceNotification - Events that are not service events but have a severity level of 'critical'
  • warningNotification - Events that are not service events but have a severity level of 'warning'

Note that healthNotification is not part of the event notification set and may be set independently.

Since each selection builds on the previous one, there exists a hierarchy between selections that must be maintained. The table below shows which notification combinations are valid. All other combinations will result in an HTTP 400 error

criticalNotification criticalNonServiceNotification warningNotification
False False False
True False False
True True False
True True True

Initial values

All values are initially false with the result being that no notifications will be sent.

SecurityBearer
Request
header Parameters
Tenant-Acid
string <uuid>

Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.

In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts API to determine the application customer IDs for your tenant accounts.

Request Body schema: application/json
required
criticalNotification
required
boolean
criticalNonServiceNotification
boolean
warningNotification
boolean
healthNotification
boolean
Responses
200

Successful Response

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

406

Not acceptable

415

Unsupported media type

500

Internal server error

Request samples
application/json
{
  • "criticalNotification": true,
  • "criticalNonServiceNotification": true,
  • "warningNotification": true,
  • "healthNotification": true
}
Response samples
application/json
{
  • "id": "36e00ac2-16fb-4dd5-8495-7e6df82fc15e",
  • "type": "compute-ops-mgmt/user-preference",
  • "generation": 1,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "criticalNotification": true,
  • "criticalNonServiceNotification": true,
  • "warningNotification": true,
  • "healthNotification": true
}