Products: Managed Backup (Agent)
Article ID: m0636Last Modified: 10-Oct-2025

PUT API/Companies

Changes company properties.

Request Information

URI Parameters

None.

Body Parameters

Company data to update.

Name Description Type Additional Information
Id Company Id GUID None
Name Company Name string None
StorageLimit Company backup limit. A negative value indicates the resource is unconstrained by a quota
integer None
LicenseSettings Company license settings: 0 - Custom (Users have custom license settings) 1 - Global Pool(Users activate paid licenses from the global pool automatically) 2 - Company Pool(Users can activate only limited number of paid licenses from the company pool) LicensingMode None
DestinationId Specifies IDs of the backup destinations assigned for a specific company array None
DefaultLicenses Specifies default license types for new installations on endpoints in a specific company integer None
AllowedLicenses Specifies allowed license types for a specific company array None

For license type enums refer to the following article.

Request Formats

application/json, text/json

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "Name": "string",
  "StorageLimit": 0,
  "LicenseSettings": 0,
  "Destinations": [
    {
      "DestinationId": "00000000-0000-0000-0000-000000000000",
      "PlanId": 0
    }
  ],
  "DefaultLicense": 0,
  "AllowedLicenses": [
    0
  ]
}

application/xml, text/xml

<CompanyModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MBSAPImvc.Engine.Models">
  <LicenseSettings>CustomUsersSettings</LicenseSettings>
  <Name>sample string 2</Name>
  <StorageLimit>1</StorageLimit>
  <Id>75dbef27-da9c-4b68-b282-ae7d6322782e</Id>
</CompanyModel>

Response Information

Resource Description

Company update result IHttpActionResult None.

Response Formats

  • application/json
  • text/json
  • application/xml
  • text/xml.
https://git.cloudberrylab.com/egor.m/doc-help-mbs.git
Production