Rule Group

Gets a list of configuration trigger

get

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

Authorizations
AuthorizationstringRequired
Query parameters
items_per_pageintegerRequired

Items Per Page

pageintegerRequired

Page Number

reversebooleanOptional

Sorting Order

sortstringOptional

Sorting Key

Responses
chevron-right
200Success
application/json
get
/ux/nccm/policy_rule_group/
200Success

Creates a new configuration profile

post

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

Authorizations
AuthorizationstringRequired
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
post
/ux/nccm/policy_rule_group/
201Success
get

API endpoint that allows users to be viewed or edited.

Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired
Responses
chevron-right
200Success
application/json
get
/ux/nccm/policy_rule_group/{id}/
200Success
put

API endpoint that allows users to be viewed or edited.

Authorizations
AuthorizationstringRequired
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
chevron-right
200Success
application/json
put
/ux/nccm/policy_rule_group/{id}/
200Success

Deletes the rule group with given id

delete

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

Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired
Responses
delete
/ux/nccm/policy_rule_group/{id}/
204

No response body

No content

post

API endpoint that allows users to be viewed or edited.

Authorizations
AuthorizationstringRequired
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
chevron-right
200Success
application/json
post
/ux/nccm/policy_rule_group/bulk-opration/
200Success
get

API endpoint that allows users to be viewed or edited.

Authorizations
AuthorizationstringRequired
Responses
chevron-right
200Success
application/json
get
/ux/nccm/policy_rule_group/get-configuration-rules/
200Success
get

API endpoint that allows users to be viewed or edited.

Authorizations
AuthorizationstringRequired
Responses
chevron-right
200Success
application/json
get
/ux/nccm/policy_rule_group/get-os-from-rule/
200Success
post

API endpoint that allows users to be viewed or edited.

Authorizations
AuthorizationstringRequired
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
chevron-right
200Success
application/json
post
/ux/nccm/policy_rule_group/get-runtime-params/
200Success
get

API endpoint that allows users to be viewed or edited.

Authorizations
AuthorizationstringRequired
Responses
chevron-right
200Success
application/json
get
/ux/nccm/policy_rule_group/get_init_options/
200Success

Retrive the rule group with given id

get

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

Authorizations
AuthorizationstringRequired
Responses
chevron-right
200Success
application/json
get
/ux/nccm/policy_rule_group/get_rule_group_by_id/
200Success
get

API endpoint that allows users to be viewed or edited.

Authorizations
AuthorizationstringRequired
Responses
chevron-right
200Success
application/json
get
/ux/nccm/policy_rule_group/save-associated-rule/
200Success
post

API endpoint that allows users to be viewed or edited.

Authorizations
AuthorizationstringRequired
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
chevron-right
200Success
application/json
post
/ux/nccm/policy_rule_group/status-updation/
200Success
post

API endpoint that allows users to be viewed or edited.

Authorizations
AuthorizationstringRequired
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
chevron-right
200Success
application/json
post
/ux/nccm/policy_rule_group/validate-uploaded-file/
200Success

Last updated