Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

GET /config/domain_management/domains

Gets the list of domains.

Gets the list of domains. You must have the System Administrator or Security Administrator permissions to call this endpoint if you are trying to retrieve the details of all domains. You can retrieve details of domains that are assigned to your Security Profile without having the System Administrator or Security Administrator permissions. If you do not have the System Administrator or Security Administrator permissions, then for each domain assigned to your security profile you can only view the values for the id and name fields. All other values return null.

Table 1: GET /config/domain_management/domains Resource Details

MIME Type

application/json

Table 2: GET /config/domain_management/domains Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

Range

header

Optional

String

text/plain

Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.

filter

query

Optional

String

text/plain

Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3: GET /config/domain_management/domains Response Codes

HTTP Response Code

Unique Code

Description

200

 

The domain list has been successfully retrieved.

500

1020

An error occurred while the domain list was being retrieved.

Response Description

A list of domains.

  • id - Integer - The ID of the domain.

  • name - String - The name of the domain.

  • description - String - The description given to the domain.

  • tenant_id - Integer - The ID of the tenant that this domain belongs to.

  • deleted - Boolean - Whether or not the domain has been deleted.

  • event_collector_ids - Array of Longs - The list of event collector IDs that are assigned to this domain.

  • log_source_ids - Array of Longs - The list of log source IDs that are assigned to this domain.

  • log_source_group_ids - Array of Longs - The list of log source group IDs that are assigned to this domain.

  • custom_properties - Array of Custom Property Objects - The list of custom properties that are assigned to this domain.

  • flow_source_ids - Array of Longs - The list of flow source IDs that are assigned to this domain.

  • flow_collector_ids - Array of Longs - The list of flow collector IDs that are assigned to this domain.

  • asset_scanner_ids - Array of Longs - The list of asset scanner IDs that are assigned to this domain.

  • qvm_scanner_ids - Array of Longs - The list of QVM scanner IDs that are assigned to this domain.

  • flow_vlans_ids - Array of Longs - The list of flow VLAN IDs that are assigned to this domain.

Response Sample