Grafana Post API

openapi: 3.2.0
info:
  title: Grafana Post 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: Post
paths:
  /saml/acs:
    parameters: []
    post:
      tags:
      - Post
      summary: Grafana Post ACS
      description: The Grafana SAML ACS (Assertion Consumer Service) POST endpoint receives and processes SAML authentication responses from identity providers after a user attempts to log in. When a user authenticates with an external IdP, the IdP sends a signed SAML assertion to this endpoint containing user identity information and authentication status. Grafana validates the SAML response signature, extracts user attributes like email, username, and roles, then creates or updates the user session accordingly. This endpoint is a critical component of SAML-based single sign-on integration, enabling Grafana to trust authentication performed by external identity management systems and grant appropriate access to authenticated users based on their SAML attributes and role mappings.
      operationId: postACS
      parameters:
      - name: RelayState
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '302':
          description: (empty)
          headers: {}
          content: {}
        '403':
          description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseBody'
        '500':
          description: InternalServerError is a general error indicating something went wrong internally.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseBody'
      deprecated: false
      x-api-evangelist-processing:
        SplitPascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        WriteDescription: true
        ChooseTags: true
  /saml/slo:
    parameters: []
    post:
      tags:
      - Post
      summary: Grafana Post SLO
      description: The Grafana SAML Single Logout (SLO) POST endpoint processes logout requests in SAML-based authentication workflows, allowing users to securely terminate their sessions across all connected service providers. When invoked, this endpoint receives SAML logout request or response messages, validates the SAML assertions, and performs the necessary cleanup to end the user's authenticated session in Grafana. This operation is essential for maintaining security in enterprise environments where centralized identity management is implemented, ensuring that when a user logs out from their identity provider or a connected application, their Grafana session is also properly terminated to prevent unauthorized access.
      operationId: postSLO
      parameters:
      - name: SAMLRequest
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: SAMLResponse
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '302':
          description: (empty)
          headers: {}
          content: {}
        '400':
          description: BadRequestError is returned when the request is invalid and it cannot be processed.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseBody'
        '403':
          description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseBody'
        '500':
          description: InternalServerError is a general error indicating something went wrong internally.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseBody'
      deprecated: false
      x-api-evangelist-processing:
        SplitPascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        WriteDescription: true
        ChooseTags: true
  /v1/provisioning/contact-points:
    parameters: []
    post:
      tags:
      - Post
      summary: Grafana Route Post Contactpoints
      description: Creates a new contact point in Grafana's alerting system through the provisioning API. This endpoint allows administrators to programmatically configure notification channels by defining how and where alert notifications should be sent. The contact point can specify various integration types such as email, Slack, PagerDuty, webhook, or other supported notification methods, along with their respective configuration settings. This is typically used for infrastructure-as-code deployments or automated Grafana configuration management, enabling teams to version control and consistently deploy alerting configurations across multiple Grafana instances without manual intervention through the UI.
      operationId: routePostContactpoints
      parameters:
      - 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: EmbeddedContactPoint
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddedContactPoint'
        '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
components:
  schemas:
    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
    ValidationError:
      title: ValidationError
      type: object
      properties:
        message:
          type: string
          examples:
          - error message
    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.'
    ErrorResponseBody:
      title: ErrorResponseBody
      required:
      - message
      type: object
      properties:
        error:
          type: string
          description: Error An optional detailed description of the actual error. Only included if running in developer mode.
        message:
          type: string
          description: a human readable version of the error
        status:
          type: string
          description: 'Status An optional status to denote the cause of the error.


            For example, a 412 Precondition Failed error may include additional information of why that error happened.'
  securitySchemes:
    api_key:
      type: apiKey
      name: Authorization
      in: header
    basic:
      type: http
      scheme: basic