Domain operations

GET/domain^{see below}

Get a list of all the domains in a multitenant structure.

GET /domain/{domainName}^{see below}

Get basic information about a given domain in a multitenant structure.

GET /domains/{domainName}^{see below}

Returns a list of all the children domains a root domain has in a multitenant structure.

GET /domain/{domainName}/retention^{see below}

Get the price plan retention values of the given multitenant domain.

GET /domain/{domainName}/roles^{see below}

Get details of all the roles in the given domain.

GET /domain/{domainName}/roles/{roleName}^{see below}

Get details of a specific role in a given domain.

GET /domain/{domainName}/policies^{see below}

Get the list of role policies available in a given domain.

GET /domain/{domainName}/applications^{see below}

Get the list of applications available in a given domain.

GET /domain/{domainName}/resources^{see below}

Get the list of role resources available in a given domain.

GET /domain/{domainName}/roles/vaults^{see below}

Get the list of role vaults available in a given domain.

GET /domain/{domainName}/preferences^{see below}

Retrieve the subset of preferences of the given domain.

GET /domain/{domainName}/preferences/limits^{see below}

Retrieve the limits in the preferences of the given domain.

GET /domain/{domainName}/visibility^{see below}

Returns a list of all the domains from which a root domain can access data in a multitenant structure.

GET /domain/{domainName}/auth^{see below}

Returns the configuration info of a multitenant domain.

GET /domain/{domainName}/keys^{see below}

Returns a list of all the API keys associated to the given domain.

GET /domain/{domainName}/keys/{key}^{see below}

Returns info of a specific API key.

POST/domain^{see below}

Create a new domain in a multitenant structure.

POST/domain/{domainName}/disable^{see below}

Disable a multitenant domain.

POST/domain/{domainName}/enable^{see below}

Enable a multitenant domain.

POST/domain/{domainName}/visibility^{see below}

Creates a new domain visibility configuration (i.e., custom data access) for a given domain.

POST/domain/{domainName}/roles^{see below}

Create a new role in a given domain.

POST/domain/{domainName}/keys^{see below}

Generate a new API key/secret pair in the domain.

PUT /domain/{domainName}/plan^{see below}

Change the current plan of a multitenant domain.

PUT /domain/{domainName}/retention^{see below}

Update the given domain plan retention configuration.

PUT /domain/{domainName}/roles ^{see below}

Update a role in a given domain.

PUT /domain/{domainName}/roles/{roleName} ^{see below}

Update a role.

PUT /domain/{domainName}/preferences ^{see below}

Update the subset of preferences of a given domain.

PUT /domain/{domainName}/preferences/limits ^{see below}

Update the limits in the preferences of a given domain.

PUT /domain/{domainName}/certificates/download ^{see below}

Download a certificate.

PUT /domain/{domainName}/auth ^{see below}

Update the configuration of a multitenant domain.

Put/domain/{domainName}/visibility^{see below}

Updates a domain visibility configuration (i.e., custom data access) for a given domain.

DELETe /domain/{domainName}^{see below}

Delete a domain.

DELETe /domain/{domainName}/roles/{roleName}^{see below}

Delete a role in a given domain.

DELETe /domain/{domainName}/keys/{key}^{see below}

Delete a specific API key.

delete/domain/{domainName}/visibility^{see below}

Deletes a domain visibility configuration (i.e., custom data access) for a given domain.

all

boolean

Set this parameter to true if you want to get all the domains, including disabled ones. The default value is false.

200

Successful response. List of domains retrieved.

4xx

Bad request.

domainName ^required

string

Enter the name of the required domain. Using the format {domainName}@{multitenantName} is optional.

200

Successful response. Domain details retrieved.

4xx

Bad request.

domainName ^required

string

Enter the name of the required domain. You must enter the full domain name using the format {domainName}@{multitenantName}

200

Successful response. List of domains retrieved.

204

Successful response. No children domains.

400

Bad request.

403

Not a multitenant.

domainName ^required

string

Enter the name of the required domain. You must enter the full domain name using the format {domainName}@{multitenantName}

200

Successful response. Domain retention values retrieved.

4xx

Bad request.

domainName ^required

string

Enter the name of the required domain.

If it is a multitenant domain, you must enter the full domain name using the format {domainName}@{multitenantName}

200

Successful response. Domain roles retrieved.

4xx

Bad request.

domainName ^required

string

Enter the name of the required domain.

If it is a multitenant domain, you must enter the full domain name using the format {domainName}@{multitenantName}

roleName ^required

string

Enter the name of the required role.

Note that this parameter is case sensitive. For Devo default roles, you must type:

• Administrator

• No privileges

full

boolean

Set this to true if you want to get additional details about the role (assigned policies, resources, applications). The default value is false.

200

Successful response. Role info retrieved.

Parameter full set to true:

Parameter full set to false:

4xx

Bad request.

domainName ^required

string

Enter the name of the required domain.

If it is a multitenant domain, you must enter the full domain name using the format {domainName}@{multitenantName}

200

Successful response. List of available policies retrieved.

4xx

Bad request.

domainName ^required

string

Enter the name of the required domain.

If it is a multitenant domain, you must enter the full domain name using the format {domainName}@{multitenantName}

200

Successful response. List of available applications retrieved.

4xx

Bad request.

domainName ^required

string

Enter the name of the required domain.

If it is a multitenant domain, you must enter the full domain name using the format {domainName}@{multitenantName}

200

Successful response. List of available resources retrieved.

4xx

Bad request.

domainName ^required

string

Enter the name of the required domain.

If it is a multitenant domain, you must enter the full domain name using the format {domainName}@{multitenantName}

200

Successful response. List of vaults retrieved.

4xx

Bad request.

domainName ^required

string

Enter the name of the required domain. You must enter the full domain name using the format {domainName}@{multitenantName}

200

Successful response. List of preferences retrieved.

400

Bad request.

domainName ^required

string

Enter the name of the required domain. You must enter the full domain name using the format {domainName}@{multitenantName}

200

Successful response. List of limits retrieved.

400

Bad request.

domainName ^required

string

Enter the name of the required domain. You must enter the full domain name using the format {domainName}@{multitenantName}

200

Successful response. List of domains retrieved.

400

Bad request.

domainName ^required

string

Enter the name of the required multitenant domain. You must enter the full domain name using the format {domainName}@{multitenantName}

200

Successful response. Authentication info retrieved.

400

Bad request.

domainName ^required

string

Enter the name of the required multitenant domain. You must enter the full domain name using the format {domainName}@{multitenantName}

200

Successful response. List of API keys retrieved.

400

Bad request.

domainName ^required

string

Enter the name of the required multitenant domain. You must enter the full domain name using the format {domainName}@{multitenantName}

key ^required

string

API key you want to retrieve.

You can get this using the GET/domain/{domainName}/keys endpoint. Find the required API key in the apiKey parameter of the response.

200

Successful response. API key info retrieved.

400

Bad request.

name ^required

string

Enter the name of the required domain.

The domain name might include the@{multitenantName}tail or not, but take into account that the full name will actually be used (for example, for name length validation).

The name value will always contain the full domain name in the response, even if you have provided only the domain name without the multitenant name tail.

plan ^required

string

Enter the name of the price plan. Assigning a domain to an existing, valid multitenant price plan is mandatory.

time

number

Indicate the retention time in months. The maximum value is 100. Contact us to have the ability to redefine table retention enabled or disabled on a plan. If the request attempts to change retention time when the ability to change retention time is disabled, the response will be 400.

volume

number

Enter the storage volume in GB. The maximum value is 100.

200

Successful response. Domain created.

400

Bad request.

domainName ^required

string

Enter the name of the required domain. You must enter the full domain name using the format {domainName}@{multitenantName}

200

Successful response. Domain disabled.

400

Bad request.

domainName ^required

string

Enter the name of the required domain. You must enter the full domain name using the format {domainName}@{multitenantName}

200

Successful response. Domain enabled.

400

Bad request.

domainName ^required

string

Enter the name of the domain you want to grant data access to other domains. You must enter the full domain name using the format {domainName}@{multitenantName}

domain ^required

string

The name of the domain you want to grant data access to other domains. You must enter the full domain name: {domainName}@{multitenantName}

reseller ^required

string

The name of the multitenant structure the domain belongs to.

type ^required

string

The type of criteria you want to use to find domains to grant access to:

• ALL_DOMAINS

• PREFIX

• SUFFIX

• DOMAIN_LIST

filter ^{when type is PREFIX/SUFFIX}

string

The specific criteria to find domains to grant access to, which consists of finding a string at the beginning or end of their names.

targets ^{when type is DOMAIN_LIST}

string

The specific criteria to find domains to grant access to, which consists of listing specific domains. You must enter the full domain name: {domainName}@{multitenantName}

200

Success. Domain visibility configuration created.

400

Bad request.

domainName ^required

string

Enter the name of the required domain. You must enter the full domain name using the format {domainName}@{multitenantName}

name ^required

string

Enter the name of the new role.

description

string

An optional description for the role.

policies

list

The role policies (or permissions) of the new role.

If this parameter is not included, all the available policies will be added to the role. Using the value [*] or * will also add all the available policies. For an empty policy list, use [].

Example: [policy_1, policy_2]

applications

list

Specify the applications available for the new role.

Using the value [*] or * will add all the available applications. For an empty application list, use [].

Example: [application_1, application_2]

defaultApplicationName

string

The required application to use as the default one. The default application name must be among the role applications specified.

A default application name is not required when the policies list is empty (a missing registry key is interpreted as an empty list)

resources

object

A JSON object where you indicate the resources to be added to the role. You mast add an array for each resource, including its ID and access level:

• id - (integer) ID of the resource to be added to the role

• editable - (integer) Set the required access level for the resource. Note that you must have the required permissions to give access to a resource; otherwise, an error will be returned. Allowed values are 0 (view access) or 1 (manage access).

Example:

resourceIds

object

A JSON object with the resource type and a list of resources IDs. Each resource ID instance takes a name plus an integer array. The name is not really important and only exists to provide a clearer way to describe the role. Each entry resource ID list can be empty.

Using the key pair *: [] will add all the available domain resources. For an empty resource list, use [].

Examples

Assign specific resources:

No resources assigned:

Add all the available domain resources (lookups and activeboards):

finderName

string

Optionally, enter the name of the default finder to be assigned to the role.

alertPermission

string

Level of permission over alerts that you want to grant to the new role. There are 3 options available:

• Null value - Permissions over alerts will not be updated over any existing ones while updating a role, or will be created empty when creating a role.

• Empty value - No permissions are given over alerts. Several policies might produce and error when the role has no permissions over any alert.

• Specific value - The role will have permissions only over the provided alerts. This is the format to follow:

  • level - The access level to be granted. Options are: all, category (can be abbreviated as cat), subcategory (can be abbreviated as sub), and context (can be abbreviated as ctx).

  • granted - The alert ID over which the access is granted. Use all to include all alerts. For the permission to work, the level and grant value must match, meaning that
    the granted ID must belong to the specified category.

  • editable - Defines if the alert can be edited or not. Use values 1 (editable) and 0 (not editable).

Note that several policies require certain alert permissions to be assigned. For example, to include any policy related with alerts, permissions over at least one alert is required. Similarly, any alert management policy requires the same but for an alert with management permissions.

When the * value is used for policies, the policies assigned will depend on the alert permissions granted. In the following example, we are granting view permissions over all alerts, so the policies assigned by the wildcard will include values like policy.alerts.view but not policy.alerts.manage

defVaultId

integer

The default vault (querying priority level) defined for the role.

maxVaultId

integer

The maximum vault defined to be used in the role.

200

Successful response. Role created.

400

Bad request.