API v2.0
Copyright © 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-05-23
Abstract
This document is for software developers who develop applications by using the OpenStack Networking API v2.0.
Contents
- Preface
- 1. Overview
- 2. Concepts
- 3. General API Information
- 4. API Operations
- 5. API Extensions
List of Tables
- 2.1. Network Attributes
- 2.2. Subnet Attributes
- 2.3. Port Attributes
- 4.1. Update Network Request Body Attributes
- 4.2. List Ports Response Fields
- 5.1. Router Attributes
- 5.2. Floating IP Attributes
- 5.3. Create Security Group Rule Request Attributes
- 5.4. Router Attributes
- 5.5. VIP Attributes
- 5.6. Pool Attributes
- 5.7. Member Attributes
- 5.8. Health Monitor Attributes
List of Examples
- 3.1. JSON Request with Headers
- 3.2. JSON Response with Headers
- 3.3. Network Collection, First Page: JSON Request
- 3.4. Network Collection, First Page: JSON Response
- 3.5. Network Collection, First Page: XML Request
- 3.6. Network Collection, First Page: XML Response
- 3.7. Network Collection, Last Page: JSON Request
- 3.8. Network Collection, Last Page: JSON Response
- 3.9. Network Collection, Last Page: XML Request
- 3.10. Network Collection, Last Page: XML Response
- 4.1. List Networks: JSON Request
- 4.2. List Networks: JSON Response
- 4.3. Show Network: JSON Request
- 4.4. Show Network: JSON Response
- 4.5. Create Network: JSON Request
- 4.6. Create Network: JSON Response
- 4.7. Bulk Create Networks: JSON Request
- 4.8. Update Network: JSON Request
- 4.9. Update Network: JSON Response
- 4.10. Delete Network: JSON Request
- 4.11. Delete Network: JSON Response
- 4.12. List Subnets: JSON Request
- 4.13. List Subnets: JSON Response
- 4.14. Show Subnet: JSON Request
- 4.15. Show Subnet: JSON Response
- 4.16. Create Subnet: JSON Request
- 4.17. Create Subnet: JSON Response
- 4.18. Bulk Create Subnets: JSON Request
- 4.19. Update Subnet: JSON Request
- 4.20. Update Subnet: JSON Response
- 4.21. Delete Subnet: JSON Request
- 4.22. Delete Subnet: Response
- 4.23. List Ports: JSON Request
- 4.24. List Ports: JSON Response
- 4.25. Show Port: JSON Request
- 4.26. Show Port: JSON Response
- 4.27. Create Port: JSON Request
- 4.28. Create Port: JSON Response
- 4.29. Update Port: JSON Request
- 4.30. Update Port: JSON Response
- 4.31. Delete Port: JSON Request
- 4.32. Delete Port: JSON Response
- 5.1. List Networks with provider attributes: JSON Response
- 5.2. List Networks with provider attributes: XML Response
- 5.3. Show network with provider attributes: JSON Response
- 5.4. Show network with provider attributes: XML Response
- 5.5. Create Network with provider attributes: JSON Request
- 5.6. Create Network with provider attributes: XML Request
- 5.7. Update provider attributes for a network: JSON Request
- 5.8. Update provider attributes for a network: XML Request
- 5.9. List Routers: JSON Request
- 5.10. List Routers: JSON Response
- 5.11. Show Router: JSON Request
- 5.12. Show Router: JSON Response
- 5.13. Create Router: JSON Request
- 5.14. Create Router: JSON Response
- 5.15. Update Router: JSON Request
- 5.16. Update Router: JSON Response
- 5.17. Delete Router: JSON Request
- 5.18. Add Router Interface: JSON Request
- 5.19. Add Router Interface: JSON Response
- 5.20. Remove Router Interface: JSON Request
- 5.21. Remove Router Interface: Response
- 5.22. List Floating IPs: JSON Request
- 5.23. List Floating IPs: JSON Response
- 5.24. Show Floating IP: JSON Request
- 5.25. Show Floating IP: JSON Response
- 5.26. Create Floating IP: JSON Request
- 5.27. Create Floating IP: JSON Response
- 5.28. Update Floating IP (associate): JSON Request
- 5.29. Update Floating IP (associate): JSON Response
- 5.30. Update Floating IP (disassociate): JSON Request
- 5.31. Update Floating IP (disassociate): JSON Response
- 5.32. Delete Floating IP: JSON Request
- 5.33. List Quotas: JSON Request
- 5.34. List Quotas: JSON Response
- 5.35. Show Quotas: JSON Request
- 5.36. Show Quotas: JSON Response
- 5.37. Update Quotas: JSON Request
- 5.38. Update Quotas: JSON Response
- 5.39. Reset Quotas: JSON Request
- 5.40. List Security Groups Request: JSON
- 5.41. List Security Groups Response: JSON
- 5.42. Create Security Group Request: JSON
- 5.43. Create Security Group Response: JSON
- 5.44. Show Security Group Request: JSON
- 5.45. Show Security Group Response: JSON
- 5.46. Delete Security Group Request: JSON
- 5.47. Delete Security Group Response: JSON
- 5.48. List Security Group Rules Request: JSON
- 5.49. List Security Group Rules Response: JSON
- 5.50. Create Security Group Rule Request: JSON
- 5.51. Create Security Group Rule Response: JSON
- 5.52. Show Security Group Rule Request: JSON
- 5.53. Show Security Group Rule Response: JSON
- 5.54. Delete Security Group Rule Request: JSON
- 5.55. Delete Security Group Rule Response: JSON
- 5.56. List Agents: JSON Request
- 5.57. List Agents: JSON Response
- 5.58. Show Agent: JSON Request
- 5.59. Show Agent: JSON Response
- 5.60. Update Agent: JSON Request
- 5.61. Update Agents: JSON Response
- 5.62. Delete Agent: JSON Request
- 5.63. Delete Agent: JSON Response
- 5.64. Update the routes attribute for a given router
- 5.65. Update routes: Response
- 5.66. List VIPs: Request
- 5.67. List VIPs: Response
- 5.68. Show VIP: Request
- 5.69. Show VIP: Response
- 5.70. Create VIP: Request
- 5.71. Create VIP: Response
- 5.72. Update VIP: Request
- 5.73. Update VIP: Response
- 5.74. Delete VIP: Request
- 5.75. Delete VIP: Response
- 5.76. List Pools: Request
- 5.77. List Pools: Response
- 5.78. Show Pool: Request
- 5.79. Show Pool: Response
- 5.80. Create Pool: Request
- 5.81. Create Pool: Response
- 5.82. Update Pool: Request
- 5.83. Update Pool: Response
- 5.84. Delete Pool: Request
- 5.85. Delete Pool: Response
- 5.86. List Members: Request
- 5.87. List Members: Response
- 5.88. Show Member: Request
- 5.89. Show Member: Response
- 5.90. Create Member: Request
- 5.91. Create Member: Response
- 5.92. Update Member: Request
- 5.93. Update Member: Response
- 5.94. Delete Member: Request
- 5.95. Delete Member: Response
- 5.96. List Health Monitors: Request
- 5.97. List Health Monitors: Response
- 5.98. Show Health Monitor: Request
- 5.99. Show Health Monitor: Response
- 5.100. Create Health Monitor: Request
- 5.101. Create Health Monitor: Response
- 5.102. Update Health Monitor: Request
- 5.103. Update Health Monitor: Response
- 5.104. Delete Health Monitor: Request
- 5.105. Delete Health Monitor: Response
- 5.106. Associate Health Monitor: Request
- 5.107. Associate Health Monitor: Response
- 5.108. Disassociate Health Monitor: Request
- 5.109. Disassociate Health Monitor: Response
- 5.110. List Networks on DHCP agent: JSON Request
- 5.111. List Networks on DHCP agent: JSON Response
- 5.112. List DHCP agents hosting network: JSON Request
- 5.113. List DHCP agents hosting network: JSON Response
- 5.114. Schedule Network: JSON Request
- 5.115. Schedule Network: JSON Response
- 5.116. Remove Network From DHCP agent: JSON Request
- 5.117. List Routers on L3 agent: JSON Request
- 5.118. List Routers on L3 agent: JSON Response
- 5.119. List L3 agents hosting router: JSON Request
- 5.120. List L3 agents hosting router: JSON Response
- 5.121. Schedule Router: JSON Request
- 5.122. Schedule Router: JSON Response
- 5.123. Remove Router From L3 agent: JSON Request

