Configuration Policies

Gets a list of configuration policies

get

This endpoint is used to fetch all the configuration pplicies 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

HTTPcURLJavaScriptPython

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

200Success

[
  {
    "id": "text",
    "status": "text",
    "creationtime": "text",
    "last_update_time": "text",
    "next_action_time": "text",
    "last_action_time": "text",
    "is_private": "text",
    "rule_description": "text",
    "schedule_descr": "text",
    "visibility": "text",
    "policyid": "text",
    "name": "text",
    "description": "text",
    "organization": "text",
    "processid": 1,
    "associate_users": "text",
    "associate_groups": "text",
    "associated_rules": "text",
    "associated_rule_groups": [],
    "lastupdatetime": "2025-08-31T16:02:16.736Z",
    "activated_by": "text",
    "activation_time": "2025-08-31T16:02:16.736Z",
    "activation_remarks": "text",
    "policy_schedule": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "lastaction": "2025-08-31T16:02:16.736Z",
    "nextaction": "2025-08-31T16:02:16.736Z",
    "progress": 1,
    "starttime": 1,
    "endtime": 1,
    "created_by": "text",
    "modified_by": "text",
    "assigned_users": [],
    "assigned_group": [],
    "is_deleted": true
  }
]

Creates a new configuration policies

post

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

Authorizations

Body

Other propertiesanyOptional

Responses

201

No response body

No content

post

HTTPcURLJavaScriptPython

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

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

201

No response body

No content

Gets a configuration policy details with the given id

get

This endpoint is used to fetch a configuration profiles in the current organization

Authorizations

Path parameters

idstringRequired

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

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

200Success

{
  "id": "text",
  "status": "text",
  "creationtime": "text",
  "last_update_time": "text",
  "next_action_time": "text",
  "last_action_time": "text",
  "is_private": "text",
  "rule_description": "text",
  "schedule_descr": "text",
  "visibility": "text",
  "policyid": "text",
  "name": "text",
  "description": "text",
  "organization": "text",
  "processid": 1,
  "associate_users": "text",
  "associate_groups": "text",
  "associated_rules": "text",
  "associated_rule_groups": [],
  "lastupdatetime": "2025-08-31T16:02:16.736Z",
  "activated_by": "text",
  "activation_time": "2025-08-31T16:02:16.736Z",
  "activation_remarks": "text",
  "policy_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "lastaction": "2025-08-31T16:02:16.736Z",
  "nextaction": "2025-08-31T16:02:16.736Z",
  "progress": 1,
  "starttime": 1,
  "endtime": 1,
  "created_by": "text",
  "modified_by": "text",
  "assigned_users": [],
  "assigned_group": [],
  "is_deleted": true
}

Edits the configuration policies with given id

put

This endpoint is used to edit an existing configuration policies for the current organization

Authorizations

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

statusstringRead-onlyRequired

creationtimestringRead-onlyRequired

last_update_timestringRead-onlyRequired

next_action_timestringRead-onlyRequired

last_action_timestringRead-onlyRequired

is_privatestringRead-onlyRequired

rule_descriptionstringRead-onlyRequired

schedule_descrstringRead-onlyRequired

visibilitystringRead-onlyRequired

policyidstring · max: 25Required

namestringOptional

descriptionstringOptional

organizationstring · max: 25Required

processidintegerOptionalDefault: 1

associate_usersstringOptional

associate_groupsstringOptional

associated_rulesstringOptional

lastupdatetimestring · date-timeOptional

activated_bystringOptional

activation_timestring · date-timeOptional

activation_remarksstringOptional

lastactionstring · date-timeOptional

nextactionstring · date-timeOptional

progressintegerOptional

starttimeintegerOptional

endtimeintegerOptional

created_bystringOptional

modified_bystringOptional

is_deletedbooleanOptional

Responses

200Success

application/json

put

HTTPcURLJavaScriptPython

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

{
  "policyid": "text",
  "name": "text",
  "description": "text",
  "organization": "text",
  "processid": 1,
  "associate_users": "text",
  "associate_groups": "text",
  "associated_rules": "text",
  "associated_rule_groups": [],
  "lastupdatetime": "2025-08-31T16:02:16.736Z",
  "activated_by": "text",
  "activation_time": "2025-08-31T16:02:16.736Z",
  "activation_remarks": "text",
  "policy_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "lastaction": "2025-08-31T16:02:16.736Z",
  "nextaction": "2025-08-31T16:02:16.736Z",
  "progress": 1,
  "starttime": 1,
  "endtime": 1,
  "created_by": "text",
  "modified_by": "text",
  "assigned_users": [],
  "assigned_group": [],
  "is_deleted": true
}

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

200Success

{
  "id": "text",
  "status": "text",
  "creationtime": "text",
  "last_update_time": "text",
  "next_action_time": "text",
  "last_action_time": "text",
  "is_private": "text",
  "rule_description": "text",
  "schedule_descr": "text",
  "visibility": "text",
  "policyid": "text",
  "name": "text",
  "description": "text",
  "organization": "text",
  "processid": 1,
  "associate_users": "text",
  "associate_groups": "text",
  "associated_rules": "text",
  "associated_rule_groups": [],
  "lastupdatetime": "2025-08-31T16:02:16.736Z",
  "activated_by": "text",
  "activation_time": "2025-08-31T16:02:16.736Z",
  "activation_remarks": "text",
  "policy_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "lastaction": "2025-08-31T16:02:16.736Z",
  "nextaction": "2025-08-31T16:02:16.736Z",
  "progress": 1,
  "starttime": 1,
  "endtime": 1,
  "created_by": "text",
  "modified_by": "text",
  "assigned_users": [],
  "assigned_group": [],
  "is_deleted": true
}

Deletes the configuration policies with given id

delete

This endpoint is used to delete an existing configuration policies for the current organization

Authorizations

Path parameters

idstringRequired

Responses

204

No response body

No content

delete

HTTPcURLJavaScriptPython

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

204

No response body

No content

post

API endpoint that allows users to be viewed or edited.

Authorizations

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

statusstringRead-onlyRequired

creationtimestringRead-onlyRequired

last_update_timestringRead-onlyRequired

next_action_timestringRead-onlyRequired

last_action_timestringRead-onlyRequired

is_privatestringRead-onlyRequired

rule_descriptionstringRead-onlyRequired

schedule_descrstringRead-onlyRequired

visibilitystringRead-onlyRequired

policyidstring · max: 25Required

namestringOptional

descriptionstringOptional

organizationstring · max: 25Required

processidintegerOptionalDefault: 1

associate_usersstringOptional

associate_groupsstringOptional

associated_rulesstringOptional

lastupdatetimestring · date-timeOptional

activated_bystringOptional

activation_timestring · date-timeOptional

activation_remarksstringOptional

lastactionstring · date-timeOptional

nextactionstring · date-timeOptional

progressintegerOptional

starttimeintegerOptional

endtimeintegerOptional

created_bystringOptional

modified_bystringOptional

is_deletedbooleanOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/nccm/configuration_policies/bulk-opration/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 609

{
  "policyid": "text",
  "name": "text",
  "description": "text",
  "organization": "text",
  "processid": 1,
  "associate_users": "text",
  "associate_groups": "text",
  "associated_rules": "text",
  "associated_rule_groups": [],
  "lastupdatetime": "2025-08-31T16:02:16.736Z",
  "activated_by": "text",
  "activation_time": "2025-08-31T16:02:16.736Z",
  "activation_remarks": "text",
  "policy_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "lastaction": "2025-08-31T16:02:16.736Z",
  "nextaction": "2025-08-31T16:02:16.736Z",
  "progress": 1,
  "starttime": 1,
  "endtime": 1,
  "created_by": "text",
  "modified_by": "text",
  "assigned_users": [],
  "assigned_group": [],
  "is_deleted": true
}

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

200Success

{
  "id": "text",
  "status": "text",
  "creationtime": "text",
  "last_update_time": "text",
  "next_action_time": "text",
  "last_action_time": "text",
  "is_private": "text",
  "rule_description": "text",
  "schedule_descr": "text",
  "visibility": "text",
  "policyid": "text",
  "name": "text",
  "description": "text",
  "organization": "text",
  "processid": 1,
  "associate_users": "text",
  "associate_groups": "text",
  "associated_rules": "text",
  "associated_rule_groups": [],
  "lastupdatetime": "2025-08-31T16:02:16.736Z",
  "activated_by": "text",
  "activation_time": "2025-08-31T16:02:16.736Z",
  "activation_remarks": "text",
  "policy_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "lastaction": "2025-08-31T16:02:16.736Z",
  "nextaction": "2025-08-31T16:02:16.736Z",
  "progress": 1,
  "starttime": 1,
  "endtime": 1,
  "created_by": "text",
  "modified_by": "text",
  "assigned_users": [],
  "assigned_group": [],
  "is_deleted": true
}

post

API endpoint that allows users to be viewed or edited.

Authorizations

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

statusstringRead-onlyRequired

creationtimestringRead-onlyRequired

last_update_timestringRead-onlyRequired

next_action_timestringRead-onlyRequired

last_action_timestringRead-onlyRequired

is_privatestringRead-onlyRequired

rule_descriptionstringRead-onlyRequired

schedule_descrstringRead-onlyRequired

visibilitystringRead-onlyRequired

policyidstring · max: 25Required

namestringOptional

descriptionstringOptional

organizationstring · max: 25Required

processidintegerOptionalDefault: 1

associate_usersstringOptional

associate_groupsstringOptional

associated_rulesstringOptional

lastupdatetimestring · date-timeOptional

activated_bystringOptional

activation_timestring · date-timeOptional

activation_remarksstringOptional

lastactionstring · date-timeOptional

nextactionstring · date-timeOptional

progressintegerOptional

starttimeintegerOptional

endtimeintegerOptional

created_bystringOptional

modified_bystringOptional

is_deletedbooleanOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/nccm/configuration_policies/multi-delete/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 609

{
  "policyid": "text",
  "name": "text",
  "description": "text",
  "organization": "text",
  "processid": 1,
  "associate_users": "text",
  "associate_groups": "text",
  "associated_rules": "text",
  "associated_rule_groups": [],
  "lastupdatetime": "2025-08-31T16:02:16.736Z",
  "activated_by": "text",
  "activation_time": "2025-08-31T16:02:16.736Z",
  "activation_remarks": "text",
  "policy_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "lastaction": "2025-08-31T16:02:16.736Z",
  "nextaction": "2025-08-31T16:02:16.736Z",
  "progress": 1,
  "starttime": 1,
  "endtime": 1,
  "created_by": "text",
  "modified_by": "text",
  "assigned_users": [],
  "assigned_group": [],
  "is_deleted": true
}

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

200Success

{
  "id": "text",
  "status": "text",
  "creationtime": "text",
  "last_update_time": "text",
  "next_action_time": "text",
  "last_action_time": "text",
  "is_private": "text",
  "rule_description": "text",
  "schedule_descr": "text",
  "visibility": "text",
  "policyid": "text",
  "name": "text",
  "description": "text",
  "organization": "text",
  "processid": 1,
  "associate_users": "text",
  "associate_groups": "text",
  "associated_rules": "text",
  "associated_rule_groups": [],
  "lastupdatetime": "2025-08-31T16:02:16.736Z",
  "activated_by": "text",
  "activation_time": "2025-08-31T16:02:16.736Z",
  "activation_remarks": "text",
  "policy_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "lastaction": "2025-08-31T16:02:16.736Z",
  "nextaction": "2025-08-31T16:02:16.736Z",
  "progress": 1,
  "starttime": 1,
  "endtime": 1,
  "created_by": "text",
  "modified_by": "text",
  "assigned_users": [],
  "assigned_group": [],
  "is_deleted": true
}

Get the options for the Configuration Polocies

get

This endpoint is used to get the default options for jobs Account Audit

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

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

200Success

{
  "id": "text",
  "status": "text",
  "creationtime": "text",
  "last_update_time": "text",
  "next_action_time": "text",
  "last_action_time": "text",
  "is_private": "text",
  "rule_description": "text",
  "schedule_descr": "text",
  "visibility": "text",
  "policyid": "text",
  "name": "text",
  "description": "text",
  "organization": "text",
  "processid": 1,
  "associate_users": "text",
  "associate_groups": "text",
  "associated_rules": "text",
  "associated_rule_groups": [],
  "lastupdatetime": "2025-08-31T16:02:16.736Z",
  "activated_by": "text",
  "activation_time": "2025-08-31T16:02:16.736Z",
  "activation_remarks": "text",
  "policy_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "lastaction": "2025-08-31T16:02:16.736Z",
  "nextaction": "2025-08-31T16:02:16.736Z",
  "progress": 1,
  "starttime": 1,
  "endtime": 1,
  "created_by": "text",
  "modified_by": "text",
  "assigned_users": [],
  "assigned_group": [],
  "is_deleted": true
}