swagger: '2.0'
info:
  version: 0.0.1
  title: Alertmanager admin remote 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: remote
  description: Remote read and write endpoints.
paths:
  /read:
    post:
      tags:
      - remote
      summary: Remote read endpoint
      description: Prometheus remote read endpoint for federated queries. Accepts and returns Protocol Buffer encoded data.
      operationId: remoteRead
      responses:
        '204':
          description: No Content
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /write:
    post:
      tags:
      - remote
      summary: Remote write endpoint
      description: Prometheus remote write endpoint for sending metrics. Accepts Protocol Buffer encoded write requests.
      operationId: remoteWrite
      responses:
        '204':
          description: No Content
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      properties:
        status:
          type: string
          enum:
          - success
          - error
          description: Response status.
          example: success
        errorType:
          type: string
          description: Type of error that occurred.
          example: bad_data
        error:
          type: string
          description: Human-readable error message.
          example: invalid parameter
      required:
      - status
      - errorType
      - error
      additionalProperties: false
      description: Error response.