The RackConnect API provides a way for you to access certain read-only information about your Cloud Servers and their RackConnect configuration. The RackConnect API is available to all customers who can manage their RackConnect configurations through MyRackspace Portal interface.
You can use the RackConnect API to access the following information:
Note:In addition to using the RackConnect API, you can now use the Cloud Servers API to query the RackConnect automation status of your next-generation Cloud Servers. The benefit of using the Cloud Servers API is that you do not need to perform the query from the same Cloud Server you want the status of. The limitations of this method are that only the RackConnect automation status is available, and this method is compatible only with next-generation Cloud Servers. If you are interested in this method, see the following article: How to programmatically determine the RackConnect Automation Status of your Cloud Servers.
The RackConnect API is exposed via regional endpoints. Use the endpoint that matches the region where your Cloud Server resides.
Note: The URLs for each API operation include a version number. When future versions of the calls available, this article will be updated. It is important to note that this version number does not relate to the version of RackConnect that you are using.
The RackConnect API authenticates all requests based on the source IP address that is initiating the request. The API endpoints are exposed only on the Private (ServiceNet) network, so the Private (ServiceNet) network IP address of your Cloud Server is used to determine the source of the request and to respond with the appropriate information. API responses are limited to information only about the specific Cloud Server from which you are querying. It is important to note that hypervisor-level protections are in place that prevent these IP addresses from being spoofed, ensuring that the instance making the request to the API endpoint is, in fact, your Cloud Server.
Note: You cannot query the RackConnect API from outside of your Cloud Server.
There is a limit of 30 requests per minute from each of your Cloud Servers. If you exceed the number of allowed requests per minute, you will receive an HTTP 403 (Forbidden) response code. The counter resets each minute.
The following operations are supported by the API. The format query string parameter is optional on each request. If it is not supplied, the default response format is used.
The following example uses curl to retrieve the automation status. Alternatively, you can use a web browser to query the RackConnect API.
$ curl https://dfw.api.rackconnect.rackspace.com/v1/automation_status?format=text
Previous Article: RackConnect Compatibility with Next-Gen Cloud Server Images
© 2011-2013 Rackspace US, Inc.
Except where otherwise noted, content on this site is licensed under a Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License