Project

skykick

0.0
The project is in a healthy, maintained state
A Ruby wrapper for the Skykick backup Portal REST APIs (readonly)
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

Runtime

>= 0.2.0
 Project Readme

Skykick Office365 backup API

Version Maintainability Test Coverage

This is a wrapper for the Skykick Office365 backup API. You can see the API endpoints here https://developers.skykick.com/apis

Currently only the GET requests to endpoints /Backup and /Alerts are implemented (readonly).

Installation

Add this line to your application's Gemfile:

gem 'skykick'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install skykick

Usage

Before you start making the requests to API provide the client id and client secret and email/password using the configuration wrapping.

require 'skykick'

Skykick.configure do |config|
  config.client_id = ENV["SKYKICK_CLIENT_ID"]
  config.client_secret = ENV["SKYKICK_CLIENT_SECRET"]
end
@client = Skykick.client()
@client.login

dc = @client.datacenters

dc.each do |t|
  puts "#{t.name}"
end

Resources

Authentication

# setup configuration
#
client.login
Resource API endpoint Description
.auth_token or .login https://apis.skykick.com/auth/token

Backup

Endpoint for backup related requests

subscriptions = client.subscriptions
Resource API endpoint
autodiscover https://apis.skykick.com/Backup/{id}/autodiscover
datacenters https://apis.skykick.com/Backup/datacenters
exchange_mailboxe https://apis.skykick.com/Backup/{id}/mailboxes/{mailboxId}
exchange_mailboxes https://apis.skykick.com/Backup/{id}/mailboxes
lastsnapshotstats https://apis.skykick.com/Backup/{backupServiceId}/lastsnapshotstats
retention_periods https://apis.skykick.com/Backup/{id}/retentionperiod
sharePoint_sites https://apis.skykick.com/Backup/{id}/sites
sku https://apis.skykick.com/Backup/{id}/sku
storage_settings https://apis.skykick.com/Backup/{id}/storagesettings
subscription_settings https://apis.skykick.com/Backup/{id}/subscriptionsettings
subscriptions https://apis.skykick.com/Backup/
partner_subscriptions(partner_id) https://apis.skykick.com/Backup/{partner_id}

Alerts

Returns Alerts for a provided Email Migration Order ID or Backup service ID.

subscriptions = client.subscriptions
alerts = client.alerts(subscriptions.first.id)
Resource API endpoint
.alerts /Alerts

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/jancotanis/skykick.

License

The gem is available as open source under the terms of the MIT License.