1.2.15 IRP API

IRP exposes a web API that uses HTTP verbs and a RESTful endpoint structure. Request and response payloads are formatted as JSON.

The API is running on the IRP instance and is reachable by default over SSL at port 10443. If called directly from the IRP instance server the API can be accessed at https://localhost:10443. Use https://hostname:10443/ in order to access the API from elsewhere on the network.

An IRP user id is required to access most of the API services. Use GMI to manage user API access tokens. IRP API uses an authenticating mechanism based on authentication tokens. The token is passed as a query parameter for all API requests that require authentication.

The API Reference is available from GMI menu.

IRP’s API is powered by Irpapid service that can be started, stopped, configured like any other IRP service. Refer to the API daemon settings section for Irpapid configuration parameter details.