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.
    • Hybrid 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 Hybrid Workloads with Business Edition, any one storage region is supported.
    • 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 do not support business edition.
    • For valid products and their values, see - https://developer.druva.com/docs/msp-product-and-attribute-values
Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
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.

Body Params

Specify the details for a new tenant.

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'

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

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'

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'

int64
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.
storageRegions
array of strings
required
  • Specify the AWS storage regions where you want to store the tenant data.
  • Get the list of AWS storage regions configured for your account in the MSC portal. Example - 'us-east-1'
storageRegions*
int64
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 Hybrid Workloads license is valid for eight years, while a SaaS Apps and Endpoints license is valid for three years.
int64
required

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

  • To create the tenant for Hybrid Workloads, specify '1'.
  • To create the tenant for SaaS Apps and Endpoints, specify '2'
features
array of objects
required

Specify the list of features that must be enabled for the tenant. It cannot be empty.

features*
Headers
string
required

Specify the Bearer access token

Responses

400

Bad Request

422

Unprocessable Entity

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json