POST v1/bunits/{bunitId}/serverdeliveryconfigs

Request Information

URI Parameters

NameDescriptionTypeAdditional information
bunitId integer

Required

Body Parameters

ServerReportDeliveryConfig
NameDescriptionTypeAdditional information
Enabled An enabled subscription will be sent out
Disable to keep information but avoid getting mails
boolean

None.

Name Name of the subscription
string

None.

Subject Custom subject set by end user. Leave blank for default subject
string

None.

SendBcc Whether or not to use BCC or To when sending emails.
Use BCC to hide receivers from each other
boolean

None.

Emails Recipient email addresses.
Collection of string

None.

IncludeDescendants Send server report for all servers in descendant business unit data centers. When false, only servers in the current business unit's data centers will be reported.
boolean

None.

IncludeOverview Include an overview with all servers and their status
boolean

None.

IncludeDetails Include detailed information on each server
boolean

None.

SendErrors Only send reports when a server fails (and returns to OK).
boolean

None.

Frequency How often the report should be sent
Types: Daily, Weekly, Monthly
Frequency

None.

FrequencyDetails A list of days if FrequencyType is weekly or monthly
if frequency is weekly valid options are 0 to 6 where 0 represents sunday and 6 represents saturday
if frequency is monthly valid options are 1 to 31 where values n represents last day of the month if no more than n days are in the month
Collection of integer

None.

DecimalMark string

None.

DateFormat string

None.

TimeFormat string

None.

DateFormatInitialized string

None.

TimeFormatInitialized string

None.

DateTimeFormat string

None.

BusinessUnit BusinessUnit

None.

Id A unique ID for the object.
integer

Read-only.

CreatedDate Time and date the object was created.
date

Read-only.

ArchivedDate Time and date the object was or is going to be archived.

Unarchived objects have no value in ArchivedDate
date

Read-only.

Request Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

Response Information

Resource Description

ServerReportDeliveryConfig
NameDescriptionTypeAdditional information
Enabled An enabled subscription will be sent out
Disable to keep information but avoid getting mails
boolean

None.

Name Name of the subscription
string

None.

Subject Custom subject set by end user. Leave blank for default subject
string

None.

SendBcc Whether or not to use BCC or To when sending emails.
Use BCC to hide receivers from each other
boolean

None.

Emails Recipient email addresses.
Collection of string

None.

IncludeDescendants Send server report for all servers in descendant business unit data centers. When false, only servers in the current business unit's data centers will be reported.
boolean

None.

IncludeOverview Include an overview with all servers and their status
boolean

None.

IncludeDetails Include detailed information on each server
boolean

None.

SendErrors Only send reports when a server fails (and returns to OK).
boolean

None.

Frequency How often the report should be sent
Types: Daily, Weekly, Monthly
Frequency

None.

FrequencyDetails A list of days if FrequencyType is weekly or monthly
if frequency is weekly valid options are 0 to 6 where 0 represents sunday and 6 represents saturday
if frequency is monthly valid options are 1 to 31 where values n represents last day of the month if no more than n days are in the month
Collection of integer

None.

DecimalMark string

None.

DateFormat string

None.

TimeFormat string

None.

DateFormatInitialized string

None.

TimeFormatInitialized string

None.

DateTimeFormat string

None.

BusinessUnit BusinessUnit

None.

Id A unique ID for the object.
integer

Read-only.

CreatedDate Time and date the object was created.
date

Read-only.

ArchivedDate Time and date the object was or is going to be archived.

Unarchived objects have no value in ArchivedDate
date

Read-only.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.