Clouddocs F5 F5 iHealth API

Name: F5 iHealth API
Brand: F5 iHealth API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentDeveloper ToolsMonitoring Observabilitybearer12 EndpointsREST

For Agents

Upload QKView files from F5 BIG-IP devices and retrieve diagnostics, file contents, and command results from the iHealth service.

Install Jentic One Beta

Connect the F5 iHealth API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the F5 iHealth API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with F5 iHealth API.

Upload QKView capture files for analysis at /qkviews

Retrieve diagnostic findings for a QKView at /qkviews/{qkviewId}/diagnostics

Browse and download files contained in a QKView archive

Run iHealth commands against an uploaded QKView and read their output

GET STARTED

Start building with F5 iHealth API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use F5 iHealth API for, with concrete tasks.

★ Automated BIG-IP Health Triage

Automate the upload-and-analyse loop that F5 administrators run after capturing a QKView during an incident. POST a QKView to /qkviews, poll /qkviews/{qkviewId}/diagnostics, and pipe the findings into a ticketing or SRE workflow. Removes the manual upload-via-portal step from the runbook.

POST a QKView file to /qkviews, then poll GET /qkviews/{qkviewId}/diagnostics until findings are available and forward to the on-call channel.

Configuration Audit Across Devices

Capture QKViews from a fleet of BIG-IP devices, upload them, and pull /qkviews/{qkviewId}/bigip/{category} for each to compare LTM, ASM, or APM configuration across the estate. Useful for compliance audits and drift detection without logging into each device.

For each QKView ID, GET /qkviews/{qkviewId}/bigip/ltm and diff the returned configuration against the golden baseline.

Targeted File Inspection

Pull individual files out of a QKView for deeper investigation without downloading the whole archive. /qkviews/{qkviewId}/files lists the contents and /qkviews/{qkviewId}/files/{fileId} returns a specific file. Saves bandwidth when only one log or config is relevant.

GET /qkviews/{qkviewId}/files, locate the desired log, then GET /qkviews/{qkviewId}/files/{fileId} to download just that file.

AI Agent BIG-IP Diagnostics

Let a Jentic-powered SRE agent triage a BIG-IP incident. The agent searches Jentic for 'analyse F5 QKView', loads the iHealth uploadQkview operation, executes it, and reads back diagnostics for the on-call engineer. Bearer tokens stay in the Jentic vault.

Search Jentic for 'upload F5 QKView and get diagnostics', load the uploadQkview operation, and execute it with the captured QKView file.

Key Endpoints

12 endpoints — jentic publishes the only available openapi specification for f5 ihealth api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/qkviews

Upload a QKView file

GET

/qkviews/{qkviewId}

Get QKView metadata and status

GET

/qkviews/{qkviewId}/diagnostics

Get diagnostic findings

GET

/qkviews/{qkviewId}/files

List files inside a QKView

GET

/qkviews/{qkviewId}/files/{fileId}

Download a specific file

GET

/qkviews/{qkviewId}/commands

List iHealth commands run against a QKView

GET

/qkviews/{qkviewId}/bigip/{category}

Get BIG-IP configuration by category

POST

/qkviews

Upload a QKView file

GET

/qkviews/{qkviewId}

Get QKView metadata and status

GET

/qkviews/{qkviewId}/diagnostics

Get diagnostic findings

GET

/qkviews/{qkviewId}/files

List files inside a QKView

GET

/qkviews/{qkviewId}/files/{fileId}

Download a specific file

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

F5 iHealth bearer tokens are stored encrypted in the Jentic vault. Agents receive scoped access tokens — the raw F5 token never enters the agent's context, which matters because iHealth tokens grant access to potentially sensitive BIG-IP captures.

Intent-based discovery

Agents search Jentic by intent (for example 'upload a QKView' or 'get F5 diagnostics') and Jentic returns the matching iHealth operation with its input schema so the agent calls the right /qkviews endpoint.

Time to first call

Direct iHealth integration: 2-3 days to handle multipart upload, polling, and bearer token refresh. Through Jentic: under 1 hour — search, load schema, execute.

FAQs

Specific to using F5 iHealth API through Jentic.

Why is there no official OpenAPI spec for F5 iHealth API?

F5 does not publish a structured OpenAPI specification for iHealth. Jentic generates and maintains this spec so that AI agents and developers can call F5 iHealth API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the F5 iHealth API use?

The API uses bearer token authentication. Obtain a token from the F5 identity service and pass it as Authorization: Bearer <token>. Through Jentic, the token is stored encrypted in the vault and injected only at execution time.

Can I upload a QKView file via the API?

Yes. POST the QKView archive to /qkviews. The response contains the qkviewId, which you use to retrieve diagnostics, files, and BIG-IP configuration data once the analysis completes.

How do I run iHealth diagnostics through Jentic?

Run jentic search 'upload F5 QKView and get diagnostics', load the uploadQkview operation, and execute it with the QKView file. Then load and execute getDiagnostics with the returned qkviewId. Jentic handles the bearer token from the stored credential.

Can I extract individual files from a QKView without downloading the whole archive?

Yes. GET /qkviews/{qkviewId}/files lists every file in the archive and GET /qkviews/{qkviewId}/files/{fileId} returns one specific file. This is the standard path for inspecting a single log or config without pulling the full QKView.

Does the API expose BIG-IP configuration in a structured way?

Yes. GET /qkviews/{qkviewId}/bigip/{category} returns the configuration for a given BIG-IP category — for example LTM, ASM, or APM — parsed from the QKView so callers do not have to parse the raw archive themselves.