As an adjunct to the GUI web interface for http://ihealth.f5.comiHealth, F5 also provides a programmatic interface available via the iHealth REST API. This API provides controls to manage QKViews including methods to manage an individuals QKView collection, as well as access to the data within any of the QKViews. iHealth users may manage their QKView collection by making HTTP calls to perform the following types of actions:
- Add a QKView
- Delete a QKView
- Toggle a QKView’s visibility in the iHealth GUI
- Retrieve a QKView uploaded previously
- Get the current API version
In addition to managing your QKView collection, this API also provides method calls to access the data associated with a QKView, including:
- iHealth diagnostic data
- subset of tmsh command output
- QKView metadata
- edit case numbers (F5 and non-F5)
Examples utilizing the iHealth API in the command reference consists of curl commands, but the methods in the API may be called from any programming language or framework that supports HTTPS calls and cookies.
The iHealth API is not supported by the F5 support organization, but is provided as a helpful addition for you to keep your BIG-IPs running as well as possible.
Currently, QKViews submitted via the API will be retained and available for 5 days, after which it will be deleted.
Here’s a list of some reference information that you can use to help you with all of your iHealth API needs. Note that these are available from most Wiki pages in the navigation pane to the left of the screen.
- Authentication - Details on obtaining credentials for API calls
- General Usage - General API Usage for the iHealth API
- QKView Collection Methods - method details on listing, adding, and deleting qkviews
- QKView Command Output - currently only a subset of available BIG-IP commands
- QKView Diagnostics - provide troubleshooting assistance
- QKView Files - obtain a list of files
- QKView Metadata - metadata associated with an uploaded QKView
- QKView Other Data - retrieves other data like system info and stats