CLI Download Jobs
This endpoint is used to fetch all the CLi Job/Sessions in the current organization
Items Per Page
Page Number
Sorting Order
Sorting Key
GET /ux/nccm/cli_jobs/?items_per_page=1&page=1 HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
[
{
"id": "text",
"created_time": "text",
"client_type_": "text",
"session_status": "text",
"session_recording_status": "text",
"user_name": "text",
"first_access_time": "text",
"last_access_time": "text",
"duration": "text",
"session_end_time": "text",
"hide_tail": "text",
"cli_job_id": "text",
"organization": "-1",
"ci_id": "-1",
"status": -1,
"userId": -1,
"session_id": "text",
"comments": "text",
"start_time": "2025-08-31T16:02:16.564Z",
"client_type": "text",
"ssh_user": "text",
"creation_time": "2025-08-31T16:02:16.564Z",
"distributed_ip": "text",
"poll_addr": "text",
"port": 1,
"audits": "text",
"approval_type": "text",
"approved_by": "text",
"approved_time": "2025-08-31T16:02:16.564Z",
"firstaccess_time": "2025-08-31T16:02:16.564Z",
"lastaccess_time": "2025-08-31T16:02:16.564Z",
"accessclose_time": "2025-08-31T16:02:16.564Z",
"how_long": 1,
"how_many_times": 1,
"how_many_times_tried": 1,
"last_update_time": "2025-08-31T16:02:16.564Z",
"file_size": "text",
"django_process_no": 1,
"session_recording": 1,
"distributed_file_copy": 1,
"incident_id": "text",
"updated_sm_incident": 1,
"agent_access_user": "text",
"ha_inserted": 1,
"is_deleted": true,
"access_reason": "text",
"client_ip": "text",
"session_end_reason": "text"
}
]
API endpoint that allows users to be viewed or edited.
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.
-1
-1
-1
-1
POST /ux/nccm/cli_jobs/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 898
{
"cli_job_id": "text",
"organization": "-1",
"ci_id": "-1",
"status": -1,
"userId": -1,
"session_id": "text",
"comments": "text",
"start_time": "2025-08-31T16:02:16.564Z",
"client_type": "text",
"ssh_user": "text",
"creation_time": "2025-08-31T16:02:16.564Z",
"distributed_ip": "text",
"poll_addr": "text",
"port": 1,
"audits": "text",
"approval_type": "text",
"approved_by": "text",
"approved_time": "2025-08-31T16:02:16.564Z",
"firstaccess_time": "2025-08-31T16:02:16.564Z",
"lastaccess_time": "2025-08-31T16:02:16.564Z",
"accessclose_time": "2025-08-31T16:02:16.564Z",
"how_long": 1,
"how_many_times": 1,
"how_many_times_tried": 1,
"last_update_time": "2025-08-31T16:02:16.564Z",
"file_size": "text",
"django_process_no": 1,
"session_recording": 1,
"distributed_file_copy": 1,
"incident_id": "text",
"updated_sm_incident": 1,
"agent_access_user": "text",
"ha_inserted": 1,
"is_deleted": true,
"access_reason": "text",
"client_ip": "text",
"session_end_reason": "text"
}
{
"id": "text",
"created_time": "text",
"client_type_": "text",
"session_status": "text",
"session_recording_status": "text",
"user_name": "text",
"first_access_time": "text",
"last_access_time": "text",
"duration": "text",
"session_end_time": "text",
"hide_tail": "text",
"cli_job_id": "text",
"organization": "-1",
"ci_id": "-1",
"status": -1,
"userId": -1,
"session_id": "text",
"comments": "text",
"start_time": "2025-08-31T16:02:16.564Z",
"client_type": "text",
"ssh_user": "text",
"creation_time": "2025-08-31T16:02:16.564Z",
"distributed_ip": "text",
"poll_addr": "text",
"port": 1,
"audits": "text",
"approval_type": "text",
"approved_by": "text",
"approved_time": "2025-08-31T16:02:16.564Z",
"firstaccess_time": "2025-08-31T16:02:16.564Z",
"lastaccess_time": "2025-08-31T16:02:16.564Z",
"accessclose_time": "2025-08-31T16:02:16.564Z",
"how_long": 1,
"how_many_times": 1,
"how_many_times_tried": 1,
"last_update_time": "2025-08-31T16:02:16.564Z",
"file_size": "text",
"django_process_no": 1,
"session_recording": 1,
"distributed_file_copy": 1,
"incident_id": "text",
"updated_sm_incident": 1,
"agent_access_user": "text",
"ha_inserted": 1,
"is_deleted": true,
"access_reason": "text",
"client_ip": "text",
"session_end_reason": "text"
}
API endpoint that allows users to be viewed or edited.
GET /ux/nccm/cli_jobs/{id}/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"id": "text",
"created_time": "text",
"client_type_": "text",
"session_status": "text",
"session_recording_status": "text",
"user_name": "text",
"first_access_time": "text",
"last_access_time": "text",
"duration": "text",
"session_end_time": "text",
"hide_tail": "text",
"cli_job_id": "text",
"organization": "-1",
"ci_id": "-1",
"status": -1,
"userId": -1,
"session_id": "text",
"comments": "text",
"start_time": "2025-08-31T16:02:16.564Z",
"client_type": "text",
"ssh_user": "text",
"creation_time": "2025-08-31T16:02:16.564Z",
"distributed_ip": "text",
"poll_addr": "text",
"port": 1,
"audits": "text",
"approval_type": "text",
"approved_by": "text",
"approved_time": "2025-08-31T16:02:16.564Z",
"firstaccess_time": "2025-08-31T16:02:16.564Z",
"lastaccess_time": "2025-08-31T16:02:16.564Z",
"accessclose_time": "2025-08-31T16:02:16.564Z",
"how_long": 1,
"how_many_times": 1,
"how_many_times_tried": 1,
"last_update_time": "2025-08-31T16:02:16.564Z",
"file_size": "text",
"django_process_no": 1,
"session_recording": 1,
"distributed_file_copy": 1,
"incident_id": "text",
"updated_sm_incident": 1,
"agent_access_user": "text",
"ha_inserted": 1,
"is_deleted": true,
"access_reason": "text",
"client_ip": "text",
"session_end_reason": "text"
}
API endpoint that allows users to be viewed or edited.
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.
-1
-1
-1
-1
PUT /ux/nccm/cli_jobs/{id}/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 898
{
"cli_job_id": "text",
"organization": "-1",
"ci_id": "-1",
"status": -1,
"userId": -1,
"session_id": "text",
"comments": "text",
"start_time": "2025-08-31T16:02:16.564Z",
"client_type": "text",
"ssh_user": "text",
"creation_time": "2025-08-31T16:02:16.564Z",
"distributed_ip": "text",
"poll_addr": "text",
"port": 1,
"audits": "text",
"approval_type": "text",
"approved_by": "text",
"approved_time": "2025-08-31T16:02:16.564Z",
"firstaccess_time": "2025-08-31T16:02:16.564Z",
"lastaccess_time": "2025-08-31T16:02:16.564Z",
"accessclose_time": "2025-08-31T16:02:16.564Z",
"how_long": 1,
"how_many_times": 1,
"how_many_times_tried": 1,
"last_update_time": "2025-08-31T16:02:16.564Z",
"file_size": "text",
"django_process_no": 1,
"session_recording": 1,
"distributed_file_copy": 1,
"incident_id": "text",
"updated_sm_incident": 1,
"agent_access_user": "text",
"ha_inserted": 1,
"is_deleted": true,
"access_reason": "text",
"client_ip": "text",
"session_end_reason": "text"
}
{
"id": "text",
"created_time": "text",
"client_type_": "text",
"session_status": "text",
"session_recording_status": "text",
"user_name": "text",
"first_access_time": "text",
"last_access_time": "text",
"duration": "text",
"session_end_time": "text",
"hide_tail": "text",
"cli_job_id": "text",
"organization": "-1",
"ci_id": "-1",
"status": -1,
"userId": -1,
"session_id": "text",
"comments": "text",
"start_time": "2025-08-31T16:02:16.564Z",
"client_type": "text",
"ssh_user": "text",
"creation_time": "2025-08-31T16:02:16.564Z",
"distributed_ip": "text",
"poll_addr": "text",
"port": 1,
"audits": "text",
"approval_type": "text",
"approved_by": "text",
"approved_time": "2025-08-31T16:02:16.564Z",
"firstaccess_time": "2025-08-31T16:02:16.564Z",
"lastaccess_time": "2025-08-31T16:02:16.564Z",
"accessclose_time": "2025-08-31T16:02:16.564Z",
"how_long": 1,
"how_many_times": 1,
"how_many_times_tried": 1,
"last_update_time": "2025-08-31T16:02:16.564Z",
"file_size": "text",
"django_process_no": 1,
"session_recording": 1,
"distributed_file_copy": 1,
"incident_id": "text",
"updated_sm_incident": 1,
"agent_access_user": "text",
"ha_inserted": 1,
"is_deleted": true,
"access_reason": "text",
"client_ip": "text",
"session_end_reason": "text"
}
API endpoint that allows users to be viewed or edited.
No response body
No content
DELETE /ux/nccm/cli_jobs/{id}/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
API endpoint that allows users to be viewed or edited.
GET /ux/nccm/cli_jobs/cli-file-remove/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"id": "text",
"created_time": "text",
"client_type_": "text",
"session_status": "text",
"session_recording_status": "text",
"user_name": "text",
"first_access_time": "text",
"last_access_time": "text",
"duration": "text",
"session_end_time": "text",
"hide_tail": "text",
"cli_job_id": "text",
"organization": "-1",
"ci_id": "-1",
"status": -1,
"userId": -1,
"session_id": "text",
"comments": "text",
"start_time": "2025-08-31T16:02:16.564Z",
"client_type": "text",
"ssh_user": "text",
"creation_time": "2025-08-31T16:02:16.564Z",
"distributed_ip": "text",
"poll_addr": "text",
"port": 1,
"audits": "text",
"approval_type": "text",
"approved_by": "text",
"approved_time": "2025-08-31T16:02:16.564Z",
"firstaccess_time": "2025-08-31T16:02:16.564Z",
"lastaccess_time": "2025-08-31T16:02:16.564Z",
"accessclose_time": "2025-08-31T16:02:16.564Z",
"how_long": 1,
"how_many_times": 1,
"how_many_times_tried": 1,
"last_update_time": "2025-08-31T16:02:16.564Z",
"file_size": "text",
"django_process_no": 1,
"session_recording": 1,
"distributed_file_copy": 1,
"incident_id": "text",
"updated_sm_incident": 1,
"agent_access_user": "text",
"ha_inserted": 1,
"is_deleted": true,
"access_reason": "text",
"client_ip": "text",
"session_end_reason": "text"
}
API endpoint that allows users to be viewed or edited.
GET /ux/nccm/cli_jobs/cli-session/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"id": "text",
"created_time": "text",
"client_type_": "text",
"session_status": "text",
"session_recording_status": "text",
"user_name": "text",
"first_access_time": "text",
"last_access_time": "text",
"duration": "text",
"session_end_time": "text",
"hide_tail": "text",
"cli_job_id": "text",
"organization": "-1",
"ci_id": "-1",
"status": -1,
"userId": -1,
"session_id": "text",
"comments": "text",
"start_time": "2025-08-31T16:02:16.564Z",
"client_type": "text",
"ssh_user": "text",
"creation_time": "2025-08-31T16:02:16.564Z",
"distributed_ip": "text",
"poll_addr": "text",
"port": 1,
"audits": "text",
"approval_type": "text",
"approved_by": "text",
"approved_time": "2025-08-31T16:02:16.564Z",
"firstaccess_time": "2025-08-31T16:02:16.564Z",
"lastaccess_time": "2025-08-31T16:02:16.564Z",
"accessclose_time": "2025-08-31T16:02:16.564Z",
"how_long": 1,
"how_many_times": 1,
"how_many_times_tried": 1,
"last_update_time": "2025-08-31T16:02:16.564Z",
"file_size": "text",
"django_process_no": 1,
"session_recording": 1,
"distributed_file_copy": 1,
"incident_id": "text",
"updated_sm_incident": 1,
"agent_access_user": "text",
"ha_inserted": 1,
"is_deleted": true,
"access_reason": "text",
"client_ip": "text",
"session_end_reason": "text"
}
API endpoint that allows users to be viewed or edited.
GET /ux/nccm/cli_jobs/cli_kill_session/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"id": "text",
"created_time": "text",
"client_type_": "text",
"session_status": "text",
"session_recording_status": "text",
"user_name": "text",
"first_access_time": "text",
"last_access_time": "text",
"duration": "text",
"session_end_time": "text",
"hide_tail": "text",
"cli_job_id": "text",
"organization": "-1",
"ci_id": "-1",
"status": -1,
"userId": -1,
"session_id": "text",
"comments": "text",
"start_time": "2025-08-31T16:02:16.564Z",
"client_type": "text",
"ssh_user": "text",
"creation_time": "2025-08-31T16:02:16.564Z",
"distributed_ip": "text",
"poll_addr": "text",
"port": 1,
"audits": "text",
"approval_type": "text",
"approved_by": "text",
"approved_time": "2025-08-31T16:02:16.564Z",
"firstaccess_time": "2025-08-31T16:02:16.564Z",
"lastaccess_time": "2025-08-31T16:02:16.564Z",
"accessclose_time": "2025-08-31T16:02:16.564Z",
"how_long": 1,
"how_many_times": 1,
"how_many_times_tried": 1,
"last_update_time": "2025-08-31T16:02:16.564Z",
"file_size": "text",
"django_process_no": 1,
"session_recording": 1,
"distributed_file_copy": 1,
"incident_id": "text",
"updated_sm_incident": 1,
"agent_access_user": "text",
"ha_inserted": 1,
"is_deleted": true,
"access_reason": "text",
"client_ip": "text",
"session_end_reason": "text"
}
API endpoint that allows users to be viewed or edited.
GET /ux/nccm/cli_jobs/options/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"id": "text",
"created_time": "text",
"client_type_": "text",
"session_status": "text",
"session_recording_status": "text",
"user_name": "text",
"first_access_time": "text",
"last_access_time": "text",
"duration": "text",
"session_end_time": "text",
"hide_tail": "text",
"cli_job_id": "text",
"organization": "-1",
"ci_id": "-1",
"status": -1,
"userId": -1,
"session_id": "text",
"comments": "text",
"start_time": "2025-08-31T16:02:16.564Z",
"client_type": "text",
"ssh_user": "text",
"creation_time": "2025-08-31T16:02:16.564Z",
"distributed_ip": "text",
"poll_addr": "text",
"port": 1,
"audits": "text",
"approval_type": "text",
"approved_by": "text",
"approved_time": "2025-08-31T16:02:16.564Z",
"firstaccess_time": "2025-08-31T16:02:16.564Z",
"lastaccess_time": "2025-08-31T16:02:16.564Z",
"accessclose_time": "2025-08-31T16:02:16.564Z",
"how_long": 1,
"how_many_times": 1,
"how_many_times_tried": 1,
"last_update_time": "2025-08-31T16:02:16.564Z",
"file_size": "text",
"django_process_no": 1,
"session_recording": 1,
"distributed_file_copy": 1,
"incident_id": "text",
"updated_sm_incident": 1,
"agent_access_user": "text",
"ha_inserted": 1,
"is_deleted": true,
"access_reason": "text",
"client_ip": "text",
"session_end_reason": "text"
}
API endpoint that allows users to be viewed or edited.
GET /ux/nccm/cli_jobs/tail-audits/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"id": "text",
"created_time": "text",
"client_type_": "text",
"session_status": "text",
"session_recording_status": "text",
"user_name": "text",
"first_access_time": "text",
"last_access_time": "text",
"duration": "text",
"session_end_time": "text",
"hide_tail": "text",
"cli_job_id": "text",
"organization": "-1",
"ci_id": "-1",
"status": -1,
"userId": -1,
"session_id": "text",
"comments": "text",
"start_time": "2025-08-31T16:02:16.564Z",
"client_type": "text",
"ssh_user": "text",
"creation_time": "2025-08-31T16:02:16.564Z",
"distributed_ip": "text",
"poll_addr": "text",
"port": 1,
"audits": "text",
"approval_type": "text",
"approved_by": "text",
"approved_time": "2025-08-31T16:02:16.564Z",
"firstaccess_time": "2025-08-31T16:02:16.564Z",
"lastaccess_time": "2025-08-31T16:02:16.564Z",
"accessclose_time": "2025-08-31T16:02:16.564Z",
"how_long": 1,
"how_many_times": 1,
"how_many_times_tried": 1,
"last_update_time": "2025-08-31T16:02:16.564Z",
"file_size": "text",
"django_process_no": 1,
"session_recording": 1,
"distributed_file_copy": 1,
"incident_id": "text",
"updated_sm_incident": 1,
"agent_access_user": "text",
"ha_inserted": 1,
"is_deleted": true,
"access_reason": "text",
"client_ip": "text",
"session_end_reason": "text"
}