Skip to main content
POST
/
v1
/
organizations
/
{organization_id}
/
reporting-groups
curl --request POST \
  --url https://api.staging.flxwvdexternal.com/v1/organizations/{organization_id}/reporting-groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Production Reporting Group",
  "product_config_id": "507f1f77bcf86cd799439030"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "execute_flexx_analyzer_agent": true,
  "organization_id": "<string>",
  "product_config_id": "<string>",
  "fishing_pattern": "<string>",
  "patch_policy_target_id": "<string>",
  "policy_reporting_group": "<string>",
  "overridden_agent_settings": {
    "remote_support": "<string>",
    "collect_device_location": true,
    "auto_update_agents": true,
    "collect_event_logs": true,
    "event_log_ids": "<string>",
    "event_logs_recurrence": 123,
    "collect_disks": true,
    "collect_services": true,
    "collect_pnp_events": true,
    "collect_public_ip": true,
    "fra_system_actions_role": "<string>",
    "unified_reporting": "<string>",
    "unified_operations": "<string>",
    "web_apps": true
  },
  "effective_agent_settings": {
    "remote_support": "<string>",
    "collect_device_location": true,
    "auto_update_agents": true,
    "collect_event_logs": true,
    "event_log_ids": "<string>",
    "event_logs_recurrence": 123,
    "collect_disks": true,
    "collect_services": true,
    "collect_pnp_events": true,
    "collect_public_ip": true,
    "fra_system_actions_role": "<string>",
    "unified_reporting": "<string>",
    "resources_report_recurrence": 123,
    "profile_storage_report_recurrence": 123,
    "sync_broker_recurrence": 123,
    "detect_new_citrix_subscriptions": true,
    "proxy_type": "<string>",
    "can_enable_flexx_agent_per_group": true,
    "web_apps": true,
    "fra_simplified_security": "<string>"
  },
  "intermediate_device_1_id": "<string>",
  "intermediate_device_2_id": "<string>",
  "intermediate_device_3_id": "<string>"
}
{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}
{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}
{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}
{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}
{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}
{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
organization id
string
required

The unique identifier of the organization

Maximum string length: 24
Pattern: ^[0-9a-f]{24}$

Body

application/json

Request body for creating a new reporting group. Reporting groups manage devices and handle configurations, patch policies, and routing of intermediary devices.

​
name
string
required

The reporting group name. Must be unique within the organization.

Maximum string length: 512
Example:

"Production Reporting Group"

​
product_config_id
string
required

Unique identifier of the product configuration to associate with this reporting group. Product configuration must exist and belong to the organization.

Maximum string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"507f1f77bcf86cd799439030"

​
patch_policy_target_id
string

Optional. Unique identifier of the patch policy target to associate with this reporting group.

Maximum string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"507f1f77bcf86cd799439040"

​
fishing_pattern
string

Optional. A regular expression pattern used to match devices. Must be a valid regex pattern. If provided, fishing_pattern_field must also be specified.

Maximum string length: 250
Example:

"Windows Workstations"

​
fishing_pattern_field
enum<string>

Optional. Field to which fishing_pattern is applied. Required if fishing_pattern is provided. Valid values: full_name (full device name), description (device description), ou (organizational unit), current_subnet (current subnet).

Available options:
full_name,
description,
ou,
current_subnet
Example:

"full_name"

​
intermediate_device_1_id
string

Optional. The unique identifier of the first intermediate device Workspace. Intermediate devices are used for actions like Wake-on-LAN in secure networks, allowing remote powering on of target devices through intermediate gateways. Intermediate devices must be sequentially defined without gaps. If intermediate_device_2_id or intermediate_device_3_id is provided, this field is required.

Maximum string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"507f1f77bcf86cd799439050"

​
intermediate_device_2_id
string

Optional. The unique identifier of the second intermediate device Workspace. Used for Wake-on-LAN actions in secure networks. Requires intermediate_device_1_id to be provided. If intermediate_device_3_id is provided, this field is required.

Maximum string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"507f1f77bcf86cd799439051"

​
intermediate_device_3_id
string

Optional. The unique identifier of the third intermediate device Workspace. Used for Wake-on-LAN actions in secure networks. Requires both intermediate_device_1_id and intermediate_device_2_id to be provided.

Maximum string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"507f1f77bcf86cd799439052"

Response

Reporting group created successfully. The response contains the created resource.

​
id
string
required

Reporting group Id

​
name
string
required

Name of the reporting group

​
execute_flexx_analyzer_agent
boolean
required

If Flexx Analyzer agent execution is enabled

​
organization_id
string | null

Organization identifier

​
product_config_id
string | null

Product configuration identifier

​
fishing_pattern
string | null

Fishing pattern name

​
fishing_pattern_field
enum<string> | null

Field to which fishing_pattern is applied. Possible values: full_name, description, ou, current_subnet.

Available options:
full_name,
description,
ou,
current_subnet
​
patch_policy_target_id
string | null

Patch policy target identifier

​
policy_reporting_group
string | null

Policy reporting group identifier

​
overridden_agent_settings
object | null

Agent settings overridden at the reporting group level

​
effective_agent_settings
object | null

Effective agent settings (combined from product configuration and overrides)

​
intermediate_device_1_id
string | null

Workspace ID of the first intermediary device (searched by sysId)

​
intermediate_device_2_id
string | null

Workspace ID of the second intermediary device (searched by sysId)

​
intermediate_device_3_id
string | null

Workspace ID of the third intermediary device (searched by sysId)