Apache HTTP Server Status API

Server status and metrics

OpenAPI Specification

apache-httpd-status-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Apache HTTP Server Balancer Status API
  version: 2.4.0
  description: Status and monitoring API for Apache HTTP Server (httpd) provided by mod_status, exposing server metrics, worker state, and load balancer information.
  contact:
    email: dev@httpd.apache.org
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:80
  description: Apache HTTP Server
tags:
- name: Status
  description: Server status and metrics
paths:
  /server-status:
    get:
      operationId: getServerStatus
      summary: Apache HTTP Server Get Server Status
      description: Get real-time server status metrics from mod_status including request rates, worker states, and CPU usage.
      tags:
      - Status
      parameters:
      - name: auto
        in: query
        required: false
        schema:
          type: string
        description: Use 'auto' for machine-readable plain-text format
      responses:
        '200':
          description: Server status retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerStatus'
  /server-info:
    get:
      operationId: getServerInfo
      summary: Apache HTTP Server Get Server Info
      description: Get detailed server configuration information from mod_info including loaded modules and directives.
      tags:
      - Status
      responses:
        '200':
          description: Server info retrieved
          content:
            text/html:
              schema:
                type: string
components:
  schemas:
    ServerStatus:
      type: object
      description: Apache HTTP Server status information from mod_status
      properties:
        ServerVersion:
          type: string
          description: Apache server version string
          example: Apache/2.4.57 (Unix)
        ServerMPM:
          type: string
          description: Multi-processing module in use
          example: event
        ServerUptimeSeconds:
          type: integer
          description: Server uptime in seconds
          example: 86400
        Load1:
          type: number
          description: 1-minute load average
          example: 0.12
        Load5:
          type: number
          description: 5-minute load average
          example: 0.09
        Load15:
          type: number
          description: 15-minute load average
          example: 0.08
        ReqPerSec:
          type: number
          description: Requests per second
          example: 142.3
        BytesPerSec:
          type: number
          description: Bytes transferred per second
          example: 512000
        BusyWorkers:
          type: integer
          description: Number of busy worker threads
          example: 10
        IdleWorkers:
          type: integer
          description: Number of idle worker threads
          example: 6
        Scoreboard:
          type: string
          description: Worker state scoreboard string
          example: ___________W_______