Rule Group

PreviousOS Image Download NextConfiguration Upload Jobs

get

API endpoint that allows users to be viewed or edited.

Authorizations

Path parameters

idstringRequired

Responses

200Success

application/json

get

GET /ux/nccm/policy_rule_group/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "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-06-07T19:08:38.224Z",
  "is_deleted": true,
  "assigned_users": [],
  "assigned_group": [],
  "is_private": true
}

Deletes the rule group with given id

delete

This endpoint is used to delete an existing rule group for the current organization

Authorizations

Path parameters

idstringRequired

Responses

204

No response body

delete

DELETE /ux/nccm/policy_rule_group/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

204

No response body

No content

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

200Success

application/json

get

GET /ux/nccm/policy_rule_group/get-configuration-rules/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "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-06-07T19:08:38.224Z",
  "is_deleted": true,
  "assigned_users": [],
  "assigned_group": [],
  "is_private": true
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

200Success

application/json

get

GET /ux/nccm/policy_rule_group/get-os-from-rule/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "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-06-07T19:08:38.224Z",
  "is_deleted": true,
  "assigned_users": [],
  "assigned_group": [],
  "is_private": true
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

200Success

application/json

get

GET /ux/nccm/policy_rule_group/get_init_options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "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-06-07T19:08:38.224Z",
  "is_deleted": true,
  "assigned_users": [],
  "assigned_group": [],
  "is_private": true
}

Retrive the rule group with given id

get

This endpoint is used to delete an existing rule group for the current organization

Authorizations

Responses

200Success

application/json

get

GET /ux/nccm/policy_rule_group/get_rule_group_by_id/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "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-06-07T19:08:38.224Z",
  "is_deleted": true,
  "assigned_users": [],
  "assigned_group": [],
  "is_private": true
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

200Success

application/json

get

GET /ux/nccm/policy_rule_group/save-associated-rule/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "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-06-07T19:08:38.224Z",
  "is_deleted": true,
  "assigned_users": [],
  "assigned_group": [],
  "is_private": true
}

Gets a list of configuration trigger

get

This endpoint is used to fetch all the configuration trigger in the current organization

Authorizations

Query parameters

items_per_pageintegerRequired

Items Per Page

pageintegerRequired

Page Number

reversebooleanOptional

Sorting Order

sortstringOptional

Sorting Key

Responses

200Success

application/json

get

GET /ux/nccm/policy_rule_group/?items_per_page=1&page=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "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-06-07T19:08:38.224Z",
    "is_deleted": true,
    "assigned_users": [],
    "assigned_group": [],
    "is_private": true
  }
]

Creates a new configuration profile

post

This endpoint is used to save a new configuration profile for the current organization

Authorizations

Body

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.

idstringRead-onlyRequired

created_by_namestringRead-onlyRequired

modified_by_namestringRead-onlyRequired

creationtimestringRead-onlyRequired

last_update_timestringRead-onlyRequired

status_optstringRead-onlyRequired

statusstringRead-onlyRequired

device_tagsstringRead-onlyRequired

associated_rulesstringRead-onlyRequired

rule_mapstringRead-onlyRequired

created_by_profilestringRead-onlyRequired

modified_by_profilestringRead-onlyRequired

rulegroupidstringRequired

namestringOptional

organizationstring · max: 25Required

descriptionstringOptional

activationbooleanOptional

iprangestringOptional

exclude_ipsstringOptional

vendorstringOptional

os_typestringOptional

modified_byintegerOptional

created_byintegerOptional

activated_byintegerOptional

activation_timestring · date-timeOptional

is_deletedbooleanOptional

is_privatebooleanOptional

Responses

201Success

application/json

post

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-06-07T19:08:38.224Z",
  "is_deleted": true,
  "assigned_users": [],
  "assigned_group": [],
  "is_private": true
}

201Success

{
  "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-06-07T19:08:38.224Z",
  "is_deleted": true,
  "assigned_users": [],
  "assigned_group": [],
  "is_private": true
}

put

API endpoint that allows users to be viewed or edited.

Authorizations

Path parameters

idstringRequired

Body

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.

idstringRead-onlyRequired

created_by_namestringRead-onlyRequired

modified_by_namestringRead-onlyRequired

creationtimestringRead-onlyRequired

last_update_timestringRead-onlyRequired

status_optstringRead-onlyRequired

statusstringRead-onlyRequired

device_tagsstringRead-onlyRequired

associated_rulesstringRead-onlyRequired

rule_mapstringRead-onlyRequired

created_by_profilestringRead-onlyRequired

modified_by_profilestringRead-onlyRequired

rulegroupidstringRequired

namestringOptional

organizationstring · max: 25Required

descriptionstringOptional

activationbooleanOptional

iprangestringOptional

exclude_ipsstringOptional

vendorstringOptional

os_typestringOptional

modified_byintegerOptional

created_byintegerOptional

activated_byintegerOptional

activation_timestring · date-timeOptional

is_deletedbooleanOptional

is_privatebooleanOptional

Responses

200Success

application/json

put

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-06-07T19:08:38.224Z",
  "is_deleted": true,
  "assigned_users": [],
  "assigned_group": [],
  "is_private": true
}

200Success

{
  "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-06-07T19:08:38.224Z",
  "is_deleted": true,
  "assigned_users": [],
  "assigned_group": [],
  "is_private": true
}

post

API endpoint that allows users to be viewed or edited.

Authorizations

Body

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.

idstringRead-onlyRequired

created_by_namestringRead-onlyRequired

modified_by_namestringRead-onlyRequired

creationtimestringRead-onlyRequired

last_update_timestringRead-onlyRequired

status_optstringRead-onlyRequired

statusstringRead-onlyRequired

device_tagsstringRead-onlyRequired

associated_rulesstringRead-onlyRequired

rule_mapstringRead-onlyRequired

created_by_profilestringRead-onlyRequired

modified_by_profilestringRead-onlyRequired

rulegroupidstringRequired

namestringOptional

organizationstring · max: 25Required

descriptionstringOptional

activationbooleanOptional

iprangestringOptional

exclude_ipsstringOptional

vendorstringOptional

os_typestringOptional

modified_byintegerOptional

created_byintegerOptional

activated_byintegerOptional

activation_timestring · date-timeOptional

is_deletedbooleanOptional

is_privatebooleanOptional

Responses

200Success

application/json

post

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-06-07T19:08:38.224Z",
  "is_deleted": true,
  "assigned_users": [],
  "assigned_group": [],
  "is_private": true
}

200Success

{
  "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-06-07T19:08:38.224Z",
  "is_deleted": true,
  "assigned_users": [],
  "assigned_group": [],
  "is_private": true
}

post

API endpoint that allows users to be viewed or edited.

Authorizations

Body

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.

idstringRead-onlyRequired

created_by_namestringRead-onlyRequired

modified_by_namestringRead-onlyRequired

creationtimestringRead-onlyRequired

last_update_timestringRead-onlyRequired

status_optstringRead-onlyRequired

statusstringRead-onlyRequired

device_tagsstringRead-onlyRequired

associated_rulesstringRead-onlyRequired

rule_mapstringRead-onlyRequired

created_by_profilestringRead-onlyRequired

modified_by_profilestringRead-onlyRequired

rulegroupidstringRequired

namestringOptional

organizationstring · max: 25Required

descriptionstringOptional

activationbooleanOptional

iprangestringOptional

exclude_ipsstringOptional

vendorstringOptional

os_typestringOptional

modified_byintegerOptional

created_byintegerOptional

activated_byintegerOptional

activation_timestring · date-timeOptional

is_deletedbooleanOptional

is_privatebooleanOptional

Responses

200Success

application/json

post

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-06-07T19:08:38.224Z",
  "is_deleted": true,
  "assigned_users": [],
  "assigned_group": [],
  "is_private": true
}

200Success

{
  "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-06-07T19:08:38.224Z",
  "is_deleted": true,
  "assigned_users": [],
  "assigned_group": [],
  "is_private": true
}

post

API endpoint that allows users to be viewed or edited.

Authorizations

Body

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.

idstringRead-onlyRequired

created_by_namestringRead-onlyRequired

modified_by_namestringRead-onlyRequired

creationtimestringRead-onlyRequired

last_update_timestringRead-onlyRequired

status_optstringRead-onlyRequired

statusstringRead-onlyRequired

device_tagsstringRead-onlyRequired

associated_rulesstringRead-onlyRequired

rule_mapstringRead-onlyRequired

created_by_profilestringRead-onlyRequired

modified_by_profilestringRead-onlyRequired

rulegroupidstringRequired

namestringOptional

organizationstring · max: 25Required

descriptionstringOptional

activationbooleanOptional

iprangestringOptional

exclude_ipsstringOptional

vendorstringOptional

os_typestringOptional

modified_byintegerOptional

created_byintegerOptional

activated_byintegerOptional

activation_timestring · date-timeOptional

is_deletedbooleanOptional

is_privatebooleanOptional

Responses

200Success

application/json

post

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-06-07T19:08:38.224Z",
  "is_deleted": true,
  "assigned_users": [],
  "assigned_group": [],
  "is_private": true
}

200Success

{
  "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-06-07T19:08:38.224Z",
  "is_deleted": true,
  "assigned_users": [],
  "assigned_group": [],
  "is_private": true
}

post

API endpoint that allows users to be viewed or edited.

Authorizations

Body

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.

idstringRead-onlyRequired

created_by_namestringRead-onlyRequired

modified_by_namestringRead-onlyRequired

creationtimestringRead-onlyRequired

last_update_timestringRead-onlyRequired

status_optstringRead-onlyRequired

statusstringRead-onlyRequired

device_tagsstringRead-onlyRequired

associated_rulesstringRead-onlyRequired

rule_mapstringRead-onlyRequired

created_by_profilestringRead-onlyRequired

modified_by_profilestringRead-onlyRequired

rulegroupidstringRequired

namestringOptional

organizationstring · max: 25Required

descriptionstringOptional

activationbooleanOptional

iprangestringOptional

exclude_ipsstringOptional

vendorstringOptional

os_typestringOptional

modified_byintegerOptional

created_byintegerOptional

activated_byintegerOptional

activation_timestring · date-timeOptional

is_deletedbooleanOptional

is_privatebooleanOptional

Responses

200Success

application/json

post

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-06-07T19:08:38.224Z",
  "is_deleted": true,
  "assigned_users": [],
  "assigned_group": [],
  "is_private": true
}

200Success

{
  "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-06-07T19:08:38.224Z",
  "is_deleted": true,
  "assigned_users": [],
  "assigned_group": [],
  "is_private": true
}