v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB

Tenants

Patch an existing tenant

Patches existing tenant for given customer for the MSP with given details.
After you initiate the operation, it is queued and a task ID is generated. You can get the task ID from the success response. Use this task ID in the 'Get Task Details' API to track the operation's progress.
Notes
- Enterprise Workloads license is valid for eight years, while a SaaS Apps and Endpoints license is valid for three years.
- Storage Regions once added, will not be removed.
- The AWS and Azure storage regions must be in the same geographic location for ‘Business’ edition.
- Feature Endpoints, D365 and Okta do not support business edition.
- For business edition, there will be only 1 storage region supported.
- If a feature is enabled/disabled in service plan it can not be overridden via this API call.
- IsEnabled is a required field while specifying tenant features.
- All the supported attributes are required while updating any feature.
- Premium Security is only supported for Enterprise Workloads.
- If 'Premium Security' needs to be enabled for a tenant, Security Posture & Observability and Enterprise Workloads Accelerated Ransomware Recovery features both should be enabled for that tenant.
- For valid products and their Product Features, see - https://developer.druva.com/docs/msp-product-and-attribute-values
- For valid products and their values, see - https://developer.druva.com/docs/msp-product-and-attribute-values
- View all supported storage regions here - https://help.druva.com/en/articles/15162912-aws-region-availability-matrix .

patch/msp/v3/customers/{customerID}/tenants/{tenantID}

Path parameters

customerIDstring required

Specify the ID of a customer for which you wish to update tenant. Get the ID of a customer using the 'List all customers' API.

tenantIDstring required

Specify the ID of a tenant for which you wish to update. Get the ID of a tenant using the 'List all tenants' API.

Headers

Authorizationstring required

Specify the Bearer access token

Request body

licenseExpiryDatestring date-time

Specify the new date on which the license of the tenant will expire. The format for this parameter value is YYYY-MM-DDTHH:MM:SSZ. Example - '2022-10-25T00:00:00Z'

quotanumber double

Specify the new value of Druva Consumption Units that should be allocated to the customer. If the customer is close to breaching this limit, an alert is sent to the configured email address based on the severity of the breach. Example - 1.5

quotaStartDatestring date-time

Specify the new date from when the Quota limit is applicable to the customer and the storage consumption begins. The format for this parameter value is YYYY-MM-DDTHH:MM:SSZ. Example - '2022-10-15T00:00:00Z'

quotaEndDatestring date-time

Specify the new date when the allocated Quota limit will expire. After the Quota limit expires, the customer cannot back up the data. The format for this parameter value is YYYY-MM-DDTHH:MM:SSZ. Example - '2022-10-15T00:00:00Z'

servicePlanIDinteger

Specify the unique ID of the Service Plan that you wish to associate with the tenant.
Get the Service Plan ID using the 'List Service Plans' API.

tenantTypeinteger

Specify the tenant type for the product.

Specify '1' if it is a Sandbox.
Specify '2' if it is Evaluation. This is a trial plan with a validity of 30 days. If you select this tenant type, the product license will be active until 30 days. After 30 days, you must change the tenant type to Commercial.
Specify '3' if it is Commercial. For this tenant type, a Enterprise Workloads license is valid for eight years, while a SaaS Apps and Endpoints license is valid for three years.

Example request

{
  "licenseExpiryDate": "2022-10-25T00:00:00Z",
  "quota": 1.5,
  "quotaStartDate": "2022-10-15T00:00:00Z",
  "quotaEndDate": "2022-10-15T00:00:00Z",
  "servicePlanID": 1,
  "tenantType": 2,
  "storageRegions": [
    {
      "name": "us-east-1",
      "storageProvider": 1
    }
  ],
  "features": [
    {
      "name": "M365",
      "isEnabled": true,
      "attrs": [
        {
          "name": "userCount"
        }
      ]
    }
  ]
}

Response

Example response

{
  "task": {
    "id": "c8b54819-486a-497a-b86e-5b93f2422711"
  }
}