Configuration Rules

Gets a list of configuration Rules

get

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

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Query parameters

items_per_pageintegerRequired

Items Per Page

pageintegerRequired

Page Number

reversebooleanOptional

Sorting Order

sortstringOptional

Sorting Key

Responses

200Success

application/json

get

/ux/nccm/configuration_rules/

HTTPcURLJavaScriptPython

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

200Success

[
  {
    "id": "text",
    "rule_config_severity": "text",
    "rule_type": "text",
    "match_criteria": "text",
    "status": "text",
    "rollback_type": "text",
    "on_violation_perform": "text",
    "remedy_configured": "text",
    "rule_description": "text",
    "ruleid": "text",
    "rule_display_id": "text",
    "organization": "text",
    "last_update_time": "2026-01-22T13:43:46.591Z",
    "creation_time": "2026-01-22T13:43:46.591Z",
    "created_by": "text",
    "modified_by": "text",
    "is_deleted": true,
    "is_private": true,
    "assigned_users": [],
    "assigned_group": [],
    "creator": "text",
    "name": "text",
    "description": "text",
    "compliance_standard": "text",
    "compliance_details": "text",
    "rule_execution_type": 1,
    "activation": true,
    "is_enabled": true,
    "vendor": "text",
    "os_type": "text",
    "is_editable": true,
    "device_type": "text",
    "config_type": "text",
    "inv_commands": "text",
    "other_configs": "text",
    "config_script_id": "text",
    "config_script_commands": "text",
    "cve_ids": [],
    "nw_reviews": "text",
    "execution": true,
    "rule_start_time": "2026-01-22T13:43:46.591Z",
    "rule_end_time": "2026-01-22T13:43:46.591Z",
    "severity": 1,
    "alarm_msg": "text",
    "notifier_id": "text",
    "rollback_script_id": "text",
    "rollback_script_commands": "text",
    "rollback_script_adv_commands": "text",
    "rollback_comments": "text",
    "continue_nextcommand_on_failure": true,
    "rule_info": "text",
    "template_id": "text",
    "os_version": "text"
  }
]

post

API endpoint that allows users to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

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

rule_config_severitystringRead-onlyRequired

rule_typestringRead-onlyRequired

match_criteriastringRead-onlyRequired

statusstringRead-onlyRequired

rollback_typestringRead-onlyRequired

on_violation_performstringRead-onlyRequired

remedy_configuredstringRead-onlyRequired

rule_descriptionstringRead-onlyRequired

ruleidstring · max: 25Required

rule_display_idstringRequired

organizationstring · max: 25Required

last_update_timestring · date-timeOptional

creation_timestring · date-timeOptional

created_bystringOptional

modified_bystringOptional

is_deletedbooleanOptional

is_privatebooleanOptional

creatorstringOptional

namestringOptional

descriptionstringOptional

compliance_standardstringOptional

compliance_detailsstringOptional

rule_execution_typeintegerOptional

activationbooleanOptionalDefault: true

is_enabledbooleanOptionalDefault: true

vendorstringOptional

os_typestringOptional

is_editablebooleanOptional

device_typestringOptional

config_typestringOptional

inv_commandsstringOptional

other_configsstringOptional

config_script_idstringOptional

config_script_commandsstringOptional

nw_reviewsstringOptional

executionbooleanOptional

rule_start_timestring · date-timeOptional

rule_end_timestring · date-timeOptional

severityintegerOptional

alarm_msgstringOptional

notifier_idstringOptional

rollback_script_idstringOptional

rollback_script_commandsstringOptional

rollback_script_adv_commandsstringOptional

rollback_commentsstringOptional

continue_nextcommand_on_failurebooleanOptional

rule_infostringOptional

template_idstringOptional

os_versionstringOptional

Responses

201Success

application/json

post

/ux/nccm/configuration_rules/

HTTPcURLJavaScriptPython

POST /ux/nccm/configuration_rules/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1053

{
  "ruleid": "text",
  "rule_display_id": "text",
  "organization": "text",
  "last_update_time": "2026-01-22T13:43:46.591Z",
  "creation_time": "2026-01-22T13:43:46.591Z",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "is_private": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text",
  "name": "text",
  "description": "text",
  "compliance_standard": "text",
  "compliance_details": "text",
  "rule_execution_type": 1,
  "activation": true,
  "is_enabled": true,
  "vendor": "text",
  "os_type": "text",
  "is_editable": true,
  "device_type": "text",
  "config_type": "text",
  "inv_commands": "text",
  "other_configs": "text",
  "config_script_id": "text",
  "config_script_commands": "text",
  "cve_ids": [],
  "nw_reviews": "text",
  "execution": true,
  "rule_start_time": "2026-01-22T13:43:46.591Z",
  "rule_end_time": "2026-01-22T13:43:46.591Z",
  "severity": 1,
  "alarm_msg": "text",
  "notifier_id": "text",
  "rollback_script_id": "text",
  "rollback_script_commands": "text",
  "rollback_script_adv_commands": "text",
  "rollback_comments": "text",
  "continue_nextcommand_on_failure": true,
  "rule_info": "text",
  "template_id": "text",
  "os_version": "text"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

201Success

{
  "id": "text",
  "rule_config_severity": "text",
  "rule_type": "text",
  "match_criteria": "text",
  "status": "text",
  "rollback_type": "text",
  "on_violation_perform": "text",
  "remedy_configured": "text",
  "rule_description": "text",
  "ruleid": "text",
  "rule_display_id": "text",
  "organization": "text",
  "last_update_time": "2026-01-22T13:43:46.591Z",
  "creation_time": "2026-01-22T13:43:46.591Z",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "is_private": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text",
  "name": "text",
  "description": "text",
  "compliance_standard": "text",
  "compliance_details": "text",
  "rule_execution_type": 1,
  "activation": true,
  "is_enabled": true,
  "vendor": "text",
  "os_type": "text",
  "is_editable": true,
  "device_type": "text",
  "config_type": "text",
  "inv_commands": "text",
  "other_configs": "text",
  "config_script_id": "text",
  "config_script_commands": "text",
  "cve_ids": [],
  "nw_reviews": "text",
  "execution": true,
  "rule_start_time": "2026-01-22T13:43:46.591Z",
  "rule_end_time": "2026-01-22T13:43:46.591Z",
  "severity": 1,
  "alarm_msg": "text",
  "notifier_id": "text",
  "rollback_script_id": "text",
  "rollback_script_commands": "text",
  "rollback_script_adv_commands": "text",
  "rollback_comments": "text",
  "continue_nextcommand_on_failure": true,
  "rule_info": "text",
  "template_id": "text",
  "os_version": "text"
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Path parameters

idstringRequired

Responses

200Success

application/json

get

/ux/nccm/configuration_rules/{id}/

HTTPcURLJavaScriptPython

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

200Success

{
  "id": "text",
  "rule_config_severity": "text",
  "rule_type": "text",
  "match_criteria": "text",
  "status": "text",
  "rollback_type": "text",
  "on_violation_perform": "text",
  "remedy_configured": "text",
  "rule_description": "text",
  "ruleid": "text",
  "rule_display_id": "text",
  "organization": "text",
  "last_update_time": "2026-01-22T13:43:46.591Z",
  "creation_time": "2026-01-22T13:43:46.591Z",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "is_private": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text",
  "name": "text",
  "description": "text",
  "compliance_standard": "text",
  "compliance_details": "text",
  "rule_execution_type": 1,
  "activation": true,
  "is_enabled": true,
  "vendor": "text",
  "os_type": "text",
  "is_editable": true,
  "device_type": "text",
  "config_type": "text",
  "inv_commands": "text",
  "other_configs": "text",
  "config_script_id": "text",
  "config_script_commands": "text",
  "cve_ids": [],
  "nw_reviews": "text",
  "execution": true,
  "rule_start_time": "2026-01-22T13:43:46.591Z",
  "rule_end_time": "2026-01-22T13:43:46.591Z",
  "severity": 1,
  "alarm_msg": "text",
  "notifier_id": "text",
  "rollback_script_id": "text",
  "rollback_script_commands": "text",
  "rollback_script_adv_commands": "text",
  "rollback_comments": "text",
  "continue_nextcommand_on_failure": true,
  "rule_info": "text",
  "template_id": "text",
  "os_version": "text"
}

put

API endpoint that allows users to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Path parameters

idstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

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

rule_config_severitystringRead-onlyRequired

rule_typestringRead-onlyRequired

match_criteriastringRead-onlyRequired

statusstringRead-onlyRequired

rollback_typestringRead-onlyRequired

on_violation_performstringRead-onlyRequired

remedy_configuredstringRead-onlyRequired

rule_descriptionstringRead-onlyRequired

ruleidstring · max: 25Required

rule_display_idstringRequired

organizationstring · max: 25Required

last_update_timestring · date-timeOptional

creation_timestring · date-timeOptional

created_bystringOptional

modified_bystringOptional

is_deletedbooleanOptional

is_privatebooleanOptional

creatorstringOptional

namestringOptional

descriptionstringOptional

compliance_standardstringOptional

compliance_detailsstringOptional

rule_execution_typeintegerOptional

activationbooleanOptionalDefault: true

is_enabledbooleanOptionalDefault: true

vendorstringOptional

os_typestringOptional

is_editablebooleanOptional

device_typestringOptional

config_typestringOptional

inv_commandsstringOptional

other_configsstringOptional

config_script_idstringOptional

config_script_commandsstringOptional

nw_reviewsstringOptional

executionbooleanOptional

rule_start_timestring · date-timeOptional

rule_end_timestring · date-timeOptional

severityintegerOptional

alarm_msgstringOptional

notifier_idstringOptional

rollback_script_idstringOptional

rollback_script_commandsstringOptional

rollback_script_adv_commandsstringOptional

rollback_commentsstringOptional

continue_nextcommand_on_failurebooleanOptional

rule_infostringOptional

template_idstringOptional

os_versionstringOptional

Responses

200Success

application/json

put

/ux/nccm/configuration_rules/{id}/

HTTPcURLJavaScriptPython

PUT /ux/nccm/configuration_rules/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1053

{
  "ruleid": "text",
  "rule_display_id": "text",
  "organization": "text",
  "last_update_time": "2026-01-22T13:43:46.591Z",
  "creation_time": "2026-01-22T13:43:46.591Z",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "is_private": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text",
  "name": "text",
  "description": "text",
  "compliance_standard": "text",
  "compliance_details": "text",
  "rule_execution_type": 1,
  "activation": true,
  "is_enabled": true,
  "vendor": "text",
  "os_type": "text",
  "is_editable": true,
  "device_type": "text",
  "config_type": "text",
  "inv_commands": "text",
  "other_configs": "text",
  "config_script_id": "text",
  "config_script_commands": "text",
  "cve_ids": [],
  "nw_reviews": "text",
  "execution": true,
  "rule_start_time": "2026-01-22T13:43:46.591Z",
  "rule_end_time": "2026-01-22T13:43:46.591Z",
  "severity": 1,
  "alarm_msg": "text",
  "notifier_id": "text",
  "rollback_script_id": "text",
  "rollback_script_commands": "text",
  "rollback_script_adv_commands": "text",
  "rollback_comments": "text",
  "continue_nextcommand_on_failure": true,
  "rule_info": "text",
  "template_id": "text",
  "os_version": "text"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "rule_config_severity": "text",
  "rule_type": "text",
  "match_criteria": "text",
  "status": "text",
  "rollback_type": "text",
  "on_violation_perform": "text",
  "remedy_configured": "text",
  "rule_description": "text",
  "ruleid": "text",
  "rule_display_id": "text",
  "organization": "text",
  "last_update_time": "2026-01-22T13:43:46.591Z",
  "creation_time": "2026-01-22T13:43:46.591Z",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "is_private": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text",
  "name": "text",
  "description": "text",
  "compliance_standard": "text",
  "compliance_details": "text",
  "rule_execution_type": 1,
  "activation": true,
  "is_enabled": true,
  "vendor": "text",
  "os_type": "text",
  "is_editable": true,
  "device_type": "text",
  "config_type": "text",
  "inv_commands": "text",
  "other_configs": "text",
  "config_script_id": "text",
  "config_script_commands": "text",
  "cve_ids": [],
  "nw_reviews": "text",
  "execution": true,
  "rule_start_time": "2026-01-22T13:43:46.591Z",
  "rule_end_time": "2026-01-22T13:43:46.591Z",
  "severity": 1,
  "alarm_msg": "text",
  "notifier_id": "text",
  "rollback_script_id": "text",
  "rollback_script_commands": "text",
  "rollback_script_adv_commands": "text",
  "rollback_comments": "text",
  "continue_nextcommand_on_failure": true,
  "rule_info": "text",
  "template_id": "text",
  "os_version": "text"
}

delete

API endpoint that allows users to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Path parameters

idstringRequired

Responses

204

No response body

delete

/ux/nccm/configuration_rules/{id}/

HTTPcURLJavaScriptPython

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

204

No response body

No content

Return JSON for Configuration Rule

post

This endpoint is to Import Text From OLD NCCM for Configuration Rule.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

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

rule_config_severitystringRead-onlyRequired

rule_typestringRead-onlyRequired

match_criteriastringRead-onlyRequired

statusstringRead-onlyRequired

rollback_typestringRead-onlyRequired

on_violation_performstringRead-onlyRequired

remedy_configuredstringRead-onlyRequired

rule_descriptionstringRead-onlyRequired

ruleidstring · max: 25Required

rule_display_idstringRequired

organizationstring · max: 25Required

last_update_timestring · date-timeOptional

creation_timestring · date-timeOptional

created_bystringOptional

modified_bystringOptional

is_deletedbooleanOptional

is_privatebooleanOptional

creatorstringOptional

namestringOptional

descriptionstringOptional

compliance_standardstringOptional

compliance_detailsstringOptional

rule_execution_typeintegerOptional

activationbooleanOptionalDefault: true

is_enabledbooleanOptionalDefault: true

vendorstringOptional

os_typestringOptional

is_editablebooleanOptional

device_typestringOptional

config_typestringOptional

inv_commandsstringOptional

other_configsstringOptional

config_script_idstringOptional

config_script_commandsstringOptional

nw_reviewsstringOptional

executionbooleanOptional

rule_start_timestring · date-timeOptional

rule_end_timestring · date-timeOptional

severityintegerOptional

alarm_msgstringOptional

notifier_idstringOptional

rollback_script_idstringOptional

rollback_script_commandsstringOptional

rollback_script_adv_commandsstringOptional

rollback_commentsstringOptional

continue_nextcommand_on_failurebooleanOptional

rule_infostringOptional

template_idstringOptional

os_versionstringOptional

Responses

200Success

application/json

post

/ux/nccm/configuration_rules/import-txt/

HTTPcURLJavaScriptPython

POST /ux/nccm/configuration_rules/import-txt/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1053

{
  "ruleid": "text",
  "rule_display_id": "text",
  "organization": "text",
  "last_update_time": "2026-01-22T13:43:46.591Z",
  "creation_time": "2026-01-22T13:43:46.591Z",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "is_private": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text",
  "name": "text",
  "description": "text",
  "compliance_standard": "text",
  "compliance_details": "text",
  "rule_execution_type": 1,
  "activation": true,
  "is_enabled": true,
  "vendor": "text",
  "os_type": "text",
  "is_editable": true,
  "device_type": "text",
  "config_type": "text",
  "inv_commands": "text",
  "other_configs": "text",
  "config_script_id": "text",
  "config_script_commands": "text",
  "cve_ids": [],
  "nw_reviews": "text",
  "execution": true,
  "rule_start_time": "2026-01-22T13:43:46.591Z",
  "rule_end_time": "2026-01-22T13:43:46.591Z",
  "severity": 1,
  "alarm_msg": "text",
  "notifier_id": "text",
  "rollback_script_id": "text",
  "rollback_script_commands": "text",
  "rollback_script_adv_commands": "text",
  "rollback_comments": "text",
  "continue_nextcommand_on_failure": true,
  "rule_info": "text",
  "template_id": "text",
  "os_version": "text"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "rule_config_severity": "text",
  "rule_type": "text",
  "match_criteria": "text",
  "status": "text",
  "rollback_type": "text",
  "on_violation_perform": "text",
  "remedy_configured": "text",
  "rule_description": "text",
  "ruleid": "text",
  "rule_display_id": "text",
  "organization": "text",
  "last_update_time": "2026-01-22T13:43:46.591Z",
  "creation_time": "2026-01-22T13:43:46.591Z",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "is_private": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text",
  "name": "text",
  "description": "text",
  "compliance_standard": "text",
  "compliance_details": "text",
  "rule_execution_type": 1,
  "activation": true,
  "is_enabled": true,
  "vendor": "text",
  "os_type": "text",
  "is_editable": true,
  "device_type": "text",
  "config_type": "text",
  "inv_commands": "text",
  "other_configs": "text",
  "config_script_id": "text",
  "config_script_commands": "text",
  "cve_ids": [],
  "nw_reviews": "text",
  "execution": true,
  "rule_start_time": "2026-01-22T13:43:46.591Z",
  "rule_end_time": "2026-01-22T13:43:46.591Z",
  "severity": 1,
  "alarm_msg": "text",
  "notifier_id": "text",
  "rollback_script_id": "text",
  "rollback_script_commands": "text",
  "rollback_script_adv_commands": "text",
  "rollback_comments": "text",
  "continue_nextcommand_on_failure": true,
  "rule_info": "text",
  "template_id": "text",
  "os_version": "text"
}

post

API endpoint that allows users to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

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

rule_config_severitystringRead-onlyRequired

rule_typestringRead-onlyRequired

match_criteriastringRead-onlyRequired

statusstringRead-onlyRequired

rollback_typestringRead-onlyRequired

on_violation_performstringRead-onlyRequired

remedy_configuredstringRead-onlyRequired

rule_descriptionstringRead-onlyRequired

ruleidstring · max: 25Required

rule_display_idstringRequired

organizationstring · max: 25Required

last_update_timestring · date-timeOptional

creation_timestring · date-timeOptional

created_bystringOptional

modified_bystringOptional

is_deletedbooleanOptional

is_privatebooleanOptional

creatorstringOptional

namestringOptional

descriptionstringOptional

compliance_standardstringOptional

compliance_detailsstringOptional

rule_execution_typeintegerOptional

activationbooleanOptionalDefault: true

is_enabledbooleanOptionalDefault: true

vendorstringOptional

os_typestringOptional

is_editablebooleanOptional

device_typestringOptional

config_typestringOptional

inv_commandsstringOptional

other_configsstringOptional

config_script_idstringOptional

config_script_commandsstringOptional

nw_reviewsstringOptional

executionbooleanOptional

rule_start_timestring · date-timeOptional

rule_end_timestring · date-timeOptional

severityintegerOptional

alarm_msgstringOptional

notifier_idstringOptional

rollback_script_idstringOptional

rollback_script_commandsstringOptional

rollback_script_adv_commandsstringOptional

rollback_commentsstringOptional

continue_nextcommand_on_failurebooleanOptional

rule_infostringOptional

template_idstringOptional

os_versionstringOptional

Responses

200Success

application/json

post

/ux/nccm/configuration_rules/is_disabled/

HTTPcURLJavaScriptPython

POST /ux/nccm/configuration_rules/is_disabled/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1053

{
  "ruleid": "text",
  "rule_display_id": "text",
  "organization": "text",
  "last_update_time": "2026-01-22T13:43:46.591Z",
  "creation_time": "2026-01-22T13:43:46.591Z",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "is_private": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text",
  "name": "text",
  "description": "text",
  "compliance_standard": "text",
  "compliance_details": "text",
  "rule_execution_type": 1,
  "activation": true,
  "is_enabled": true,
  "vendor": "text",
  "os_type": "text",
  "is_editable": true,
  "device_type": "text",
  "config_type": "text",
  "inv_commands": "text",
  "other_configs": "text",
  "config_script_id": "text",
  "config_script_commands": "text",
  "cve_ids": [],
  "nw_reviews": "text",
  "execution": true,
  "rule_start_time": "2026-01-22T13:43:46.591Z",
  "rule_end_time": "2026-01-22T13:43:46.591Z",
  "severity": 1,
  "alarm_msg": "text",
  "notifier_id": "text",
  "rollback_script_id": "text",
  "rollback_script_commands": "text",
  "rollback_script_adv_commands": "text",
  "rollback_comments": "text",
  "continue_nextcommand_on_failure": true,
  "rule_info": "text",
  "template_id": "text",
  "os_version": "text"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "rule_config_severity": "text",
  "rule_type": "text",
  "match_criteria": "text",
  "status": "text",
  "rollback_type": "text",
  "on_violation_perform": "text",
  "remedy_configured": "text",
  "rule_description": "text",
  "ruleid": "text",
  "rule_display_id": "text",
  "organization": "text",
  "last_update_time": "2026-01-22T13:43:46.591Z",
  "creation_time": "2026-01-22T13:43:46.591Z",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "is_private": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text",
  "name": "text",
  "description": "text",
  "compliance_standard": "text",
  "compliance_details": "text",
  "rule_execution_type": 1,
  "activation": true,
  "is_enabled": true,
  "vendor": "text",
  "os_type": "text",
  "is_editable": true,
  "device_type": "text",
  "config_type": "text",
  "inv_commands": "text",
  "other_configs": "text",
  "config_script_id": "text",
  "config_script_commands": "text",
  "cve_ids": [],
  "nw_reviews": "text",
  "execution": true,
  "rule_start_time": "2026-01-22T13:43:46.591Z",
  "rule_end_time": "2026-01-22T13:43:46.591Z",
  "severity": 1,
  "alarm_msg": "text",
  "notifier_id": "text",
  "rollback_script_id": "text",
  "rollback_script_commands": "text",
  "rollback_script_adv_commands": "text",
  "rollback_comments": "text",
  "continue_nextcommand_on_failure": true,
  "rule_info": "text",
  "template_id": "text",
  "os_version": "text"
}

post

API endpoint that allows users to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

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

rule_config_severitystringRead-onlyRequired

rule_typestringRead-onlyRequired

match_criteriastringRead-onlyRequired

statusstringRead-onlyRequired

rollback_typestringRead-onlyRequired

on_violation_performstringRead-onlyRequired

remedy_configuredstringRead-onlyRequired

rule_descriptionstringRead-onlyRequired

ruleidstring · max: 25Required

rule_display_idstringRequired

organizationstring · max: 25Required

last_update_timestring · date-timeOptional

creation_timestring · date-timeOptional

created_bystringOptional

modified_bystringOptional

is_deletedbooleanOptional

is_privatebooleanOptional

creatorstringOptional

namestringOptional

descriptionstringOptional

compliance_standardstringOptional

compliance_detailsstringOptional

rule_execution_typeintegerOptional

activationbooleanOptionalDefault: true

is_enabledbooleanOptionalDefault: true

vendorstringOptional

os_typestringOptional

is_editablebooleanOptional

device_typestringOptional

config_typestringOptional

inv_commandsstringOptional

other_configsstringOptional

config_script_idstringOptional

config_script_commandsstringOptional

nw_reviewsstringOptional

executionbooleanOptional

rule_start_timestring · date-timeOptional

rule_end_timestring · date-timeOptional

severityintegerOptional

alarm_msgstringOptional

notifier_idstringOptional

rollback_script_idstringOptional

rollback_script_commandsstringOptional

rollback_script_adv_commandsstringOptional

rollback_commentsstringOptional

continue_nextcommand_on_failurebooleanOptional

rule_infostringOptional

template_idstringOptional

os_versionstringOptional

Responses

200Success

application/json

post

/ux/nccm/configuration_rules/is_enabled/

HTTPcURLJavaScriptPython

POST /ux/nccm/configuration_rules/is_enabled/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1053

{
  "ruleid": "text",
  "rule_display_id": "text",
  "organization": "text",
  "last_update_time": "2026-01-22T13:43:46.591Z",
  "creation_time": "2026-01-22T13:43:46.591Z",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "is_private": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text",
  "name": "text",
  "description": "text",
  "compliance_standard": "text",
  "compliance_details": "text",
  "rule_execution_type": 1,
  "activation": true,
  "is_enabled": true,
  "vendor": "text",
  "os_type": "text",
  "is_editable": true,
  "device_type": "text",
  "config_type": "text",
  "inv_commands": "text",
  "other_configs": "text",
  "config_script_id": "text",
  "config_script_commands": "text",
  "cve_ids": [],
  "nw_reviews": "text",
  "execution": true,
  "rule_start_time": "2026-01-22T13:43:46.591Z",
  "rule_end_time": "2026-01-22T13:43:46.591Z",
  "severity": 1,
  "alarm_msg": "text",
  "notifier_id": "text",
  "rollback_script_id": "text",
  "rollback_script_commands": "text",
  "rollback_script_adv_commands": "text",
  "rollback_comments": "text",
  "continue_nextcommand_on_failure": true,
  "rule_info": "text",
  "template_id": "text",
  "os_version": "text"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "rule_config_severity": "text",
  "rule_type": "text",
  "match_criteria": "text",
  "status": "text",
  "rollback_type": "text",
  "on_violation_perform": "text",
  "remedy_configured": "text",
  "rule_description": "text",
  "ruleid": "text",
  "rule_display_id": "text",
  "organization": "text",
  "last_update_time": "2026-01-22T13:43:46.591Z",
  "creation_time": "2026-01-22T13:43:46.591Z",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "is_private": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text",
  "name": "text",
  "description": "text",
  "compliance_standard": "text",
  "compliance_details": "text",
  "rule_execution_type": 1,
  "activation": true,
  "is_enabled": true,
  "vendor": "text",
  "os_type": "text",
  "is_editable": true,
  "device_type": "text",
  "config_type": "text",
  "inv_commands": "text",
  "other_configs": "text",
  "config_script_id": "text",
  "config_script_commands": "text",
  "cve_ids": [],
  "nw_reviews": "text",
  "execution": true,
  "rule_start_time": "2026-01-22T13:43:46.591Z",
  "rule_end_time": "2026-01-22T13:43:46.591Z",
  "severity": 1,
  "alarm_msg": "text",
  "notifier_id": "text",
  "rollback_script_id": "text",
  "rollback_script_commands": "text",
  "rollback_script_adv_commands": "text",
  "rollback_comments": "text",
  "continue_nextcommand_on_failure": true,
  "rule_info": "text",
  "template_id": "text",
  "os_version": "text"
}

post

API endpoint that allows users to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

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

rule_config_severitystringRead-onlyRequired

rule_typestringRead-onlyRequired

match_criteriastringRead-onlyRequired

statusstringRead-onlyRequired

rollback_typestringRead-onlyRequired

on_violation_performstringRead-onlyRequired

remedy_configuredstringRead-onlyRequired

rule_descriptionstringRead-onlyRequired

ruleidstring · max: 25Required

rule_display_idstringRequired

organizationstring · max: 25Required

last_update_timestring · date-timeOptional

creation_timestring · date-timeOptional

created_bystringOptional

modified_bystringOptional

is_deletedbooleanOptional

is_privatebooleanOptional

creatorstringOptional

namestringOptional

descriptionstringOptional

compliance_standardstringOptional

compliance_detailsstringOptional

rule_execution_typeintegerOptional

activationbooleanOptionalDefault: true

is_enabledbooleanOptionalDefault: true

vendorstringOptional

os_typestringOptional

is_editablebooleanOptional

device_typestringOptional

config_typestringOptional

inv_commandsstringOptional

other_configsstringOptional

config_script_idstringOptional

config_script_commandsstringOptional

nw_reviewsstringOptional

executionbooleanOptional

rule_start_timestring · date-timeOptional

rule_end_timestring · date-timeOptional

severityintegerOptional

alarm_msgstringOptional

notifier_idstringOptional

rollback_script_idstringOptional

rollback_script_commandsstringOptional

rollback_script_adv_commandsstringOptional

rollback_commentsstringOptional

continue_nextcommand_on_failurebooleanOptional

rule_infostringOptional

template_idstringOptional

os_versionstringOptional

Responses

200Success

application/json

post

/ux/nccm/configuration_rules/multidelete/

HTTPcURLJavaScriptPython

POST /ux/nccm/configuration_rules/multidelete/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1053

{
  "ruleid": "text",
  "rule_display_id": "text",
  "organization": "text",
  "last_update_time": "2026-01-22T13:43:46.591Z",
  "creation_time": "2026-01-22T13:43:46.591Z",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "is_private": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text",
  "name": "text",
  "description": "text",
  "compliance_standard": "text",
  "compliance_details": "text",
  "rule_execution_type": 1,
  "activation": true,
  "is_enabled": true,
  "vendor": "text",
  "os_type": "text",
  "is_editable": true,
  "device_type": "text",
  "config_type": "text",
  "inv_commands": "text",
  "other_configs": "text",
  "config_script_id": "text",
  "config_script_commands": "text",
  "cve_ids": [],
  "nw_reviews": "text",
  "execution": true,
  "rule_start_time": "2026-01-22T13:43:46.591Z",
  "rule_end_time": "2026-01-22T13:43:46.591Z",
  "severity": 1,
  "alarm_msg": "text",
  "notifier_id": "text",
  "rollback_script_id": "text",
  "rollback_script_commands": "text",
  "rollback_script_adv_commands": "text",
  "rollback_comments": "text",
  "continue_nextcommand_on_failure": true,
  "rule_info": "text",
  "template_id": "text",
  "os_version": "text"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "rule_config_severity": "text",
  "rule_type": "text",
  "match_criteria": "text",
  "status": "text",
  "rollback_type": "text",
  "on_violation_perform": "text",
  "remedy_configured": "text",
  "rule_description": "text",
  "ruleid": "text",
  "rule_display_id": "text",
  "organization": "text",
  "last_update_time": "2026-01-22T13:43:46.591Z",
  "creation_time": "2026-01-22T13:43:46.591Z",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "is_private": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text",
  "name": "text",
  "description": "text",
  "compliance_standard": "text",
  "compliance_details": "text",
  "rule_execution_type": 1,
  "activation": true,
  "is_enabled": true,
  "vendor": "text",
  "os_type": "text",
  "is_editable": true,
  "device_type": "text",
  "config_type": "text",
  "inv_commands": "text",
  "other_configs": "text",
  "config_script_id": "text",
  "config_script_commands": "text",
  "cve_ids": [],
  "nw_reviews": "text",
  "execution": true,
  "rule_start_time": "2026-01-22T13:43:46.591Z",
  "rule_end_time": "2026-01-22T13:43:46.591Z",
  "severity": 1,
  "alarm_msg": "text",
  "notifier_id": "text",
  "rollback_script_id": "text",
  "rollback_script_commands": "text",
  "rollback_script_adv_commands": "text",
  "rollback_comments": "text",
  "continue_nextcommand_on_failure": true,
  "rule_info": "text",
  "template_id": "text",
  "os_version": "text"
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/nccm/configuration_rules/options/

HTTPcURLJavaScriptPython

GET /ux/nccm/configuration_rules/options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "rule_config_severity": "text",
  "rule_type": "text",
  "match_criteria": "text",
  "status": "text",
  "rollback_type": "text",
  "on_violation_perform": "text",
  "remedy_configured": "text",
  "rule_description": "text",
  "ruleid": "text",
  "rule_display_id": "text",
  "organization": "text",
  "last_update_time": "2026-01-22T13:43:46.591Z",
  "creation_time": "2026-01-22T13:43:46.591Z",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "is_private": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text",
  "name": "text",
  "description": "text",
  "compliance_standard": "text",
  "compliance_details": "text",
  "rule_execution_type": 1,
  "activation": true,
  "is_enabled": true,
  "vendor": "text",
  "os_type": "text",
  "is_editable": true,
  "device_type": "text",
  "config_type": "text",
  "inv_commands": "text",
  "other_configs": "text",
  "config_script_id": "text",
  "config_script_commands": "text",
  "cve_ids": [],
  "nw_reviews": "text",
  "execution": true,
  "rule_start_time": "2026-01-22T13:43:46.591Z",
  "rule_end_time": "2026-01-22T13:43:46.591Z",
  "severity": 1,
  "alarm_msg": "text",
  "notifier_id": "text",
  "rollback_script_id": "text",
  "rollback_script_commands": "text",
  "rollback_script_adv_commands": "text",
  "rollback_comments": "text",
  "continue_nextcommand_on_failure": true,
  "rule_info": "text",
  "template_id": "text",
  "os_version": "text"
}

Return JSON for Configuration Rule

post

Save Imported Text From OLD NCCM for Configuration Rule.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

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

rule_config_severitystringRead-onlyRequired

rule_typestringRead-onlyRequired

match_criteriastringRead-onlyRequired

statusstringRead-onlyRequired

rollback_typestringRead-onlyRequired

on_violation_performstringRead-onlyRequired

remedy_configuredstringRead-onlyRequired

rule_descriptionstringRead-onlyRequired

ruleidstring · max: 25Required

rule_display_idstringRequired

organizationstring · max: 25Required

last_update_timestring · date-timeOptional

creation_timestring · date-timeOptional

created_bystringOptional

modified_bystringOptional

is_deletedbooleanOptional

is_privatebooleanOptional

creatorstringOptional

namestringOptional

descriptionstringOptional

compliance_standardstringOptional

compliance_detailsstringOptional

rule_execution_typeintegerOptional

activationbooleanOptionalDefault: true

is_enabledbooleanOptionalDefault: true

vendorstringOptional

os_typestringOptional

is_editablebooleanOptional

device_typestringOptional

config_typestringOptional

inv_commandsstringOptional

other_configsstringOptional

config_script_idstringOptional

config_script_commandsstringOptional

nw_reviewsstringOptional

executionbooleanOptional

rule_start_timestring · date-timeOptional

rule_end_timestring · date-timeOptional

severityintegerOptional

alarm_msgstringOptional

notifier_idstringOptional

rollback_script_idstringOptional

rollback_script_commandsstringOptional

rollback_script_adv_commandsstringOptional

rollback_commentsstringOptional

continue_nextcommand_on_failurebooleanOptional

rule_infostringOptional

template_idstringOptional

os_versionstringOptional

Responses

200Success

application/json

post

/ux/nccm/configuration_rules/save-txt/

HTTPcURLJavaScriptPython

POST /ux/nccm/configuration_rules/save-txt/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1053

{
  "ruleid": "text",
  "rule_display_id": "text",
  "organization": "text",
  "last_update_time": "2026-01-22T13:43:46.591Z",
  "creation_time": "2026-01-22T13:43:46.591Z",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "is_private": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text",
  "name": "text",
  "description": "text",
  "compliance_standard": "text",
  "compliance_details": "text",
  "rule_execution_type": 1,
  "activation": true,
  "is_enabled": true,
  "vendor": "text",
  "os_type": "text",
  "is_editable": true,
  "device_type": "text",
  "config_type": "text",
  "inv_commands": "text",
  "other_configs": "text",
  "config_script_id": "text",
  "config_script_commands": "text",
  "cve_ids": [],
  "nw_reviews": "text",
  "execution": true,
  "rule_start_time": "2026-01-22T13:43:46.591Z",
  "rule_end_time": "2026-01-22T13:43:46.591Z",
  "severity": 1,
  "alarm_msg": "text",
  "notifier_id": "text",
  "rollback_script_id": "text",
  "rollback_script_commands": "text",
  "rollback_script_adv_commands": "text",
  "rollback_comments": "text",
  "continue_nextcommand_on_failure": true,
  "rule_info": "text",
  "template_id": "text",
  "os_version": "text"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "rule_config_severity": "text",
  "rule_type": "text",
  "match_criteria": "text",
  "status": "text",
  "rollback_type": "text",
  "on_violation_perform": "text",
  "remedy_configured": "text",
  "rule_description": "text",
  "ruleid": "text",
  "rule_display_id": "text",
  "organization": "text",
  "last_update_time": "2026-01-22T13:43:46.591Z",
  "creation_time": "2026-01-22T13:43:46.591Z",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "is_private": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text",
  "name": "text",
  "description": "text",
  "compliance_standard": "text",
  "compliance_details": "text",
  "rule_execution_type": 1,
  "activation": true,
  "is_enabled": true,
  "vendor": "text",
  "os_type": "text",
  "is_editable": true,
  "device_type": "text",
  "config_type": "text",
  "inv_commands": "text",
  "other_configs": "text",
  "config_script_id": "text",
  "config_script_commands": "text",
  "cve_ids": [],
  "nw_reviews": "text",
  "execution": true,
  "rule_start_time": "2026-01-22T13:43:46.591Z",
  "rule_end_time": "2026-01-22T13:43:46.591Z",
  "severity": 1,
  "alarm_msg": "text",
  "notifier_id": "text",
  "rollback_script_id": "text",
  "rollback_script_commands": "text",
  "rollback_script_adv_commands": "text",
  "rollback_comments": "text",
  "continue_nextcommand_on_failure": true,
  "rule_info": "text",
  "template_id": "text",
  "os_version": "text"
}

Return JSON for Configuration Rule

post

This endpoint is to Import Json for Configuration Rule.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

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

rule_config_severitystringRead-onlyRequired

rule_typestringRead-onlyRequired

match_criteriastringRead-onlyRequired

statusstringRead-onlyRequired

rollback_typestringRead-onlyRequired

on_violation_performstringRead-onlyRequired

remedy_configuredstringRead-onlyRequired

rule_descriptionstringRead-onlyRequired

ruleidstring · max: 25Required

rule_display_idstringRequired

organizationstring · max: 25Required

last_update_timestring · date-timeOptional

creation_timestring · date-timeOptional

created_bystringOptional

modified_bystringOptional

is_deletedbooleanOptional

is_privatebooleanOptional

creatorstringOptional

namestringOptional

descriptionstringOptional

compliance_standardstringOptional

compliance_detailsstringOptional

rule_execution_typeintegerOptional

activationbooleanOptionalDefault: true

is_enabledbooleanOptionalDefault: true

vendorstringOptional

os_typestringOptional

is_editablebooleanOptional

device_typestringOptional

config_typestringOptional

inv_commandsstringOptional

other_configsstringOptional

config_script_idstringOptional

config_script_commandsstringOptional

nw_reviewsstringOptional

executionbooleanOptional

rule_start_timestring · date-timeOptional

rule_end_timestring · date-timeOptional

severityintegerOptional

alarm_msgstringOptional

notifier_idstringOptional

rollback_script_idstringOptional

rollback_script_commandsstringOptional

rollback_script_adv_commandsstringOptional

rollback_commentsstringOptional

continue_nextcommand_on_failurebooleanOptional

rule_infostringOptional

template_idstringOptional

os_versionstringOptional

Responses

200Success

application/json

post

/ux/nccm/configuration_rules/validate-json/

HTTPcURLJavaScriptPython

POST /ux/nccm/configuration_rules/validate-json/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1053

{
  "ruleid": "text",
  "rule_display_id": "text",
  "organization": "text",
  "last_update_time": "2026-01-22T13:43:46.591Z",
  "creation_time": "2026-01-22T13:43:46.591Z",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "is_private": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text",
  "name": "text",
  "description": "text",
  "compliance_standard": "text",
  "compliance_details": "text",
  "rule_execution_type": 1,
  "activation": true,
  "is_enabled": true,
  "vendor": "text",
  "os_type": "text",
  "is_editable": true,
  "device_type": "text",
  "config_type": "text",
  "inv_commands": "text",
  "other_configs": "text",
  "config_script_id": "text",
  "config_script_commands": "text",
  "cve_ids": [],
  "nw_reviews": "text",
  "execution": true,
  "rule_start_time": "2026-01-22T13:43:46.591Z",
  "rule_end_time": "2026-01-22T13:43:46.591Z",
  "severity": 1,
  "alarm_msg": "text",
  "notifier_id": "text",
  "rollback_script_id": "text",
  "rollback_script_commands": "text",
  "rollback_script_adv_commands": "text",
  "rollback_comments": "text",
  "continue_nextcommand_on_failure": true,
  "rule_info": "text",
  "template_id": "text",
  "os_version": "text"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "rule_config_severity": "text",
  "rule_type": "text",
  "match_criteria": "text",
  "status": "text",
  "rollback_type": "text",
  "on_violation_perform": "text",
  "remedy_configured": "text",
  "rule_description": "text",
  "ruleid": "text",
  "rule_display_id": "text",
  "organization": "text",
  "last_update_time": "2026-01-22T13:43:46.591Z",
  "creation_time": "2026-01-22T13:43:46.591Z",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "is_private": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text",
  "name": "text",
  "description": "text",
  "compliance_standard": "text",
  "compliance_details": "text",
  "rule_execution_type": 1,
  "activation": true,
  "is_enabled": true,
  "vendor": "text",
  "os_type": "text",
  "is_editable": true,
  "device_type": "text",
  "config_type": "text",
  "inv_commands": "text",
  "other_configs": "text",
  "config_script_id": "text",
  "config_script_commands": "text",
  "cve_ids": [],
  "nw_reviews": "text",
  "execution": true,
  "rule_start_time": "2026-01-22T13:43:46.591Z",
  "rule_end_time": "2026-01-22T13:43:46.591Z",
  "severity": 1,
  "alarm_msg": "text",
  "notifier_id": "text",
  "rollback_script_id": "text",
  "rollback_script_commands": "text",
  "rollback_script_adv_commands": "text",
  "rollback_comments": "text",
  "continue_nextcommand_on_failure": true,
  "rule_info": "text",
  "template_id": "text",
  "os_version": "text"
}