Prometheus general API

General Alertmanager operations

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

prometheus-io-general-api-openapi.yml Raw ↑
swagger: '2.0'
info:
  version: 0.0.1
  title: Alertmanager admin general API
  description: API of the Prometheus Alertmanager (https://github.com/prometheus/alertmanager)
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
basePath: /api/v2/
consumes:
- application/json
produces:
- application/json
tags:
- name: general
  description: General Alertmanager operations
paths:
  /status:
    get:
      tags:
      - general
      operationId: getStatus
      description: Get current status of an Alertmanager instance and its cluster
      responses:
        '200':
          description: Get status response
          schema:
            $ref: '#/definitions/alertmanagerStatus'
definitions:
  versionInfo:
    type: object
    properties:
      version:
        type: string
      revision:
        type: string
      branch:
        type: string
      buildUser:
        type: string
      buildDate:
        type: string
      goVersion:
        type: string
    required:
    - version
    - revision
    - branch
    - buildUser
    - buildDate
    - goVersion
  peerStatus:
    type: object
    properties:
      name:
        type: string
      address:
        type: string
    required:
    - name
    - address
  alertmanagerStatus:
    type: object
    properties:
      cluster:
        $ref: '#/definitions/clusterStatus'
      versionInfo:
        $ref: '#/definitions/versionInfo'
      config:
        $ref: '#/definitions/alertmanagerConfig'
      uptime:
        type: string
        format: date-time
    required:
    - cluster
    - versionInfo
    - config
    - uptime
  clusterStatus:
    type: object
    properties:
      name:
        type: string
      status:
        type: string
        enum:
        - ready
        - settling
        - disabled
      peers:
        type: array
        items:
          $ref: '#/definitions/peerStatus'
    required:
    - status
  alertmanagerConfig:
    type: object
    properties:
      original:
        type: string
    required:
    - original