Price plans

A price plan is a set of capabilities and features related to a set of domains. These price plans allow our resellers or MSSPs to group their domains in order to apply different specifications such as data retention specs, a different set of applications, roles, or finders.

The Provisioning API offers a series of endpoints that allow users to manage and configure different aspects of their price plans:

Plan resources management

GET /plan/{planName}/applications

Retrieves a list with the applications available in the price plan.

GET /plan/{planName}/policies

Retrieves a list with the policies available in the given price plan.

GET /plan/{planName}/roles/vaults

Retrieves a list with the vaults available in the given price plan.

GET /plan/{planName}/configuration

Retrieves the plan’s configuration. Its output should be similar to:

{
  "usersCount": 10, 
  "redefineTablesRetention": true, 
  "shareAcrossPlan": false, 
  "queryForever": false 
}

• usersCount indicates the maximum number of users per domain.
• redefineTablesRetention allows users to redefine the retention for the domains in this plan.
• shareAcrossPlan allows sharing user's resources among the roles of the plan.
• queryForever runs queries in real-time when they start.

PUT /plan/{planName}/configuration

Updates the plan configuration. The body of the request should follow this format:

{
  "usersCount": 5, 
  "redefineTablesRetention": false, 
  "shareAcrossPlan": true, 
  "queryForever": true
}

PUT /plan/{planName}/applications

Updates the plan applications. You must indicate a list of the applications to be activated for this plan. All the applications specified must be available in the plan. The body of the request should follow this format:

[
  "application1", 
  "application2",
...
]