Swagger API

About this task

This guide shows how to access and use InformixHQ REST APIs via Swagger UI to integrate InformixHQ server APIs in your custom application. It covers authentication, trying endpoints, and common workflows (config, users, servers, agent configuration, etc).

The InformixHQ REST APIs are organized into the following groups:
  1. Server and Groups: Manage Informix Servers and groups created in InformixHQ.
  2. Configuration: View and update InformixHQ configurations.
  3. Auths and Users: Handle InformixHQ login and user management.
  4. System Reports: Run system reports against an Informix server and manage custom report definitions.
  5. Monitoring: Manage monitoring profiles, sensors, and sensor data.
  6. Alerting: Manage server alert criteria profiles and altering incidents.
  7. Permissions: View and manage InformixHQ user permissions on registered Informix servers.
  8. Onconfig: Read and update Informix server config parameters.
  9. Schema Manager: Manage databases, open SQL sessions, execute queries, and view query history.

Procedure

Use the following steps:
  1. Accessing Swagger UI:
    Open Swagger UI in your environment (host/port may vary): <https://<host>:<port>/swagger-ui/index.html
    In Swagger UI, you can browse all endpoints, read examples, and use Try it out to run live calls.
    Note: Try it out will add the records to the h2db database of InformixHQ. It is recommended to take a backup of h2db database before trying it out or use it on your staging/testing environment.
  2. Authentication:
    The API uses HTTP Basic authentication. Provide your InformixHQ username and password. For the first time users, change the InformixHQ password from logging into InformixHQ, and then use the Swagger UI.