CLI Download Jobs

Gets a list of CLI Jos/Sessions

get

This endpoint is used to fetch all the CLi Job/Sessions in the current organization

Authorizations
AuthorizationstringRequired
Query parameters
items_per_pageintegerRequired

Items Per Page

pageintegerRequired

Page Number

reversebooleanOptional

Sorting Order

sortstringOptional

Sorting Key

Responses
chevron-right
200Success
application/json
get
/ux/nccm/cli_jobs/
200Success
post

API endpoint that allows users to be viewed or edited.

Authorizations
AuthorizationstringRequired
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
created_timestringRead-onlyRequired
client_type_stringRead-onlyRequired
session_statusstringRead-onlyRequired
session_recording_statusstringRead-onlyRequired
user_namestringRead-onlyRequired
first_access_timestringRead-onlyRequired
last_access_timestringRead-onlyRequired
durationstringRead-onlyRequired
session_end_timestringRead-onlyRequired
hide_tailstringRead-onlyRequired
cli_job_idstring · max: 25Required
organizationstringOptionalDefault: -1
ci_idstringOptionalDefault: -1
statusintegerOptionalDefault: -1
userIdintegerOptionalDefault: -1
session_idstringOptional
commentsstringOptional
start_timestring · date-timeOptional
client_typestringOptional
ssh_userstringOptional
creation_timestring · date-timeOptional
distributed_ipstringOptional
poll_addrstringOptional
portintegerOptional
auditsstringOptional
approval_typestringOptional
approved_bystringOptional
approved_timestring · date-timeOptional
firstaccess_timestring · date-timeOptional
lastaccess_timestring · date-timeOptional
accessclose_timestring · date-timeOptional
how_longintegerOptional
how_many_timesintegerOptional
how_many_times_triedintegerOptional
last_update_timestring · date-timeOptional
file_sizestringOptional
django_process_nointegerOptional
session_recordingintegerOptional
distributed_file_copyintegerOptional
incident_idstringOptional
updated_sm_incidentintegerOptional
agent_access_userstringOptional
ha_insertedintegerOptional
is_deletedbooleanOptional
access_reasonstringOptional
client_ipstringOptional
session_end_reasonstringOptional
Responses
post
/ux/nccm/cli_jobs/
201Success
get

API endpoint that allows users to be viewed or edited.

Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired
Responses
chevron-right
200Success
application/json
get
/ux/nccm/cli_jobs/{id}/
200Success
put

API endpoint that allows users to be viewed or edited.

Authorizations
AuthorizationstringRequired
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
created_timestringRead-onlyRequired
client_type_stringRead-onlyRequired
session_statusstringRead-onlyRequired
session_recording_statusstringRead-onlyRequired
user_namestringRead-onlyRequired
first_access_timestringRead-onlyRequired
last_access_timestringRead-onlyRequired
durationstringRead-onlyRequired
session_end_timestringRead-onlyRequired
hide_tailstringRead-onlyRequired
cli_job_idstring · max: 25Required
organizationstringOptionalDefault: -1
ci_idstringOptionalDefault: -1
statusintegerOptionalDefault: -1
userIdintegerOptionalDefault: -1
session_idstringOptional
commentsstringOptional
start_timestring · date-timeOptional
client_typestringOptional
ssh_userstringOptional
creation_timestring · date-timeOptional
distributed_ipstringOptional
poll_addrstringOptional
portintegerOptional
auditsstringOptional
approval_typestringOptional
approved_bystringOptional
approved_timestring · date-timeOptional
firstaccess_timestring · date-timeOptional
lastaccess_timestring · date-timeOptional
accessclose_timestring · date-timeOptional
how_longintegerOptional
how_many_timesintegerOptional
how_many_times_triedintegerOptional
last_update_timestring · date-timeOptional
file_sizestringOptional
django_process_nointegerOptional
session_recordingintegerOptional
distributed_file_copyintegerOptional
incident_idstringOptional
updated_sm_incidentintegerOptional
agent_access_userstringOptional
ha_insertedintegerOptional
is_deletedbooleanOptional
access_reasonstringOptional
client_ipstringOptional
session_end_reasonstringOptional
Responses
chevron-right
200Success
application/json
put
/ux/nccm/cli_jobs/{id}/
200Success
delete

API endpoint that allows users to be viewed or edited.

Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired
Responses
delete
/ux/nccm/cli_jobs/{id}/
204

No response body

No content

get

API endpoint that allows users to be viewed or edited.

Authorizations
AuthorizationstringRequired
Responses
chevron-right
200Success
application/json
get
/ux/nccm/cli_jobs/cli-file-remove/
200Success
get

API endpoint that allows users to be viewed or edited.

Authorizations
AuthorizationstringRequired
Responses
chevron-right
200Success
application/json
get
/ux/nccm/cli_jobs/cli-session/
200Success
get

API endpoint that allows users to be viewed or edited.

Authorizations
AuthorizationstringRequired
Responses
chevron-right
200Success
application/json
get
/ux/nccm/cli_jobs/cli_kill_session/
200Success
get

API endpoint that allows users to be viewed or edited.

Authorizations
AuthorizationstringRequired
Responses
chevron-right
200Success
application/json
get
/ux/nccm/cli_jobs/options/
200Success
get

API endpoint that allows users to be viewed or edited.

Authorizations
AuthorizationstringRequired
Responses
chevron-right
200Success
application/json
get
/ux/nccm/cli_jobs/tail-audits/
200Success

Last updated