Squid Configuration API

openapi: 3.1.0
info:
  title: Squid Cache Manager Cache Statistics Configuration API
  description: The Squid Cache Manager is a built-in HTTP management interface that exposes internal statistics, cache operations, and runtime state via HTTP requests. It provides endpoints for retrieving cache statistics, managing connections, viewing counters, and performing cache operations. Access is typically restricted to localhost or authorized IP ranges.
  version: 6.x
  contact:
    name: Squid Project
    url: http://www.squid-cache.org/Support/
  license:
    name: GNU General Public License v2
    url: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
servers:
- url: http://localhost:3128/squid-internal-mgr
  description: Local Squid Cache Manager (default port)
security:
- BasicAuth: []
tags:
- name: Configuration
  description: Runtime configuration and ACL information
paths:
  /config:
    get:
      operationId: getCacheConfig
      summary: Get Cache Configuration
      description: Returns the current Squid configuration (squid.conf) as loaded at startup or last reload. Sensitive values such as LDAP passwords are redacted.
      tags:
      - Configuration
      responses:
        '200':
          description: Current Squid configuration
          content:
            text/plain:
              schema:
                type: string
  /acl_list:
    get:
      operationId: getACLList
      summary: Get ACL List
      description: Returns all defined access control lists (ACLs) and their current membership, including IP ranges, domain lists, and time specifications.
      tags:
      - Configuration
      responses:
        '200':
          description: ACL list
          content:
            text/plain:
              schema:
                type: string
components:
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: Cache manager password configured via cachemgr_passwd in squid.conf