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
Retrieves a list with the applications available in the price plan.
Retrieves a list with the policies available in the given price plan.
Reseller plan custom roles
There are custom roles that can be configured for a given reseller’s plan. Those roles cannot be managed at the web UI, only through this API or using NASS. On the Devo UI, these roles can be assigned to any domain. This allows the reseller administrator to fix the policies and resources that the users of a domain can access, avoiding to expose some resources that only should be applied to other belonging plan domains.
You must consider the following:
Basic roles Admin and No Privileges are taken from the defaults at the price plan instead of the global ones.
The owner of a domain is a role Admin flagged as Owner.
Multiple roles apply.
These are the available endpoints for custom plan role management:
Creates a new custom role. See the required parameters and more information here.
Retrieves all the roles belonging to the specified price plan.
Retrieves information about the specified role. Note that this endpoint allows you to use the parameter
full=true to receive a more detailed response.
Deletes the specified role. Note that roles cannot be deleted if they are assigned to one or several users.
Updates a role specification.
Change a domain price plan
This operation changes the assigned price plan of a given reseller domain. Notice that performing this operation implies changing all roles that belonged to the previous price plan (roles owner by the domain are left untouched). The request needs the following params:
|The new price plan name to apply to the domain. This parameter is mandatory.|
This parameter is optional and modifies what the API does with the existing roles. Options include:
This operation is quite complex and distinguishes between legacy and regular resellers, so a detailed workflow will be included here.
Update ingestion values
The price plan specific values assigned to a domain can be changed including the following params to your request:
|The time value to be assigned (for example: 100.0)|
|The volume value to be assigned (for example: 250.0)|