API v2
Copyright © 2009, 2010, 2011, 2012, 2013 OpenStack Foundation
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
2013-04-30
Abstract
This document is intended for software developers interested in developing applications using the OpenStack Compute Application Programming Interface (API).
List of Tables
- 1.1. Sample Rate Limits
- 1.2. Sample Absolute Limits
- 1.3. Fault Elements and Error Codes
- 2.1. Create Server Request Attributes
- 2.2. Update Server Request Body Attributes
- 2.3. List Addresses by Network URI Parameters
- 2.4. Change Administrator Password Request Body Attributes
- 2.5. Reboot Server Request Attributes
- 2.6. Rebuild Server Request Attributes
- 2.7. Resize Server Request Attributes
- 2.8. Create Image Request Attributes
- 2.9. Set Metadata Request Attributes
- 2.10. Update Metadata Request Attributes
- 2.11. Set Metadata Item Request Attributes
- 3.1. Back up Server Instance Request Parameters
- 3.2. Live-Migrate Server Request Parameters
- 3.3. Reset Server State Request Parameters
List of Examples
- 1.1. Request with Headers: JSON
- 1.2. Response with Headers: XML
- 1.3. JSON Request with XML Query Extension for the Response
- 1.4. ID Image Reference: JSON
- 1.5. ID Image Reference: XML
- 1.6. Full Image Reference: JSON
- 1.7. Full Image Reference: XML
- 1.8. Server with Self Links: JSON
- 1.9. Server with Self Links: XML
- 1.10. Server with Alternate Link: JSON
- 1.11. Image with Alternate Link: XML
- 1.12. Images Collection, First Page: XML
- 1.13. Images Collection, First Page: JSON
- 1.14. Images Collection, Second Page: XML
- 1.15. Images Collection, Second Page: JSON
- 1.16. Images Collection, Last Page: XML
- 1.17. Images Collection, Last Page: JSON
- 1.18. Paginated Metadata in an Image: XML
- 1.19. Paginated Metadata in an Image: JSON
- 1.20. Limit Response: XML
- 1.21. Limit Response: JSON
- 1.22. Request with MIME type versioning
- 1.23. Request with URI versioning
- 1.24. Multiple Choices Response: XML
- 1.25. Multiple Choices Response: JSON
- 1.26. Versions List Request
- 1.27. Versions List Response: XML
- 1.28. Versions List Response: Atom
- 1.29. Versions List Response: JSON
- 1.30. Version Details Request
- 1.31. Version Details Response: XML
- 1.32. Version Details Response: Atom
- 1.33. Version Details Response: JSON
- 1.34. Extensions Response: XML
- 1.35. Extensions Response: JSON
- 1.36. Extension Response: xml
- 1.37. Extension Response: JSON
- 1.38. Extended Server Response: XML
- 1.39. Extended Server Response: JSON
- 1.40. Extended Action: XML
- 1.41. Extended Action: JSON
- 1.42. Fault Response: XML
- 1.43. Fault Response: JSON
- 1.44. Fault Response, Item Not Found: XML
- 1.45. Fault Response, Item Not Found: JSON
- 1.46. Fault Response, Over Limit: XML
- 1.47. Fault Response, Over Limit: JSON
- 1.48. Server In Error State: XML
- 1.49. Server In Error State: JSON
- 1.50. Image In Error State: XML
- 1.51. Image In Error State: JSON
- 2.1. List Servers Response: XML (detail)
- 2.2. List Servers Response: JSON (detail)
- 2.3. Server Create Request: JSON
- 2.4. Server Create Response: JSON
- 2.5. Server Create Request: XML
- 2.6. Server Create Response: XML
- 2.7. Creating a Server with a Access IP: XML
- 2.8. Creating a Server with a Access IP: JSON
- 2.9. Creating a Server with Multiple Access IPs: XML
- 2.10. Creating a Server with Multiple Access IPs: JSON
- 2.11. Server Details Response: XML
- 2.12. Server Details Response: JSON
- 2.13. Server Update Name Request: XML
- 2.14. Server Update Name Request: JSON
- 2.15. Server Update Name Response: XML
- 2.16. Server Update Name Response: JSON
- 2.17. Server Update Access Address Request: XML
- 2.18. Server Update Access Address Request: JSON
- 2.19. Server Update Access Address Response: XML
- 2.20. Server Update Access Address Response: JSON
- 2.21. Addresses List Response: XML
- 2.22. Addresses List Response: JSON
- 2.23. List Addresses by Network Response: XML
- 2.24. List Addresses by Network Response: JSON
- 2.25. Action Change Password Request: XML
- 2.26. Action Change Password Request: JSON
- 2.27. Action Reboot Request: XML
- 2.28. Action Reboot Request: JSON
- 2.29. Action Rebuild Request: XML
- 2.30. Action Rebuild Request: JSON
- 2.31. Action Rebuild Response: XML
- 2.32. Action Rebuild Response: JSON
- 2.33. Action Resize Request: XML
- 2.34. Action Resize Request: JSON
- 2.35. Action Confirm Resize Request: XML
- 2.36. Action Confirm Resize Request: JSON
- 2.37. Action Revert Resize Request: XML
- 2.38. Action Revert Resize Request: JSON
- 2.39. Action Create Image Request: XML
- 2.40. Action Create Image Request: JSON
- 2.41. Flavors List Response: XML (detail)
- 2.42. Flavors List Response: JSON (detail)
- 2.43. Flavor Details Response: XML
- 2.44. Flavor Details Response: JSON
- 2.45. Images List Response: XML (detail)
- 2.46. Images List Response: JSON (detail)
- 2.47. Image Details Response: XML
- 2.48. Image Details Response: JSON
- 2.49. Metadata List Response: XML
- 2.50. Metadata List Response: JSON
- 2.51. Set Metadata Request: XML
- 2.52. Set Metadata Request: JSON
- 2.53. Set Metadata Response: XML
- 2.54. Set Metadata Response: JSON
- 2.55. Update Metadata Request: XML
- 2.56. Update Metadata Request: JSON
- 2.57. Update Metadata Response: XML
- 2.58. Update Metadata Response: JSON
- 2.59. Metadata Item Response: XML
- 2.60. Metadata Item Response: JSON
- 2.61. Set Metadata Item Request: XML
- 2.62. Set Metadata Item Request: JSON
- 2.63. Set Metadata Item Response: XML
- 2.64. Set Metadata Item Response: JSON
- 3.1. Pause Server Request: XML
- 3.2. Pause Server Request: XML
- 3.3. Unpause Server Request: XML
- 3.4. Unpause Server Request: XML
- 3.5. Suspend Server Request: XML
- 3.6. Suspend Server Request: XML
- 3.7. Resume Server Request: XML
- 3.8. Resume Server Request: XML
- 3.9. Migrate Server Request: XML
- 3.10. Reset Networking on Server Request: XML
- 3.11. Reset Networking on Server Request: XML
- 3.12. Inject Network Information Request: XML
- 3.13. Inject Network Information Request: XML
- 3.14. Lock Server Request: XML
- 3.15. Lock Server Request: XML
- 3.16. Unlock Server Request: XML
- 3.17. Unlock Server Request: XML
- 3.18. Back up Server Instance Request: XML
- 3.19. Back up Server Instance Request: XML
- 3.20. Live-Migrate Server Request: XML
- 3.21. Live-Migrate Server Request: XML
- 3.22. Reset Server State Request: XML
- 3.23. Reset Server State Request: XML

