Adding Backup Accounts

In this article

    You can add a Microsoft Office 365 backup account to the backup configuration to minimize throttling when backing up Microsoft SharePoint and OneDrive for Business items.

    Request

    PUT https://<hostname>:4443/v5/Organizations/{organizationId}/backupaccounts

    Request Headers

    The request header must contain an authorization token of the current session.

    Request Parameters

    The following parameter must be specified in the URL of the request:

    Parameter

    Type

    Description

    organizationId

    string

    Specifies the identification number of the Office 365 organization. For more information on how to get this parameter, see Getting Organizations.

    Request Body

    The following table lists available request properties:

    Property

    Type

    Description

    groupMember

    groupMemberObject

    An identification number of the group to which the account belongs.

    groupMemberObject

    Property

    Type

    Description

    groupId

    string

    An identification number of the group to which the account belongs.

    login

    string

    A login name.

    name

    string

    An account name.

    type

    string

    The type of the account.

    Request Example

    Request:

    PUT https://abc.tech.local:4443/v5/Organizations/6f9b3da3-204d-4a4b-b466-55586e0233fc/backupaccounts

     

    Request Header:

    Authorization: Bearer <Access-Token>

    Request Body:

    [{

      "groupMember":{

         "groupId":"6e570850-9ce9-40ed-b81d-41772dabcead00000000-0000-0000-0000-000000000000",

         "login":"account1@office365.onmicrosoft.com",

         "name":"tworker1",

         "type":"User"

      },

      "password":"XXXXX"

    }]

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns a response code 201 Created.

    Response Headers

    The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

    Header

    Description

    Content-length

    The length of the response body.

    Content-type

    The media type and syntax of the response body message: application/json; charset=utf-8

    Response Body

    The response contains the following information:

    Property

    Type

    Description

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Response Example

    Response:

    201 Created

     

    Response Body:

    {

      "_links":{

         "self":{

            "href":"https://abc.tech.local:4443/v5/organizations/6f9b3da3-204d-4a4b-b466-55586e0233fc/backupaccounts"

         }

      }

    }