Rule Group
This endpoint is used to fetch all the configuration trigger in the current organization
Items Per Page
Page Number
Sorting Order
Sorting Key
GET /ux/nccm/policy_rule_group/?items_per_page=1&page=1 HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
[
{
"id": "text",
"created_by_name": "text",
"modified_by_name": "text",
"creationtime": "text",
"last_update_time": "text",
"status_opt": "text",
"status": "text",
"device_tags": "text",
"associated_rules": "text",
"rule_map": "text",
"created_by_profile": "text",
"modified_by_profile": "text",
"rulegroupid": "text",
"name": "text",
"organization": "text",
"description": "text",
"activation": true,
"iprange": "text",
"exclude_ips": "text",
"vendor": "text",
"os_type": "text",
"modified_by": 1,
"created_by": 1,
"activated_by": 1,
"activation_time": "2025-12-06T06:35:35.286Z",
"is_deleted": true,
"assigned_users": [],
"assigned_group": [],
"is_private": true
}
]This endpoint is used to save a new configuration profile for the current organization
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
POST /ux/nccm/policy_rule_group/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 337
{
"rulegroupid": "text",
"name": "text",
"organization": "text",
"description": "text",
"activation": true,
"iprange": "text",
"exclude_ips": "text",
"vendor": "text",
"os_type": "text",
"modified_by": 1,
"created_by": 1,
"activated_by": 1,
"activation_time": "2025-12-06T06:35:35.286Z",
"is_deleted": true,
"assigned_users": [],
"assigned_group": [],
"is_private": true
}{
"id": "text",
"created_by_name": "text",
"modified_by_name": "text",
"creationtime": "text",
"last_update_time": "text",
"status_opt": "text",
"status": "text",
"device_tags": "text",
"associated_rules": "text",
"rule_map": "text",
"created_by_profile": "text",
"modified_by_profile": "text",
"rulegroupid": "text",
"name": "text",
"organization": "text",
"description": "text",
"activation": true,
"iprange": "text",
"exclude_ips": "text",
"vendor": "text",
"os_type": "text",
"modified_by": 1,
"created_by": 1,
"activated_by": 1,
"activation_time": "2025-12-06T06:35:35.286Z",
"is_deleted": true,
"assigned_users": [],
"assigned_group": [],
"is_private": true
}API endpoint that allows users to be viewed or edited.
GET /ux/nccm/policy_rule_group/{id}/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"id": "text",
"created_by_name": "text",
"modified_by_name": "text",
"creationtime": "text",
"last_update_time": "text",
"status_opt": "text",
"status": "text",
"device_tags": "text",
"associated_rules": "text",
"rule_map": "text",
"created_by_profile": "text",
"modified_by_profile": "text",
"rulegroupid": "text",
"name": "text",
"organization": "text",
"description": "text",
"activation": true,
"iprange": "text",
"exclude_ips": "text",
"vendor": "text",
"os_type": "text",
"modified_by": 1,
"created_by": 1,
"activated_by": 1,
"activation_time": "2025-12-06T06:35:35.286Z",
"is_deleted": true,
"assigned_users": [],
"assigned_group": [],
"is_private": true
}API endpoint that allows users to be viewed or edited.
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
PUT /ux/nccm/policy_rule_group/{id}/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 337
{
"rulegroupid": "text",
"name": "text",
"organization": "text",
"description": "text",
"activation": true,
"iprange": "text",
"exclude_ips": "text",
"vendor": "text",
"os_type": "text",
"modified_by": 1,
"created_by": 1,
"activated_by": 1,
"activation_time": "2025-12-06T06:35:35.286Z",
"is_deleted": true,
"assigned_users": [],
"assigned_group": [],
"is_private": true
}{
"id": "text",
"created_by_name": "text",
"modified_by_name": "text",
"creationtime": "text",
"last_update_time": "text",
"status_opt": "text",
"status": "text",
"device_tags": "text",
"associated_rules": "text",
"rule_map": "text",
"created_by_profile": "text",
"modified_by_profile": "text",
"rulegroupid": "text",
"name": "text",
"organization": "text",
"description": "text",
"activation": true,
"iprange": "text",
"exclude_ips": "text",
"vendor": "text",
"os_type": "text",
"modified_by": 1,
"created_by": 1,
"activated_by": 1,
"activation_time": "2025-12-06T06:35:35.286Z",
"is_deleted": true,
"assigned_users": [],
"assigned_group": [],
"is_private": true
}This endpoint is used to delete an existing rule group for the current organization
No response body
DELETE /ux/nccm/policy_rule_group/{id}/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
API endpoint that allows users to be viewed or edited.
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
POST /ux/nccm/policy_rule_group/bulk-opration/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 337
{
"rulegroupid": "text",
"name": "text",
"organization": "text",
"description": "text",
"activation": true,
"iprange": "text",
"exclude_ips": "text",
"vendor": "text",
"os_type": "text",
"modified_by": 1,
"created_by": 1,
"activated_by": 1,
"activation_time": "2025-12-06T06:35:35.286Z",
"is_deleted": true,
"assigned_users": [],
"assigned_group": [],
"is_private": true
}{
"id": "text",
"created_by_name": "text",
"modified_by_name": "text",
"creationtime": "text",
"last_update_time": "text",
"status_opt": "text",
"status": "text",
"device_tags": "text",
"associated_rules": "text",
"rule_map": "text",
"created_by_profile": "text",
"modified_by_profile": "text",
"rulegroupid": "text",
"name": "text",
"organization": "text",
"description": "text",
"activation": true,
"iprange": "text",
"exclude_ips": "text",
"vendor": "text",
"os_type": "text",
"modified_by": 1,
"created_by": 1,
"activated_by": 1,
"activation_time": "2025-12-06T06:35:35.286Z",
"is_deleted": true,
"assigned_users": [],
"assigned_group": [],
"is_private": true
}API endpoint that allows users to be viewed or edited.
GET /ux/nccm/policy_rule_group/get-configuration-rules/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"id": "text",
"created_by_name": "text",
"modified_by_name": "text",
"creationtime": "text",
"last_update_time": "text",
"status_opt": "text",
"status": "text",
"device_tags": "text",
"associated_rules": "text",
"rule_map": "text",
"created_by_profile": "text",
"modified_by_profile": "text",
"rulegroupid": "text",
"name": "text",
"organization": "text",
"description": "text",
"activation": true,
"iprange": "text",
"exclude_ips": "text",
"vendor": "text",
"os_type": "text",
"modified_by": 1,
"created_by": 1,
"activated_by": 1,
"activation_time": "2025-12-06T06:35:35.286Z",
"is_deleted": true,
"assigned_users": [],
"assigned_group": [],
"is_private": true
}API endpoint that allows users to be viewed or edited.
GET /ux/nccm/policy_rule_group/get-os-from-rule/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"id": "text",
"created_by_name": "text",
"modified_by_name": "text",
"creationtime": "text",
"last_update_time": "text",
"status_opt": "text",
"status": "text",
"device_tags": "text",
"associated_rules": "text",
"rule_map": "text",
"created_by_profile": "text",
"modified_by_profile": "text",
"rulegroupid": "text",
"name": "text",
"organization": "text",
"description": "text",
"activation": true,
"iprange": "text",
"exclude_ips": "text",
"vendor": "text",
"os_type": "text",
"modified_by": 1,
"created_by": 1,
"activated_by": 1,
"activation_time": "2025-12-06T06:35:35.286Z",
"is_deleted": true,
"assigned_users": [],
"assigned_group": [],
"is_private": true
}API endpoint that allows users to be viewed or edited.
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
POST /ux/nccm/policy_rule_group/get-runtime-params/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 337
{
"rulegroupid": "text",
"name": "text",
"organization": "text",
"description": "text",
"activation": true,
"iprange": "text",
"exclude_ips": "text",
"vendor": "text",
"os_type": "text",
"modified_by": 1,
"created_by": 1,
"activated_by": 1,
"activation_time": "2025-12-06T06:35:35.286Z",
"is_deleted": true,
"assigned_users": [],
"assigned_group": [],
"is_private": true
}{
"id": "text",
"created_by_name": "text",
"modified_by_name": "text",
"creationtime": "text",
"last_update_time": "text",
"status_opt": "text",
"status": "text",
"device_tags": "text",
"associated_rules": "text",
"rule_map": "text",
"created_by_profile": "text",
"modified_by_profile": "text",
"rulegroupid": "text",
"name": "text",
"organization": "text",
"description": "text",
"activation": true,
"iprange": "text",
"exclude_ips": "text",
"vendor": "text",
"os_type": "text",
"modified_by": 1,
"created_by": 1,
"activated_by": 1,
"activation_time": "2025-12-06T06:35:35.286Z",
"is_deleted": true,
"assigned_users": [],
"assigned_group": [],
"is_private": true
}API endpoint that allows users to be viewed or edited.
GET /ux/nccm/policy_rule_group/get_init_options/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"id": "text",
"created_by_name": "text",
"modified_by_name": "text",
"creationtime": "text",
"last_update_time": "text",
"status_opt": "text",
"status": "text",
"device_tags": "text",
"associated_rules": "text",
"rule_map": "text",
"created_by_profile": "text",
"modified_by_profile": "text",
"rulegroupid": "text",
"name": "text",
"organization": "text",
"description": "text",
"activation": true,
"iprange": "text",
"exclude_ips": "text",
"vendor": "text",
"os_type": "text",
"modified_by": 1,
"created_by": 1,
"activated_by": 1,
"activation_time": "2025-12-06T06:35:35.286Z",
"is_deleted": true,
"assigned_users": [],
"assigned_group": [],
"is_private": true
}This endpoint is used to delete an existing rule group for the current organization
GET /ux/nccm/policy_rule_group/get_rule_group_by_id/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"id": "text",
"created_by_name": "text",
"modified_by_name": "text",
"creationtime": "text",
"last_update_time": "text",
"status_opt": "text",
"status": "text",
"device_tags": "text",
"associated_rules": "text",
"rule_map": "text",
"created_by_profile": "text",
"modified_by_profile": "text",
"rulegroupid": "text",
"name": "text",
"organization": "text",
"description": "text",
"activation": true,
"iprange": "text",
"exclude_ips": "text",
"vendor": "text",
"os_type": "text",
"modified_by": 1,
"created_by": 1,
"activated_by": 1,
"activation_time": "2025-12-06T06:35:35.286Z",
"is_deleted": true,
"assigned_users": [],
"assigned_group": [],
"is_private": true
}API endpoint that allows users to be viewed or edited.
GET /ux/nccm/policy_rule_group/save-associated-rule/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"id": "text",
"created_by_name": "text",
"modified_by_name": "text",
"creationtime": "text",
"last_update_time": "text",
"status_opt": "text",
"status": "text",
"device_tags": "text",
"associated_rules": "text",
"rule_map": "text",
"created_by_profile": "text",
"modified_by_profile": "text",
"rulegroupid": "text",
"name": "text",
"organization": "text",
"description": "text",
"activation": true,
"iprange": "text",
"exclude_ips": "text",
"vendor": "text",
"os_type": "text",
"modified_by": 1,
"created_by": 1,
"activated_by": 1,
"activation_time": "2025-12-06T06:35:35.286Z",
"is_deleted": true,
"assigned_users": [],
"assigned_group": [],
"is_private": true
}API endpoint that allows users to be viewed or edited.
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
POST /ux/nccm/policy_rule_group/status-updation/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 337
{
"rulegroupid": "text",
"name": "text",
"organization": "text",
"description": "text",
"activation": true,
"iprange": "text",
"exclude_ips": "text",
"vendor": "text",
"os_type": "text",
"modified_by": 1,
"created_by": 1,
"activated_by": 1,
"activation_time": "2025-12-06T06:35:35.286Z",
"is_deleted": true,
"assigned_users": [],
"assigned_group": [],
"is_private": true
}{
"id": "text",
"created_by_name": "text",
"modified_by_name": "text",
"creationtime": "text",
"last_update_time": "text",
"status_opt": "text",
"status": "text",
"device_tags": "text",
"associated_rules": "text",
"rule_map": "text",
"created_by_profile": "text",
"modified_by_profile": "text",
"rulegroupid": "text",
"name": "text",
"organization": "text",
"description": "text",
"activation": true,
"iprange": "text",
"exclude_ips": "text",
"vendor": "text",
"os_type": "text",
"modified_by": 1,
"created_by": 1,
"activated_by": 1,
"activation_time": "2025-12-06T06:35:35.286Z",
"is_deleted": true,
"assigned_users": [],
"assigned_group": [],
"is_private": true
}API endpoint that allows users to be viewed or edited.
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
POST /ux/nccm/policy_rule_group/validate-uploaded-file/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 337
{
"rulegroupid": "text",
"name": "text",
"organization": "text",
"description": "text",
"activation": true,
"iprange": "text",
"exclude_ips": "text",
"vendor": "text",
"os_type": "text",
"modified_by": 1,
"created_by": 1,
"activated_by": 1,
"activation_time": "2025-12-06T06:35:35.286Z",
"is_deleted": true,
"assigned_users": [],
"assigned_group": [],
"is_private": true
}{
"id": "text",
"created_by_name": "text",
"modified_by_name": "text",
"creationtime": "text",
"last_update_time": "text",
"status_opt": "text",
"status": "text",
"device_tags": "text",
"associated_rules": "text",
"rule_map": "text",
"created_by_profile": "text",
"modified_by_profile": "text",
"rulegroupid": "text",
"name": "text",
"organization": "text",
"description": "text",
"activation": true,
"iprange": "text",
"exclude_ips": "text",
"vendor": "text",
"os_type": "text",
"modified_by": 1,
"created_by": 1,
"activated_by": 1,
"activation_time": "2025-12-06T06:35:35.286Z",
"is_deleted": true,
"assigned_users": [],
"assigned_group": [],
"is_private": true
}Last updated