This chapter explains the distinction among the Illumio Public Stable, Public Experimental, and private APIs.
Public Stable APIs
The Public Stable APIs are generally available to all Illumio customers, are documented, and are stable. “Stable” means that Illumio will not introduce any further breaking changes to the API. If a breaking change is required, another version of the API will be introduced, and the previous version will continue to be supported for a minimum of six (6) months.
Public Experimental APIs
The Public Experimental APIs are generally available to all Illumio customers, are documented, but are subject to change from release to release. If you use experimental APIs, such as in scripts, be aware that some of them might change. Some of these APIs might be promoted to Public Stable at a future date, or could be made no longer available.
To help distinguish which APIs are "Public Experimental," this API guide uses orange color for headings inside these files.
Private APIs
In addition to the Public Stable or Public Experimental APIs, the Illumio Core includes additional Private APIs used by the PCE web console. The private Illumio APIs are not exposed to end-users, are not documented, or supported for use.
Illumio REST API Versions
Illumio REST APIs follow the release versions of other Illumio components, such as the PCE and VEN.
Illumio REST API Schema Files
Illumio REST API schema files follow the standard JSON schema form described at http://json-schema.org/. The file name convention is the Illumio REST API URL name with underscore rather than slashes + _ + operation + .schema.json. For example, for the login API, the payload schema file is named: user_login_get.schema.json.