Grafana Put API

openapi: 3.2.0
info:
  title: Grafana Put API
  description: 'Grafana is an open-source analytics and visualization platform that helps you monitor and analyze data from various sources. It lets you create customizable dashboards with charts, graphs, and alerts to visualize metrics and logs in real-time. Commonly used for monitoring infrastructure, applications, and business metrics, Grafana connects to dozens of data sources like Prometheus, Elasticsearch, and cloud platforms, making it easier to understand system performance, troubleshoot issues, and track key indicators all in one place. '
  contact:
    name: Grafana Labs
    url: https://grafana.com
    email: hello@grafana.com
  version: 0.0.1
servers:
- url: http://{defaultHost}
  variables:
    defaultHost:
      default: www.example.com/api
- url: https://{defaultHost}
  variables:
    defaultHost:
      default: www.example.com/api
security:
- basic: []
- api_key: []
tags:
- name: Put
paths:
  /v1/provisioning/contact-points/{UID}:
    parameters: []
    put:
      tags:
      - Put
      summary: Grafana Route Put Contactpoint
      description: Updates an existing contact point in Grafana's alerting system using its unique identifier (UID). This PUT operation allows administrators to modify the configuration of a specific notification channel or contact point, such as updating webhook URLs, email addresses, Slack channels, or other alerting destination settings. The endpoint requires the contact point's UID in the path and accepts a request body containing the updated contact point configuration including its name, type, and integration-specific settings. This is part of Grafana's provisioning API, enabling programmatic management of alerting infrastructure and ensuring contact points can be maintained through automation or infrastructure-as-code practices.
      operationId: routePutContactpoint
      parameters:
      - name: UID
        in: path
        description: UID is the contact point unique identifier
        required: true
        schema:
          type: string
      - name: X-Disable-Provenance
        in: header
        description: ''
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmbeddedContactPoint'
        required: false
      responses:
        '202':
          description: Ack
          headers: {}
          content:
            application/json:
              schema:
                type: object
                contentMediaType: application/json
        '400':
          description: ValidationError
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
      deprecated: false
      x-api-evangelist-processing:
        SplitPascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        WriteDescription: true
        ChooseTags: true
  /v1/provisioning/templates/{name}:
    parameters: []
    put:
      tags:
      - Put
      summary: Grafana Route Put Template
      description: Updates an existing notification template in Grafana's provisioning system by replacing the template configuration identified by the specified name parameter. This PUT operation allows administrators to modify template content, formatting, and other properties used for alert notifications. The route accepts the template name as a path parameter and expects the complete updated template definition in the request body, which will overwrite the existing template configuration while maintaining the same identifier.
      operationId: routePutTemplate
      parameters:
      - name: name
        in: path
        description: Template group name
        required: true
        schema:
          type: string
      - name: X-Disable-Provenance
        in: header
        description: ''
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationTemplateContent'
        required: false
      responses:
        '202':
          description: NotificationTemplate
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationTemplate'
        '400':
          description: PublicError
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicError'
        '409':
          description: PublicError
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicError'
      deprecated: false
      x-api-evangelist-processing:
        SplitPascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        WriteDescription: true
        ChooseTags: true
components:
  schemas:
    PublicError:
      title: PublicError
      type: object
      properties:
        extra:
          type: object
          additionalProperties: {}
        message:
          type: string
        messageId:
          type: string
        statusCode:
          type: integer
          contentEncoding: int64
      description: 'PublicError is derived from Error and only contains information

        available to the end user.'
    Type:
      title: Type
      enum:
      - alertmanager
      - dingding
      - discord
      - email
      - googlechat
      - kafka
      - line
      - opsgenie
      - pagerduty
      - pushover
      - sensugo
      - slack
      - teams
      - telegram
      - threema
      - victorops
      - webhook
      - wecom
      type: string
      examples:
      - webhook
    NotificationTemplate:
      title: NotificationTemplate
      type: object
      properties:
        name:
          type: string
        provenance:
          type: string
        template:
          type: string
        version:
          type: string
    EmbeddedContactPoint:
      title: EmbeddedContactPoint
      required:
      - settings
      - type
      type: object
      properties:
        disableResolveMessage:
          type: boolean
          examples:
          - false
        name:
          type: string
          description: 'Name is used as grouping key in the UI. Contact points with the

            same name will be grouped in the UI.'
          examples:
          - webhook_1
        provenance:
          type: string
          readOnly: true
        settings:
          type: object
        type:
          allOf:
          - $ref: '#/components/schemas/Type'
          - examples:
            - webhook
        uid:
          maxLength: 40
          minLength: 1
          pattern: ^[a-zA-Z0-9\-\_]+$
          type: string
          description: 'UID is the unique identifier of the contact point. The UID can be

            set by the user.'
          examples:
          - my_external_reference
      description: 'EmbeddedContactPoint is the contact point type that is used

        by grafanas embedded alertmanager implementation.'
    NotificationTemplateContent:
      title: NotificationTemplateContent
      type: object
      properties:
        template:
          type: string
        version:
          type: string
    ValidationError:
      title: ValidationError
      type: object
      properties:
        message:
          type: string
          examples:
          - error message
  securitySchemes:
    api_key:
      type: apiKey
      name: Authorization
      in: header
    basic:
      type: http
      scheme: basic