Crosswork Grouping API

Version 7.1.0

v1.0 - 2025-05-29

Added

GET /groups/{groupUuids}

Get group hierarchies

Deprecated

GET /group/{groupUuids}

Get group hierarchies

Removed

• Nothing.

Fixed

• Nothing.

Changed

GET /rule/classifier/{classifier}

Parameters:

Changed: classifier in path

Type of classifier used to filter rules.

Return Type:

New response : 400 Bad Request

Bad Request

New response : 500 Internal Server Error

Internal Server Error

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body, which is a generic structure containing only the relevant API return data.

• Changed content type : application/json

GET /group/{groupUuids}

Parameters:

Changed: groupUuids in path

Comma-separated list of UUIDs identifying the groups whose hierarchies are to be retrieved.

Changed: brief in query

Flag indicating whether to return a brief view of the group hierarchies. Default is false.

Return Type:

New response : 400 Bad Request

Bad Request

New response : 500 Internal Server Error

Internal Server Error

Changed response : 200 OK

Successfully retrieved the group hierarchies.

• Changed content type : application/json

GET /group/root/{classifiers}/uuid

Parameters:

Changed: classifiers in path

List of classifiers used to filter root groups.

Return Type:

New response : 400 Bad Request

Bad Request

New response : 500 Internal Server Error

Internal Server Error

Changed response : 200 OK

Successfully retrieved the root group UUIDs.

• Changed content type : application/json

GET /rule/{uuid}

Parameters:

Changed: uuid in path

UUID of the rule to retrieve.

Return Type:

New response : 400 Bad Request

Bad Request

New response : 500 Internal Server Error

Internal Server Error

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body, which is a generic structure containing only the relevant API return data.

• Changed content type : application/json

  • Changed property uuid (string)

    Unique identifier for the rule, if available.

  • Changed property classifier (string)

    Classifier type for the rule.

  • Changed property conditions (object -> string)

    Refer rule/conditions API for supported conditions properties and operators

  • Changed property targetGroupUuid (string)

    UUID of the target group associated with the rule, if applicable.

PUT /rule/{uuid}

Parameters:

Changed: uuid in path

UUID of the rule to update.

Request:

Details of the rule to be updated.

Changed content type : application/json

• Changed property uuid (string)

  Unique identifier for the rule, if available.

• Changed property classifier (string)

  Classifier type for the rule.

• Changed property conditions (object -> string)

  Refer rule/conditions API for supported conditions properties and operators

• Changed property targetGroupUuid (string)

  UUID of the target group associated with the rule, if applicable.

Return Type:

New response : 400 Bad Request

Bad Request

New response : 500 Internal Server Error

Internal Server Error

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body, which is a generic structure containing only the relevant API return data.

• Changed content type : application/json

  • Changed property status (string)

    Status of the operation result, indicating success, partial success, or error.

  • Changed property error (string)

    Error message, if any, associated with the result.

  • Changed property details (object)

    Additional details related to the result, stored as key-value pairs.

  • Changed property group (object)

    Data Transfer Object representing a group, including its properties and relationships.

    • Changed property uuid (string)

      Unique identifier for the group, if available.

    • Changed property name (string)

      Name of the group.

    • Changed property description (string)

      Description of the group.

    • Changed property discoveryType (string)

      Type of discovery used for the group, if applicable.

    • Changed property nodeType (string)

      Node type of the group, if applicable.

    • Changed property classifier (string)

      Classifier associated with the group.

    • Changed property referenceUuid (string)

      Reference UUID linked to the group, if applicable.

    • Changed property children (array)

      List of child groups under this group.

    • Changed property parentUuid (string)

      UUID of the parent group, if applicable.

    • Changed property parentName (string)

      Name of the parent group, if applicable.

    • Changed property childrenCount (integer)

      Number of child groups.

  • Changed property rule (object)

    Data Transfer Object representing a rule, including its attributes and conditions.

    • Changed property uuid (string)

      Unique identifier for the rule, if available.

    • Changed property classifier (string)

      Classifier type for the rule.

    • Changed property conditions (object -> string)

      Refer rule/conditions API for supported conditions properties and operators

    • Changed property targetGroupUuid (string)

      UUID of the target group associated with the rule, if applicable.

DELETE /rule/{uuid}

Parameters:

Changed: uuid in path

UUID of the rule to delete.

Return Type:

New response : 400 Bad Request

Bad Request

New response : 500 Internal Server Error

Internal Server Error

Changed response : 200 OK

Successfully deleted the rule.

• Changed content type : application/json

  • Changed property status (string)

    Status of the operation result, indicating success, partial success, or error.

  • Changed property error (string)

    Error message, if any, associated with the result.

  • Changed property details (object)

    Additional details related to the result, stored as key-value pairs.

  • Changed property group (object)

    Data Transfer Object representing a group, including its properties and relationships.

    • Changed property uuid (string)

      Unique identifier for the group, if available.

    • Changed property name (string)

      Name of the group.

    • Changed property description (string)

      Description of the group.

    • Changed property discoveryType (string)

      Type of discovery used for the group, if applicable.

    • Changed property nodeType (string)

      Node type of the group, if applicable.

    • Changed property classifier (string)

      Classifier associated with the group.

    • Changed property referenceUuid (string)

      Reference UUID linked to the group, if applicable.

    • Changed property children (array)

      List of child groups under this group.

    • Changed property parentUuid (string)

      UUID of the parent group, if applicable.

    • Changed property parentName (string)

      Name of the parent group, if applicable.

    • Changed property childrenCount (integer)

      Number of child groups.

  • Changed property rule (object)

    Data Transfer Object representing a rule, including its attributes and conditions.

    • Changed property uuid (string)

      Unique identifier for the rule, if available.

    • Changed property classifier (string)

      Classifier type for the rule.

    • Changed property conditions (object -> string)

      Refer rule/conditions API for supported conditions properties and operators

    • Changed property targetGroupUuid (string)

      UUID of the target group associated with the rule, if applicable.

PUT /group/{groupUuid}

Parameters:

Changed: groupUuid in path

UUID of the group to update.

Request:

Details of the group to be updated.

Changed content type : application/json

• Changed property name (string)

  Name of the group to be updated. This field is required.

• Changed property description (string)

  Optional description of the group.

• Changed property parentUuid (string)

  UUID of the parent group. This field is required.

Return Type:

New response : 400 Bad Request

Bad Request

New response : 500 Internal Server Error

Internal Server Error

Changed response : 200 OK

Successfully updated the group.

• Changed content type : application/json

  • Changed property status (string)

    Status of the operation result, indicating success, partial success, or error.

  • Changed property error (string)

    Error message, if any, associated with the result.

  • Changed property details (object)

    Additional details related to the result, stored as key-value pairs.

  • Changed property group (object)

    Data Transfer Object representing a group, including its properties and relationships.

    • Changed property uuid (string)

      Unique identifier for the group, if available.

    • Changed property name (string)

      Name of the group.

    • Changed property description (string)

      Description of the group.

    • Changed property discoveryType (string)

      Type of discovery used for the group, if applicable.

    • Changed property nodeType (string)

      Node type of the group, if applicable.

    • Changed property classifier (string)

      Classifier associated with the group.

    • Changed property referenceUuid (string)

      Reference UUID linked to the group, if applicable.

    • Changed property children (array)

      List of child groups under this group.

    • Changed property parentUuid (string)

      UUID of the parent group, if applicable.

    • Changed property parentName (string)

      Name of the parent group, if applicable.

    • Changed property childrenCount (integer)

      Number of child groups.

  • Changed property rule (object)

    Data Transfer Object representing a rule, including its attributes and conditions.

    • Changed property uuid (string)

      Unique identifier for the rule, if available.

    • Changed property classifier (string)

      Classifier type for the rule.

    • Changed property conditions (object -> string)

      Refer rule/conditions API for supported conditions properties and operators

    • Changed property targetGroupUuid (string)

      UUID of the target group associated with the rule, if applicable.

DELETE /group/{groupUuid}

Parameters:

Changed: groupUuid in path

UUID of the group to delete.

Return Type:

New response : 400 Bad Request

Bad Request

New response : 500 Internal Server Error

Internal Server Error

Changed response : 200 OK

Successfully deleted the group.

• Changed content type : application/json

  • Changed property status (string)

    Status of the operation result, indicating success, partial success, or error.

  • Changed property error (string)

    Error message, if any, associated with the result.

  • Changed property details (object)

    Additional details related to the result, stored as key-value pairs.

  • Changed property group (object)

    Data Transfer Object representing a group, including its properties and relationships.

    • Changed property uuid (string)

      Unique identifier for the group, if available.

    • Changed property name (string)

      Name of the group.

    • Changed property description (string)

      Description of the group.

    • Changed property discoveryType (string)

      Type of discovery used for the group, if applicable.

    • Changed property nodeType (string)

      Node type of the group, if applicable.

    • Changed property classifier (string)

      Classifier associated with the group.

    • Changed property referenceUuid (string)

      Reference UUID linked to the group, if applicable.

    • Changed property children (array)

      List of child groups under this group.

    • Changed property parentUuid (string)

      UUID of the parent group, if applicable.

    • Changed property parentName (string)

      Name of the parent group, if applicable.

    • Changed property childrenCount (integer)

      Number of child groups.

  • Changed property rule (object)

    Data Transfer Object representing a rule, including its attributes and conditions.

    • Changed property uuid (string)

      Unique identifier for the rule, if available.

    • Changed property classifier (string)

      Classifier type for the rule.

    • Changed property conditions (object -> string)

      Refer rule/conditions API for supported conditions properties and operators

    • Changed property targetGroupUuid (string)

      UUID of the target group associated with the rule, if applicable.

PUT /group/{groupUuid}/members

Delete members (e.g. devices)

Parameters:

Changed: groupUuid in path

UUID of the group from which members will be deleted.

Changed: selectAll in query

Indicates whether to select all members for deletion. Default is false.

Request:

Details of the members to be deleted.

Changed content type : application/json

• Changed property references (array)

  Collection of UUIDs representing the members (e.g., devices) to be deleted.

  Changed items (string):

  Collection of UUIDs representing the members (e.g., devices) to be deleted.

Return Type:

New response : 400 Bad Request

Bad Request

New response : 500 Internal Server Error

Internal Server Error

Changed response : 200 OK

Successfully deleted the specified members.

• Changed content type : application/json

  • Changed property status (string)

    Status of the operation result, indicating success, partial success, or error.

  • Changed property error (string)

    Error message, if any, associated with the result.

  • Changed property details (object)

    Additional details related to the result, stored as key-value pairs.

  • Changed property group (object)

    Data Transfer Object representing a group, including its properties and relationships.

    • Changed property uuid (string)

      Unique identifier for the group, if available.

    • Changed property name (string)

      Name of the group.

    • Changed property description (string)

      Description of the group.

    • Changed property discoveryType (string)

      Type of discovery used for the group, if applicable.

    • Changed property nodeType (string)

      Node type of the group, if applicable.

    • Changed property classifier (string)

      Classifier associated with the group.

    • Changed property referenceUuid (string)

      Reference UUID linked to the group, if applicable.

    • Changed property children (array)

      List of child groups under this group.

    • Changed property parentUuid (string)

      UUID of the parent group, if applicable.

    • Changed property parentName (string)

      Name of the parent group, if applicable.

    • Changed property childrenCount (integer)

      Number of child groups.

  • Changed property rule (object)

    Data Transfer Object representing a rule, including its attributes and conditions.

    • Changed property uuid (string)

      Unique identifier for the rule, if available.

    • Changed property classifier (string)

      Classifier type for the rule.

    • Changed property conditions (object -> string)

      Refer rule/conditions API for supported conditions properties and operators

    • Changed property targetGroupUuid (string)

      UUID of the target group associated with the rule, if applicable.

POST /rule

Request:

Details of the rule to be created.

Changed content type : application/json

• Changed property uuid (string)

  Unique identifier for the rule, if available.

• Changed property classifier (string)

  Classifier type for the rule.

• Changed property conditions (object -> string)

  Refer rule/conditions API for supported conditions properties and operators

• Changed property targetGroupUuid (string)

  UUID of the target group associated with the rule, if applicable.

Return Type:

New response : 400 Bad Request

Bad Request

New response : 500 Internal Server Error

Internal Server Error

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body, which is a generic structure containing only the relevant API return data.

• Changed content type : application/json

  • Changed property status (string)

    Status of the operation result, indicating success, partial success, or error.

  • Changed property error (string)

    Error message, if any, associated with the result.

  • Changed property details (object)

    Additional details related to the result, stored as key-value pairs.

  • Changed property group (object)

    Data Transfer Object representing a group, including its properties and relationships.

    • Changed property uuid (string)

      Unique identifier for the group, if available.

    • Changed property name (string)

      Name of the group.

    • Changed property description (string)

      Description of the group.

    • Changed property discoveryType (string)

      Type of discovery used for the group, if applicable.

    • Changed property nodeType (string)

      Node type of the group, if applicable.

    • Changed property classifier (string)

      Classifier associated with the group.

    • Changed property referenceUuid (string)

      Reference UUID linked to the group, if applicable.

    • Changed property children (array)

      List of child groups under this group.

    • Changed property parentUuid (string)

      UUID of the parent group, if applicable.

    • Changed property parentName (string)

      Name of the parent group, if applicable.

    • Changed property childrenCount (integer)

      Number of child groups.

  • Changed property rule (object)

    Data Transfer Object representing a rule, including its attributes and conditions.

    • Changed property uuid (string)

      Unique identifier for the rule, if available.

    • Changed property classifier (string)

      Classifier type for the rule.

    • Changed property conditions (object -> string)

      Refer rule/conditions API for supported conditions properties and operators

    • Changed property targetGroupUuid (string)

      UUID of the target group associated with the rule, if applicable.

GET /port/{groupUuid}

Parameters:

Changed: groupUuid in path

UUID of the group for which ports are to be retrieved.

Changed: mode in query

Mode in which to retrieve ports. Optional parameter.

Return Type:

New response : 400 Bad Request

Bad Request

New response : 500 Internal Server Error

Internal Server Error

Changed response : 200 OK

Successfully retrieved the ports.

• Changed content type : application/json

  • Changed property status (string)

    Status of the operation result, indicating success, partial success, or error.

  • Changed property error (string)

    Error message, if any, associated with the result.

  • Changed property details (object)

    Additional details related to the result, stored as key-value pairs.

  • Changed property total (integer)

    Total number of ports included in the result.

  • Changed property group (object)

    Data Transfer Object representing a group, including its properties and relationships.

    • Changed property uuid (string)

      Unique identifier for the group, if available.

    • Changed property name (string)

      Name of the group.

    • Changed property description (string)

      Description of the group.

    • Changed property discoveryType (string)

      Type of discovery used for the group, if applicable.

    • Changed property nodeType (string)

      Node type of the group, if applicable.

    • Changed property classifier (string)

      Classifier associated with the group.

    • Changed property referenceUuid (string)

      Reference UUID linked to the group, if applicable.

    • Changed property children (array)

      List of child groups under this group.

    • Changed property parentUuid (string)

      UUID of the parent group, if applicable.

    • Changed property parentName (string)

      Name of the parent group, if applicable.

    • Changed property childrenCount (integer)

      Number of child groups.

  • Changed property rule (object)

    Data Transfer Object representing a rule, including its attributes and conditions.

    • Changed property uuid (string)

      Unique identifier for the rule, if available.

    • Changed property classifier (string)

      Classifier type for the rule.

    • Changed property conditions (object -> string)

      Refer rule/conditions API for supported conditions properties and operators

    • Changed property targetGroupUuid (string)

      UUID of the target group associated with the rule, if applicable.

  • Changed property ports (array)

    Collection of PortDTO objects representing the ports involved in the operation.

    Changed items (object):

    Data Transfer Object representing a port, including its attributes such as UUIDs, name, type, and more.

    • Changed property portUuid (string)

      Unique identifier for the port.

    • Changed property deviceUuid (string)

      UUID of the device to which the port belongs.

    • Changed property node_ip (string)

      IP address of the node associated with the port.

    • Changed property hostName (string)

      Host name associated with the port.

    • Changed property portName (string)

      Name of the port.

    • Changed property description (string)

      Description of the port.

    • Changed property speed (string)

      Speed of the port.

    • Changed property type (string)

      Type of the port, indicating its function or role.

    • Changed property delete (boolean)

      Flag indicating whether the port is marked for deletion.

    • Changed property discoveryType (string)

      Type of discovery mechanism used for the port.

POST /port/{groupUuid}

Parameters:

Changed: groupUuid in path

UUID of the group to which ports will be manually added.

Request:

Details of the ports to be added.

Changed content type : application/json

• Changed property ports (array)

  Collection of PortDTO objects representing the ports to be added or deleted, with a maximum size of 10,000.

  Changed items (object):

  Data Transfer Object representing a port, including its attributes such as UUIDs, name, type, and more.

  • Changed property portUuid (string)

    Unique identifier for the port.

  • Changed property deviceUuid (string)

    UUID of the device to which the port belongs.

  • Changed property node_ip (string)

    IP address of the node associated with the port.

  • Changed property hostName (string)

    Host name associated with the port.

  • Changed property portName (string)

    Name of the port.

  • Changed property description (string)

    Description of the port.

  • Changed property speed (string)

    Speed of the port.

  • Changed property type (string)

    Type of the port, indicating its function or role.

  • Changed property delete (boolean)

    Flag indicating whether the port is marked for deletion.

  • Changed property discoveryType (string)

    Type of discovery mechanism used for the port.

Return Type:

New response : 400 Bad Request

Bad Request

New response : 500 Internal Server Error

Internal Server Error

Changed response : 200 OK

Successfully added the ports.

• Changed content type : application/json

  • Changed property status (string)

    Status of the operation result, indicating success, partial success, or error.

  • Changed property error (string)

    Error message, if any, associated with the result.

  • Changed property details (object)

    Additional details related to the result, stored as key-value pairs.

  • Changed property group (object)

    Data Transfer Object representing a group, including its properties and relationships.

    • Changed property uuid (string)

      Unique identifier for the group, if available.

    • Changed property name (string)

      Name of the group.

    • Changed property description (string)

      Description of the group.

    • Changed property discoveryType (string)

      Type of discovery used for the group, if applicable.

    • Changed property nodeType (string)

      Node type of the group, if applicable.

    • Changed property classifier (string)

      Classifier associated with the group.

    • Changed property referenceUuid (string)

      Reference UUID linked to the group, if applicable.

    • Changed property children (array)

      List of child groups under this group.

    • Changed property parentUuid (string)

      UUID of the parent group, if applicable.

    • Changed property parentName (string)

      Name of the parent group, if applicable.

    • Changed property childrenCount (integer)

      Number of child groups.

  • Changed property rule (object)

    Data Transfer Object representing a rule, including its attributes and conditions.

    • Changed property uuid (string)

      Unique identifier for the rule, if available.

    • Changed property classifier (string)

      Classifier type for the rule.

    • Changed property conditions (object -> string)

      Refer rule/conditions API for supported conditions properties and operators

    • Changed property targetGroupUuid (string)

      UUID of the target group associated with the rule, if applicable.

DELETE /port/{groupUuid}

Parameters:

Changed: groupUuid in path

UUID of the group from which ports will be manually deleted.

Changed: selectAll in query

Flag to indicate if all ports should be selected for deletion. Default is false.

Request:

Details of the ports to be deleted.

Changed content type : application/json

• Changed property ports (array)

  Collection of PortDTO objects representing the ports to be added or deleted, with a maximum size of 10,000.

  Changed items (object):

  Data Transfer Object representing a port, including its attributes such as UUIDs, name, type, and more.

  • Changed property portUuid (string)

    Unique identifier for the port.

  • Changed property deviceUuid (string)

    UUID of the device to which the port belongs.

  • Changed property node_ip (string)

    IP address of the node associated with the port.

  • Changed property hostName (string)

    Host name associated with the port.

  • Changed property portName (string)

    Name of the port.

  • Changed property description (string)

    Description of the port.

  • Changed property speed (string)

    Speed of the port.

  • Changed property type (string)

    Type of the port, indicating its function or role.

  • Changed property delete (boolean)

    Flag indicating whether the port is marked for deletion.

  • Changed property discoveryType (string)

    Type of discovery mechanism used for the port.

Return Type:

New response : 400 Bad Request

Bad Request

New response : 500 Internal Server Error

Internal Server Error

Changed response : 200 OK

Successfully deleted the ports.

• Changed content type : application/json

  • Changed property status (string)

    Status of the operation result, indicating success, partial success, or error.

  • Changed property error (string)

    Error message, if any, associated with the result.

  • Changed property details (object)

    Additional details related to the result, stored as key-value pairs.

  • Changed property group (object)

    Data Transfer Object representing a group, including its properties and relationships.

    • Changed property uuid (string)

      Unique identifier for the group, if available.

    • Changed property name (string)

      Name of the group.

    • Changed property description (string)

      Description of the group.

    • Changed property discoveryType (string)

      Type of discovery used for the group, if applicable.

    • Changed property nodeType (string)

      Node type of the group, if applicable.

    • Changed property classifier (string)

      Classifier associated with the group.

    • Changed property referenceUuid (string)

      Reference UUID linked to the group, if applicable.

    • Changed property children (array)

      List of child groups under this group.

    • Changed property parentUuid (string)

      UUID of the parent group, if applicable.

    • Changed property parentName (string)

      Name of the parent group, if applicable.

    • Changed property childrenCount (integer)

      Number of child groups.

  • Changed property rule (object)

    Data Transfer Object representing a rule, including its attributes and conditions.

    • Changed property uuid (string)

      Unique identifier for the rule, if available.

    • Changed property classifier (string)

      Classifier type for the rule.

    • Changed property conditions (object -> string)

      Refer rule/conditions API for supported conditions properties and operators

    • Changed property targetGroupUuid (string)

      UUID of the target group associated with the rule, if applicable.

POST /group

Request:

Details of the group to be created.

Changed content type : application/json

• Changed property name (string)

  Name of the group to be created. This field is required.

• Changed property description (string)

  Optional description of the group.

• Changed property classifier (string)

  Classifier type for the group.

• Changed property parentUuid (string)

  UUID of the parent group, if applicable.

Return Type:

New response : 400 Bad Request

Bad Request

New response : 500 Internal Server Error

Internal Server Error

Changed response : 200 OK

Successfully created the group.

• Changed content type : application/json

  • Changed property status (string)

    Status of the operation result, indicating success, partial success, or error.

  • Changed property error (string)

    Error message, if any, associated with the result.

  • Changed property details (object)

    Additional details related to the result, stored as key-value pairs.

  • Changed property group (object)

    Data Transfer Object representing a group, including its properties and relationships.

    • Changed property uuid (string)

      Unique identifier for the group, if available.

    • Changed property name (string)

      Name of the group.

    • Changed property description (string)

      Description of the group.

    • Changed property discoveryType (string)

      Type of discovery used for the group, if applicable.

    • Changed property nodeType (string)

      Node type of the group, if applicable.

    • Changed property classifier (string)

      Classifier associated with the group.

    • Changed property referenceUuid (string)

      Reference UUID linked to the group, if applicable.

    • Changed property children (array)

      List of child groups under this group.

    • Changed property parentUuid (string)

      UUID of the parent group, if applicable.

    • Changed property parentName (string)

      Name of the parent group, if applicable.

    • Changed property childrenCount (integer)

      Number of child groups.

  • Changed property rule (object)

    Data Transfer Object representing a rule, including its attributes and conditions.

    • Changed property uuid (string)

      Unique identifier for the rule, if available.

    • Changed property classifier (string)

      Classifier type for the rule.

    • Changed property conditions (object -> string)

      Refer rule/conditions API for supported conditions properties and operators

    • Changed property targetGroupUuid (string)

      UUID of the target group associated with the rule, if applicable.

POST /group/member/move

Parameters:

Changed: selectAll in query

Flag to indicate if all members should be selected for moving. Default is false.

Request:

Details of the members to be moved, including source and destination group information.

Changed content type : application/json

• Changed property groupUuid (string)

  UUID of the source group from which members are to be copied or moved.

• Changed property newGroupUuid (string)

  UUID of the target group to which members are to be copied or moved.

• Changed property references (array)

  Collection of UUIDs representing the members (e.g., devices) to be copied or moved, with a maximum size of 10,000.

  Changed items (string):

  Collection of UUIDs representing the members (e.g., devices) to be copied or moved, with a maximum size of 10,000.

Return Type:

New response : 400 Bad Request

Bad Request

New response : 500 Internal Server Error

Internal Server Error

Changed response : 200 OK

Successfully moved the members.

• Changed content type : application/json

  • Changed property status (string)

    Status of the operation result, indicating success, partial success, or error.

  • Changed property error (string)

    Error message, if any, associated with the result.

  • Changed property details (object)

    Additional details related to the result, stored as key-value pairs.

  • Changed property group (object)

    Data Transfer Object representing a group, including its properties and relationships.

    • Changed property uuid (string)

      Unique identifier for the group, if available.

    • Changed property name (string)

      Name of the group.

    • Changed property description (string)

      Description of the group.

    • Changed property discoveryType (string)

      Type of discovery used for the group, if applicable.

    • Changed property nodeType (string)

      Node type of the group, if applicable.

    • Changed property classifier (string)

      Classifier associated with the group.

    • Changed property referenceUuid (string)

      Reference UUID linked to the group, if applicable.

    • Changed property children (array)

      List of child groups under this group.

    • Changed property parentUuid (string)

      UUID of the parent group, if applicable.

    • Changed property parentName (string)

      Name of the parent group, if applicable.

    • Changed property childrenCount (integer)

      Number of child groups.

  • Changed property rule (object)

    Data Transfer Object representing a rule, including its attributes and conditions.

    • Changed property uuid (string)

      Unique identifier for the rule, if available.

    • Changed property classifier (string)

      Classifier type for the rule.

    • Changed property conditions (object -> string)

      Refer rule/conditions API for supported conditions properties and operators

    • Changed property targetGroupUuid (string)

      UUID of the target group associated with the rule, if applicable.

POST /group/member/copy

Parameters:

Changed: selectAll in query

Flag to indicate if all member s should be selected for copying. Default is false.

Request:

Details of the members to be copied, including source and destination group information.

Changed content type : application/json

• Changed property groupUuid (string)

  UUID of the source group from which members are to be copied or moved.

• Changed property newGroupUuid (string)

  UUID of the target group to which members are to be copied or moved.

• Changed property references (array)

  Collection of UUIDs representing the members (e.g., devices) to be copied or moved, with a maximum size of 10,000.

  Changed items (string):

  Collection of UUIDs representing the members (e.g., devices) to be copied or moved, with a maximum size of 10,000.

Return Type:

New response : 400 Bad Request

Bad Request

New response : 500 Internal Server Error

Internal Server Error

Changed response : 200 OK

Successfully copied the members.

• Changed content type : application/json

  • Changed property status (string)

    Status of the operation result, indicating success, partial success, or error.

  • Changed property error (string)

    Error message, if any, associated with the result.

  • Changed property details (object)

    Additional details related to the result, stored as key-value pairs.

  • Changed property group (object)

    Data Transfer Object representing a group, including its properties and relationships.

    • Changed property uuid (string)

      Unique identifier for the group, if available.

    • Changed property name (string)

      Name of the group.

    • Changed property description (string)

      Description of the group.

    • Changed property discoveryType (string)

      Type of discovery used for the group, if applicable.

    • Changed property nodeType (string)

      Node type of the group, if applicable.

    • Changed property classifier (string)

      Classifier associated with the group.

    • Changed property referenceUuid (string)

      Reference UUID linked to the group, if applicable.

    • Changed property children (array)

      List of child groups under this group.

    • Changed property parentUuid (string)

      UUID of the parent group, if applicable.

    • Changed property parentName (string)

      Name of the parent group, if applicable.

    • Changed property childrenCount (integer)

      Number of child groups.

  • Changed property rule (object)

    Data Transfer Object representing a rule, including its attributes and conditions.

    • Changed property uuid (string)

      Unique identifier for the rule, if available.

    • Changed property classifier (string)

      Classifier type for the rule.

    • Changed property conditions (object -> string)

      Refer rule/conditions API for supported conditions properties and operators

    • Changed property targetGroupUuid (string)

      UUID of the target group associated with the rule, if applicable.

GET /rule/group/{groupUuid}

Parameters:

Changed: groupUuid in path

UUID of the group for which rules are to be retrieved.

Return Type:

New response : 400 Bad Request

Bad Request

New response : 500 Internal Server Error

Internal Server Error

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body, which is a generic structure containing only the relevant API return data.

• Changed content type : application/json

  • Changed property status (string)

    Status of the operation result, indicating success, partial success, or error.

  • Changed property error (string)

    Error message, if any, associated with the result.

  • Changed property details (object)

    Additional details related to the result, stored as key-value pairs.

  • Changed property group (object)

    Data Transfer Object representing a group, including its properties and relationships.

    • Changed property uuid (string)

      Unique identifier for the group, if available.

    • Changed property name (string)

      Name of the group.

    • Changed property description (string)

      Description of the group.

    • Changed property discoveryType (string)

      Type of discovery used for the group, if applicable.

    • Changed property nodeType (string)

      Node type of the group, if applicable.

    • Changed property classifier (string)

      Classifier associated with the group.

    • Changed property referenceUuid (string)

      Reference UUID linked to the group, if applicable.

    • Changed property children (array)

      List of child groups under this group.

    • Changed property parentUuid (string)

      UUID of the parent group, if applicable.

    • Changed property parentName (string)

      Name of the parent group, if applicable.

    • Changed property childrenCount (integer)

      Number of child groups.

  • Changed property rule (object)

    Data Transfer Object representing a rule, including its attributes and conditions.

    • Changed property uuid (string)

      Unique identifier for the rule, if available.

    • Changed property classifier (string)

      Classifier type for the rule.

    • Changed property conditions (object -> string)

      Refer rule/conditions API for supported conditions properties and operators

    • Changed property targetGroupUuid (string)

      UUID of the target group associated with the rule, if applicable.

GET /group/{groupUuid}/details

Parameters:

Changed: groupUuid in path

UUID of the group whose details are to be retrieved.

Return Type:

New response : 400 Bad Request

Bad Request

New response : 500 Internal Server Error

Internal Server Error

Changed response : 200 OK

OK

• Changed content type : application/json

  • Changed property status (string)

    Status of the operation result, indicating success, partial success, or error.

  • Changed property error (string)

    Error message, if any, associated with the result.

  • Changed property details (object)

    Additional details related to the result, stored as key-value pairs.

  • Changed property group (object)

    Data Transfer Object representing a group, including its properties and relationships.

    • Changed property uuid (string)

      Unique identifier for the group, if available.

    • Changed property name (string)

      Name of the group.

    • Changed property description (string)

      Description of the group.

    • Changed property discoveryType (string)

      Type of discovery used for the group, if applicable.

    • Changed property nodeType (string)

      Node type of the group, if applicable.

    • Changed property classifier (string)

      Classifier associated with the group.

    • Changed property referenceUuid (string)

      Reference UUID linked to the group, if applicable.

    • Changed property children (array)

      List of child groups under this group.

    • Changed property parentUuid (string)

      UUID of the parent group, if applicable.

    • Changed property parentName (string)

      Name of the parent group, if applicable.

    • Changed property childrenCount (integer)

      Number of child groups.

  • Changed property rule (object)

    Data Transfer Object representing a rule, including its attributes and conditions.

    • Changed property uuid (string)

      Unique identifier for the rule, if available.

    • Changed property classifier (string)

      Classifier type for the rule.

    • Changed property conditions (object -> string)

      Refer rule/conditions API for supported conditions properties and operators

    • Changed property targetGroupUuid (string)

      UUID of the target group associated with the rule, if applicable.

GET /device/{groupUuid}

Parameters:

Changed: groupUuid in path

UUID of the group whose associated devices are to be retrieved.

Return Type:

New response : 400 Bad Request

Bad Request

New response : 500 Internal Server Error

Internal Server Error

Changed response : 200 OK

Successfully retrieved the devices associated with the group UUID.

• Changed content type : application/json

  • Changed property status (string)

    Status of the operation result, indicating success, partial success, or error.

  • Changed property error (string)

    Error message, if any, associated with the result.

  • Changed property details (object)

    Additional details related to the result, stored as key-value pairs.

  • Changed property total (integer)

    Total number of devices included in the result.

  • Changed property group (object)

    Data Transfer Object representing a group, including its properties and relationships.

    • Changed property uuid (string)

      Unique identifier for the group, if available.

    • Changed property name (string)

      Name of the group.

    • Changed property description (string)

      Description of the group.

    • Changed property discoveryType (string)

      Type of discovery used for the group, if applicable.

    • Changed property nodeType (string)

      Node type of the group, if applicable.

    • Changed property classifier (string)

      Classifier associated with the group.

    • Changed property referenceUuid (string)

      Reference UUID linked to the group, if applicable.

    • Changed property children (array)

      List of child groups under this group.

    • Changed property parentUuid (string)

      UUID of the parent group, if applicable.

    • Changed property parentName (string)

      Name of the parent group, if applicable.

    • Changed property childrenCount (integer)

      Number of child groups.

  • Changed property rule (object)

    Data Transfer Object representing a rule, including its attributes and conditions.

    • Changed property uuid (string)

      Unique identifier for the rule, if available.

    • Changed property classifier (string)

      Classifier type for the rule.

    • Changed property conditions (object -> string)

      Refer rule/conditions API for supported conditions properties and operators

    • Changed property targetGroupUuid (string)

      UUID of the target group associated with the rule, if applicable.

  • Changed property devices (array)

    Collection of DeviceDTO objects representing the devices involved in the operation.

    Changed items (object):

    Data Transfer Object representing a device, including its unique identifier and attributes.

    • Changed property uuid (string)

      Unique identifier for the device. This field is required.

    • Changed property attributes (object)

      Map of attributes associated with the device, with a maximum of 100 entries.

GET /ports/rule/conditions

Return Type:

New response : 400 Bad Request

Bad Request

New response : 500 Internal Server Error

Internal Server Error

Changed response : 200 OK

OK

• Changed content type : application/json

  • Changed property conditions (array)

    Adds a dynamic rule condition to the existing set of conditions.

    Changed items (object):

    Data Transfer Object representing a rule condition, including its attribute name, type, and operators.

    • Changed property attributeName (string)

      Name of the attribute associated with the condition.

    • Changed property type (string)

      Type of the rule condition, determining if it applies to strings or numbers.

    • Changed property operators (array)

      Set of operators applicable to the rule condition.

      Changed items (object):

      Data Transfer Object representing an operator for rule conditions, including its name and optional predefined values.

      • Changed property operatorName (string)

        Name of the operator, which is required.

      • Changed property preDefinedValues (array)

        Set of predefined values associated with the operator, if applicable.

        Changed items (object):

        Set of predefined values associated with the operator, if applicable.

GET /device/rule/conditions

Return Type:

New response : 400 Bad Request

Bad Request

New response : 500 Internal Server Error

Internal Server Error

Changed response : 200 OK

Successfully retrieved the device rules, conditions, supported operators, and attributes.

• Changed content type : application/json

  • Changed property conditions (array)

    Set of rule conditions representing various criteria such as hostname, IP address, reachability, and product specifications.

    Changed items (object):

    Data Transfer Object representing a rule condition, including its attribute name, type, and operators.

    • Changed property attributeName (string)

      Name of the attribute associated with the condition.

    • Changed property type (string)

      Type of the rule condition, determining if it applies to strings or numbers.

    • Changed property operators (array)

      Set of operators applicable to the rule condition.

      Changed items (object):

      Data Transfer Object representing an operator for rule conditions, including its name and optional predefined values.

      • Changed property operatorName (string)

        Name of the operator, which is required.

      • Changed property preDefinedValues (array)

        Set of predefined values associated with the operator, if applicable.

        Changed items (object):

        Set of predefined values associated with the operator, if applicable.