docs.rackspace.com/api

Transcription

1 docs.rackspace.com/api

2 Rackspace Cloud Backup Release ( ) 2015 Rackspace US, Inc. This document is intended for software developers who are interested in developing applications using the Rackspace Cloud Backup Application Programming Interface (API). The document is for informational purposes only and is provided AS IS. RACKSPACE MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, AS TO THE ACCURACY OR COM- PLETENESS OF THE CONTENTS OF THIS DOCUMENT AND RESERVES THE RIGHT TO MAKE CHANGES TO SPECIFICATIONS AND PROD- UCT/SERVICES DESCRIPTION AT ANY TIME WITHOUT NOTICE. RACKSPACE SERVICES OFFERINGS ARE SUBJECT TO CHANGE WITH- OUT NOTICE. USERS MUST TAKE FULL RESPONSIBILITY FOR APPLICATION OF ANY SERVICES MENTIONED HEREIN. EXCEPT AS SET FORTH IN RACKSPACE GENERAL TERMS AND CONDITIONS AND/OR CLOUD TERMS OF SERVICE, RACKSPACE ASSUMES NO LIABILITY WHATSOEVER, AND DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY, RELATING TO ITS SERVICES INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT. Except as expressly provided in any written license agreement from Rackspace, the furnishing of this document does not give you any license to patents, trademarks, copyrights, or other intellectual property. Rackspace, Rackspace logo and Fanatical Support are registered service marks of Rackspace US, Inc. All other product names and trademarks used in this document are for identification purposes only and are property of their respective owners. ii

3 Table of Contents Preface... iv Document change history... 1 September 09, March 04, January 14, September 02, August 12, July 22, April 14, February 14, February 5, January 28, January 10, December 31, November 4, October 21, October 16, September 09, July 31, June 24, March 05, iii

4 Preface This document describes new features and changes for the Cloud Backup API. For detailed information about the Cloud Backup API, see the following documentation at at Cloud Backup Getting Started Guide Cloud Backup Developer Guide Support for Cloud Backup is available 24x7x365 via phone or chat, or you can also file a ticket. You can also provide feedback by using the Product Feedback forum. Rackspace welcomes your comments, feedback, and bug reports. iv

5 Document change history This version of the release notes replaces and obsoletes all earlier versions. The most recent changes are described in the following table: Revision Date March 4, 2015 September 2, 2014 Summary of Changes Added the request parameter, machineagentid, and an example request to the Delete agent operation description in the Cloud Backup Developer Guide. Removed the London endpoint, since Rackspace now has one global endpoint for authentication using the Rackspace Cloud Identity service. The following additions were made to enhance Cloud Backup to enable cross-datacenter restores: Added the BackupDataCenter parameter to the following operations in Restore configuration operations in Rackspace Cloud Backup Developer Guide: As a request and response parameter to the operation to create a restore configuration As a request parameter to the operation to update a restore configuration Added the BackupDataCenter parameter to the following operation in Restore operations in Rackspace Cloud Backup Developer Guide : As a response parameter to the operation to list details about a restore Added the BackupId parameter to the following operations in Activity operations in Rackspace Cloud Backup Developer Guide: As a response parameter to the operation to list the activity for an agent August 12, 2014 July 22, 2014 April 14, 2014 February 14, 2014 February 5, 2014 January 28, 2014 January 10, 2014 December 31, 2013 As a response parameter to the operation to list the activity for a user Published the new Cloud Backup Getting Started Guide for the API. The example requests in this guide use curl. In the "Service access endpoints" section in the Cloud Backup Developer Guide and in the Cloud Backup Getting Started Guide, added a link to About Regions to provide guidance on choosing a regionalized endpoint. Reworked the API operations chapter in the Cloud Backup Developer Guide to use a Web Application Description Language (WADL) file for the operation descriptions. Added the change encryption password operation. Added Role Based Access Control (RBAC). Updated the description of the list all agents for this user operation to include instructions to use the list agent details operation to retrieve the correct values for TimeOfLastSuccessfulBackup, as well as Status. Added the BackupContainer response parameter to the list agent details operation. Added a note to the description of the list agent details operation to describe how to handle an agent with a Status of Offline that is not posting any heartbeats. Added a note to the description of the list agent details operation to indicate that Status is always Offline for this operation. Changed the normal response code from 200 to 204 for the delete restore configuration operation. Added the BackupMachineId parameter description to the create restore configuration operation. November 4, 2013 Updated the instructions for locating the API key, tenant ID, and account number in the Cloud Control Panel in the Authentication section. Added the wake up agents operation. 1

6 Revision Date October 21, 2013 October 16, 2013 Summary of Changes Changed the service access endpoint in the examples in the API operations chapter from the generic endpoint, to one of the supported endpoints, Added the HKG service endpoint. Added the HostServerId response parameter to the list agent details operation. Added the list agent details by host server ID operation. September 11, 2013 July 31, 2013 Added MachineAgentId to the request parameters for the create backup configuration operation. Added the migrate vault operation to the agent operations. Added the update agent backup behavior operation to the agent operations. Updated regionalized service endpoints and added IAD. June 24, 2013 The following changes where made in the Cloud Backup Developer Guide: Added descriptions of request and response parameters for all operations in the API operations chapter. Updated information about the use of authentication endpoints. You can now use either the US endpoint or UK endpoint to access the Identity service, regardless of US or UK identities. Removed the Date/Time section. The Cloud Backup API now supports only Microsoft Date Format and not ISO. Added Sydney (SYD) data center to data center specifications. Removed the Help operations section that was at the end of the book as these are classified as internal calls. Changed all occurrences of to March 5, 2013 Initial release of Cloud Backup Developer Guide. 2

7 September 09, 2015 Added the request parameter, machineagentid, and an example request to the Delete agent operation description in the Cloud Backup Developer Guide. 3

8 March 04, 2015 Removed the London endpoint, since Rackspace now has one global endpoint for authentication using the Rackspace Cloud Identity service. See the following documents: Generate an authentication token in Rackspace Cloud Backup Getting Started Guide Authentication in Rackspace Cloud Backup Developer Guide 4

9 January 14, 2015 Added information and links about multi-factor authentication in the following documents: Generate an authentication token in Rackspace Cloud Backup Getting Started Guide Authentication in Rackspace Cloud Backup Developer Guide 5

10 September 02, 2014 Product enhancement Cloud Backup was enhanced to enable cross-datacenter restores. The following additions were made to enhance Cloud Backup to enable cross-datacenter restores: Added the BackupDataCenter parameter to the following operations in Restore configuration operations in Rackspace Cloud Backup Developer Guide: As a request and response parameter to the operation to create a restore configuration As a request parameter to the operation to update a restore configuration Added the BackupDataCenter parameter to the following operation in Restore operations in Rackspace Cloud Backup Developer Guide : As a response parameter to the operation to list details about a restore Added the BackupId parameter to the following operations in Activity operations in Rackspace Cloud Backup Developer Guide: As a response parameter to the operation to list the activity for an agent As a response parameter to the operation to list the activity for a user 6

11 August 12, 2014 Published the Cloud Backup Getting Started Guide, which includes examples using curl. 7

12 July 22, 2014 In Service access endpoints in Rackspace Cloud Backup Developer Guide in the Cloud Backup Developer Guide and in the Cloud Backup Getting Started Guide, a link to the Knowledge Center article About Regions was added to provide guidance on choosing a regionalized endpoint. 8

13 April 14, 2014 The API operations chapter in the Cloud Backup Developer Guide was reworked to use a Web Application Description Language (WADL) file for the operation descriptions. 9

14 February 14, 2014 This release of the Cloud Backup API adds the change encryption password operation. This operation changes the encryption password. (If you need assistance generating your encrypted key, see "Generating Your Encrypted Key In Cloud Backup" in the Knowledge Center.) For more information, see the Change encryption password section in the API operations chapter in the Cloud Backup Developer Guide. 10

15 February 5, 2014 This release of the Cloud Backup API includes Role Based Access Control (RBAC). Role Based Access Control (RBAC) restricts access to the capabilities of Rackspace Cloud services, including the Cloud Backup API, to authorized users only. RBAC enables Rackspace Cloud customers to specify which account users of their Cloud account have access to which Cloud Backup API service capabilities, based on roles defined by Rackspace. The permissions to perform certain operations in Cloud Backup API create, read, update, delete are assigned to specific roles, and these roles can be assigned by the Cloud account admin user to account users of the account. For more information, see the section on RBAC in the Cloud Backup Developer Guide. 11

16 January 28, 2014 The description of the list all agents for this user operation was updated to include instructions to use the list agent details operation to retrieve the correct values for Time- OfLastSuccessfulBackup, as well as Status. 12

17 January 10, 2014 The description for the list agent details operation was updated to include the Backup- Container response parameter. 13

18 December 31, 2013 The description for the list agent details operation was updated to describe how to handle an agent with a Status of Offline that is not posting any heartbeats. The description for the list agent details operation was updated to include a note that Status is always Offline for this operation. The description for the delete restore configuration operation was updated to change the normal response code from 200 to 204. The description for the create restore configuration operation was updated to add the BackupMachineId parameter description. The instructions for locating the API key, tenant ID, and account number in the Cloud Control Panel in the Authentication section was updated. 14

19 November 4, 2013 API Updates The wake up agents operation was added. The description for the wake up agents operation was added. The service access endpoint in the examples in the API operations chapter was changed from the generic endpoint, to one of the supported endpoints, 15

20 October 21, 2013 This release includes the addition of the HKG service endpoint for the Cloud Backup API. 16

21 October 16, 2013 API Updates The list agent details by host server ID operation was added. The HostServerId response parameter description was added to the description of the list agent details operation. The description of the list agent details by host server ID operation was added. 17

22 September 09, 2013 The MachineAgentId request parameter description was added to the description of the create backup configuration operation. 18

23 July 31, 2013 API Updates The migrate vault operation was added to the agent operations. The update agent backup behavior operation was added to the agent operations. The regionalized service endpoints were updated to add IAD. The description of the migrate vault operation was added to the agent operations. The description of the update agent backup behavior operation was added to the agent operations. The regionalized service endpoints section were updated to add IAD. 19

24 June 24, 2013 API Updates You can now use either the US endpoint or UK endpoint to access the Identity service, regardless of US or UK identities. The Date/Time section was removed. The Cloud Backup API now supports only Microsoft Date Format and not ISO. The Sydney (SYD) data center was added to data center specifications. Descriptions of the request and response parameters were added for all operations in the API operations chapter. The information about the use of authentication endpoints was updated. You can now use either the US endpoint or UK endpoint to access the Identity service, regardless of US or UK identities. The Date/Time section was removed. The Cloud Backup API now supports only Microsoft Date Format and not ISO. The Sydney (SYD) data center was added to data center specifications. The Help operations section was removed as these are classified as internal calls. All occurrences of were changed to 20

25 March 05, 2013 This is the initial release of Cloud Backup Developer Guide. 21