Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@Celerium
Celerium committed Sep 20, 2023
1 parent 5cabe17 commit f77ae12
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 59 deletions.
30 changes: 16 additions & 14 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -153,20 +153,22 @@ Calling an API resource is as simple as running `Get-Datto<resourceName>`
- 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 | Volume | - | `Get-DattoVolume` | - | - |
| SaaS | **SaaS** * | - | `Get-DattoSaaS` | - | - |
| SaaS | Domains | - | `Get-DattoDomain` | - | - |
| SaaS | Seats | - | `Get-DattoSeat` | - | - |
| SaaS | Applications | - | `Get-DattoApplication` | - | - |
| 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-DattoGet-DattoVMRestore` | - | - |
| BCDR | Volume | - | `Get-DattoVolume` | - | - |
| SaaS | **SaaS** * | - | `Get-DattoSaaS` | - | - |
| SaaS | Domains | - | `Get-DattoDomain` | - | - |
| SaaS | Seats | - | `Get-DattoSeat` | - | - |
| SaaS | Applications | - | `Get-DattoApplication` | - | - |
| SaaS | BulkSeatAssignment | - | `Get-DattoBulkSeatAssignment` | - | - |

- :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.
Expand Down
63 changes: 32 additions & 31 deletions docs/TrackingCSV.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,34 +17,35 @@ I recommend downloading the CSV from the link provided rather then viewing the t

## CSV markdown table

|Category |EndpointUri |Method|Function |Complete|Notes |
|---------|----------------------------------------------|------|--------------------------|--------|-----------------------------------------------------|
|BCDR |/bcdr/agent |GET |Get-DattoAgent |YES |As of 2022-04 this endpoint does not return any data.|
|BCDR |/bcdr/device/{serialNumber}/asset/agent |GET |Get-DattoAgent |YES | |
|BCDR |/bcdr/device/{serialNumber}/alert |GET |Get-DattoAlert |YES | |
|BCDR |/bcdr/device/{serialNumber}/asset |GET |Get-DattoAsset |YES | |
|BCDR |/bcdr/ |GET |Get-DattoBCDR |YES |Special command that combines all BCDR endpoints |
|BCDR |/bcdr/device |GET |Get-DattoDevice |YES | |
|BCDR |/bcdr/device/{serialNumber} |GET |Get-DattoDevice |YES | |
|BCDR |/bcdr/device/{serialNumber}/asset/share |GET |Get-DattoShare |YES | |
|BCDR |/bcdr/device/{serialNumber}/asset/{volumeName}|GET |Get-DattoVolume |YES | |
|Internal | |POST |Add-DattoAPIKey |YES | |
|Internal | |POST |Add-DattoBaseURI |YES | |
|Internal | |POST |Initialize-DattoModule |YES | |
|Internal | |PUT |ConvertTo-DattoQueryString|YES | |
|Internal | |GET |Export-DattoModuleSettings|YES | |
|Internal | |GET |Get-DattoAPIKey |YES | |
|Internal | |GET |Get-DattoBaseURI |YES | |
|Internal | |GET |Get-DattoModuleSettings |YES | |
|Internal | |GET |Import-DattoModuleSettings|YES | |
|Internal | |GET |Invoke-DattoRequest |YES | |
|Internal | |DELETE|Remove-DattoAPIKey |YES | |
|Internal | |DELETE|Remove-DattoBaseURI |YES | |
|Internal | |DELETE|Remove-DattoModuleSettings|YES | |
|Internal | |GET |Test-DattoAPIKey |YES | |
|Internal | |GET |Get-DattoMetaData |YES | |
|Reporting|/report/activity-log |GET |Get-DattoActivityLog |YES | |
|SaaS |/sass/{sassCustomerId}/applications |GET |Get-DattoApplication |YES | |
|SaaS |/sass/domains |GET |Get-DattoDomain |YES | |
|SaaS |/sass/ |GET |Get-DattoSaaS |YES |Special command that combines all SaaS endpoints |
|SaaS |/sass/{sassCustomerId}/seats |GET |Get-DattoSeat |YES | |
|Category |EndpointUri |Method|Function |Complete|Notes |
|---------|------------------------------------------------------------------|------|---------------------------|--------|-----------------------------------------------------|
|BCDR |/bcdr/agent |GET |Get-DattoAgent |YES |As of 2022-04 this endpoint does not return any data.|
|BCDR |/bcdr/device/{serialNumber}/asset/agent |GET |Get-DattoAgent |YES | |
|BCDR |/bcdr/device/{serialNumber}/alert |GET |Get-DattoAlert |YES | |
|BCDR |/bcdr/device/{serialNumber}/asset |GET |Get-DattoAsset |YES | |
|BCDR |/bcdr/ |GET |Get-DattoBCDR |YES |Special command that combines all BCDR endpoints |
|BCDR |/bcdr/device |GET |Get-DattoDevice |YES | |
|BCDR |/bcdr/device/{serialNumber} |GET |Get-DattoDevice |YES | |
|BCDR |/bcdr/device/{serialNumber}/asset/share |GET |Get-DattoShare |YES | |
|BCDR |/bcdr/device/{serialNumber}/vm-restores |GET |Get-DattoVMRestore |Yes |Cannot fully validate at this time |
|BCDR |/bcdr/device/{serialNumber}/asset/{volumeName} |GET |Get-DattoVolume |YES | |
|Internal | |POST |Add-DattoAPIKey |YES | |
|Internal | |POST |Add-DattoBaseURI |YES | |
|Internal | |PUT |ConvertTo-DattoQueryString |YES | |
|Internal | |GET |Export-DattoModuleSettings |YES | |
|Internal | |GET |Get-DattoAPIKey |YES | |
|Internal | |GET |Get-DattoBaseURI |YES | |
|Internal | |GET |Get-DattoMetaData |YES | |
|Internal | |GET |Get-DattoModuleSettings |YES | |
|Internal | |GET |Import-DattoModuleSettings |YES | |
|Internal | |GET |Invoke-DattoRequest |YES | |
|Internal | |DELETE|Remove-DattoAPIKey |YES | |
|Internal | |DELETE|Remove-DattoBaseURI |YES | |
|Internal | |DELETE|Remove-DattoModuleSettings |YES | |
|Internal | |GET |Test-DattoAPIKey |YES | |
|Reporting|/report/activity-log |GET |Get-DattoActivityLog |YES | |
|SaaS |/sass/{sassCustomerId}/applications |GET |Get-DattoApplication |YES | |
|SaaS |/saas/{saasCustomerId}/{externalSubscriptionId}/bulkSeatAssignment|GET |Get-DattoBulkSeatAssignment|YES |Cannot fully validate at this time |
|SaaS |/sass/domains |GET |Get-DattoDomain |YES | |
|SaaS |/sass/ |GET |Get-DattoSaaS |YES |Special command that combines all SaaS endpoints |
|SaaS |/sass/{sassCustomerId}/seats |GET |Get-DattoSeat |YES | |
30 changes: 16 additions & 14 deletions docs/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -163,20 +163,22 @@ Calling an API resource is as simple as running `Get-Datto<resourceName>`
- 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 | Volume | - | `Get-DattoVolume` | - | - |
| SaaS | **SaaS** * | - | `Get-DattoSaaS` | - | - |
| SaaS | Domains | - | `Get-DattoDomain` | - | - |
| SaaS | Seats | - | `Get-DattoSeat` | - | - |
| SaaS | Applications | - | `Get-DattoApplication` | - | - |
| 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-DattoGet-DattoVMRestore` | - | - |
| BCDR | Volume | - | `Get-DattoVolume` | - | - |
| SaaS | **SaaS** * | - | `Get-DattoSaaS` | - | - |
| SaaS | Domains | - | `Get-DattoDomain` | - | - |
| SaaS | Seats | - | `Get-DattoSeat` | - | - |
| SaaS | Applications | - | `Get-DattoApplication` | - | - |
| SaaS | BulkSeatAssignment | - | `Get-DattoBulkSeatAssignment` | - | - |

- :warning: `Get-DattoBCDR` & `Get-DattoSaaS` are special functions.
- They are **NOT** endpoints in Datto's REST API and are a single set of commands the can run endpoints in their associate sections.
Expand Down

0 comments on commit f77ae12

Please sign in to comment.