The Prime Infrastructure API attempts to conform to the design principles of Representational State Transfer ( REST). Simply change the format extension of a request to get results in the format of your choice. The documentation notes which formats are available for each method. The API supports XML and JSON data formats.
Prime Infrastructure API usage is rate limited to protect Prime Infrastructure itself, and ensure fair access for all clients of the Prime Infrastructure API.
Filtering, sorting, and paging are available for most of the REST resources. This allows control of the amount of data being returned by a request. The documentation notes which formats are available for each method.
In general, methods to retrieve data from Prime Infrastructure API require a GET request. Methods that submit, change, or destroy data require a POST, PUT, or DELETE. Prime Infrastructure API methods will return an error if you do not make your request with the correct request type. Check the detailed documentation to see the correct request type. HTTP Response Codes are meaningful.
All requests to Prime Infrastructure API must be authenticated.
The virtual domains to which a user has access is managed in the same way for normal UI access. This means that API requests will scoped by the "default" domain that is specified in the Prime Infrastructure application. It is possible to switch to an alternative domain in a session, provided always that the user has permissions to view that new domain.
The url for the API contains a segment for the major version (currently v1). In future releases, any changes that result in a change of behavior will result in the release of a new major version of the API. The previous behavior will be maintained for some time to permit a smooth migration path. Such changes will be advertised though product release documentation and the What's New page.