POST v1/bunits/{bunitId}/consumers/{consumerId}/microsoft365account/backuppolicies

Assign a backup policy to a account

Request Information

URI Parameters

NameDescriptionTypeAdditional information
bunitId integer

Required

consumerId integer

Required

Body Parameters

BackupPolicy
NameDescriptionTypeAdditional information
Name Name
Provided by SP Plus
string

None.

SppId Unique ID
Provided by SP Plus
integer

None.

Description Description
Imported from IBM Storage Protect
string

None.

Version Version
Imported from IBM Storage Protect
string

None.

Simple Simple
Imported from IBM Storage Protect
boolean

None.

Type Type
Imported from IBM Storage Protect
string

None.

UseEncryption UseEncryption
Imported from IBM Storage Protect
boolean

None.

Site Site
Imported from IBM Storage Protect
string

None.

RetentionDays Retention days
Imported from IBM Storage Protect
integer

None.

Frequency Frequency
Imported from IBM Storage Protect
integer

None.

TriggerType Trigger type
Imported from IBM Storage Protect
string

None.

ActivateDate Activated date
Imported from IBM Storage Protect
date

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.

application/xml, text/xml

Sample:
<BackupPolicy xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>12</Id>
  <CreatedDate>2024-05-20T17:22:38.6592198+02:00</CreatedDate>
  <ArchivedDate>2024-05-20T17:22:38.6592198+02:00</ArchivedDate>
  <Name>sample string 1</Name>
  <SppId>2</SppId>
  <Description>sample string 3</Description>
  <Version>sample string 4</Version>
  <Simple>true</Simple>
  <Type>sample string 6</Type>
  <UseEncryption>true</UseEncryption>
  <Site>sample string 8</Site>
  <RetentionDays>9</RetentionDays>
  <Frequency>10</Frequency>
  <TriggerType>sample string 11</TriggerType>
  <ActivateDate>2024-05-20T17:22:38.6592198+02:00</ActivateDate>
</BackupPolicy>

Response Information

Resource Description

BackupPolicy
NameDescriptionTypeAdditional information
Name Name
Provided by SP Plus
string

None.

SppId Unique ID
Provided by SP Plus
integer

None.

Description Description
Imported from IBM Storage Protect
string

None.

Version Version
Imported from IBM Storage Protect
string

None.

Simple Simple
Imported from IBM Storage Protect
boolean

None.

Type Type
Imported from IBM Storage Protect
string

None.

UseEncryption UseEncryption
Imported from IBM Storage Protect
boolean

None.

Site Site
Imported from IBM Storage Protect
string

None.

RetentionDays Retention days
Imported from IBM Storage Protect
integer

None.

Frequency Frequency
Imported from IBM Storage Protect
integer

None.

TriggerType Trigger type
Imported from IBM Storage Protect
string

None.

ActivateDate Activated date
Imported from IBM Storage Protect
date

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.

application/xml, text/xml

Sample:
<BackupPolicy xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>12</Id>
  <CreatedDate>2024-05-20T17:22:38.6592198+02:00</CreatedDate>
  <ArchivedDate>2024-05-20T17:22:38.6592198+02:00</ArchivedDate>
  <Name>sample string 1</Name>
  <SppId>2</SppId>
  <Description>sample string 3</Description>
  <Version>sample string 4</Version>
  <Simple>true</Simple>
  <Type>sample string 6</Type>
  <UseEncryption>true</UseEncryption>
  <Site>sample string 8</Site>
  <RetentionDays>9</RetentionDays>
  <Frequency>10</Frequency>
  <TriggerType>sample string 11</TriggerType>
  <ActivateDate>2024-05-20T17:22:38.6592198+02:00</ActivateDate>
</BackupPolicy>