Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/celerium/datto-powershellwrapper
PowerShell wrapper for the Datto BCDR API
https://github.com/celerium/datto-powershellwrapper
api bcdr celerium datto powershell rest rest-api saas
Last synced: about 1 month ago
JSON representation
PowerShell wrapper for the Datto BCDR API
- Host: GitHub
- URL: https://github.com/celerium/datto-powershellwrapper
- Owner: Celerium
- License: mit
- Created: 2022-01-28T01:36:53.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-09T15:48:19.000Z (10 months ago)
- Last Synced: 2024-03-10T15:55:36.790Z (10 months ago)
- Topics: api, bcdr, celerium, datto, powershell, rest, rest-api, saas
- Language: PowerShell
- Homepage: https://celerium.github.io/Datto-PowerShellWrapper/
- Size: 1.99 MB
- Stars: 4
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
Celerium_DattoAPI
[![Az_Pipeline][Az_Pipeline-shield]][Az_Pipeline-url]
[![GitHub_Pages][GitHub_Pages-shield]][GitHub_Pages-url]
[![PoshGallery_Version][PoshGallery_Version-shield]][PoshGallery_Version-url]
[![PoshGallery_Platforms][PoshGallery_Platforms-shield]][PoshGallery_Platforms-url]
[![PoshGallery_Downloads][PoshGallery_Downloads-shield]][PoshGallery_Downloads-url]
[![codeSize][codeSize-shield]][codeSize-url]
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![Blog][Website-shield]][Website-url]
[![GitHub_License][GitHub_License-shield]][GitHub_License-url]
---
## Buy me a coffee
Whether you use this project, have learned something from it, or just like it, please consider supporting it by buying me a coffee, so I can dedicate more time on open-source projects like this :)
---
---
## About The Project
The [DattoAPI](https://www.datto.com/) offers users the ability to extract data from Datto into third-party reporting tools and aims to abstract away the details of interacting with Datto's API endpoints in such a way that is consistent with PowerShell nomenclature. This gives system administrators and PowerShell developers a convenient and familiar way of using Datto's API to create documentation scripts, automation, and integrations.
- :book: Project documentation can be found on [Github Pages](https://celerium.github.io/Datto-PowerShellWrapper/)
- :book: Datto's REST API documentation on their management portal [here](https://portal.dattobackup.com/integrations/api) *[ Requires a login ]*.
Datto features a REST API that makes use of common HTTP request methods. In order to maintain PowerShell best practices, only approved verbs are used.
- GET -> `Get-`
- PUT -> `Set-`
Additionally, PowerShell's `verb-noun` nomenclature is respected. Each noun is prefixed with `Datto` in an attempt to prevent naming problems.
For example, one might access the `/bcdr/device` endpoint by running the following PowerShell command with the appropriate parameters:
```posh
Get-DattoDevice -serialNumber 12345
```
## Install
This module can be installed directly from the [PowerShell Gallery](https://www.powershellgallery.com/packages/DattoAPI) with the following command:
```posh
Install-Module -Name DattoAPI
```
- :information_source: This module supports PowerShell 5.0+ and *should* work in PowerShell Core.
- :information_source: If you are running an older version of PowerShell, or if PowerShellGet is unavailable, you can manually download the *main* branch and place the *DattoAPI* folder into the (default) `C:\Program Files\WindowsPowerShell\Modules` folder.
Project documentation can be found on [Github Pages](https://celerium.github.io/Datto-PowerShellWrapper/)
- A full list of functions can be retrieved by running `Get-Command -Module DattoAPI`.
- Help info and a list of parameters can be found by running `Get-Help `, such as:
```posh
Get-Help Get-DattoDevice
Get-Help Get-DattoDevice -Full
```
## Initial Setup
After installing this module, you will need to configure both the *base URI* & *API access tokens* that are used to talk with the Datto API.
1. Run `Add-DattoBaseURI`
- By default, Datto's `https://api.datto.com/v1` URI is used.
- If you have your own API gateway or proxy, you may put in your own custom URI by specifying the `-base_uri` parameter:
- `Add-DattoBaseURI -base_uri http://myapi.gateway.celerium.org`
2. Run `Add-DattoAPIKey -Api_Key_Public 12345 -Api_Key_Secret 123456789`
- It will prompt you to enter your API access tokens if you do not specify them.
- Datto API access tokens are generated via the Datto portal at *Admin > Integrations*
3. [**optional**] Run `Export-DattoModuleSettings`
- This will create a config file at `%UserProfile%\DattoAPI` that holds the *base uri* & *API access tokens* information.
- Next time you run `Import-Module -Name DattoAPI`, this configuration file will automatically be loaded.
- :warning: Exporting module settings encrypts your API access tokens in a format that can **only be unencrypted by the user principal** that encrypted the secret. It makes use of .NET DPAPI, which for Windows uses reversible encrypted tied to your user principal. This means that you **cannot copy** your configuration file to another computer or user account and expect it to work.
- :warning: However in Linux\Unix operating systems the secret keys are more obfuscated than encrypted so it is recommend to use a more secure & cross-platform storage method.
## Usage
Calling an API resource is as simple as running `Get-Datto`
- The following is a table of supported functions and their corresponding API resources:
- Table entries with [ `-` ] indicate that the functionality is **NOT** supported by the Datto API at this time.
| Section | API Resource | Create | Read | Update | Delete |
| --------- | ------------------ | ------ | ----------------------------- | ------------------------- | ------ |
| Reporting | ActivityLog | - | `Get-DattoActivityLog` | - | - |
| BCDR | Agent | - | `Get-DattoAgent` | - | - |
| BCDR | Alert | - | `Get-DattoAlert` | - | - |
| BCDR | Asset | - | `Get-DattoAsset` | - | - |
| BCDR | **BCDR** * | - | `Get-DattoBCDR` | - | - |
| BCDR | Device | - | `Get-DattoDevice` | - | - |
| BCDR | Share | - | `Get-DattoShare` | - | - |
| BCDR | VMRestore | - | `Get-DattoVMRestore` | - | - |
| BCDR | Volume | - | `Get-DattoVolume` | - | - |
| SaaS | **SaaS** * | - | `Get-DattoSaaS` | - | - |
| SaaS | Domains | - | `Get-DattoDomain` | - | - |
| SaaS | Seats | - | `Get-DattoSeat` | - | - |
| SaaS | Applications | - | `Get-DattoApplication` | - | - |
| SaaS | BulkSeatChange | - | - | `Set-DattoBulkSeatChange` | - |
- :warning: `Get-DattoBCDR` & `Get-DattoSaaS` are special functions.
- These are **NOT** endpoints in Datto's REST API and are a single set of commands that can run endpoints in their associate sections.
- I included them because they made scripting easier and felt like a nice-to-have feature IMO
Each `Get-Datto*` function will respond with the raw data that Datto's API provides.
- :warning: Returned data is mostly structured the same but can vary between commands.
- pagination - Information about the number of pages of results are available and other metadata.
- items - The actual information requested (this is what most people care about)
## Roadmap
- [ ] Add Changelog
- [x] Build more robust Pester & ScriptAnalyzer tests
- [x] Figure out how to do CI & PowerShell gallery automation
- [ ] Add example scripts & automation
See the [open issues](https://github.com/Celerium/Datto-PowerShellWrapper/issues) for a full list of proposed features (and known issues).
---
## Contributing
Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
See the [CONTRIBUTING](https://github.com/Celerium/Datto-PowerShellWrapper/blob/main/.github/CONTRIBUTING.md) guide for more information about contributing.
## License
Distributed under the MIT License. See [`LICENSE`](https://github.com/Celerium/Datto-PowerShellWrapper/blob/main/LICENSE) for more information.
[![GitHub_License][GitHub_License-shield]][GitHub_License-url]
## Contact
## Acknowledgments
Big thank you to the following people and services as they have provided me with lots of helpful information as I continue this project!
- [GitHub Pages](https://pages.github.com)
- [Img Shields](https://shields.io)
- [Font Awesome](https://fontawesome.com)
- [Choose an Open Source License](https://choosealicense.com)
- [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet)
[Az_Pipeline-shield]: https://img.shields.io/azure-devops/build/AzCelerium/DattoAPI/4?style=for-the-badge&label=DevOps_Build
[Az_Pipeline-url]: https://dev.azure.com/AzCelerium/DattoAPI/_build?definitionId=4
[GitHub_Pages-shield]: https://img.shields.io/github/actions/workflow/status/celerium/Datto-PowerShellWrapper/pages%2Fpages-build-deployment?style=for-the-badge&label=GitHub%20Pages
[GitHub_Pages-url]: https://github.com/Celerium/Datto-PowerShellWrapper/actions/workflows/pages/pages-build-deployment
[GitHub_License-shield]: https://img.shields.io/github/license/celerium/Datto-PowerShellWrapper?style=for-the-badge
[GitHub_License-url]: https://github.com/Celerium/Datto-PowerShellWrapper/blob/main/LICENSE
[PoshGallery_Version-shield]: https://img.shields.io/powershellgallery/v/dattoapi?include_prereleases&style=for-the-badge
[PoshGallery_Version-url]: https://www.powershellgallery.com/packages/DattoAPI
[PoshGallery_Platforms-shield]: https://img.shields.io/powershellgallery/p/Dattoapi?style=for-the-badge
[PoshGallery_Platforms-url]: https://www.powershellgallery.com/packages/DattoAPI
[PoshGallery_Downloads-shield]: https://img.shields.io/powershellgallery/dt/DattoAPI?style=for-the-badge
[PoshGallery_Downloads-url]: https://www.powershellgallery.com/packages/DattoAPI
[website-shield]: https://img.shields.io/website?up_color=blue&url=https%3A%2F%2Fcelerium.org&style=for-the-badge&label=Blog
[website-url]: https://celerium.org
[codeSize-shield]: https://img.shields.io/github/repo-size/celerium/Datto-PowerShellWrapper?style=for-the-badge
[codeSize-url]: https://github.com/Celerium/Datto-PowerShellWrapper
[contributors-shield]: https://img.shields.io/github/contributors/celerium/Datto-PowerShellWrapper?style=for-the-badge
[contributors-url]: https://github.com/Celerium/Datto-PowerShellWrapper/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/celerium/Datto-PowerShellWrapper?style=for-the-badge
[forks-url]: https://github.com/Celerium/Datto-PowerShellWrapper/network/members
[stars-shield]: https://img.shields.io/github/stars/celerium/Datto-PowerShellWrapper?style=for-the-badge
[stars-url]: https://github.com/Celerium/Datto-PowerShellWrapper/stargazers
[issues-shield]: https://img.shields.io/github/issues/Celerium/Datto-PowerShellWrapper?style=for-the-badge
[issues-url]: https://github.com/Celerium/Datto-PowerShellWrapper/issues
