F5

F5 Connections API

The Connections API from F5 — 1 operation(s) for connections.

GitHub OpenAPI

Operations 2

GET /connections Return client connections statistics #
DELETE /connections Reset client connections statistics #

Documentation

📖
Documentation
https://nginx.org/en/docs/http/ngx_http_api_module.html
📖
APIReference
https://demo.nginx.com/swagger-ui/
📖
Documentation
https://clouddocs.f5.com/products/extensions/f5-appsvcs-extension/latest/
📖
Documentation
https://clouddocs.f5.com/products/extensions/f5-appsvcs-templates/latest/
📖
Documentation
https://clouddocs.f5.com/products/extensions/f5-declarative-onboarding/latest/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/f5/refs/heads/main/openapi/f5-connections-api-openapi.yml

Other Resources

🔗
SourceCode
https://github.com/nginx/nginx.org/blob/main/yaml/nginx_api.yaml
🔗
SourceCode
https://github.com/F5Networks/f5-appsvcs-extension
🔗
ChangeLog
https://github.com/F5Networks/f5-appsvcs-extension/releases
🔗
SourceCode
https://github.com/F5Networks/f5-appsvcs-templates
🔗
ChangeLog
https://github.com/F5Networks/f5-appsvcs-templates/releases
🔗
SourceCode
https://github.com/F5Networks/f5-declarative-onboarding
🔗
ChangeLog
https://github.com/F5Networks/f5-declarative-onboarding/releases

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

GitHub Google LinkedIn

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

OpenAPI Specification

f5-connections-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: '9.0'
  title: NGINX Plus REST Connections API
  description: NGINX Plus REST API provides access to NGINX Plus status information, on-the-fly configuration of upstream servers and key-value pairs management for http and stream.
servers:
- url: /api/9
tags:
- name: Connections
paths:
  /connections:
    get:
      tags:
      - Connections
      summary: Return client connections statistics
      description: Returns statistics of client connections.
      operationId: getConnections
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxConnections'
        '404':
          description: Unknown version (*UnknownVersion*)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxError'
      parameters:
      - in: query
        name: fields
        description: Limits which fields of the connections statistics will be output.
        schema:
          type: string
    delete:
      tags:
      - Connections
      summary: Reset client connections statistics
      description: Resets statistics of accepted and dropped client connections.
      operationId: deleteConnections
      responses:
        '204':
          description: Success
        '404':
          description: Unknown version (*UnknownVersion*)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxError'
        '405':
          description: Method disabled (*MethodDisabled*)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NginxError'
components:
  schemas:
    NginxConnections:
      title: Connections
      description: 'The number of accepted, dropped, active, and idle connections.

        '
      type: object
      properties:
        accepted:
          type: integer
          description: The total number of accepted client connections.
        dropped:
          type: integer
          description: The total number of dropped client connections.
        active:
          type: integer
          description: The current number of active client connections.
        idle:
          type: integer
          description: The current number of idle client connections.
      example:
        accepted: 4968119
        dropped: 0
        active: 5
        idle: 117
    NginxError:
      title: Error
      description: 'nginx error object.

        '
      type: object
      properties:
        error:
          type: object
          properties:
            status:
              type: integer
              description: HTTP error code.
            text:
              type: string
              description: Error description.
            code:
              type: string
              description: Internal nginx error code.
        request_id:
          type: string
          description: The ID of the request, equals the value of the <a href="https://nginx.org/en/docs/http/ngx_http_core_module.html#var_request_id">$request_id</a> variable.
        href:
          type: string
          description: Link to reference documentation.