API Versioning

This chapter discusses the current version of the NetMRI API Core. The version number is stated on the title page and in the footers.

Specific versions of the API are available at <your NetMRI URI>/api/X, whereX is a version string for the API version.

To maintain version flexibility, a client should determine the latest version root using the /api/base_uri call, which is independent of the version and does not require authentication. This API call accepts a version string and returns the URI root that the client should use for that version of the API.

The NetMRI Perl API package automatically determines the available API version. If you upgrade NetMRI but do not upgrade the NetMRI API module, the client host will continue to access the older API. This prevents scripts using the API from breaking immediately, although Infoblox strongly recommends upgrades as soon as possible to the latest API version to assure continued forward compatibility.

After authenticating, the client may also call /api/server_info, which will also always be available at that un-versioned URI. This method returns a variety of version information, including the most recent version of the API supported by the server.