spec/EndpointMap.json

{
  "contractVersion": "v1",
  "operationCount": 22,
  "operations": [
    {
      "method": "GET",
      "path": "/v1/bcdr/agent",
      "operationId": "v1GetAgents",
      "tag": "BCDR",
      "summary": "Returns a list of your clients (organizations) and their respective agents.",
      "command": "Get-DattoBcdrClient",
      "parameterSet": "Default",
      "result": "BcdrClient[]",
      "resultProperty": "clients"
    },
    {
      "method": "GET",
      "path": "/v1/bcdr/device",
      "operationId": "v1GetDevices",
      "tag": "BCDR",
      "summary": "Returns a list of your devices.",
      "command": "Get-DattoBcdrDevice",
      "parameterSet": "List",
      "result": "Device[]",
      "resultProperty": "items"
    },
    {
      "method": "GET",
      "path": "/v1/bcdr/device/{serialNumber}",
      "operationId": "v1GetDevice",
      "tag": "BCDR",
      "summary": "Get device information by serial number.",
      "command": "Get-DattoBcdrDevice",
      "parameterSet": "BySerial",
      "result": "Device"
    },
    {
      "method": "GET",
      "path": "/v1/bcdr/device/{serialNumber}/alert",
      "operationId": "v1GetDeviceAlerts",
      "tag": "BCDR",
      "summary": "Get alerts for a given device.",
      "command": "Get-DattoBcdrAlert",
      "parameterSet": "Default",
      "result": "Alert[]",
      "resultProperty": "items"
    },
    {
      "method": "GET",
      "path": "/v1/bcdr/device/{serialNumber}/asset",
      "operationId": "v1GetAssets",
      "tag": "BCDR",
      "summary": "Get assets (agents and shares) for a given device.",
      "command": "Get-DattoBcdrAsset",
      "parameterSet": "List",
      "result": "DeviceAsset[]",
      "responseShape": "array-or-envelope"
    },
    {
      "method": "GET",
      "path": "/v1/bcdr/device/{serialNumber}/asset/agent",
      "operationId": "v1GetAgentsForDevice",
      "tag": "BCDR",
      "summary": "Get agents for a given device.",
      "command": "Get-DattoBcdrAgent",
      "parameterSet": "Default",
      "result": "DeviceAsset[]",
      "responseShape": "array-or-envelope"
    },
    {
      "method": "GET",
      "path": "/v1/bcdr/device/{serialNumber}/asset/share",
      "operationId": "v1GetShares",
      "tag": "BCDR",
      "summary": "Get shares for a given device.",
      "command": "Get-DattoBcdrShare",
      "parameterSet": "Default",
      "result": "DeviceAsset[]",
      "responseShape": "array-or-envelope"
    },
    {
      "method": "GET",
      "path": "/v1/bcdr/device/{serialNumber}/asset/{volumeName}",
      "operationId": "v1GetAssetByVolume",
      "tag": "BCDR",
      "summary": "Get an asset(s)(agent or share) for a specific volume on a device.",
      "command": "Get-DattoBcdrAsset",
      "parameterSet": "ByVolume",
      "result": "DeviceAsset[]",
      "responseShape": "array-or-envelope"
    },
    {
      "method": "GET",
      "path": "/v1/bcdr/device/{serialNumber}/asset/{volumeName}/screenshot/latest",
      "operationId": "v1GetDeviceAssetScreenshotLatest",
      "tag": "BCDR",
      "summary": "Get the latest screenshot binary image data for a specific volume on a device.",
      "command": "Save-DattoBcdrAssetScreenshot",
      "parameterSet": "Default",
      "result": "image/png",
      "binary": true
    },
    {
      "method": "GET",
      "path": "/v1/bcdr/device/{serialNumber}/vm-restores",
      "operationId": "v1GetDeviceRestores",
      "tag": "BCDR",
      "summary": "Get device VM restores by serial number.",
      "command": "Get-DattoBcdrVmRestore",
      "parameterSet": "Default",
      "result": "DeviceVMRestore[]",
      "resultProperty": "items"
    },
    {
      "method": "PUT",
      "path": "/v1/dtc/agent/{agentUuid}/bandwidth",
      "operationId": "v1DTCAgentBandwidth",
      "tag": "Direct-to-Cloud",
      "summary": "Update the bandwidth settings for a single direct-to-cloud agent.",
      "command": "Set-DattoDtcAgentBandwidth",
      "parameterSet": "Default",
      "result": "BandwidthSettingsResponse"
    },
    {
      "method": "GET",
      "path": "/v1/dtc/assets",
      "operationId": "v1DTCAssets",
      "tag": "Direct-to-Cloud",
      "summary": "Get details for direct-to-cloud assets.",
      "command": "Get-DattoDtcAsset",
      "parameterSet": "Default",
      "result": "DTCAssetsData",
      "responseShape": "contract-defined object; envelope tolerated"
    },
    {
      "method": "GET",
      "path": "/v1/dtc/rmm-templates",
      "operationId": "v1DTCRMMTemplate",
      "tag": "Direct-to-Cloud",
      "summary": "Get RMM templates.",
      "command": "Get-DattoDtcRmmTemplate",
      "parameterSet": "Default",
      "result": "RMMTemplates[]",
      "resultProperty": "items"
    },
    {
      "method": "GET",
      "path": "/v1/dtc/storage-pool",
      "operationId": "v1DTCStoragePool",
      "tag": "Direct-to-Cloud",
      "summary": "Get storage pool usage by pool name.",
      "command": "Get-DattoDtcStoragePool",
      "parameterSet": "Default",
      "result": "StoragePool[]",
      "resultProperty": "items"
    },
    {
      "method": "GET",
      "path": "/v1/dtc/{clientId}/assets",
      "operationId": "v1DTCAllAssetDetails",
      "tag": "Direct-to-Cloud",
      "summary": "Get all direct-to-cloud assets for a specified client.",
      "command": "Get-DattoDtcClientAsset",
      "parameterSet": "List",
      "result": "DTCAssetsData",
      "responseShape": "contract-defined object; envelope tolerated"
    },
    {
      "method": "GET",
      "path": "/v1/dtc/{clientId}/assets/{assetUuid}",
      "operationId": "v1DTCAssetDetails",
      "tag": "Direct-to-Cloud",
      "summary": "Get further details for a specific direct-to-cloud asset.",
      "command": "Get-DattoDtcClientAsset",
      "parameterSet": "ByAsset",
      "result": "DTCAssetDetails"
    },
    {
      "method": "GET",
      "path": "/v1/dtc/{clientId}/assets/{assetUuid}/screenshot/latest",
      "operationId": "v1DTCAssetScreenshotLatest",
      "tag": "Direct-to-Cloud",
      "summary": "Get the latest screenshot binary image data for a specific direct-to-cloud asset.",
      "command": "Save-DattoDtcAssetScreenshot",
      "parameterSet": "Default",
      "result": "image/jpeg",
      "binary": true
    },
    {
      "method": "GET",
      "path": "/v1/report/activity-log",
      "operationId": "v1GetActivityLog",
      "tag": "Reporting",
      "summary": "Gets a filtered list of activity logs ordered by date.",
      "command": "Get-DattoActivityLog",
      "parameterSet": "Default",
      "result": "ActivityLog[]",
      "resultProperty": "items"
    },
    {
      "method": "GET",
      "path": "/v1/saas/domains",
      "operationId": "v1GetSaaSDomainData",
      "tag": "SaaS Protection",
      "summary": "Get SaaS Protection data about what domains are being protected.",
      "command": "Get-DattoSaasDomain",
      "parameterSet": "Default",
      "result": "SaasDomain[]"
    },
    {
      "method": "GET",
      "path": "/v1/saas/{saasCustomerId}/applications",
      "operationId": "v1GetSaaSBackupData",
      "tag": "SaaS Protection",
      "summary": "Get SaaS Protection backup data for the given customer.",
      "command": "Get-DattoSaasBackup",
      "parameterSet": "Default",
      "result": "SaasBackup[]"
    },
    {
      "method": "GET",
      "path": "/v1/saas/{saasCustomerId}/seats",
      "operationId": "v1GetSaaSSeatsData",
      "tag": "SaaS Protection",
      "summary": "Get SaaS Protection seats data for the given customer.",
      "command": "Get-DattoSaasSeat",
      "parameterSet": "Default",
      "result": "SaasSeat[]"
    },
    {
      "method": "PUT",
      "path": "/v1/saas/{saasCustomerId}/{externalSubscriptionId}/bulkSeatChange",
      "operationId": "v1BulkSeatAssignment",
      "tag": "SaaS Protection",
      "summary": "Bulk seats assignment.",
      "command": "Set-DattoSaasSeatAssignment",
      "parameterSet": "Default",
      "result": "BulkSeatAssignment"
    }
  ]
}