Prometheus Status API

openapi: 3.1.0
info:
  title: Prometheus Alertmanager Admin Status API
  description: The Prometheus Alertmanager HTTP API v2 provides endpoints for querying active alert status, creating and managing silences, retrieving receiver configurations, and checking cluster peer status. Alertmanager deduplicates, groups, and routes alert notifications to receivers such as email, PagerDuty, Slack, and OpsGenie. The API base path is /api/v2.
  version: v0.28.0
  contact:
    name: Prometheus Project
    url: https://prometheus.io/community/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://{host}:{port}
  description: Alertmanager server
  variables:
    host:
      default: localhost
      description: Alertmanager server hostname
    port:
      default: '9093'
      description: Alertmanager server port
tags:
- name: Status
  description: Endpoints for retrieving Alertmanager configuration, cluster status, and version information.
paths:
  /api/v2/status:
    get:
      operationId: getStatus
      summary: Prometheus Get Alertmanager status
      description: Returns the current status of the Alertmanager including the current loaded configuration, cluster peers, and version information.
      tags:
      - Status
      responses:
        '200':
          description: Status returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertmanagerStatus'
  /api/v1/alertmanagers:
    get:
      operationId: getAlertmanagers
      summary: Prometheus Get Alertmanager discovery status
      description: Returns an overview of the current state of the Prometheus Alertmanager service discovery including active and dropped Alertmanager instances.
      tags:
      - Status
      responses:
        '200':
          description: Alertmanager discovery status returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertmanagersResponse'
  /api/v1/status/config:
    get:
      operationId: getConfig
      summary: Prometheus Get server configuration
      description: Returns the currently loaded configuration file as a YAML string. Includes the full Prometheus configuration including scrape configs, rule files, and alerting configuration.
      tags:
      - Status
      responses:
        '200':
          description: Configuration returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigResponse'
  /api/v1/status/flags:
    get:
      operationId: getFlags
      summary: Prometheus Get command-line flags
      description: Returns the values of all command-line flag settings currently in use by the Prometheus server.
      tags:
      - Status
      responses:
        '200':
          description: Flags returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlagsResponse'
  /api/v1/status/buildinfo:
    get:
      operationId: getBuildInfo
      summary: Prometheus Get build information
      description: Returns build and version information for the Prometheus server, including version, revision, branch, build user, build date, and Go version.
      tags:
      - Status
      responses:
        '200':
          description: Build information returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuildInfoResponse'
  /api/v1/status/runtimeinfo:
    get:
      operationId: getRuntimeInfo
      summary: Prometheus Get runtime information
      description: Returns various runtime properties about the Prometheus server including the start time, storage retention, TSDB stats summary, and corruptible chunk count.
      tags:
      - Status
      responses:
        '200':
          description: Runtime information returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuntimeInfoResponse'
  /api/v1/status/walreplay:
    get:
      operationId: getWalReplayStatus
      summary: Prometheus Get WAL replay status
      description: Returns the current status of the WAL (Write-Ahead Log) replay. WAL replay occurs during Prometheus startup to recover data from the most recent checkpoint.
      tags:
      - Status
      responses:
        '200':
          description: WAL replay status returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WalReplayResponse'
  /-/healthy:
    get:
      operationId: checkHealth
      summary: Prometheus Health check
      description: Returns 200 if the Pushgateway is healthy and ready to accept pushed metrics. Used for liveness probes in Kubernetes deployments.
      tags:
      - Status
      responses:
        '200':
          description: Pushgateway is healthy
  /-/ready:
    get:
      operationId: checkReady
      summary: Prometheus Readiness check
      description: Returns 200 when the Pushgateway is ready to serve traffic. Used for readiness probes in Kubernetes deployments.
      tags:
      - Status
      responses:
        '200':
          description: Pushgateway is ready
  /api/v1/status:
    get:
      operationId: getStatus
      summary: Prometheus Get Pushgateway status
      description: Returns build information and runtime status for the Pushgateway server including version, revision, and configuration flags.
      tags:
      - Status
      responses:
        '200':
          description: Status returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
components:
  schemas:
    AlertmanagersResponse:
      type: object
      description: Response containing Alertmanager discovery status.
      required:
      - status
      - data
      properties:
        status:
          type: string
          enum:
          - success
          - error
        data:
          type: object
          properties:
            activeAlertmanagers:
              type: array
              items:
                type: object
                properties:
                  url:
                    type: string
                    format: uri
                    description: Alertmanager URL.
            droppedAlertmanagers:
              type: array
              items:
                type: object
                properties:
                  url:
                    type: string
                    format: uri
                    description: Dropped Alertmanager URL.
    BuildInfoResponse:
      type: object
      description: Response containing Prometheus build information.
      required:
      - status
      - data
      properties:
        status:
          type: string
          enum:
          - success
          - error
        data:
          type: object
          properties:
            version:
              type: string
              description: Prometheus version.
            revision:
              type: string
              description: Git commit SHA.
            branch:
              type: string
              description: Git branch.
            buildUser:
              type: string
              description: User who built this binary.
            buildDate:
              type: string
              description: Date the binary was built.
            goVersion:
              type: string
              description: Go version used to build.
    AlertmanagerStatus:
      type: object
      description: Overall status of the Alertmanager instance.
      required:
      - cluster
      - versionInfo
      - config
      - uptime
      properties:
        cluster:
          type: object
          description: Cluster peer status.
          properties:
            name:
              type: string
              description: Name of this cluster member.
            status:
              type: string
              enum:
              - ready
              - settling
              - disabled
              description: Cluster status.
            peers:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                    description: Peer name.
                  address:
                    type: string
                    description: Peer address.
        versionInfo:
          type: object
          description: Version information.
          properties:
            version:
              type: string
            revision:
              type: string
            branch:
              type: string
            buildUser:
              type: string
            buildDate:
              type: string
            goVersion:
              type: string
        config:
          type: object
          description: Currently loaded configuration.
          properties:
            original:
              type: string
              description: The raw configuration file content as a string.
        uptime:
          type: string
          format: date-time
          description: Timestamp when Alertmanager started.
    WalReplayResponse:
      type: object
      description: Response containing WAL replay progress.
      required:
      - status
      - data
      properties:
        status:
          type: string
          enum:
          - success
          - error
        data:
          type: object
          properties:
            min:
              type: integer
              description: Minimum segment being replayed.
            max:
              type: integer
              description: Maximum segment to replay.
            current:
              type: integer
              description: Current segment being replayed.
            state:
              type: string
              enum:
              - waiting
              - in progress
              - done
              description: WAL replay state.
    ConfigResponse:
      type: object
      description: Response containing the current Prometheus configuration.
      required:
      - status
      - data
      properties:
        status:
          type: string
          enum:
          - success
          - error
        data:
          type: object
          properties:
            yaml:
              type: string
              description: Currently loaded Prometheus configuration as YAML string.
    StatusResponse:
      type: object
      description: Pushgateway build and runtime status.
      properties:
        status:
          type: string
          enum:
          - success
        data:
          type: object
          properties:
            version:
              type: string
              description: Pushgateway version.
            revision:
              type: string
              description: Git revision.
            branch:
              type: string
              description: Git branch.
            buildUser:
              type: string
              description: User who built this binary.
            buildDate:
              type: string
              description: Build date.
            goVersion:
              type: string
              description: Go version.
    RuntimeInfoResponse:
      type: object
      description: Response containing Prometheus runtime information.
      required:
      - status
      - data
      properties:
        status:
          type: string
          enum:
          - success
          - error
        data:
          type: object
          properties:
            startTime:
              type: string
              format: date-time
              description: When Prometheus was started.
            CWD:
              type: string
              description: Current working directory.
            reloadConfigSuccess:
              type: boolean
              description: Whether the last configuration reload was successful.
            lastConfigTime:
              type: string
              format: date-time
              description: Timestamp of the last successful configuration reload.
            corruptionCount:
              type: integer
              description: Number of corrupted chunks detected.
            goroutineCount:
              type: integer
              description: Number of active goroutines.
            GOMAXPROCS:
              type: integer
              description: Maximum number of CPUs used by Go runtime.
            GOMEMLIMIT:
              type: integer
              description: Memory limit in bytes set for the Go runtime.
            GOGC:
              type: string
              description: GC frequency setting.
            GODEBUG:
              type: string
              description: GODEBUG settings.
            storageRetention:
              type: string
              description: Storage retention duration.
    FlagsResponse:
      type: object
      description: Response containing command-line flag values.
      required:
      - status
      - data
      properties:
        status:
          type: string
          enum:
          - success
          - error
        data:
          type: object
          additionalProperties:
            type: string
          description: Map of flag names to their current values.
externalDocs:
  description: Alertmanager Documentation
  url: https://prometheus.io/docs/alerting/latest/alertmanager/