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).

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.