Module: Skykick::Client::Backup

Included in:
Skykick::Client
Defined in:
lib/skykick/client/backup.rb

Overview

Contains all backup-related API calls for managing Skykick backup subscriptions and settings. This module provides methods to interact with backup services, including retrieving subscription settings, storage settings, and mailbox information.

See Also:

Instance Method Summary collapse

Instance Method Details

#autodiscover(id) ⇒ Hash

Retrieves the auto-discover state (enabled/disabled) for Exchange and SharePoint backups in a subscription.

Examples:

Check auto-discover state

client.autodiscover('sub123')  # => Returns the auto-discover state of the subscription

Parameters:

  • id (String) —

    The subscription ID.

Returns:

  • (Hash) —

    Auto-discover states for Exchange and SharePoint.



119
120
121
 
# File 'lib/skykick/client/backup.rb', line 119

def autodiscover(id)
  get("Backup/#{id}/autodiscover")
end

#datacenters ⇒ Array<Hash>

Retrieves a list of supported Azure data centers.

Examples:

Fetch available data centers

client.datacenters  # => Returns a list of supported data centers

Returns:

  • (Array<Hash>) —

    A list of Azure data centers supported by Skykick.



15
16
17
 
# File 'lib/skykick/client/backup.rb', line 15

def datacenters
  get('Backup/datacenters')
end

#exchange_mailbox(id, mailbox_id) ⇒ Hash

Retrieves details of a specific Exchange mailbox in a backup subscription.

Examples:

Get details of a specific mailbox

client.exchange_mailbox('sub123', 'mailbox123')  # => Returns mailbox details

Parameters:

  • id (String) —

    The subscription ID.

  • mailbox_id (String) —

    The unique identifier of the mailbox.

Returns:

  • (Hash) —

    Details of the specified Exchange mailbox.



110
111
112
 
# File 'lib/skykick/client/backup.rb', line 110

def exchange_mailbox(id, mailbox_id)
  get("Backup/#{id}/mailboxes/#{mailbox_id}")
end

#exchange_mailboxes(id) ⇒ Array<Hash>

Retrieves a list of Exchange mailboxes and their statuses (enabled/disabled) for a backup subscription.

Examples:

Get Exchange mailboxes

client.exchange_mailboxes('sub123')  # => Returns a list of Exchange mailboxes and statuses

Parameters:

  • id (String) —

    The subscription ID.

Returns:

  • (Array<Hash>) —

    A list of Exchange mailboxes and their statuses.



100
101
102
 
# File 'lib/skykick/client/backup.rb', line 100

def exchange_mailboxes(id)
  get("Backup/#{id}/mailboxes")
end

#lastsnapshotstats(id) ⇒ Hash

Retrieves snapshot statistics from SKDataWarehouse for all mailboxes in a given backup subscription.

Examples:

Fetch last snapshot stats

client.lastsnapshotstats('sub123')  # => Returns snapshot stats for the subscription's mailboxes

Parameters:

  • id (String) —

    The subscription ID.

Returns:

  • (Hash) —

    Snapshot statistics for the mailboxes.



91
92
93
 
# File 'lib/skykick/client/backup.rb', line 91

def lastsnapshotstats(id)
  get("Backup/#{id}/lastsnapshotstats")
end

#partner_subscriptions(partner_id) ⇒ Array<Hash>

Retrieves a list of backup subscription orders for a specific partner.

Examples:

Get partner backup subscriptions

client.partner_subscriptions('partner123')  # => Returns subscriptions for the partner

Parameters:

  • partner_id (String) —

    The unique identifier of the partner.

Returns:

  • (Array<Hash>) —

    A list of partner-specific backup subscriptions.



32
33
34
 
# File 'lib/skykick/client/backup.rb', line 32

def partner_subscriptions(partner_id)
  get("Backup/#{partner_id}")
end

#retentionperiod(id) ⇒ Hash

Note:

There is a known spelling issue in the response field: ‘ExchangeRentionPeriodInDays`. This is intentional to avoid breaking existing integrations.

Retrieves the data retention periods for a backup subscription. Different retention periods apply for Exchange and SharePoint data.

Examples:

Get retention periods

client.retentionperiod('sub123')  # => Returns retention periods for Exchange and SharePoint data

Parameters:

  • id (String) —

    The subscription ID.

Returns:

  • (Hash) —

    Retention period details.



82
83
84
 
# File 'lib/skykick/client/backup.rb', line 82

def retentionperiod(id)
  get("Backup/#{id}/retentionperiod")
end

#sharepoint_sites(id) ⇒ Array<Hash>

Retrieves a list of SharePoint site URLs and their statuses (enabled/disabled) for a backup subscription.

Examples:

Get SharePoint sites

client.sharepoint_sites('sub123')  # => Returns a list of SharePoint sites and their statuses

Parameters:

  • id (String) —

    The subscription ID.

Returns:

  • (Array<Hash>) —

    A list of SharePoint site URLs and statuses.



69
70
71
 
# File 'lib/skykick/client/backup.rb', line 69

def sharepoint_sites(id)
  get("Backup/#{id}/sites")
end

#sku(id) ⇒ Hash

Retrieves SKU or promotional details for a backup service.

Examples:

Fetch SKU details

client.sku('sub123')  # => Returns SKU or promo details

Parameters:

  • id (String) —

    The subscription ID.

Returns:

  • (Hash) —

    SKU or promotional details.



60
61
62
 
# File 'lib/skykick/client/backup.rb', line 60

def sku(id)
  get("Backup/#{id}/sku")
end

#storage_settings(id) ⇒ Hash

Retrieves storage settings for a backup subscription.

Examples:

Get storage settings

client.storage_settings('sub123')  # => Returns storage settings

Parameters:

  • id (String) —

    The subscription ID.

Returns:

  • (Hash) —

    Storage settings for the specified subscription.



51
52
53
 
# File 'lib/skykick/client/backup.rb', line 51

def storage_settings(id)
  get("Backup/#{id}/storagesettings")
end

#subscription_settings(id) ⇒ Hash

Retrieves backup subscription settings, including the state of Exchange and SharePoint Backups, the number of enabled mailboxes and SharePoint sites, and the subscription state.

Examples:

Fetch subscription settings

client.subscription_settings('sub123')  # => Returns backup subscription settings

Parameters:

  • id (String) —

    The subscription ID.

Returns:

  • (Hash) —

    Backup subscription settings.



42
43
44
 
# File 'lib/skykick/client/backup.rb', line 42

def subscription_settings(id)
  get("Backup/#{id}/subscriptionsettings")
end

#subscriptions ⇒ Array<Hash>

Retrieves a list of placed Backup subscription orders.

Examples:

Get all backup subscriptions

client.subscriptions  # => Returns a list of placed backup subscription orders

Returns:

  • (Array<Hash>) —

    A list of backup subscriptions.



23
24
25
 
# File 'lib/skykick/client/backup.rb', line 23

def subscriptions
  get('Backup')
end