### Generate Installer Source: https://app.ninjarmm.com/apidocs?links.active=core Generates an installer for an organization. ```APIDOC ## POST /v2/organization/generate-installer ### Description Generate installer ### Method POST ### Endpoint /v2/organization/generate-installer ``` -------------------------------- ### Generate Installer by Type Source: https://app.ninjarmm.com/apidocs?links.active=core Generates a specific type of installer for an organization and location. ```APIDOC ## GET /v2/organization/{id}/location/{location_id}/installer/{installer_type} ### Description Generate installer ### Method GET ### Endpoint /v2/organization/{id}/location/{location_id}/installer/{installer_type} ``` -------------------------------- ### Get Device Scripting Options Source: https://app.ninjarmm.com/apidocs?links.active=core Retrieves scripting options for a specific device. ```APIDOC ## GET /v2/device/{id}/scripting/options ### Description Device scripting options ### Method GET ### Endpoint /v2/device/{id}/scripting/options ``` -------------------------------- ### Get Windows Event Conditions Source: https://app.ninjarmm.com/apidocs?links.active=core Retrieves Windows event conditions for a policy. ```APIDOC ## GET /v2/policies/{policy_id}/condition/windows-event ### Description Get windows event conditions ### Method GET ### Endpoint /v2/policies/{policy_id}/condition/windows-event ``` -------------------------------- ### Get Ticket Source: https://app.ninjarmm.com/apidocs?links.active=core Retrieves details for a specific ticket. ```APIDOC ## GET /v2/ticketing/ticket/{ticketId} ### Description Ticket ### Method GET ### Endpoint /v2/ticketing/ticket/{ticketId} ``` -------------------------------- ### Get Device Dashboard URL Source: https://app.ninjarmm.com/apidocs?links.active=core Retrieves the dashboard URL for a specific device. ```APIDOC ## GET /v2/device/{id}/dashboard-url ### Description Device link ### Method GET ### Endpoint /v2/device/{id}/dashboard-url ``` -------------------------------- ### Get Ticket Statuses Source: https://app.ninjarmm.com/apidocs?links.active=core Retrieves a list of available ticket statuses. ```APIDOC ## GET /v2/ticketing/statuses ### Description Get list of ticket status ### Method GET ### Endpoint /v2/ticketing/statuses ``` -------------------------------- ### Get Custom Fields Policy Conditions Source: https://app.ninjarmm.com/apidocs?links.active=core Retrieves custom fields for policy conditions. ```APIDOC ## GET /v2/policies/{policy_id}/condition/custom-fields ### Description Get custom fields policy conditions ### Method GET ### Endpoint /v2/policies/{policy_id}/condition/custom-fields ``` -------------------------------- ### Get Windows Event Condition by ID Source: https://app.ninjarmm.com/apidocs?links.active=core Retrieves a specific Windows event condition by its ID. ```APIDOC ## GET /v2/policies/{policy_id}/condition/windows-event/{condition_id} ### Description Get windows event condition ### Method GET ### Endpoint /v2/policies/{policy_id}/condition/windows-event/{condition_id} ``` -------------------------------- ### Get Ticket Form by ID Source: https://app.ninjarmm.com/apidocs?links.active=core Retrieves a specific ticket form by its ID. ```APIDOC ## GET /v2/ticketing/ticket-form/{id} ### Description Ticket form ### Method GET ### Endpoint /v2/ticketing/ticket-form/{id} ``` -------------------------------- ### Get Custom Fields Policy Condition by ID Source: https://app.ninjarmm.com/apidocs?links.active=core Retrieves a specific custom fields policy condition by its ID. ```APIDOC ## GET /v2/policies/{policy_id}/condition/custom-fields/{condition_id} ### Description Get custom fields policy condition ### Method GET ### Endpoint /v2/policies/{policy_id}/condition/custom-fields/{condition_id} ``` -------------------------------- ### Run OS Patch Apply Source: https://app.ninjarmm.com/apidocs?links.active=core Initiates the OS patch apply process for a device. ```APIDOC ## POST /v2/device/{id}/patch/os/apply ### Description Run OS patch apply ### Method POST ### Endpoint /v2/device/{id}/patch/os/apply ``` -------------------------------- ### Run Software Patch Apply Source: https://app.ninjarmm.com/apidocs?links.active=core Initiates the software patch apply process for a device. ```APIDOC ## POST /v2/device/{id}/patch/software/apply ### Description Run Software patch apply ### Method POST ### Endpoint /v2/device/{id}/patch/software/apply ``` -------------------------------- ### Run OS Patch Scan Source: https://app.ninjarmm.com/apidocs?links.active=core Initiates an OS patch scan for a device. ```APIDOC ## POST /v2/device/{id}/patch/os/scan ### Description Run OS patch scan ### Method POST ### Endpoint /v2/device/{id}/patch/os/scan ``` -------------------------------- ### Run Software Patch Scan Source: https://app.ninjarmm.com/apidocs?links.active=core Initiates a software patch scan for a device. ```APIDOC ## POST /v2/device/{id}/patch/software/scan ### Description Run Software patch scan ### Method POST ### Endpoint /v2/device/{id}/patch/software/scan ``` -------------------------------- ### Create End User Source: https://app.ninjarmm.com/apidocs?links.active=core Creates a new end user. ```APIDOC ## POST /v2/user/end-users ### Description Create end user ### Method POST ### Endpoint /v2/user/end-users ``` -------------------------------- ### Create Contact Source: https://app.ninjarmm.com/apidocs?links.active=core Creates a new contact in the system. ```APIDOC ## POST /v2/contacts ### Description Create a contact ### Method POST ### Endpoint /v2/contacts ``` -------------------------------- ### Create Organization Source: https://app.ninjarmm.com/apidocs?links.active=core Creates a new organization. ```APIDOC ## POST /v2/organizations ### Description Create new organization ### Method POST ### Endpoint /v2/organizations ``` -------------------------------- ### Create Policy Source: https://app.ninjarmm.com/apidocs?links.active=core Creates a new policy. ```APIDOC ## POST /v2/policies ### Description Creates new Policy ### Method POST ### Endpoint /v2/policies ``` -------------------------------- ### Create Ticket Source: https://app.ninjarmm.com/apidocs?links.active=core Creates a new support ticket. ```APIDOC ## POST /v2/ticketing/ticket ### Description Create ticket ### Method POST ### Endpoint /v2/ticketing/ticket ``` -------------------------------- ### System Core Resources Source: https://app.ninjarmm.com/apidocs?links.active=core Endpoints for accessing core system entities and resources. ```APIDOC ## GET /v2/contacts ### Description Retrieves a list of contacts. ### Method GET ### Endpoint /v2/contacts ``` ```APIDOC ## GET /v2/contact/{id} ### Description Retrieves details for a specific contact. ### Method GET ### Endpoint /v2/contact/{id} ``` ```APIDOC ## GET /v2/organizations ### Description Retrieves a list of organizations. ### Method GET ### Endpoint /v2/organizations ``` ```APIDOC ## GET /v2/policies ### Description Retrieves a list of policies. ### Method GET ### Endpoint /v2/policies ``` ```APIDOC ## GET /v2/jobs ### Description Retrieves a list of active jobs. ### Method GET ### Endpoint /v2/jobs ``` ```APIDOC ## GET /v2/activities ### Description Retrieves a list of activities. ### Method GET ### Endpoint /v2/activities ``` ```APIDOC ## GET /v2/alerts ### Description Retrieves a list of active alerts (triggered conditions). ### Method GET ### Endpoint /v2/alerts ``` ```APIDOC ## GET /v2/automation/scripts ### Description Retrieves a list of all available automation scripts. ### Method GET ### Endpoint /v2/automation/scripts ``` ```APIDOC ## GET /v2/device-custom-fields ### Description Retrieves information about device custom fields. ### Method GET ### Endpoint /v2/device-custom-fields ``` ```APIDOC ## GET /v2/devices ### Description Retrieves a list of devices. ### Method GET ### Endpoint /v2/devices ``` ```APIDOC ## GET /v2/devices-detailed ### Description Retrieves a detailed list of devices. ### Method GET ### Endpoint /v2/devices-detailed ``` ```APIDOC ## GET /v2/notification-channels/enabled ### Description Retrieves a list of enabled notification channels. ### Method GET ### Endpoint /v2/notification-channels/enabled ``` ```APIDOC ## GET /v2/groups ### Description Retrieves a list of groups (saved searches). ### Method GET ### Endpoint /v2/groups ``` ```APIDOC ## GET /v2/locations ### Description Retrieves a list of locations. ### Method GET ### Endpoint /v2/locations ``` ```APIDOC ## GET /v2/roles ### Description Retrieves a list of device roles. ### Method GET ### Endpoint /v2/roles ``` ```APIDOC ## GET /v2/notification-channels ### Description Retrieves a list of notification channels. ### Method GET ### Endpoint /v2/notification-channels ``` ```APIDOC ## GET /v2/organizations-detailed ### Description Retrieves a detailed list of organizations. ### Method GET ### Endpoint /v2/organizations-detailed ``` ```APIDOC ## GET /v2/tasks ### Description Retrieves a list of scheduled tasks. ### Method GET ### Endpoint /v2/tasks ``` ```APIDOC ## GET /v2/software-products ### Description Retrieves a list of supported 3rd party software. ### Method GET ### Endpoint /v2/software-products ``` ```APIDOC ## GET /v2/users ### Description Retrieves a list of users. ### Method GET ### Endpoint /v2/users ``` ```APIDOC ## GET /v2/devices/search ### Description Finds devices based on specified criteria. ### Method GET ### Endpoint /v2/devices/search ``` ```APIDOC ## GET /v2/user/end-users ### Description Retrieves a list of end users. ### Method GET ### Endpoint /v2/user/end-users ``` ```APIDOC ## GET /v2/user/technicians ### Description Retrieves a list of technicians. ### Method GET ### Endpoint /v2/user/technicians ``` ```APIDOC ## GET /v2/user/roles ### Description Retrieves user roles. ### Method GET ### Endpoint /v2/user/roles ``` -------------------------------- ### Create Technician Source: https://app.ninjarmm.com/apidocs?links.active=core Creates a new technician. ```APIDOC ## POST /v2/user/technicians ### Description Create a technician ### Method POST ### Endpoint /v2/user/technicians ``` -------------------------------- ### Run Script or Built-in Action Source: https://app.ninjarmm.com/apidocs?links.active=core Executes a script or a built-in action on a device. ```APIDOC ## POST /v2/device/{id}/script/run ### Description Run script or built-in action ### Method POST ### Endpoint /v2/device/{id}/script/run ``` -------------------------------- ### List Boards Source: https://app.ninjarmm.com/apidocs?links.active=core Retrieves a list of available boards for ticketing. ```APIDOC ## GET /v2/ticketing/trigger/boards ### Description List boards ### Method GET ### Endpoint /v2/ticketing/trigger/boards ``` -------------------------------- ### Approve/Reject Devices Source: https://app.ninjarmm.com/apidocs?links.active=core Approves or rejects devices based on the specified mode. ```APIDOC ## POST /v2/devices/approval/{mode} ### Description Approve/Reject devices ### Method POST ### Endpoint /v2/devices/approval/{mode} ``` -------------------------------- ### Backup API Source: https://app.ninjarmm.com/apidocs?links.active=core Endpoints for managing backup settings and jobs, including bandwidth throttling and integrity checks. ```APIDOC ## POST /v2/backup/bandwidth-throttle ### Description Sets the bandwidth throttle for a device. ### Method POST ### Endpoint /v2/backup/bandwidth-throttle ``` ```APIDOC ## GET /v2/backup/integrity-check-jobs ### Description Integrity check jobs. ### Method GET ### Endpoint /v2/backup/integrity-check-jobs ``` ```APIDOC ## POST /v2/backup/integrity-check-jobs ### Description Create an integrity check job. ### Method POST ### Endpoint /v2/backup/integrity-check-jobs ``` ```APIDOC ## GET /v2/backup/jobs ### Description Backup jobs. ### Method GET ### Endpoint /v2/backup/jobs ``` -------------------------------- ### Unmanaged Devices API Source: https://app.ninjarmm.com/apidocs?links.active=core Endpoints for managing unmanaged devices, including creation, decommissioning, updates, and deletion. ```APIDOC ## POST /v2/itam/unmanaged-device ### Description Create an Unmanaged Device. ### Method POST ### Endpoint /v2/itam/unmanaged-device ## POST /v2/itam/unmanaged-device/{nodeId}/decommission ### Description Decommission an Unmanaged Device. ### Method POST ### Endpoint /v2/itam/unmanaged-device/{nodeId}/decommission ## POST /v2/itam/unmanaged-device/decommissionList ### Description Decommission an Unmanaged Device List. ### Method POST ### Endpoint /v2/itam/unmanaged-device/decommissionList ## PUT /v2/itam/unmanaged-device/{nodeId} ### Description Update an Unmanaged Device. ### Method PUT ### Endpoint /v2/itam/unmanaged-device/{nodeId} ## DELETE /v2/itam/unmanaged-device/{nodeId} ### Description Delete an Unmanaged Device. ### Method DELETE ### Endpoint /v2/itam/unmanaged-device/{nodeId} ## POST /v2/staged-device ### Description Create staged device. ### Method POST ### Endpoint /v2/staged-device ``` -------------------------------- ### Create Windows Event Condition Source: https://app.ninjarmm.com/apidocs?links.active=core Creates a new Windows event condition for a policy. ```APIDOC ## POST /v2/policies/{policy_id}/condition/windows-event ### Description Create windows event condition ### Method POST ### Endpoint /v2/policies/{policy_id}/condition/windows-event ``` -------------------------------- ### Software Licenses API Source: https://app.ninjarmm.com/apidocs?links.active=core Endpoints for managing software licenses, including creation, retrieval, update, deletion, and assignment retrieval. ```APIDOC ## POST /v2/software-license ### Description Create a Software License. ### Method POST ### Endpoint /v2/software-license ## GET /v2/software-license/{licenseId} ### Description Get Software License. ### Method GET ### Endpoint /v2/software-license/{licenseId} ## PUT /v2/software-license/{licenseId} ### Description Update a Software License. ### Method PUT ### Endpoint /v2/software-license/{licenseId} ## DELETE /v2/software-license/{licenseId} ### Description Delete a Software License. ### Method DELETE ### Endpoint /v2/software-license/{licenseId} ## GET /v2/software-license/licenses ### Description Get All Software Licenses. ### Method GET ### Endpoint /v2/software-license/licenses ## GET /v2/software-license/{licenseId}/assignments ### Description Get Software License Assignments. ### Method GET ### Endpoint /v2/software-license/{licenseId}/assignments ## POST /v2/software-license/upsert ### Description Create or Update a Software License. ### Method POST ### Endpoint /v2/software-license/upsert ``` -------------------------------- ### Checklist Templates Source: https://app.ninjarmm.com/apidocs?links.active=core Endpoints for managing checklist templates, including archiving, creating, updating, and deleting. ```APIDOC ## POST /v2/checklist/archive ### Description Archive a checklist template. ### Method POST ### Endpoint /v2/checklist/archive ``` ```APIDOC ## GET /v2/checklist/templates ### Description List checklist templates. ### Method GET ### Endpoint /v2/checklist/templates ``` ```APIDOC ## PUT /v2/checklist/templates ### Description Update checklist templates. ### Method PUT ### Endpoint /v2/checklist/templates ``` ```APIDOC ## POST /v2/checklist/templates ### Description Create checklist templates. ### Method POST ### Endpoint /v2/checklist/templates ``` ```APIDOC ## DELETE /v2/checklist/template/{checklistTemplateId} ### Description Delete a checklist template. ### Method DELETE ### Endpoint /v2/checklist/template/{checklistTemplateId} ``` ```APIDOC ## POST /v2/checklist/templates/delete ### Description Delete checklist templates. ### Method POST ### Endpoint /v2/checklist/templates/delete ``` ```APIDOC ## POST /v2/checklist/restore ### Description Restore a checklist template. ### Method POST ### Endpoint /v2/checklist/restore ``` -------------------------------- ### Document Templates Source: https://app.ninjarmm.com/apidocs?links.active=core Endpoints for managing document templates, including archiving, creating, updating, and deleting. ```APIDOC ## POST /v2/document-templates/{documentTemplateId}/archive ### Description Archive a document template. ### Method POST ### Endpoint /v2/document-templates/{documentTemplateId}/archive ``` ```APIDOC ## POST /v2/document-templates/archive ### Description Archive multiple document templates. ### Method POST ### Endpoint /v2/document-templates/archive ``` ```APIDOC ## GET /v2/document-templates ### Description List document templates with fields. ### Method GET ### Endpoint /v2/document-templates ``` ```APIDOC ## POST /v2/document-templates ### Description Create document template. ### Method POST ### Endpoint /v2/document-templates ``` ```APIDOC ## GET /v2/document-templates/{documentTemplateId} ### Description Get document template. ### Method GET ### Endpoint /v2/document-templates/{documentTemplateId} ``` ```APIDOC ## PUT /v2/document-templates/{documentTemplateId} ### Description Update document template. ### Method PUT ### Endpoint /v2/document-templates/{documentTemplateId} ``` ```APIDOC ## DELETE /v2/document-templates/{documentTemplateId} ### Description Delete a document template. ### Method DELETE ### Endpoint /v2/document-templates/{documentTemplateId} ``` ```APIDOC ## POST /v2/document-templates/{documentTemplateId}/restore ### Description Restore a document template. ### Method POST ### Endpoint /v2/document-templates/{documentTemplateId}/restore ``` ```APIDOC ## POST /v2/document-templates/restore ### Description Restore a document template. ### Method POST ### Endpoint /v2/document-templates/restore ``` -------------------------------- ### Organization Checklists Source: https://app.ninjarmm.com/apidocs?links.active=core Endpoints for managing organization checklists, including archiving, creating, updating, and deleting. ```APIDOC ## POST /v2/organization/archive ### Description Archive organization checklists. ### Method POST ### Endpoint /v2/organization/archive ``` ```APIDOC ## GET /v2/organization/checklists ### Description List client checklists. ### Method GET ### Endpoint /v2/organization/checklists ``` ```APIDOC ## PUT /v2/organization/checklists ### Description Update organization checklists. ### Method PUT ### Endpoint /v2/organization/checklists ``` ```APIDOC ## POST /v2/organization/checklists ### Description Create organization checklists. ### Method POST ### Endpoint /v2/organization/checklists ``` ```APIDOC ## POST /v2/organization/{organizationId}/checklists-from-templates ### Description Create organization checklists from templates. ### Method POST ### Endpoint /v2/organization/{organizationId}/checklists-from-templates ``` ```APIDOC ## GET /v2/organization/checklist/{checklistId} ### Description Get client checklist. ### Method GET ### Endpoint /v2/organization/checklist/{checklistId} ``` ```APIDOC ## DELETE /v2/organization/checklist/{checklistId} ### Description Delete an organization checklist. ### Method DELETE ### Endpoint /v2/organization/checklist/{checklistId} ``` ```APIDOC ## POST /v2/organization/checklists/delete ### Description Delete organization checklists. ### Method POST ### Endpoint /v2/organization/checklists/delete ``` ```APIDOC ## GET /v2/organization/checklist/{checklistId}/signed-urls ### Description Get organization checklist signed urls. ### Method GET ### Endpoint /v2/organization/checklist/{checklistId}/signed-urls ``` ```APIDOC ## POST /v2/organization/checklists/promote-with-name ### Description Promote organization checklists. ### Method POST ### Endpoint /v2/organization/checklists/promote-with-name ``` ```APIDOC ## POST /v2/organization/checklists/promote ### Description Promote organization checklists. ### Method POST ### Endpoint /v2/organization/checklists/promote ``` ```APIDOC ## POST /v2/organization/restore ### Description Restore organization checklists. ### Method POST ### Endpoint /v2/organization/restore ``` -------------------------------- ### Set Device Owner Source: https://app.ninjarmm.com/apidocs?links.active=core Sets the owner for a specific device. ```APIDOC ## POST /v2/device/{id}/owner/{ownerUid} ### Description Set device owner ### Method POST ### Endpoint /v2/device/{id}/owner/{ownerUid} ``` -------------------------------- ### Node Roles Source: https://app.ninjarmm.com/apidocs?links.active=core Endpoints for managing node roles, including creation, updates, deletion, and listing. ```APIDOC ## POST /v2/noderole ### Description Create node roles. ### Method POST ### Endpoint /v2/noderole ``` ```APIDOC ## PATCH /v2/noderole ### Description Update node roles. ### Method PATCH ### Endpoint /v2/noderole ``` ```APIDOC ## POST /v2/noderole/delete ### Description Delete node roles. ### Method POST ### Endpoint /v2/noderole/delete ``` ```APIDOC ## GET /v2/noderole/list ### Description Get all node roles. ### Method GET ### Endpoint /v2/noderole/list ``` -------------------------------- ### List Contacts Source: https://app.ninjarmm.com/apidocs?links.active=core Retrieves a list of contacts. ```APIDOC ## GET /v2/ticketing/contact/contacts ### Description List contacts ### Method GET ### Endpoint /v2/ticketing/contact/contacts ``` -------------------------------- ### Billing Products API Source: https://app.ninjarmm.com/apidocs?links.active=core Endpoints for managing billing products, including activation, deactivation, creation, retrieval, and updates. ```APIDOC ## PATCH /v2/billing/products/{id}/activate ### Description Activates a product. ### Method PATCH ### Endpoint /v2/billing/products/{id}/activate ``` ```APIDOC ## GET /v2/billing/products ### Description Get all products. ### Method GET ### Endpoint /v2/billing/products ``` ```APIDOC ## POST /v2/billing/products ### Description Creates a product. ### Method POST ### Endpoint /v2/billing/products ``` ```APIDOC ## PATCH /v2/billing/products/{id}/deactivate ### Description Deactivates a product. ### Method PATCH ### Endpoint /v2/billing/products/{id}/deactivate ``` ```APIDOC ## GET /v2/billing/products/{id} ### Description Get product by ID. ### Method GET ### Endpoint /v2/billing/products/{id} ``` ```APIDOC ## PUT /v2/billing/products/{id} ### Description Updates a product. ### Method PUT ### Endpoint /v2/billing/products/{id} ``` -------------------------------- ### Reset Device Policy Overrides Source: https://app.ninjarmm.com/apidocs?links.active=core Resets policy overrides for a specific device. ```APIDOC ## DELETE /v2/device/{id}/policy/overrides ### Description Reset device policy overrides ### Method DELETE ### Endpoint /v2/device/{id}/policy/overrides ``` -------------------------------- ### Device Endpoints Source: https://app.ninjarmm.com/apidocs?links.active=core Endpoints for retrieving detailed information about individual devices. ```APIDOC ## GET /v2/device/{id} ### Description Retrieves details for a specific device. ### Method GET ### Endpoint /v2/device/{id} ``` ```APIDOC ## GET /v2/device/{id}/jobs ### Description Retrieves information about currently running (active) jobs for a specific device. ### Method GET ### Endpoint /v2/device/{id}/jobs ``` ```APIDOC ## GET /v2/device/{id}/activities ### Description Retrieves activities for a specific device. ### Method GET ### Endpoint /v2/device/{id}/activities ``` ```APIDOC ## GET /v2/device/{id}/alerts ### Description Retrieves alerts (triggered conditions) for a specific device. ### Method GET ### Endpoint /v2/device/{id}/alerts ``` ```APIDOC ## GET /v2/device/{id}/disks ### Description Retrieves information about disk drives for a specific device. ### Method GET ### Endpoint /v2/device/{id}/disks ``` ```APIDOC ## GET /v2/device/{id}/os-patch-installs ### Description Retrieves the OS Patch installation report for a specific device. ### Method GET ### Endpoint /v2/device/{id}/os-patch-installs ``` ```APIDOC ## GET /v2/device/{id}/software-patch-installs ### Description Retrieves the Software Patch history for a specific device. ### Method GET ### Endpoint /v2/device/{id}/software-patch-installs ``` ```APIDOC ## GET /v2/device/{id}/last-logged-on-user ### Description Retrieves information about the last logged-on user for a specific device. ### Method GET ### Endpoint /v2/device/{id}/last-logged-on-user ``` ```APIDOC ## GET /v2/device/{id}/network-interfaces ### Description Retrieves information about network interfaces for a specific device. ### Method GET ### Endpoint /v2/device/{id}/network-interfaces ``` ```APIDOC ## GET /v2/device/{id}/os-patches ### Description Retrieves information about OS patches for a specific device. ### Method GET ### Endpoint /v2/device/{id}/os-patches ``` ```APIDOC ## GET /v2/device/{id}/software-patches ### Description Retrieves information about pending, failed, and rejected software patches for a specific device. ### Method GET ### Endpoint /v2/device/{id}/software-patches ``` ```APIDOC ## GET /v2/device/{id}/processors ### Description Retrieves information about processors for a specific device. ### Method GET ### Endpoint /v2/device/{id}/processors ``` ```APIDOC ## GET /v2/device/{id}/windows-services ### Description Retrieves information about Windows services for a specific device. ### Method GET ### Endpoint /v2/device/{id}/windows-services ``` ```APIDOC ## GET /v2/device/{id}/software ### Description Retrieves the software inventory for a specific device. ### Method GET ### Endpoint /v2/device/{id}/software ``` ```APIDOC ## GET /v2/device/{id}/volumes ### Description Retrieves information about storage volumes for a specific device. ### Method GET ### Endpoint /v2/device/{id}/volumes ``` ```APIDOC ## GET /v2/device/{id}/custom-fields ### Description Retrieves custom fields for a specific device. ### Method GET ### Endpoint /v2/device/{id}/custom-fields ``` ```APIDOC ## PATCH /v2/device/{id}/custom-fields ### Description Updates field values for a specific device's custom fields. ### Method PATCH ### Endpoint /v2/device/{id}/custom-fields ``` ```APIDOC ## GET /v2/device/{id}/policy/overrides ### Description Retrieves a summary of device policy overrides. ### Method GET ### Endpoint /v2/device/{id}/policy/overrides ``` -------------------------------- ### Knowledge Base Articles API Source: https://app.ninjarmm.com/apidocs?links.active=core Endpoints for managing knowledge base articles and folders, including uploads, archiving, deletion, and retrieval. ```APIDOC ## POST /v2/attachments/temp/upload ### Description Upload temporary attachments. ### Method POST ### Endpoint /v2/attachments/temp/upload ``` ```APIDOC ## POST /v2/knowledgebase/articles/archive ### Description Archive knowledge base articles. ### Method POST ### Endpoint /v2/knowledgebase/articles/archive ``` ```APIDOC ## POST /v2/knowledgebase/folders/archive ### Description Archive knowledge base folders. ### Method POST ### Endpoint /v2/knowledgebase/folders/archive ``` ```APIDOC ## POST /v2/knowledgebase/articles ### Description Create knowledge base articles. ### Method POST ### Endpoint /v2/knowledgebase/articles ``` ```APIDOC ## PATCH /v2/knowledgebase/articles ### Description Update knowledge base articles. ### Method PATCH ### Endpoint /v2/knowledgebase/articles ``` ```APIDOC ## POST /v2/knowledgebase/articles/delete ### Description Delete knowledge base articles. ### Method POST ### Endpoint /v2/knowledgebase/articles/delete ``` ```APIDOC ## POST /v2/knowledgebase/folders/delete ### Description Delete knowledge base folders. ### Method POST ### Endpoint /v2/knowledgebase/folders/delete ``` ```APIDOC ## GET /v2/knowledgebase/article/{articleId}/download ### Description Download knowledge base article. ### Method GET ### Endpoint /v2/knowledgebase/article/{articleId}/download ``` ```APIDOC ## GET /v2/knowledgebase/organization/articles ### Description Lists organization knowledge base articles. ### Method GET ### Endpoint /v2/knowledgebase/organization/articles ``` ```APIDOC ## GET /v2/knowledgebase/global/articles ### Description Lists global knowledge base articles. ### Method GET ### Endpoint /v2/knowledgebase/global/articles ``` ```APIDOC ## GET /v2/knowledgebase/article/{articleId}/signed-urls ### Description Get knowledge base article signed urls. ### Method GET ### Endpoint /v2/knowledgebase/article/{articleId}/signed-urls ``` ```APIDOC ## GET /v2/knowledgebase/folder/{folderId} ### Description Returns knowledge base folder. ### Method GET ### Endpoint /v2/knowledgebase/folder/{folderId} ``` ```APIDOC ## GET /v2/knowledgebase/folder ### Description Returns knowledge base folder. ### Method GET ### Endpoint /v2/knowledgebase/folder ``` ```APIDOC ## PATCH /v2/knowledgebase/folders/move ### Description Move knowledge base items. ### Method PATCH ### Endpoint /v2/knowledgebase/folders/move ``` ```APIDOC ## POST /v2/knowledgebase/articles/restore ### Description Restore archive knowledge base articles. ### Method POST ### Endpoint /v2/knowledgebase/articles/restore ``` ```APIDOC ## POST /v2/knowledgebase/folders/restore ### Description Restore archived knowledge base folders. ### Method POST ### Endpoint /v2/knowledgebase/folders/restore ``` ```APIDOC ## POST /v2/knowledgebase/articles/upload ### Description Upload knowledge base articles. ### Method POST ### Endpoint /v2/knowledgebase/articles/upload ``` ```APIDOC ## GET /v2/related-items/{relatedItemId}/attachment/download ### Description Download related item attachment. ### Method GET ### Endpoint /v2/related-items/{relatedItemId}/attachment/download ``` ```APIDOC ## GET /v2/related-items/with-entity/{entityType}/{entityId}/attachments/signed-urls ### Description Get related item attachments signed urls. ### Method GET ### Endpoint /v2/related-items/with-entity/{entityType}/{entityId}/attachments/signed-urls ``` -------------------------------- ### List Users by User Type Source: https://app.ninjarmm.com/apidocs?links.active=core Retrieves a list of users filtered by user type. ```APIDOC ## GET /v2/ticketing/app-user-contact ### Description List of users by user type ### Method GET ### Endpoint /v2/ticketing/app-user-contact ``` -------------------------------- ### List Ticket Log Entries Source: https://app.ninjarmm.com/apidocs?links.active=core Retrieves a list of log entries for a specific ticket. ```APIDOC ## GET /v2/ticketing/ticket/{ticketId}/log-entry ### Description List ticket log entries ### Method GET ### Endpoint /v2/ticketing/ticket/{ticketId}/log-entry ``` -------------------------------- ### Custom Fields Source: https://app.ninjarmm.com/apidocs?links.active=core Endpoints for managing custom fields, including bulk operations, creation, retrieval, and updates. ```APIDOC ## PUT /v2/custom-fields/bulk ### Description Bulk update custom fields. ### Method PUT ### Endpoint /v2/custom-fields/bulk ``` ```APIDOC ## POST /v2/custom-fields/bulk ### Description Bulk create custom fields. ### Method POST ### Endpoint /v2/custom-fields/bulk ``` ```APIDOC ## DELETE /v2/custom-fields/bulk ### Description Bulk delete custom fields. ### Method DELETE ### Endpoint /v2/custom-fields/bulk ``` ```APIDOC ## GET /v2/custom-fields ### Description Get custom fields with pagination. ### Method GET ### Endpoint /v2/custom-fields ``` ```APIDOC ## POST /v2/custom-fields ### Description Create a new custom field. ### Method POST ### Endpoint /v2/custom-fields ``` ```APIDOC ## GET /v2/custom-fields/field-name/{fieldName} ### Description Get custom field by field name. ### Method GET ### Endpoint /v2/custom-fields/field-name/{fieldName} ``` ```APIDOC ## PUT /v2/custom-fields/field-name/{fieldName} ### Description Update custom field by field name. ### Method PUT ### Endpoint /v2/custom-fields/field-name/{fieldName} ``` ```APIDOC ## DELETE /v2/custom-fields/field-name/{fieldName} ### Description Delete custom field by field name. ### Method DELETE ### Endpoint /v2/custom-fields/field-name/{fieldName} ``` ```APIDOC ## GET /v2/custom-fields/entity-type/{entityType}/{entityId}/signed-urls ### Description Get custom field signed urls. ### Method GET ### Endpoint /v2/custom-fields/entity-type/{entityType}/{entityId}/signed-urls ``` -------------------------------- ### Organization Documents Source: https://app.ninjarmm.com/apidocs?links.active=core Endpoints for managing organization documents, including archiving, creating, updating, and deleting. ```APIDOC ## POST /v2/organization/document/{clientDocumentId}/archive ### Description Archive an organization document. ### Method POST ### Endpoint /v2/organization/document/{clientDocumentId}/archive ``` ```APIDOC ## POST /v2/organization/documents/archive ### Description Archives organization documents. ### Method POST ### Endpoint /v2/organization/documents/archive ``` ```APIDOC ## POST /v2/organization/{organizationId}/template/{documentTemplateId}/document ### Description Create organization document. ### Method POST ### Endpoint /v2/organization/{organizationId}/template/{documentTemplateId}/document ``` ```APIDOC ## GET /v2/organization/documents ### Description List all organization documents with field values. ### Method GET ### Endpoint /v2/organization/documents ``` ```APIDOC ## POST /v2/organization/documents ### Description Create organization documents. ### Method POST ### Endpoint /v2/organization/documents ``` ```APIDOC ## PATCH /v2/organization/documents ### Description Update organization documents. ### Method PATCH ### Endpoint /v2/organization/documents ``` ```APIDOC ## DELETE /v2/organization/document/{clientDocumentId} ### Description Delete an archived organization document. ### Method DELETE ### Endpoint /v2/organization/document/{clientDocumentId} ``` ```APIDOC ## GET /v2/organization/document/{clientDocumentId}/signed-urls ### Description Get organization document signed urls. ### Method GET ### Endpoint /v2/organization/document/{clientDocumentId}/signed-urls ``` ```APIDOC ## GET /v2/organization/{organizationId}/documents ### Description List organization documents with field values. ### Method GET ### Endpoint /v2/organization/{organizationId}/documents ``` ```APIDOC ## POST /v2/organization/document/{clientDocumentId}/restore ### Description Restore an organization document. ### Method POST ### Endpoint /v2/organization/document/{clientDocumentId}/restore ``` ```APIDOC ## POST /v2/organization/documents/restore ### Description Restore multiple multi page organization documents. ### Method POST ### Endpoint /v2/organization/documents/restore ``` ```APIDOC ## POST /v2/organization/{organizationId}/document/{clientDocumentId} ### Description Update organization document. ### Method POST ### Endpoint /v2/organization/{organizationId}/document/{clientDocumentId} ``` -------------------------------- ### Reboot Device Source: https://app.ninjarmm.com/apidocs?links.active=core Reboots a device based on the specified mode. ```APIDOC ## POST /v2/device/{id}/reboot/{mode} ### Description Reboot device ### Method POST ### Endpoint /v2/device/{id}/reboot/{mode} ``` -------------------------------- ### Add Location to Organization Source: https://app.ninjarmm.com/apidocs?links.active=core Adds a new location to an existing organization. ```APIDOC ## POST /v2/organization/{id}/locations ### Description Add new location to organization ### Method POST ### Endpoint /v2/organization/{id}/locations ``` -------------------------------- ### Update API Webhook Configuration Source: https://app.ninjarmm.com/apidocs?links.active=core Updates the API Webhook configuration. ```APIDOC ## PUT /v2/webhook ### Description Update API Webhook configuration ### Method PUT ### Endpoint /v2/webhook ``` -------------------------------- ### Windows Service Control Source: https://app.ninjarmm.com/apidocs?links.active=core Controls a Windows service on a device. ```APIDOC ## POST /v2/device/{id}/windows-service/{serviceId}/control ### Description Windows service control ### Method POST ### Endpoint /v2/device/{id}/windows-service/{serviceId}/control ``` -------------------------------- ### Asset Tags API Source: https://app.ninjarmm.com/apidocs?links.active=core Endpoints for managing asset tags, including batch tagging, creation, retrieval, update, deletion, and merging. ```APIDOC ## POST /v2/tag/{assetType} ### Description Batch tag assets. ### Method POST ### Endpoint /v2/tag/{assetType} ## GET /v2/tag ### Description Get Asset Tags. ### Method GET ### Endpoint /v2/tag ## POST /v2/tag ### Description Create an Asset Tag. ### Method POST ### Endpoint /v2/tag ## PUT /v2/tag/{tagId} ### Description Update an Asset Tag. ### Method PUT ### Endpoint /v2/tag/{tagId} ## DELETE /v2/tag/{tagId} ### Description Delete an Asset Tag. ### Method DELETE ### Endpoint /v2/tag/{tagId} ## POST /v2/tag/delete ### Description Delete several Asset Tags. ### Method POST ### Endpoint /v2/tag/delete ## POST /v2/tag/merge ### Description Merge existing tags. ### Method POST ### Endpoint /v2/tag/merge ## PUT /v2/tag/{assetType}/{assetId} ### Description Set tags for an asset. ### Method PUT ### Endpoint /v2/tag/{assetType}/{assetId} ``` -------------------------------- ### Billing Ticket Products API Source: https://app.ninjarmm.com/apidocs?links.active=core Endpoints for managing ticket products within the billing system, including adhoc and catalog product creation, deletion, and updates. ```APIDOC ## POST /v2/billing/ticket-products/adhoc ### Description Creates an adhoc ticket product. ### Method POST ### Endpoint /v2/billing/ticket-products/adhoc ``` ```APIDOC ## POST /v2/billing/ticket-products/catalog ### Description Creates a catalog ticket product. ### Method POST ### Endpoint /v2/billing/ticket-products/catalog ``` ```APIDOC ## GET /v2/billing/ticket-products/ticket/{id} ### Description Get all products related to a ticket. ### Method GET ### Endpoint /v2/billing/ticket-products/ticket/{id} ``` ```APIDOC ## POST /v2/billing/ticket-products/delete ### Description Removes a list of ticket products from a ticket. ### Method POST ### Endpoint /v2/billing/ticket-products/delete ``` ```APIDOC ## PUT /v2/billing/ticket-products/{ticketProductId} ### Description Updates a ticket product. ### Method PUT ### Endpoint /v2/billing/ticket-products/{ticketProductId} ``` ```APIDOC ## PUT /v2/billing/ticket-time-entry/{timeEntryId} ### Description Updates PSA properties of a ticket time entry. ### Method PUT ### Endpoint /v2/billing/ticket-time-entry/{timeEntryId} ``` -------------------------------- ### List Ticket Forms Source: https://app.ninjarmm.com/apidocs?links.active=core Retrieves a list of available ticket forms. ```APIDOC ## GET /v2/ticketing/ticket-form ### Description List ticket forms ### Method GET ### Endpoint /v2/ticketing/ticket-form ``` -------------------------------- ### List Tickets for Board Source: https://app.ninjarmm.com/apidocs?links.active=core Retrieves a list of tickets associated with a specific board. ```APIDOC ## POST /v2/ticketing/trigger/board/{boardId}/run ### Description List of tickets for board ### Method POST ### Endpoint /v2/ticketing/trigger/board/{boardId}/run ``` -------------------------------- ### List Ticket Attributes Source: https://app.ninjarmm.com/apidocs?links.active=core Retrieves a list of available ticket attributes. ```APIDOC ## GET /v2/ticketing/attributes ### Description List ticket attributes ### Method GET ### Endpoint /v2/ticketing/attributes ``` -------------------------------- ### Vulnerability Management Source: https://app.ninjarmm.com/apidocs?links.active=core Endpoints for vulnerability management, including fetching scan groups and uploading data. ```APIDOC ## GET /v2/vulnerability/scan-groups ### Description Fetch all Scan Groups. ### Method GET ### Endpoint /v2/vulnerability/scan-groups ``` ```APIDOC ## GET /v2/vulnerability/scan-groups/{scan-group-id} ### Description Fetch Scan Group. ### Method GET ### Endpoint /v2/vulnerability/scan-groups/{scan-group-id} ``` ```APIDOC ## POST /v2/vulnerability/scan-groups/{scan-group-id}/upload ### Description Upload CSV. ### Method POST ### Endpoint /v2/vulnerability/scan-groups/{scan-group-id}/upload ``` -------------------------------- ### Custom Tabs API Source: https://app.ninjarmm.com/apidocs?links.active=core Endpoints for managing custom tabs, including creation, retrieval, update, deletion, and visibility settings. ```APIDOC ## POST /v2/tab ### Description Create a new Custom Tab. ### Method POST ### Endpoint /v2/tab ## GET /v2/tab/{tabId} ### Description Retrieve a Custom Tab. ### Method GET ### Endpoint /v2/tab/{tabId} ## DELETE /v2/tab/{tabId} ### Description Delete a Custom Tab. ### Method DELETE ### Endpoint /v2/tab/{tabId} ## PATCH /v2/tab/{tabId} ### Description Update a Custom Tab. ### Method PATCH ### Endpoint /v2/tab/{tabId} ## GET /v2/tab/{tabId}/end-user ### Description Retrieve the requested tab along with any extensions for end-user tabs. ### Method GET ### Endpoint /v2/tab/{tabId}/end-user ## GET /v2/tab/{tabId}/organization ### Description Retrieve the requested tab along with any extensions for organization and location tabs. ### Method GET ### Endpoint /v2/tab/{tabId}/organization ## GET /v2/tab/{tabId}/role/{roleId} ### Description Retrieve the requested tab along with any extensions based on the supplied roleId. ### Method GET ### Endpoint /v2/tab/{tabId}/role/{roleId} ## GET /v2/tab/summary/end-user ### Description Retrieve all of the custom tabs available to end user views. ### Method GET ### Endpoint /v2/tab/summary/end-user ## GET /v2/tab/summary/organization ### Description Retrieve all of the custom tabs available to organizations and locations. ### Method GET ### Endpoint /v2/tab/summary/organization ## GET /v2/tab/summary/role/{roleId} ### Description Retrieve all of the custom tabs that would appear for the given role. ### Method GET ### Endpoint /v2/tab/summary/role/{roleId} ## PATCH /v2/tab/rename ### Description Rename a Custom Tab. ### Method PATCH ### Endpoint /v2/tab/rename ## PATCH /v2/tab/role/{roleId}/visibility ### Description Set the tab visibility of the specified tab. ### Method PATCH ### Endpoint /v2/tab/role/{roleId}/visibility ## PATCH /v2/tab/end-user/order ### Description Update the order of custom tabs for end-user tabs. ### Method PATCH ### Endpoint /v2/tab/end-user/order ## PATCH /v2/tab/organization/order ### Description Update the order of custom tabs for organizations and locations. ### Method PATCH ### Endpoint /v2/tab/organization/order ## PATCH /v2/tab/role/{roleId}/order ### Description Update the order of custom tabs for a specific role. ### Method PATCH ### Endpoint /v2/tab/role/{roleId}/order ```