F5 Load Balancer Inspect API

Inspect the current state of BIG-IP configuration classes known to Declarative Onboarding.

Operations 1

GET /inspect F5 Load Balancer Inspect current BIG-IP state #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/f5-load-balancer-inspect-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

f5-load-balancer-inspect-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: F5 Load Balancer F5 BIG-IP Declarative Onboarding (DO)…
  description: The Declarative Onboarding (DO) extension automates the initial BIG-IP system configuration and provisioning using a declarative JSON model. DO handles Layer 1-3 onboarding tasks including licensing, DNS and NTP configuration, VLAN setup, self IP assignment, user management, and module provisioning. Administrators submit a single JSON declaration describing the desired initial device state, and DO configures the BIG-IP system accordingly.
  version: 1.41.0
  contact:
    name: F5 Networks Support
    email: support@f5.com
    url: https://www.f5.com/services/support
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  termsOfService: https://www.f5.com/company/policies/terms-of-use
servers:
- url: https://{bigip_host}/mgmt/shared/declarative-onboarding
  description: BIG-IP Declarative Onboarding Endpoint
  variables:
    bigip_host:
      default: 192.168.1.245
      description: Hostname or IP address of the BIG-IP device. Use port 8443 for single-NIC BIG-IP deployments.
security:
- basicAuth: []
- tokenAuth: []
tags:
- name: Inspect
  description: Inspect the current state of BIG-IP configuration classes known to Declarative Onboarding.
paths:
  /inspect:
    get:
      operationId: inspectCurrentState
      summary: F5 Load Balancer Inspect current BIG-IP state
      description: Returns the classes Declarative Onboarding is aware of and their current state on the BIG-IP system. Useful for understanding the current device configuration in DO terms.
      tags:
      - Inspect
      responses:
        '200':
          description: Current state inspection retrieved
          content:
            application/json:
              schema:
                type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
  responses:
    Unauthorized:
      description: Authentication credentials were missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using BIG-IP admin credentials.
    tokenAuth:
      type: apiKey
      in: header
      name: X-F5-Auth-Token
      description: Token-based authentication from /mgmt/shared/authn/login.
externalDocs:
  description: F5 BIG-IP Declarative Onboarding Documentation
  url: https://clouddocs.f5.com/products/extensions/f5-declarative-onboarding/latest/