F5 Insight

OpenAPI spec for F5 Insight device fleet monitoring and analytics automation via API

F5 Insight is F5's monitoring and analytics platform for device fleet management, providing unified visibility, software lifecycle management, and centralized configuration across F5 infrastructure.

This project provides OpenAPI specs for automating against F5 Insight's REST API via an Integration Model, plus a Studio Project of ready-to-import CRUD workflows built on that model.

Table of Contents

• Contents
• Requirements
• Integration Configuration
• OpenAPIs
  • f5_insight-latest.json
  • f5_insight-v1.2.2.json
• Studio Projects
  • F5 Insight Project
    • Folder Structure
    • Dependencies

Contents

Requirements

Integration Configuration

Import f5_insight-latest.json as an Integration Model in Admin > Integrations, then create an integration pointing at your F5 Insight instance.

Authentication is HTTP Basic Auth, supported on every operation in this spec.

The instance's authentication/server properties should look like this once configured:

{
  "authentication": {
    "basicAuth": {
      "username": "<your-username>",
      "password": "<your-password>"
    }
  },
  "server": {
    "protocol": "https",
    "host": "<your-f5-insight-host>",
    "base_path": ""
  }
}

Note the empty base_path — every operation's path already includes the full /api/... prefix literally, so a non-empty base path (e.g. /api) would double it up.

OpenAPIs

f5_insight-latest.json

Built from F5's own published OpenAPI spec (embedded in their API documentation site, extracted from the page's Redoc bundle), curated to the core fleet-management categories.

Resources included, by category:

• Device Management: devices, data centers, trust stores, device migration/import tasks
• Device Templates: template CRUD, attach/deploy/clone/lock
• Inventory, Infrastructure Discovery: fleet and discovered-resource inventory
• Cloud Environments / Cloud Providers: connection and environment configuration (vSphere, etc.)
• Software Distribution / Software Installation / Upgrade: job lifecycle, scheduling, compatibility and flight checks
• Backup, Storage: backup/restore, storage target configuration
• Licensing: license pools, offerings, members
• Jobs, Observability, Health and Readiness, Audit Console, Telemetry Configuration, Validation, Workflows, Tasks, VM Tasks, Images, Schedule, Configuration, FQDN Configuration, Lifecycle, Compatibility Matrix

Excluded: authentication/authorization/identity-provider administration (one-time setup, not routine automation), AI-assistant chat history and insights, feature flags, and other internal admin tooling, plus 5 operations requiring multipart file uploads (image/backup/upgrade-bundle uploads, device migration bundles) — outside this repo's REST/JSON automation scope. Also excluded: OData-style query parameters ($select, $filter, $orderby, $top, $skip, $count) on 2 list operations — both work fine without them (unfiltered list results).

A handful of workflow names (e.g. generic device/job/workflow CRUD) are prefixed with F5 Insight to avoid colliding with identically-named workflows already published for other products — workflow names are unique across the whole Itential Platform instance, not scoped per-project.

f5_insight-v1.2.2.json

Full, unmodified vendor spec for the F5 Insight API, version 1.2.2. See f5_insight-latest.json above for the curated subset if you just need common fleet-management automation.

Studio Projects

F5 Insight Project

Backed by the F5 Insight:latest Integration Model (see f5_insight-latest.json above). The project contains 227 workflows organized into 27 folders.

Folder Structure

Dependencies