Reporting Groups

Update a reporting group

Updates the configuration of an existing reporting group, including name, description, patch policy target, search pattern, and intermediate devices. This endpoint implements full replacement semantics: all updateable fields must be included in the request. Omitting optional fields will clear them (idempotent behavior). Optionally configure intermediate devices (up to 3) by providing Workspace identifiers. Intermediate devices are used for actions like Wake-on-LAN in secure networks, allowing remote powering on of devices through intermediate gateways. Intermediate devices must be defined sequentially: you cannot define intermediate_device_2_id without intermediate_device_1_id, nor intermediate_device_3_id without intermediate_device_2_id. All intermediate device Workspace IDs must exist and belong to the organization. Returns the updated resource (200) after a successful update.

PUT

organizations

{organization_id}

reporting-groups

{reporting_group_id}

curl --request PUT \
  --url https://api.staging.flxwvdexternal.com/v1/organizations/{organization_id}/reporting-groups/{reporting_group_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Production Reporting Group",
  "description": "Updated Reporting Group for Production Environments",
  "patch_policy_target_id": "507f1f77bcf86cd799439040",
  "fishing_pattern": "Windows Workstations",
  "fishing_pattern_field": "full_name",
  "intermediate_device_1_id": "507f1f77bcf86cd799439050",
  "intermediate_device_2_id": "507f1f77bcf86cd799439051",
  "intermediate_device_3_id": "507f1f77bcf86cd799439052"
}
'

{
  "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}$

reporting_group_id

string

required

The unique identifier of the reporting group to be updated

Maximum string length: 24

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

Body

application/json

Request body to update an existing reporting group. This endpoint implements complete replacement semantics: all updateable fields must be included. Optional fields omitted will be cleared (idempotent behavior). Intermediate devices are used for Wake-on-LAN actions in secure networks, allowing remote powering on of devices through intermediate gateways. Intermediate devices must be defined sequentially: you cannot define intermediate_device_2_id without intermediate_device_1_id, nor intermediate_device_3_id without intermediate_device_2_id. All intermediate device Workspace IDs must exist and belong to the organization.

name

string

required

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

Maximum string length: 512

Example:

"Updated Production Reporting Group"

description

string

Optional. A description of the reporting group's purpose and usage.

Maximum string length: 1000

Example:

"Updated Reporting Group for Production Environments"

patch_policy_target_id

string

Optional. The unique identifier of the patch policy target to be associated with this reporting group. Set it to null or omit it to remove the association.

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. Omit to remove the pattern.

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 Workspace of the first intermediate device. Intermediate devices are used for Wake-on-LAN actions in secure networks, allowing remote powering on of target devices through intermediate gateways. Intermediate devices must be sequentially defined without gaps. Omitting will clear all intermediate devices. 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 Workspace of the second intermediate device. Used for Wake-on-LAN actions in secure networks. Requires intermediate_device_1_id to be provided. If omitted while intermediate_device_1_id is provided, this and intermediate_device_3_id will be cleared. 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 Workspace of the third intermediate device. Used for actions like Wake-on-LAN in secure networks. Requires both intermediate_device_1_id and intermediate_device_2_id to be provided. If omitted while intermediate_device_1_id and intermediate_device_2_id are provided, this field will be cleared.

Maximum string length: 24

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

Example:

"507f1f77bcf86cd799439052"

Response

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

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

Show child attributes

effective_agent_settings

object | null

Effective agent settings (combined from product configuration and overrides)

Show child attributes

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)

Retrieve a reporting group

Delete a reporting group

⌘I

curl --request PUT \
  --url https://api.staging.flxwvdexternal.com/v1/organizations/{organization_id}/reporting-groups/{reporting_group_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Production Reporting Group",
  "description": "Updated Reporting Group for Production Environments",
  "patch_policy_target_id": "507f1f77bcf86cd799439040",
  "fishing_pattern": "Windows Workstations",
  "fishing_pattern_field": "full_name",
  "intermediate_device_1_id": "507f1f77bcf86cd799439050",
  "intermediate_device_2_id": "507f1f77bcf86cd799439051",
  "intermediate_device_3_id": "507f1f77bcf86cd799439052"
}
'

{
  "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>"
  }
}