Product DocsSchemaAuthentication

OS Image Download

Gets a list of tags

get

This endpoint is used to fetch all the tags in the current organization

Authorizations
Query parameters
items_per_pageintegerRequired

Items Per Page

pageintegerRequired

Page Number

reversebooleanOptional

Sorting Order

sortstringOptional

Sorting Key

Responses
200Success
application/json
get
GET /ux/nccm/os-image/?items_per_page=1&page=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
[
  {
    "id": "text",
    "last_update_time": "text",
    "image_id": "text",
    "download_status_obj": "text",
    "uploader_profile": "text",
    "img_id": "text",
    "organization": "text",
    "vendor": "text",
    "description": "text",
    "ostype": "text",
    "series": "text",
    "model": "text",
    "os_version": "text",
    "image_type": "text",
    "image_size": "text",
    "min_dram": 1,
    "min_flash": 1,
    "md5_hash": "text",
    "file_name": "text",
    "file_path": "text",
    "creation_time": "2025-08-31T16:02:56.596Z",
    "modified_time": "2025-08-31T16:02:56.596Z",
    "uploader_id": "2",
    "uploaded_by": "text",
    "uploaded_type": 1,
    "is_checked": true,
    "is_deleted": true,
    "job_iteration_id": "text",
    "job_id": "text"
  }
]

Creates a new configuration profile

post

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

Authorizations
Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired
last_update_timestringRead-onlyRequired
image_idstringRead-onlyRequired
download_status_objstringRead-onlyRequired
uploader_profilestringRead-onlyRequired
img_idstring · max: 25Required
organizationstring · max: 25Required
vendorstringOptional
descriptionstringOptional
ostypestringOptional
seriesstringOptional
modelstringOptional
os_versionstringOptional
image_typestringOptional
image_sizestringOptional
min_dramintegerOptional
min_flashintegerOptional
md5_hashstringOptional
file_namestringOptional
file_pathstringOptional
creation_timestring · date-timeOptional
modified_timestring · date-timeOptional
uploader_idstring | nullableOptionalDefault: 2
uploaded_bystringOptional
uploaded_typeintegerOptional
is_checkedbooleanOptional
is_deletedbooleanOptional
job_iteration_idstringOptional
job_idstringOptional
Responses
201Success
application/json
post
POST /ux/nccm/os-image/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 487

{
  "img_id": "text",
  "organization": "text",
  "vendor": "text",
  "description": "text",
  "ostype": "text",
  "series": "text",
  "model": "text",
  "os_version": "text",
  "image_type": "text",
  "image_size": "text",
  "min_dram": 1,
  "min_flash": 1,
  "md5_hash": "text",
  "file_name": "text",
  "file_path": "text",
  "creation_time": "2025-08-31T16:02:56.596Z",
  "modified_time": "2025-08-31T16:02:56.596Z",
  "uploader_id": "2",
  "uploaded_by": "text",
  "uploaded_type": 1,
  "is_checked": true,
  "is_deleted": true,
  "job_iteration_id": "text",
  "job_id": "text"
}
201Success
{
  "id": "text",
  "last_update_time": "text",
  "image_id": "text",
  "download_status_obj": "text",
  "uploader_profile": "text",
  "img_id": "text",
  "organization": "text",
  "vendor": "text",
  "description": "text",
  "ostype": "text",
  "series": "text",
  "model": "text",
  "os_version": "text",
  "image_type": "text",
  "image_size": "text",
  "min_dram": 1,
  "min_flash": 1,
  "md5_hash": "text",
  "file_name": "text",
  "file_path": "text",
  "creation_time": "2025-08-31T16:02:56.596Z",
  "modified_time": "2025-08-31T16:02:56.596Z",
  "uploader_id": "2",
  "uploaded_by": "text",
  "uploaded_type": 1,
  "is_checked": true,
  "is_deleted": true,
  "job_iteration_id": "text",
  "job_id": "text"
}

Gets a global param with the given id

get

This endpoint is used to fetch a global parameters in the current organization

Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /ux/nccm/os-image/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "id": "text",
  "last_update_time": "text",
  "image_id": "text",
  "download_status_obj": "text",
  "uploader_profile": "text",
  "img_id": "text",
  "organization": "text",
  "vendor": "text",
  "description": "text",
  "ostype": "text",
  "series": "text",
  "model": "text",
  "os_version": "text",
  "image_type": "text",
  "image_size": "text",
  "min_dram": 1,
  "min_flash": 1,
  "md5_hash": "text",
  "file_name": "text",
  "file_path": "text",
  "creation_time": "2025-08-31T16:02:56.596Z",
  "modified_time": "2025-08-31T16:02:56.596Z",
  "uploader_id": "2",
  "uploaded_by": "text",
  "uploaded_type": 1,
  "is_checked": true,
  "is_deleted": true,
  "job_iteration_id": "text",
  "job_id": "text"
}

Edits the tag with given id

put

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

Authorizations
Path parameters
idstringRequired
Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired
last_update_timestringRead-onlyRequired
image_idstringRead-onlyRequired
download_status_objstringRead-onlyRequired
uploader_profilestringRead-onlyRequired
img_idstring · max: 25Required
organizationstring · max: 25Required
vendorstringOptional
descriptionstringOptional
ostypestringOptional
seriesstringOptional
modelstringOptional
os_versionstringOptional
image_typestringOptional
image_sizestringOptional
min_dramintegerOptional
min_flashintegerOptional
md5_hashstringOptional
file_namestringOptional
file_pathstringOptional
creation_timestring · date-timeOptional
modified_timestring · date-timeOptional
uploader_idstring | nullableOptionalDefault: 2
uploaded_bystringOptional
uploaded_typeintegerOptional
is_checkedbooleanOptional
is_deletedbooleanOptional
job_iteration_idstringOptional
job_idstringOptional
Responses
200Success
application/json
put
PUT /ux/nccm/os-image/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 487

{
  "img_id": "text",
  "organization": "text",
  "vendor": "text",
  "description": "text",
  "ostype": "text",
  "series": "text",
  "model": "text",
  "os_version": "text",
  "image_type": "text",
  "image_size": "text",
  "min_dram": 1,
  "min_flash": 1,
  "md5_hash": "text",
  "file_name": "text",
  "file_path": "text",
  "creation_time": "2025-08-31T16:02:56.596Z",
  "modified_time": "2025-08-31T16:02:56.596Z",
  "uploader_id": "2",
  "uploaded_by": "text",
  "uploaded_type": 1,
  "is_checked": true,
  "is_deleted": true,
  "job_iteration_id": "text",
  "job_id": "text"
}
200Success
{
  "id": "text",
  "last_update_time": "text",
  "image_id": "text",
  "download_status_obj": "text",
  "uploader_profile": "text",
  "img_id": "text",
  "organization": "text",
  "vendor": "text",
  "description": "text",
  "ostype": "text",
  "series": "text",
  "model": "text",
  "os_version": "text",
  "image_type": "text",
  "image_size": "text",
  "min_dram": 1,
  "min_flash": 1,
  "md5_hash": "text",
  "file_name": "text",
  "file_path": "text",
  "creation_time": "2025-08-31T16:02:56.596Z",
  "modified_time": "2025-08-31T16:02:56.596Z",
  "uploader_id": "2",
  "uploaded_by": "text",
  "uploaded_type": 1,
  "is_checked": true,
  "is_deleted": true,
  "job_iteration_id": "text",
  "job_id": "text"
}

Deletes the tag with given id

delete

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

Authorizations
Path parameters
idstringRequired
Responses
204

No response body

No content
delete
DELETE /ux/nccm/os-image/{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

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
last_update_timestringRead-onlyRequired
image_idstringRead-onlyRequired
download_status_objstringRead-onlyRequired
uploader_profilestringRead-onlyRequired
img_idstring · max: 25Required
organizationstring · max: 25Required
vendorstringOptional
descriptionstringOptional
ostypestringOptional
seriesstringOptional
modelstringOptional
os_versionstringOptional
image_typestringOptional
image_sizestringOptional
min_dramintegerOptional
min_flashintegerOptional
md5_hashstringOptional
file_namestringOptional
file_pathstringOptional
creation_timestring · date-timeOptional
modified_timestring · date-timeOptional
uploader_idstring | nullableOptionalDefault: 2
uploaded_bystringOptional
uploaded_typeintegerOptional
is_checkedbooleanOptional
is_deletedbooleanOptional
job_iteration_idstringOptional
job_idstringOptional
Responses
200Success
application/json
post
POST /ux/nccm/os-image/file-upload-status/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 487

{
  "img_id": "text",
  "organization": "text",
  "vendor": "text",
  "description": "text",
  "ostype": "text",
  "series": "text",
  "model": "text",
  "os_version": "text",
  "image_type": "text",
  "image_size": "text",
  "min_dram": 1,
  "min_flash": 1,
  "md5_hash": "text",
  "file_name": "text",
  "file_path": "text",
  "creation_time": "2025-08-31T16:02:56.596Z",
  "modified_time": "2025-08-31T16:02:56.596Z",
  "uploader_id": "2",
  "uploaded_by": "text",
  "uploaded_type": 1,
  "is_checked": true,
  "is_deleted": true,
  "job_iteration_id": "text",
  "job_id": "text"
}
200Success
{
  "id": "text",
  "last_update_time": "text",
  "image_id": "text",
  "download_status_obj": "text",
  "uploader_profile": "text",
  "img_id": "text",
  "organization": "text",
  "vendor": "text",
  "description": "text",
  "ostype": "text",
  "series": "text",
  "model": "text",
  "os_version": "text",
  "image_type": "text",
  "image_size": "text",
  "min_dram": 1,
  "min_flash": 1,
  "md5_hash": "text",
  "file_name": "text",
  "file_path": "text",
  "creation_time": "2025-08-31T16:02:56.596Z",
  "modified_time": "2025-08-31T16:02:56.596Z",
  "uploader_id": "2",
  "uploaded_by": "text",
  "uploaded_type": 1,
  "is_checked": true,
  "is_deleted": true,
  "job_iteration_id": "text",
  "job_id": "text"
}

Get the file types to generagte hash key

get

This endpoint is used to get the file types that is allowed to generate the hash key

Authorizations
Responses
200Success
application/json
get
GET /ux/nccm/os-image/get-allowed-file-types/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "id": "text",
  "last_update_time": "text",
  "image_id": "text",
  "download_status_obj": "text",
  "uploader_profile": "text",
  "img_id": "text",
  "organization": "text",
  "vendor": "text",
  "description": "text",
  "ostype": "text",
  "series": "text",
  "model": "text",
  "os_version": "text",
  "image_type": "text",
  "image_size": "text",
  "min_dram": 1,
  "min_flash": 1,
  "md5_hash": "text",
  "file_name": "text",
  "file_path": "text",
  "creation_time": "2025-08-31T16:02:56.596Z",
  "modified_time": "2025-08-31T16:02:56.596Z",
  "uploader_id": "2",
  "uploaded_by": "text",
  "uploaded_type": 1,
  "is_checked": true,
  "is_deleted": true,
  "job_iteration_id": "text",
  "job_id": "text"
}
post

API endpoint that allows users to be viewed or edited.

Authorizations
Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired
last_update_timestringRead-onlyRequired
image_idstringRead-onlyRequired
download_status_objstringRead-onlyRequired
uploader_profilestringRead-onlyRequired
img_idstring · max: 25Required
organizationstring · max: 25Required
vendorstringOptional
descriptionstringOptional
ostypestringOptional
seriesstringOptional
modelstringOptional
os_versionstringOptional
image_typestringOptional
image_sizestringOptional
min_dramintegerOptional
min_flashintegerOptional
md5_hashstringOptional
file_namestringOptional
file_pathstringOptional
creation_timestring · date-timeOptional
modified_timestring · date-timeOptional
uploader_idstring | nullableOptionalDefault: 2
uploaded_bystringOptional
uploaded_typeintegerOptional
is_checkedbooleanOptional
is_deletedbooleanOptional
job_iteration_idstringOptional
job_idstringOptional
Responses
200Success
application/json
post
POST /ux/nccm/os-image/multidelete/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 487

{
  "img_id": "text",
  "organization": "text",
  "vendor": "text",
  "description": "text",
  "ostype": "text",
  "series": "text",
  "model": "text",
  "os_version": "text",
  "image_type": "text",
  "image_size": "text",
  "min_dram": 1,
  "min_flash": 1,
  "md5_hash": "text",
  "file_name": "text",
  "file_path": "text",
  "creation_time": "2025-08-31T16:02:56.596Z",
  "modified_time": "2025-08-31T16:02:56.596Z",
  "uploader_id": "2",
  "uploaded_by": "text",
  "uploaded_type": 1,
  "is_checked": true,
  "is_deleted": true,
  "job_iteration_id": "text",
  "job_id": "text"
}
200Success
{
  "id": "text",
  "last_update_time": "text",
  "image_id": "text",
  "download_status_obj": "text",
  "uploader_profile": "text",
  "img_id": "text",
  "organization": "text",
  "vendor": "text",
  "description": "text",
  "ostype": "text",
  "series": "text",
  "model": "text",
  "os_version": "text",
  "image_type": "text",
  "image_size": "text",
  "min_dram": 1,
  "min_flash": 1,
  "md5_hash": "text",
  "file_name": "text",
  "file_path": "text",
  "creation_time": "2025-08-31T16:02:56.596Z",
  "modified_time": "2025-08-31T16:02:56.596Z",
  "uploader_id": "2",
  "uploaded_by": "text",
  "uploaded_type": 1,
  "is_checked": true,
  "is_deleted": true,
  "job_iteration_id": "text",
  "job_id": "text"
}

Get the options for the Download Jobs

get

This endpoint is used to get the default options for Download Jobs

Authorizations
Responses
200Success
application/json
get
GET /ux/nccm/os-image/options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "id": "text",
  "last_update_time": "text",
  "image_id": "text",
  "download_status_obj": "text",
  "uploader_profile": "text",
  "img_id": "text",
  "organization": "text",
  "vendor": "text",
  "description": "text",
  "ostype": "text",
  "series": "text",
  "model": "text",
  "os_version": "text",
  "image_type": "text",
  "image_size": "text",
  "min_dram": 1,
  "min_flash": 1,
  "md5_hash": "text",
  "file_name": "text",
  "file_path": "text",
  "creation_time": "2025-08-31T16:02:56.596Z",
  "modified_time": "2025-08-31T16:02:56.596Z",
  "uploader_id": "2",
  "uploaded_by": "text",
  "uploaded_type": 1,
  "is_checked": true,
  "is_deleted": true,
  "job_iteration_id": "text",
  "job_id": "text"
}
get

API endpoint that allows users to be viewed or edited.

Authorizations
Responses
200Success
application/json
get
GET /ux/nccm/os-image/os-images-objs/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "id": "text",
  "last_update_time": "text",
  "image_id": "text",
  "download_status_obj": "text",
  "uploader_profile": "text",
  "img_id": "text",
  "organization": "text",
  "vendor": "text",
  "description": "text",
  "ostype": "text",
  "series": "text",
  "model": "text",
  "os_version": "text",
  "image_type": "text",
  "image_size": "text",
  "min_dram": 1,
  "min_flash": 1,
  "md5_hash": "text",
  "file_name": "text",
  "file_path": "text",
  "creation_time": "2025-08-31T16:02:56.596Z",
  "modified_time": "2025-08-31T16:02:56.596Z",
  "uploader_id": "2",
  "uploaded_by": "text",
  "uploaded_type": 1,
  "is_checked": true,
  "is_deleted": true,
  "job_iteration_id": "text",
  "job_id": "text"
}
get

API endpoint that allows users to be viewed or edited.

Authorizations
Responses
200Success
application/json
get
GET /ux/nccm/os-image/os-images-status/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "id": "text",
  "last_update_time": "text",
  "image_id": "text",
  "download_status_obj": "text",
  "uploader_profile": "text",
  "img_id": "text",
  "organization": "text",
  "vendor": "text",
  "description": "text",
  "ostype": "text",
  "series": "text",
  "model": "text",
  "os_version": "text",
  "image_type": "text",
  "image_size": "text",
  "min_dram": 1,
  "min_flash": 1,
  "md5_hash": "text",
  "file_name": "text",
  "file_path": "text",
  "creation_time": "2025-08-31T16:02:56.596Z",
  "modified_time": "2025-08-31T16:02:56.596Z",
  "uploader_id": "2",
  "uploaded_by": "text",
  "uploaded_type": 1,
  "is_checked": true,
  "is_deleted": true,
  "job_iteration_id": "text",
  "job_id": "text"
}
post

API endpoint that allows users to be viewed or edited.

Authorizations
Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired
last_update_timestringRead-onlyRequired
image_idstringRead-onlyRequired
download_status_objstringRead-onlyRequired
uploader_profilestringRead-onlyRequired
img_idstring · max: 25Required
organizationstring · max: 25Required
vendorstringOptional
descriptionstringOptional
ostypestringOptional
seriesstringOptional
modelstringOptional
os_versionstringOptional
image_typestringOptional
image_sizestringOptional
min_dramintegerOptional
min_flashintegerOptional
md5_hashstringOptional
file_namestringOptional
file_pathstringOptional
creation_timestring · date-timeOptional
modified_timestring · date-timeOptional
uploader_idstring | nullableOptionalDefault: 2
uploaded_bystringOptional
uploaded_typeintegerOptional
is_checkedbooleanOptional
is_deletedbooleanOptional
job_iteration_idstringOptional
job_idstringOptional
Responses
200Success
application/json
post
POST /ux/nccm/os-image/os-img-recve/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 487

{
  "img_id": "text",
  "organization": "text",
  "vendor": "text",
  "description": "text",
  "ostype": "text",
  "series": "text",
  "model": "text",
  "os_version": "text",
  "image_type": "text",
  "image_size": "text",
  "min_dram": 1,
  "min_flash": 1,
  "md5_hash": "text",
  "file_name": "text",
  "file_path": "text",
  "creation_time": "2025-08-31T16:02:56.596Z",
  "modified_time": "2025-08-31T16:02:56.596Z",
  "uploader_id": "2",
  "uploaded_by": "text",
  "uploaded_type": 1,
  "is_checked": true,
  "is_deleted": true,
  "job_iteration_id": "text",
  "job_id": "text"
}
200Success
{
  "id": "text",
  "last_update_time": "text",
  "image_id": "text",
  "download_status_obj": "text",
  "uploader_profile": "text",
  "img_id": "text",
  "organization": "text",
  "vendor": "text",
  "description": "text",
  "ostype": "text",
  "series": "text",
  "model": "text",
  "os_version": "text",
  "image_type": "text",
  "image_size": "text",
  "min_dram": 1,
  "min_flash": 1,
  "md5_hash": "text",
  "file_name": "text",
  "file_path": "text",
  "creation_time": "2025-08-31T16:02:56.596Z",
  "modified_time": "2025-08-31T16:02:56.596Z",
  "uploader_id": "2",
  "uploaded_by": "text",
  "uploaded_type": 1,
  "is_checked": true,
  "is_deleted": true,
  "job_iteration_id": "text",
  "job_id": "text"
}
get

API endpoint that allows users to be viewed or edited.

Authorizations
Responses
200Success
application/json
get
GET /ux/nccm/os-image/os-job-audit/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "id": "text",
  "last_update_time": "text",
  "image_id": "text",
  "download_status_obj": "text",
  "uploader_profile": "text",
  "img_id": "text",
  "organization": "text",
  "vendor": "text",
  "description": "text",
  "ostype": "text",
  "series": "text",
  "model": "text",
  "os_version": "text",
  "image_type": "text",
  "image_size": "text",
  "min_dram": 1,
  "min_flash": 1,
  "md5_hash": "text",
  "file_name": "text",
  "file_path": "text",
  "creation_time": "2025-08-31T16:02:56.596Z",
  "modified_time": "2025-08-31T16:02:56.596Z",
  "uploader_id": "2",
  "uploaded_by": "text",
  "uploaded_type": 1,
  "is_checked": true,
  "is_deleted": true,
  "job_iteration_id": "text",
  "job_id": "text"
}

Delete os schedule the given id

get

This endpoint is used to delete a os schedule in the current organization

Authorizations
Responses
200Success
application/json
get
GET /ux/nccm/os-image/os-schedule-delete/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "id": "text",
  "last_update_time": "text",
  "image_id": "text",
  "download_status_obj": "text",
  "uploader_profile": "text",
  "img_id": "text",
  "organization": "text",
  "vendor": "text",
  "description": "text",
  "ostype": "text",
  "series": "text",
  "model": "text",
  "os_version": "text",
  "image_type": "text",
  "image_size": "text",
  "min_dram": 1,
  "min_flash": 1,
  "md5_hash": "text",
  "file_name": "text",
  "file_path": "text",
  "creation_time": "2025-08-31T16:02:56.596Z",
  "modified_time": "2025-08-31T16:02:56.596Z",
  "uploader_id": "2",
  "uploaded_by": "text",
  "uploaded_type": 1,
  "is_checked": true,
  "is_deleted": true,
  "job_iteration_id": "text",
  "job_id": "text"
}

Gets a os schedule the given id

get

This endpoint is used to fetch a os schedule in the current organization

Authorizations
Responses
200Success
application/json
get
GET /ux/nccm/os-image/os-schedule-detail/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "id": "text",
  "last_update_time": "text",
  "image_id": "text",
  "download_status_obj": "text",
  "uploader_profile": "text",
  "img_id": "text",
  "organization": "text",
  "vendor": "text",
  "description": "text",
  "ostype": "text",
  "series": "text",
  "model": "text",
  "os_version": "text",
  "image_type": "text",
  "image_size": "text",
  "min_dram": 1,
  "min_flash": 1,
  "md5_hash": "text",
  "file_name": "text",
  "file_path": "text",
  "creation_time": "2025-08-31T16:02:56.596Z",
  "modified_time": "2025-08-31T16:02:56.596Z",
  "uploader_id": "2",
  "uploaded_by": "text",
  "uploaded_type": 1,
  "is_checked": true,
  "is_deleted": true,
  "job_iteration_id": "text",
  "job_id": "text"
}
get

API endpoint that allows users to be viewed or edited.

Authorizations
Responses
200Success
application/json
get
GET /ux/nccm/os-image/os-schedule-details/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "id": "text",
  "last_update_time": "text",
  "image_id": "text",
  "download_status_obj": "text",
  "uploader_profile": "text",
  "img_id": "text",
  "organization": "text",
  "vendor": "text",
  "description": "text",
  "ostype": "text",
  "series": "text",
  "model": "text",
  "os_version": "text",
  "image_type": "text",
  "image_size": "text",
  "min_dram": 1,
  "min_flash": 1,
  "md5_hash": "text",
  "file_name": "text",
  "file_path": "text",
  "creation_time": "2025-08-31T16:02:56.596Z",
  "modified_time": "2025-08-31T16:02:56.596Z",
  "uploader_id": "2",
  "uploaded_by": "text",
  "uploaded_type": 1,
  "is_checked": true,
  "is_deleted": true,
  "job_iteration_id": "text",
  "job_id": "text"
}
get

API endpoint that allows users to be viewed or edited.

Authorizations
Responses
200Success
application/json
get
GET /ux/nccm/os-image/os-schedule-options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "id": "text",
  "last_update_time": "text",
  "image_id": "text",
  "download_status_obj": "text",
  "uploader_profile": "text",
  "img_id": "text",
  "organization": "text",
  "vendor": "text",
  "description": "text",
  "ostype": "text",
  "series": "text",
  "model": "text",
  "os_version": "text",
  "image_type": "text",
  "image_size": "text",
  "min_dram": 1,
  "min_flash": 1,
  "md5_hash": "text",
  "file_name": "text",
  "file_path": "text",
  "creation_time": "2025-08-31T16:02:56.596Z",
  "modified_time": "2025-08-31T16:02:56.596Z",
  "uploader_id": "2",
  "uploaded_by": "text",
  "uploaded_type": 1,
  "is_checked": true,
  "is_deleted": true,
  "job_iteration_id": "text",
  "job_id": "text"
}

Search Options os schedule the given ids

get

This endpoint is used to Search options os schedule in the current organization

Authorizations
Responses
200Success
application/json
get
GET /ux/nccm/os-image/os-schedule-search-options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "id": "text",
  "last_update_time": "text",
  "image_id": "text",
  "download_status_obj": "text",
  "uploader_profile": "text",
  "img_id": "text",
  "organization": "text",
  "vendor": "text",
  "description": "text",
  "ostype": "text",
  "series": "text",
  "model": "text",
  "os_version": "text",
  "image_type": "text",
  "image_size": "text",
  "min_dram": 1,
  "min_flash": 1,
  "md5_hash": "text",
  "file_name": "text",
  "file_path": "text",
  "creation_time": "2025-08-31T16:02:56.596Z",
  "modified_time": "2025-08-31T16:02:56.596Z",
  "uploader_id": "2",
  "uploaded_by": "text",
  "uploaded_type": 1,
  "is_checked": true,
  "is_deleted": true,
  "job_iteration_id": "text",
  "job_id": "text"
}

Enable/disable os schedule the given ids

get

This endpoint is used to Enable/disable os schedule in the current organization

Authorizations
Responses
200Success
application/json
get
GET /ux/nccm/os-image/os-schedule-toggle-state/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "id": "text",
  "last_update_time": "text",
  "image_id": "text",
  "download_status_obj": "text",
  "uploader_profile": "text",
  "img_id": "text",
  "organization": "text",
  "vendor": "text",
  "description": "text",
  "ostype": "text",
  "series": "text",
  "model": "text",
  "os_version": "text",
  "image_type": "text",
  "image_size": "text",
  "min_dram": 1,
  "min_flash": 1,
  "md5_hash": "text",
  "file_name": "text",
  "file_path": "text",
  "creation_time": "2025-08-31T16:02:56.596Z",
  "modified_time": "2025-08-31T16:02:56.596Z",
  "uploader_id": "2",
  "uploaded_by": "text",
  "uploaded_type": 1,
  "is_checked": true,
  "is_deleted": true,
  "job_iteration_id": "text",
  "job_id": "text"
}
post

API endpoint that allows users to be viewed or edited.

Authorizations
Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired
last_update_timestringRead-onlyRequired
image_idstringRead-onlyRequired
download_status_objstringRead-onlyRequired
uploader_profilestringRead-onlyRequired
img_idstring · max: 25Required
organizationstring · max: 25Required
vendorstringOptional
descriptionstringOptional
ostypestringOptional
seriesstringOptional
modelstringOptional
os_versionstringOptional
image_typestringOptional
image_sizestringOptional
min_dramintegerOptional
min_flashintegerOptional
md5_hashstringOptional
file_namestringOptional
file_pathstringOptional
creation_timestring · date-timeOptional
modified_timestring · date-timeOptional
uploader_idstring | nullableOptionalDefault: 2
uploaded_bystringOptional
uploaded_typeintegerOptional
is_checkedbooleanOptional
is_deletedbooleanOptional
job_iteration_idstringOptional
job_idstringOptional
Responses
200Success
application/json
post
POST /ux/nccm/os-image/save-osimage-schedule-info/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 487

{
  "img_id": "text",
  "organization": "text",
  "vendor": "text",
  "description": "text",
  "ostype": "text",
  "series": "text",
  "model": "text",
  "os_version": "text",
  "image_type": "text",
  "image_size": "text",
  "min_dram": 1,
  "min_flash": 1,
  "md5_hash": "text",
  "file_name": "text",
  "file_path": "text",
  "creation_time": "2025-08-31T16:02:56.596Z",
  "modified_time": "2025-08-31T16:02:56.596Z",
  "uploader_id": "2",
  "uploaded_by": "text",
  "uploaded_type": 1,
  "is_checked": true,
  "is_deleted": true,
  "job_iteration_id": "text",
  "job_id": "text"
}
200Success
{
  "id": "text",
  "last_update_time": "text",
  "image_id": "text",
  "download_status_obj": "text",
  "uploader_profile": "text",
  "img_id": "text",
  "organization": "text",
  "vendor": "text",
  "description": "text",
  "ostype": "text",
  "series": "text",
  "model": "text",
  "os_version": "text",
  "image_type": "text",
  "image_size": "text",
  "min_dram": 1,
  "min_flash": 1,
  "md5_hash": "text",
  "file_name": "text",
  "file_path": "text",
  "creation_time": "2025-08-31T16:02:56.596Z",
  "modified_time": "2025-08-31T16:02:56.596Z",
  "uploader_id": "2",
  "uploaded_by": "text",
  "uploaded_type": 1,
  "is_checked": true,
  "is_deleted": true,
  "job_iteration_id": "text",
  "job_id": "text"
}

Search Options os schedule the given ids

post

This endpoint is used to Search options os schedule in the current organization

Authorizations
Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired
last_update_timestringRead-onlyRequired
image_idstringRead-onlyRequired
download_status_objstringRead-onlyRequired
uploader_profilestringRead-onlyRequired
img_idstring · max: 25Required
organizationstring · max: 25Required
vendorstringOptional
descriptionstringOptional
ostypestringOptional
seriesstringOptional
modelstringOptional
os_versionstringOptional
image_typestringOptional
image_sizestringOptional
min_dramintegerOptional
min_flashintegerOptional
md5_hashstringOptional
file_namestringOptional
file_pathstringOptional
creation_timestring · date-timeOptional
modified_timestring · date-timeOptional
uploader_idstring | nullableOptionalDefault: 2
uploaded_bystringOptional
uploaded_typeintegerOptional
is_checkedbooleanOptional
is_deletedbooleanOptional
job_iteration_idstringOptional
job_idstringOptional
Responses
200Success
application/json
post
POST /ux/nccm/os-image/trigger-osdownload/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 487

{
  "img_id": "text",
  "organization": "text",
  "vendor": "text",
  "description": "text",
  "ostype": "text",
  "series": "text",
  "model": "text",
  "os_version": "text",
  "image_type": "text",
  "image_size": "text",
  "min_dram": 1,
  "min_flash": 1,
  "md5_hash": "text",
  "file_name": "text",
  "file_path": "text",
  "creation_time": "2025-08-31T16:02:56.596Z",
  "modified_time": "2025-08-31T16:02:56.596Z",
  "uploader_id": "2",
  "uploaded_by": "text",
  "uploaded_type": 1,
  "is_checked": true,
  "is_deleted": true,
  "job_iteration_id": "text",
  "job_id": "text"
}
200Success
{
  "id": "text",
  "last_update_time": "text",
  "image_id": "text",
  "download_status_obj": "text",
  "uploader_profile": "text",
  "img_id": "text",
  "organization": "text",
  "vendor": "text",
  "description": "text",
  "ostype": "text",
  "series": "text",
  "model": "text",
  "os_version": "text",
  "image_type": "text",
  "image_size": "text",
  "min_dram": 1,
  "min_flash": 1,
  "md5_hash": "text",
  "file_name": "text",
  "file_path": "text",
  "creation_time": "2025-08-31T16:02:56.596Z",
  "modified_time": "2025-08-31T16:02:56.596Z",
  "uploader_id": "2",
  "uploaded_by": "text",
  "uploaded_type": 1,
  "is_checked": true,
  "is_deleted": true,
  "job_iteration_id": "text",
  "job_id": "text"
}
PreviousManage VulnerabilitiesNextRule Group