{"id":15202976,"url":"https://github.com/rhymeswithmogul/ninjarmm-powershell","last_synced_at":"2025-10-02T18:32:02.226Z","repository":{"id":135521111,"uuid":"305801904","full_name":"rhymeswithmogul/NinjaRMM-PowerShell","owner":"rhymeswithmogul","description":"An PowerShell module to interact with the NinjaRMM Public API.  (Not affiliated in any way with NinjaRMM.)","archived":true,"fork":false,"pushed_at":"2022-11-24T17:05:45.000Z","size":89,"stargazers_count":17,"open_issues_count":0,"forks_count":11,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-09-28T04:21:10.500Z","etag":null,"topics":["api","api-client","api-rest","api-restful","ninjarmm","ninjarmm-api","powershell","powershell-adminscripts","powershell-cmdlets","powershell-core","powershell-gallery","powershell-module","pwsh","rmm","windows-powershell"],"latest_commit_sha":null,"homepage":"https://www.powershellgallery.com/packages/NinjaRmmApi/","language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rhymeswithmogul.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-10-20T18:40:17.000Z","updated_at":"2024-07-23T18:25:42.000Z","dependencies_parsed_at":null,"dependency_job_id":"daa1eee7-731f-4edf-99de-cd074b4e6772","html_url":"https://github.com/rhymeswithmogul/NinjaRMM-PowerShell","commit_stats":{"total_commits":12,"total_committers":3,"mean_commits":4.0,"dds":0.5,"last_synced_commit":"d2e50130df612e4e4e746de662e7db09271c5bf3"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rhymeswithmogul%2FNinjaRMM-PowerShell","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rhymeswithmogul%2FNinjaRMM-PowerShell/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rhymeswithmogul%2FNinjaRMM-PowerShell/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rhymeswithmogul%2FNinjaRMM-PowerShell/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rhymeswithmogul","download_url":"https://codeload.github.com/rhymeswithmogul/NinjaRMM-PowerShell/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235038194,"owners_count":18926232,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","api-client","api-rest","api-restful","ninjarmm","ninjarmm-api","powershell","powershell-adminscripts","powershell-cmdlets","powershell-core","powershell-gallery","powershell-module","pwsh","rmm","windows-powershell"],"created_at":"2024-09-28T04:20:57.465Z","updated_at":"2025-10-02T18:32:01.873Z","avatar_url":"https://github.com/rhymeswithmogul.png","language":"PowerShell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# THIS PROJECT IS DEAD, BUT YOU CAN STILL FORK IT\r\nI've changed jobs, and I no longer have access to NinjaRMM.  This module implemented version 0.x of the API, which I'm told is long dead.  Fork this project and keep it alive!  This repo and module will remain for historical purposes.\r\n\r\n\u003chr\u003e\r\n\r\n![NinjaRmmApi logo](https://raw.githubusercontent.com/rhymeswithmogul/NinjaRMM-PowerShell/main/NinjaRmmApi.png)\r\n# NinjaRmmApi\r\n[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](https://github.com/rhymeswithmogul/NinjaRMM-PowerShell/blob/main/CODE_OF_CONDUCT.md) \r\n\r\nA PowerShell module to interact with [the NinjaRMM Public API](https://www.ninjarmm.com/dev-api/).  This currently complies with [beta version 0.1.2 of the specification](https://ninjaresources.s3.amazonaws.com/PublicApi/0.1.2/NinjaRMM%20Public%20API%20v0.1.2.pdf).\r\n\r\n## Installing this module\r\nThis module is available in [PowerShell Gallery](https://www.powershellgallery.com/packages/NinjaRmmApi):\r\n```powershell\r\nPS C:\\\u003e Install-Module NinjaRmmApi\r\n```\r\nOr, download it from here and save all of the files somewhere in your `$PSModulePath`.\r\n\r\n## Before you start\r\nTo get started with this module, you will need to log into your dashboard and [request an API key](https://app.ninjarmm.com/#/configuration/integrations/api).  Write down the access key ID and the secret access key.  You will not see them again!\r\n\r\nThen, in your PowerShell session, teach it your secrets with `Set-NinjaRmmSecrets`.\r\n```powershell\r\nPS C:\\\u003e Set-NinjaRmmSecrets -AccessKeyID \"TF4STGMDR4H7AEXAMPLE\" -SecretAccessKey \"eh14c4ngchhu6283he03j6o7ar2fcuca0example\"\r\n```\r\nYou will need to do this every time you start a new PowerShell session;  this module does *not* store your keys for you!  For long-term storage, consider using a password manager, sticking the keys in your `$Profile` file, or using the [SecretManagement module](https://github.com/powershell/secretmanagement).  How you do this is an exercise left to the reader.\r\n\r\n## Using this module\r\nNow that that's been done, start using their API!\r\n\r\n### Customers\r\nYou can look up customer information with the `Get-NinjaRmmCustomers` cmdlet.  With no arguments, it returns a list of all customers.  You can also use the -CustomerID parameter to fetch a specific customer.  The NinjaRMM API returns data as objects that you can parse with other PowerShell cmdlets like `Format-List` and `Select-Object` (and, of course, everyone's favorite, `Out-GridView`!).\r\n```powershell\r\nPS C:\\\u003e Get-NinjaRmmCustomers -CustomerID 42\r\n\r\nid name         description\r\n-- ----         --------------\r\n42 Deep Thought Bring a towel.\r\n```\r\n\r\n### Devices\r\nYou can get devices in the same manner, by using `Get-NinjaRmmDevices`.  Again, your results are PowerShell objects that you can work with.\r\n```powershell\r\nPS C:\\\u003e $myComputer = Get-NinjaRmmDevices -DeviceID 528\r\nPS C:\\\u003e $myComputer.System | Format-List\r\n\r\nmanufacturer       : Hewlett-Packard\r\nname               : RECEPTION-PC\r\nmodel              : HP Z400 Workstation\r\ndns_host_name      : Reception-PC\r\nbios_serial_number : 2UA1234567\r\nserial_number      : 2UA1234567\r\ndomain             : WORKGROUP\r\n```\r\n\r\n### Alerts\r\nYou can get and reset alerts, too:\r\n```powershell\r\nPS C:\\\u003e $alertsToReviewLater = Get-NinjaRmmAlerts -Since 3071641\r\n\r\nPS C:\\\u003e Reset-NinjaRmmAlert -AlertID 3071642\r\n```\r\n\r\n## After you're done\r\nWhen you are finished, it is best practice to remove your API key from memory:\r\n```powershell\r\nPS C:\\\u003e Reset-NinjaRmmSecrets\r\n```\r\n\r\n## What else can I do?\r\nThere is plenty of help to read.  Get started with this:\r\n```powershell\r\nPS C:\\\u003e Get-Help about_NinjaRmmApi\r\n```\r\n\r\n## Legal Notices\r\nNeither I nor this code are in any way affiliated with, related to, or endorsed by NinjaRMM, LLC.  I'm just a user.  If you need support with this PowerShell module, don't go to them.  Open an issue or pull request instead.\r\n\r\nThis program is free software:  you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.\r\n\r\nThis program is distributed in the hope that it will be useful, but **WITHOUT ANY WARRANTY**; without even the implied warranty of **MERCHANTABILITY** or **FITNESS FOR A PARTICULAR PURPOSE**.  Test anything you build with this tool.\r\n\r\n## Contributing\r\nThe NinjaRMM API is under active development;  thus, so is this module.  Contributions are welcome!\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frhymeswithmogul%2Fninjarmm-powershell","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frhymeswithmogul%2Fninjarmm-powershell","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frhymeswithmogul%2Fninjarmm-powershell/lists"}