Configuration Template

Gets a list of configuration template

get

This endpoint is used to fetch all the configuration template 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_template/?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",
    "status": "text",
    "is_private": "text",
    "user_list": "text",
    "teams_list": "text",
    "configuration_template_visibility": "text",
    "simple_script_exe_visibility": "text",
    "created_by_profile": "text",
    "modified_by_profile": "text",
    "template_id": "text",
    "organization": "text",
    "name": "text",
    "description": "text",
    "vendor": "text",
    "os_name": "text",
    "model": "text",
    "series": "text",
    "template_type": "text",
    "script_type": 1,
    "is_approval_required": true,
    "is_production_enabled": true,
    "quick_add": true,
    "script_commands": "text",
    "script_profile_commands": "text",
    "configuration_store": "text",
    "shell": "text",
    "last_update_time": "2025-08-31T16:03:07.835Z",
    "template_group": "text",
    "created_by": "text",
    "modified_by": "text",
    "creation_time": "2025-08-31T16:03:07.835Z",
    "is_deleted": true,
    "is_enabled": true,
    "assigned_users": [],
    "assigned_group": [],
    "creator": "text"
  }
]

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

created_by_namestringRead-onlyRequired

modified_by_namestringRead-onlyRequired

statusstringRead-onlyRequired

is_privatestringRead-onlyRequired

user_liststringRead-onlyRequired

teams_liststringRead-onlyRequired

configuration_template_visibilitystringRead-onlyRequired

simple_script_exe_visibilitystringRead-onlyRequired

created_by_profilestringRead-onlyRequired

modified_by_profilestringRead-onlyRequired

template_idstring · max: 25Required

organizationstring · max: 25Required

namestringOptional

descriptionstringOptional

vendorstringOptional

os_namestringOptional

modelstringOptional

seriesstringOptional

template_typestringOptional

script_typeintegerOptional

is_approval_requiredbooleanOptional

is_production_enabledbooleanOptional

quick_addbooleanOptional

script_commandsstringOptional

script_profile_commandsstringOptional

configuration_storestringOptional

shellstringOptional

last_update_timestring · date-timeOptional

template_groupstringOptional

created_bystringOptional

modified_bystringOptional

creation_timestring · date-timeOptional

is_deletedbooleanOptional

is_enabledbooleanOptionalDefault: true

creatorstringOptional

Responses

201Success

application/json

post

HTTPcURLJavaScriptPython

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

{
  "template_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "vendor": "text",
  "os_name": "text",
  "model": "text",
  "series": "text",
  "template_type": "text",
  "script_type": 1,
  "is_approval_required": true,
  "is_production_enabled": true,
  "quick_add": true,
  "script_commands": "text",
  "script_profile_commands": "text",
  "configuration_store": "text",
  "shell": "text",
  "last_update_time": "2025-08-31T16:03:07.835Z",
  "template_group": "text",
  "created_by": "text",
  "modified_by": "text",
  "creation_time": "2025-08-31T16:03:07.835Z",
  "is_deleted": true,
  "is_enabled": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text"
}

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

201Success

{
  "id": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "status": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "configuration_template_visibility": "text",
  "simple_script_exe_visibility": "text",
  "created_by_profile": "text",
  "modified_by_profile": "text",
  "template_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "vendor": "text",
  "os_name": "text",
  "model": "text",
  "series": "text",
  "template_type": "text",
  "script_type": 1,
  "is_approval_required": true,
  "is_production_enabled": true,
  "quick_add": true,
  "script_commands": "text",
  "script_profile_commands": "text",
  "configuration_store": "text",
  "shell": "text",
  "last_update_time": "2025-08-31T16:03:07.835Z",
  "template_group": "text",
  "created_by": "text",
  "modified_by": "text",
  "creation_time": "2025-08-31T16:03:07.835Z",
  "is_deleted": true,
  "is_enabled": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text"
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

Path parameters

idstringRequired

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

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

200Success

{
  "id": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "status": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "configuration_template_visibility": "text",
  "simple_script_exe_visibility": "text",
  "created_by_profile": "text",
  "modified_by_profile": "text",
  "template_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "vendor": "text",
  "os_name": "text",
  "model": "text",
  "series": "text",
  "template_type": "text",
  "script_type": 1,
  "is_approval_required": true,
  "is_production_enabled": true,
  "quick_add": true,
  "script_commands": "text",
  "script_profile_commands": "text",
  "configuration_store": "text",
  "shell": "text",
  "last_update_time": "2025-08-31T16:03:07.835Z",
  "template_group": "text",
  "created_by": "text",
  "modified_by": "text",
  "creation_time": "2025-08-31T16:03:07.835Z",
  "is_deleted": true,
  "is_enabled": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text"
}

put

API endpoint that allows users to be viewed or edited.

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

created_by_namestringRead-onlyRequired

modified_by_namestringRead-onlyRequired

statusstringRead-onlyRequired

is_privatestringRead-onlyRequired

user_liststringRead-onlyRequired

teams_liststringRead-onlyRequired

configuration_template_visibilitystringRead-onlyRequired

simple_script_exe_visibilitystringRead-onlyRequired

created_by_profilestringRead-onlyRequired

modified_by_profilestringRead-onlyRequired

template_idstring · max: 25Required

organizationstring · max: 25Required

namestringOptional

descriptionstringOptional

vendorstringOptional

os_namestringOptional

modelstringOptional

seriesstringOptional

template_typestringOptional

script_typeintegerOptional

is_approval_requiredbooleanOptional

is_production_enabledbooleanOptional

quick_addbooleanOptional

script_commandsstringOptional

script_profile_commandsstringOptional

configuration_storestringOptional

shellstringOptional

last_update_timestring · date-timeOptional

template_groupstringOptional

created_bystringOptional

modified_bystringOptional

creation_timestring · date-timeOptional

is_deletedbooleanOptional

is_enabledbooleanOptionalDefault: true

creatorstringOptional

Responses

200Success

application/json

put

HTTPcURLJavaScriptPython

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

{
  "template_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "vendor": "text",
  "os_name": "text",
  "model": "text",
  "series": "text",
  "template_type": "text",
  "script_type": 1,
  "is_approval_required": true,
  "is_production_enabled": true,
  "quick_add": true,
  "script_commands": "text",
  "script_profile_commands": "text",
  "configuration_store": "text",
  "shell": "text",
  "last_update_time": "2025-08-31T16:03:07.835Z",
  "template_group": "text",
  "created_by": "text",
  "modified_by": "text",
  "creation_time": "2025-08-31T16:03:07.835Z",
  "is_deleted": true,
  "is_enabled": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text"
}

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

200Success

{
  "id": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "status": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "configuration_template_visibility": "text",
  "simple_script_exe_visibility": "text",
  "created_by_profile": "text",
  "modified_by_profile": "text",
  "template_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "vendor": "text",
  "os_name": "text",
  "model": "text",
  "series": "text",
  "template_type": "text",
  "script_type": 1,
  "is_approval_required": true,
  "is_production_enabled": true,
  "quick_add": true,
  "script_commands": "text",
  "script_profile_commands": "text",
  "configuration_store": "text",
  "shell": "text",
  "last_update_time": "2025-08-31T16:03:07.835Z",
  "template_group": "text",
  "created_by": "text",
  "modified_by": "text",
  "creation_time": "2025-08-31T16:03:07.835Z",
  "is_deleted": true,
  "is_enabled": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text"
}

delete

API endpoint that allows users to be viewed or edited.

Authorizations

Path parameters

idstringRequired

Responses

204

No response body

No content

delete

HTTPcURLJavaScriptPython

DELETE /ux/nccm/configuration_template/{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

created_by_namestringRead-onlyRequired

modified_by_namestringRead-onlyRequired

statusstringRead-onlyRequired

is_privatestringRead-onlyRequired

user_liststringRead-onlyRequired

teams_liststringRead-onlyRequired

configuration_template_visibilitystringRead-onlyRequired

simple_script_exe_visibilitystringRead-onlyRequired

created_by_profilestringRead-onlyRequired

modified_by_profilestringRead-onlyRequired

template_idstring · max: 25Required

organizationstring · max: 25Required

namestringOptional

descriptionstringOptional

vendorstringOptional

os_namestringOptional

modelstringOptional

seriesstringOptional

template_typestringOptional

script_typeintegerOptional

is_approval_requiredbooleanOptional

is_production_enabledbooleanOptional

quick_addbooleanOptional

script_commandsstringOptional

script_profile_commandsstringOptional

configuration_storestringOptional

shellstringOptional

last_update_timestring · date-timeOptional

template_groupstringOptional

created_bystringOptional

modified_bystringOptional

creation_timestring · date-timeOptional

is_deletedbooleanOptional

is_enabledbooleanOptionalDefault: true

creatorstringOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/nccm/configuration_template/create-csv/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 605

{
  "template_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "vendor": "text",
  "os_name": "text",
  "model": "text",
  "series": "text",
  "template_type": "text",
  "script_type": 1,
  "is_approval_required": true,
  "is_production_enabled": true,
  "quick_add": true,
  "script_commands": "text",
  "script_profile_commands": "text",
  "configuration_store": "text",
  "shell": "text",
  "last_update_time": "2025-08-31T16:03:07.835Z",
  "template_group": "text",
  "created_by": "text",
  "modified_by": "text",
  "creation_time": "2025-08-31T16:03:07.835Z",
  "is_deleted": true,
  "is_enabled": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text"
}

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

200Success

{
  "id": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "status": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "configuration_template_visibility": "text",
  "simple_script_exe_visibility": "text",
  "created_by_profile": "text",
  "modified_by_profile": "text",
  "template_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "vendor": "text",
  "os_name": "text",
  "model": "text",
  "series": "text",
  "template_type": "text",
  "script_type": 1,
  "is_approval_required": true,
  "is_production_enabled": true,
  "quick_add": true,
  "script_commands": "text",
  "script_profile_commands": "text",
  "configuration_store": "text",
  "shell": "text",
  "last_update_time": "2025-08-31T16:03:07.835Z",
  "template_group": "text",
  "created_by": "text",
  "modified_by": "text",
  "creation_time": "2025-08-31T16:03:07.835Z",
  "is_deleted": true,
  "is_enabled": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text"
}

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

created_by_namestringRead-onlyRequired

modified_by_namestringRead-onlyRequired

statusstringRead-onlyRequired

is_privatestringRead-onlyRequired

user_liststringRead-onlyRequired

teams_liststringRead-onlyRequired

configuration_template_visibilitystringRead-onlyRequired

simple_script_exe_visibilitystringRead-onlyRequired

created_by_profilestringRead-onlyRequired

modified_by_profilestringRead-onlyRequired

template_idstring · max: 25Required

organizationstring · max: 25Required

namestringOptional

descriptionstringOptional

vendorstringOptional

os_namestringOptional

modelstringOptional

seriesstringOptional

template_typestringOptional

script_typeintegerOptional

is_approval_requiredbooleanOptional

is_production_enabledbooleanOptional

quick_addbooleanOptional

script_commandsstringOptional

script_profile_commandsstringOptional

configuration_storestringOptional

shellstringOptional

last_update_timestring · date-timeOptional

template_groupstringOptional

created_bystringOptional

modified_bystringOptional

creation_timestring · date-timeOptional

is_deletedbooleanOptional

is_enabledbooleanOptionalDefault: true

creatorstringOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/nccm/configuration_template/csv_cols/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 605

{
  "template_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "vendor": "text",
  "os_name": "text",
  "model": "text",
  "series": "text",
  "template_type": "text",
  "script_type": 1,
  "is_approval_required": true,
  "is_production_enabled": true,
  "quick_add": true,
  "script_commands": "text",
  "script_profile_commands": "text",
  "configuration_store": "text",
  "shell": "text",
  "last_update_time": "2025-08-31T16:03:07.835Z",
  "template_group": "text",
  "created_by": "text",
  "modified_by": "text",
  "creation_time": "2025-08-31T16:03:07.835Z",
  "is_deleted": true,
  "is_enabled": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text"
}

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

200Success

{
  "id": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "status": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "configuration_template_visibility": "text",
  "simple_script_exe_visibility": "text",
  "created_by_profile": "text",
  "modified_by_profile": "text",
  "template_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "vendor": "text",
  "os_name": "text",
  "model": "text",
  "series": "text",
  "template_type": "text",
  "script_type": 1,
  "is_approval_required": true,
  "is_production_enabled": true,
  "quick_add": true,
  "script_commands": "text",
  "script_profile_commands": "text",
  "configuration_store": "text",
  "shell": "text",
  "last_update_time": "2025-08-31T16:03:07.835Z",
  "template_group": "text",
  "created_by": "text",
  "modified_by": "text",
  "creation_time": "2025-08-31T16:03:07.835Z",
  "is_deleted": true,
  "is_enabled": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text"
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/configuration_template/download_csv/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "status": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "configuration_template_visibility": "text",
  "simple_script_exe_visibility": "text",
  "created_by_profile": "text",
  "modified_by_profile": "text",
  "template_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "vendor": "text",
  "os_name": "text",
  "model": "text",
  "series": "text",
  "template_type": "text",
  "script_type": 1,
  "is_approval_required": true,
  "is_production_enabled": true,
  "quick_add": true,
  "script_commands": "text",
  "script_profile_commands": "text",
  "configuration_store": "text",
  "shell": "text",
  "last_update_time": "2025-08-31T16:03:07.835Z",
  "template_group": "text",
  "created_by": "text",
  "modified_by": "text",
  "creation_time": "2025-08-31T16:03:07.835Z",
  "is_deleted": true,
  "is_enabled": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text"
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/configuration_template/download_xls/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "status": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "configuration_template_visibility": "text",
  "simple_script_exe_visibility": "text",
  "created_by_profile": "text",
  "modified_by_profile": "text",
  "template_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "vendor": "text",
  "os_name": "text",
  "model": "text",
  "series": "text",
  "template_type": "text",
  "script_type": 1,
  "is_approval_required": true,
  "is_production_enabled": true,
  "quick_add": true,
  "script_commands": "text",
  "script_profile_commands": "text",
  "configuration_store": "text",
  "shell": "text",
  "last_update_time": "2025-08-31T16:03:07.835Z",
  "template_group": "text",
  "created_by": "text",
  "modified_by": "text",
  "creation_time": "2025-08-31T16:03:07.835Z",
  "is_deleted": true,
  "is_enabled": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text"
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/configuration_template/file_details/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "status": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "configuration_template_visibility": "text",
  "simple_script_exe_visibility": "text",
  "created_by_profile": "text",
  "modified_by_profile": "text",
  "template_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "vendor": "text",
  "os_name": "text",
  "model": "text",
  "series": "text",
  "template_type": "text",
  "script_type": 1,
  "is_approval_required": true,
  "is_production_enabled": true,
  "quick_add": true,
  "script_commands": "text",
  "script_profile_commands": "text",
  "configuration_store": "text",
  "shell": "text",
  "last_update_time": "2025-08-31T16:03:07.835Z",
  "template_group": "text",
  "created_by": "text",
  "modified_by": "text",
  "creation_time": "2025-08-31T16:03:07.835Z",
  "is_deleted": true,
  "is_enabled": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text"
}

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

created_by_namestringRead-onlyRequired

modified_by_namestringRead-onlyRequired

statusstringRead-onlyRequired

is_privatestringRead-onlyRequired

user_liststringRead-onlyRequired

teams_liststringRead-onlyRequired

configuration_template_visibilitystringRead-onlyRequired

simple_script_exe_visibilitystringRead-onlyRequired

created_by_profilestringRead-onlyRequired

modified_by_profilestringRead-onlyRequired

template_idstring · max: 25Required

organizationstring · max: 25Required

namestringOptional

descriptionstringOptional

vendorstringOptional

os_namestringOptional

modelstringOptional

seriesstringOptional

template_typestringOptional

script_typeintegerOptional

is_approval_requiredbooleanOptional

is_production_enabledbooleanOptional

quick_addbooleanOptional

script_commandsstringOptional

script_profile_commandsstringOptional

configuration_storestringOptional

shellstringOptional

last_update_timestring · date-timeOptional

template_groupstringOptional

created_bystringOptional

modified_bystringOptional

creation_timestring · date-timeOptional

is_deletedbooleanOptional

is_enabledbooleanOptionalDefault: true

creatorstringOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

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

{
  "template_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "vendor": "text",
  "os_name": "text",
  "model": "text",
  "series": "text",
  "template_type": "text",
  "script_type": 1,
  "is_approval_required": true,
  "is_production_enabled": true,
  "quick_add": true,
  "script_commands": "text",
  "script_profile_commands": "text",
  "configuration_store": "text",
  "shell": "text",
  "last_update_time": "2025-08-31T16:03:07.835Z",
  "template_group": "text",
  "created_by": "text",
  "modified_by": "text",
  "creation_time": "2025-08-31T16:03:07.835Z",
  "is_deleted": true,
  "is_enabled": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text"
}

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

200Success

{
  "id": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "status": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "configuration_template_visibility": "text",
  "simple_script_exe_visibility": "text",
  "created_by_profile": "text",
  "modified_by_profile": "text",
  "template_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "vendor": "text",
  "os_name": "text",
  "model": "text",
  "series": "text",
  "template_type": "text",
  "script_type": 1,
  "is_approval_required": true,
  "is_production_enabled": true,
  "quick_add": true,
  "script_commands": "text",
  "script_profile_commands": "text",
  "configuration_store": "text",
  "shell": "text",
  "last_update_time": "2025-08-31T16:03:07.835Z",
  "template_group": "text",
  "created_by": "text",
  "modified_by": "text",
  "creation_time": "2025-08-31T16:03:07.835Z",
  "is_deleted": true,
  "is_enabled": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text"
}

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

created_by_namestringRead-onlyRequired

modified_by_namestringRead-onlyRequired

statusstringRead-onlyRequired

is_privatestringRead-onlyRequired

user_liststringRead-onlyRequired

teams_liststringRead-onlyRequired

configuration_template_visibilitystringRead-onlyRequired

simple_script_exe_visibilitystringRead-onlyRequired

created_by_profilestringRead-onlyRequired

modified_by_profilestringRead-onlyRequired

template_idstring · max: 25Required

organizationstring · max: 25Required

namestringOptional

descriptionstringOptional

vendorstringOptional

os_namestringOptional

modelstringOptional

seriesstringOptional

template_typestringOptional

script_typeintegerOptional

is_approval_requiredbooleanOptional

is_production_enabledbooleanOptional

quick_addbooleanOptional

script_commandsstringOptional

script_profile_commandsstringOptional

configuration_storestringOptional

shellstringOptional

last_update_timestring · date-timeOptional

template_groupstringOptional

created_bystringOptional

modified_bystringOptional

creation_timestring · date-timeOptional

is_deletedbooleanOptional

is_enabledbooleanOptionalDefault: true

creatorstringOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

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

{
  "template_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "vendor": "text",
  "os_name": "text",
  "model": "text",
  "series": "text",
  "template_type": "text",
  "script_type": 1,
  "is_approval_required": true,
  "is_production_enabled": true,
  "quick_add": true,
  "script_commands": "text",
  "script_profile_commands": "text",
  "configuration_store": "text",
  "shell": "text",
  "last_update_time": "2025-08-31T16:03:07.835Z",
  "template_group": "text",
  "created_by": "text",
  "modified_by": "text",
  "creation_time": "2025-08-31T16:03:07.835Z",
  "is_deleted": true,
  "is_enabled": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text"
}

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

200Success

{
  "id": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "status": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "configuration_template_visibility": "text",
  "simple_script_exe_visibility": "text",
  "created_by_profile": "text",
  "modified_by_profile": "text",
  "template_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "vendor": "text",
  "os_name": "text",
  "model": "text",
  "series": "text",
  "template_type": "text",
  "script_type": 1,
  "is_approval_required": true,
  "is_production_enabled": true,
  "quick_add": true,
  "script_commands": "text",
  "script_profile_commands": "text",
  "configuration_store": "text",
  "shell": "text",
  "last_update_time": "2025-08-31T16:03:07.835Z",
  "template_group": "text",
  "created_by": "text",
  "modified_by": "text",
  "creation_time": "2025-08-31T16:03:07.835Z",
  "is_deleted": true,
  "is_enabled": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text"
}

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

created_by_namestringRead-onlyRequired

modified_by_namestringRead-onlyRequired

statusstringRead-onlyRequired

is_privatestringRead-onlyRequired

user_liststringRead-onlyRequired

teams_liststringRead-onlyRequired

configuration_template_visibilitystringRead-onlyRequired

simple_script_exe_visibilitystringRead-onlyRequired

created_by_profilestringRead-onlyRequired

modified_by_profilestringRead-onlyRequired

template_idstring · max: 25Required

organizationstring · max: 25Required

namestringOptional

descriptionstringOptional

vendorstringOptional

os_namestringOptional

modelstringOptional

seriesstringOptional

template_typestringOptional

script_typeintegerOptional

is_approval_requiredbooleanOptional

is_production_enabledbooleanOptional

quick_addbooleanOptional

script_commandsstringOptional

script_profile_commandsstringOptional

configuration_storestringOptional

shellstringOptional

last_update_timestring · date-timeOptional

template_groupstringOptional

created_bystringOptional

modified_bystringOptional

creation_timestring · date-timeOptional

is_deletedbooleanOptional

is_enabledbooleanOptionalDefault: true

creatorstringOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

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

{
  "template_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "vendor": "text",
  "os_name": "text",
  "model": "text",
  "series": "text",
  "template_type": "text",
  "script_type": 1,
  "is_approval_required": true,
  "is_production_enabled": true,
  "quick_add": true,
  "script_commands": "text",
  "script_profile_commands": "text",
  "configuration_store": "text",
  "shell": "text",
  "last_update_time": "2025-08-31T16:03:07.835Z",
  "template_group": "text",
  "created_by": "text",
  "modified_by": "text",
  "creation_time": "2025-08-31T16:03:07.835Z",
  "is_deleted": true,
  "is_enabled": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text"
}

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

200Success

{
  "id": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "status": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "configuration_template_visibility": "text",
  "simple_script_exe_visibility": "text",
  "created_by_profile": "text",
  "modified_by_profile": "text",
  "template_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "vendor": "text",
  "os_name": "text",
  "model": "text",
  "series": "text",
  "template_type": "text",
  "script_type": 1,
  "is_approval_required": true,
  "is_production_enabled": true,
  "quick_add": true,
  "script_commands": "text",
  "script_profile_commands": "text",
  "configuration_store": "text",
  "shell": "text",
  "last_update_time": "2025-08-31T16:03:07.835Z",
  "template_group": "text",
  "created_by": "text",
  "modified_by": "text",
  "creation_time": "2025-08-31T16:03:07.835Z",
  "is_deleted": true,
  "is_enabled": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text"
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

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

200Success

{
  "id": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "status": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "configuration_template_visibility": "text",
  "simple_script_exe_visibility": "text",
  "created_by_profile": "text",
  "modified_by_profile": "text",
  "template_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "vendor": "text",
  "os_name": "text",
  "model": "text",
  "series": "text",
  "template_type": "text",
  "script_type": 1,
  "is_approval_required": true,
  "is_production_enabled": true,
  "quick_add": true,
  "script_commands": "text",
  "script_profile_commands": "text",
  "configuration_store": "text",
  "shell": "text",
  "last_update_time": "2025-08-31T16:03:07.835Z",
  "template_group": "text",
  "created_by": "text",
  "modified_by": "text",
  "creation_time": "2025-08-31T16:03:07.835Z",
  "is_deleted": true,
  "is_enabled": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text"
}

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

created_by_namestringRead-onlyRequired

modified_by_namestringRead-onlyRequired

statusstringRead-onlyRequired

is_privatestringRead-onlyRequired

user_liststringRead-onlyRequired

teams_liststringRead-onlyRequired

configuration_template_visibilitystringRead-onlyRequired

simple_script_exe_visibilitystringRead-onlyRequired

created_by_profilestringRead-onlyRequired

modified_by_profilestringRead-onlyRequired

template_idstring · max: 25Required

organizationstring · max: 25Required

namestringOptional

descriptionstringOptional

vendorstringOptional

os_namestringOptional

modelstringOptional

seriesstringOptional

template_typestringOptional

script_typeintegerOptional

is_approval_requiredbooleanOptional

is_production_enabledbooleanOptional

quick_addbooleanOptional

script_commandsstringOptional

script_profile_commandsstringOptional

configuration_storestringOptional

shellstringOptional

last_update_timestring · date-timeOptional

template_groupstringOptional

created_bystringOptional

modified_bystringOptional

creation_timestring · date-timeOptional

is_deletedbooleanOptional

is_enabledbooleanOptionalDefault: true

creatorstringOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/nccm/configuration_template/production_ready/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 605

{
  "template_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "vendor": "text",
  "os_name": "text",
  "model": "text",
  "series": "text",
  "template_type": "text",
  "script_type": 1,
  "is_approval_required": true,
  "is_production_enabled": true,
  "quick_add": true,
  "script_commands": "text",
  "script_profile_commands": "text",
  "configuration_store": "text",
  "shell": "text",
  "last_update_time": "2025-08-31T16:03:07.835Z",
  "template_group": "text",
  "created_by": "text",
  "modified_by": "text",
  "creation_time": "2025-08-31T16:03:07.835Z",
  "is_deleted": true,
  "is_enabled": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text"
}

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

200Success

{
  "id": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "status": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "configuration_template_visibility": "text",
  "simple_script_exe_visibility": "text",
  "created_by_profile": "text",
  "modified_by_profile": "text",
  "template_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "vendor": "text",
  "os_name": "text",
  "model": "text",
  "series": "text",
  "template_type": "text",
  "script_type": 1,
  "is_approval_required": true,
  "is_production_enabled": true,
  "quick_add": true,
  "script_commands": "text",
  "script_profile_commands": "text",
  "configuration_store": "text",
  "shell": "text",
  "last_update_time": "2025-08-31T16:03:07.835Z",
  "template_group": "text",
  "created_by": "text",
  "modified_by": "text",
  "creation_time": "2025-08-31T16:03:07.835Z",
  "is_deleted": true,
  "is_enabled": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text"
}

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

created_by_namestringRead-onlyRequired

modified_by_namestringRead-onlyRequired

statusstringRead-onlyRequired

is_privatestringRead-onlyRequired

user_liststringRead-onlyRequired

teams_liststringRead-onlyRequired

configuration_template_visibilitystringRead-onlyRequired

simple_script_exe_visibilitystringRead-onlyRequired

created_by_profilestringRead-onlyRequired

modified_by_profilestringRead-onlyRequired

template_idstring · max: 25Required

organizationstring · max: 25Required

namestringOptional

descriptionstringOptional

vendorstringOptional

os_namestringOptional

modelstringOptional

seriesstringOptional

template_typestringOptional

script_typeintegerOptional

is_approval_requiredbooleanOptional

is_production_enabledbooleanOptional

quick_addbooleanOptional

script_commandsstringOptional

script_profile_commandsstringOptional

configuration_storestringOptional

shellstringOptional

last_update_timestring · date-timeOptional

template_groupstringOptional

created_bystringOptional

modified_bystringOptional

creation_timestring · date-timeOptional

is_deletedbooleanOptional

is_enabledbooleanOptionalDefault: true

creatorstringOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/nccm/configuration_template/toggle-template-quickadd/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 605

{
  "template_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "vendor": "text",
  "os_name": "text",
  "model": "text",
  "series": "text",
  "template_type": "text",
  "script_type": 1,
  "is_approval_required": true,
  "is_production_enabled": true,
  "quick_add": true,
  "script_commands": "text",
  "script_profile_commands": "text",
  "configuration_store": "text",
  "shell": "text",
  "last_update_time": "2025-08-31T16:03:07.835Z",
  "template_group": "text",
  "created_by": "text",
  "modified_by": "text",
  "creation_time": "2025-08-31T16:03:07.835Z",
  "is_deleted": true,
  "is_enabled": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text"
}

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

200Success

{
  "id": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "status": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "configuration_template_visibility": "text",
  "simple_script_exe_visibility": "text",
  "created_by_profile": "text",
  "modified_by_profile": "text",
  "template_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "vendor": "text",
  "os_name": "text",
  "model": "text",
  "series": "text",
  "template_type": "text",
  "script_type": 1,
  "is_approval_required": true,
  "is_production_enabled": true,
  "quick_add": true,
  "script_commands": "text",
  "script_profile_commands": "text",
  "configuration_store": "text",
  "shell": "text",
  "last_update_time": "2025-08-31T16:03:07.835Z",
  "template_group": "text",
  "created_by": "text",
  "modified_by": "text",
  "creation_time": "2025-08-31T16:03:07.835Z",
  "is_deleted": true,
  "is_enabled": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text"
}

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

created_by_namestringRead-onlyRequired

modified_by_namestringRead-onlyRequired

statusstringRead-onlyRequired

is_privatestringRead-onlyRequired

user_liststringRead-onlyRequired

teams_liststringRead-onlyRequired

configuration_template_visibilitystringRead-onlyRequired

simple_script_exe_visibilitystringRead-onlyRequired

created_by_profilestringRead-onlyRequired

modified_by_profilestringRead-onlyRequired

template_idstring · max: 25Required

organizationstring · max: 25Required

namestringOptional

descriptionstringOptional

vendorstringOptional

os_namestringOptional

modelstringOptional

seriesstringOptional

template_typestringOptional

script_typeintegerOptional

is_approval_requiredbooleanOptional

is_production_enabledbooleanOptional

quick_addbooleanOptional

script_commandsstringOptional

script_profile_commandsstringOptional

configuration_storestringOptional

shellstringOptional

last_update_timestring · date-timeOptional

template_groupstringOptional

created_bystringOptional

modified_bystringOptional

creation_timestring · date-timeOptional

is_deletedbooleanOptional

is_enabledbooleanOptionalDefault: true

creatorstringOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/nccm/configuration_template/upload-csv/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 605

{
  "template_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "vendor": "text",
  "os_name": "text",
  "model": "text",
  "series": "text",
  "template_type": "text",
  "script_type": 1,
  "is_approval_required": true,
  "is_production_enabled": true,
  "quick_add": true,
  "script_commands": "text",
  "script_profile_commands": "text",
  "configuration_store": "text",
  "shell": "text",
  "last_update_time": "2025-08-31T16:03:07.835Z",
  "template_group": "text",
  "created_by": "text",
  "modified_by": "text",
  "creation_time": "2025-08-31T16:03:07.835Z",
  "is_deleted": true,
  "is_enabled": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text"
}

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

200Success

{
  "id": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "status": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "configuration_template_visibility": "text",
  "simple_script_exe_visibility": "text",
  "created_by_profile": "text",
  "modified_by_profile": "text",
  "template_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "vendor": "text",
  "os_name": "text",
  "model": "text",
  "series": "text",
  "template_type": "text",
  "script_type": 1,
  "is_approval_required": true,
  "is_production_enabled": true,
  "quick_add": true,
  "script_commands": "text",
  "script_profile_commands": "text",
  "configuration_store": "text",
  "shell": "text",
  "last_update_time": "2025-08-31T16:03:07.835Z",
  "template_group": "text",
  "created_by": "text",
  "modified_by": "text",
  "creation_time": "2025-08-31T16:03:07.835Z",
  "is_deleted": true,
  "is_enabled": true,
  "assigned_users": [],
  "assigned_group": [],
  "creator": "text"
}