Sign in

v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB
Tenants

Create a new tenant

  • Creates a new tenant for a customer.
  • 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.
  • Note
    • This API does not support the creation of a Sandbox tenant.
    • Enterprise Workloads license is valid for eight years, while a SaaS Apps and Endpoints license is valid for three years.
    • Storage Regions once added, cannot be removed.
    • For SaaS Apps & Endpoint and Enterprise Workloads with Business Edition, any one storage region is supported.
    • The AWS and Azure storage regions must be in the same geographic location for ‘Business’ edition.
    • At least one AWS storage region is required for Enterprise Workloads.
    • All features enabled in the associated Service plan will be enabled compulsorily for the tenant. Need to send those feature attributes in the API.
    • Feature Endpoints, D365 and Okta do not support business edition.
    • 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 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 .
post/msp/v3/customers/{customerID}/tenants

Path parameters

customerIDstring required

Specify the unique ID of the customer for whom you wish to create a new tenant. Get the ID of the customer using the 'List all customers' API.

Headers

Authorizationstring required

Specify the Bearer access token

Request body

licenseExpiryDatestring date-time required

Specify the date on which 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 Druva Consumption Units to be allocated to this 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 Start date from when the quota limit will be applicable to the customer account and the storage consumption usage begins. The format for this parameter value is YYYY-MM-DDTHH:MM:SSZ. Example - '2022-10-25T00:00:00Z'

quotaEndDatestring date-time

Specify the End date on which the quota limit will end for the customer account. The format for this parameter value is YYYY-MM-DDTHH:MM:SSZ. Example - '2022-10-25T00:00:00Z'

servicePlanIDinteger required
  • 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 required

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.
productIDinteger required

Specify the ID of the product for which the tenant is being created.

  • To create the tenant for Enterprise Workloads, specify '1'.
  • To create the tenant for SaaS Apps and Endpoints, specify '2'

Example request

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

Response

Ok

Example response

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