> ## Documentation Index
> Fetch the complete documentation index at: https://docs.togai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create an alert

> Create an alert



## OpenAPI

````yaml post /alerts
openapi: 3.0.3
info:
  version: '1.0'
  title: Togai Apis
  contact:
    email: engg@togai.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  description: APIs for Togai App
servers:
  - description: Api endpoint
    url: https://api.togai.com/
  - description: Sandbox api endpoint
    url: https://sandbox-api.togai.com/
security:
  - bearerAuth: []
tags:
  - name: Customers
    description: Customer level calls
  - name: Accounts
    description: Account level calls
  - name: Event Schemas
    description: Event Schema level calls
  - name: Usage Meters
    description: Usage Meter level calls
  - name: Price Plans
    description: (DEPRECATED) Price Plan level calls
  - name: PricePlanV2
    description: Price Plan V2 level calls
  - name: Schedules
    description: Account Schedule level calls
  - name: Pricing Rules
    description: Pricing Rules level calls
  - name: Settings
    description: Settings
  - name: Price Experimentation
    description: Price Experimentation apis
  - name: InvoiceGroups
    description: Invoice Group level calls
  - name: Organization
    description: Organization level calls
  - name: FileStorage
    description: File Storage level calls
  - name: Aliases
    description: Alias level calls
  - name: Reports
    description: Report level calls
  - name: ReportTemplates
    description: Report Template level calls
  - name: Customer Portal
    description: Portal level calls
  - name: Alerts
    description: Alert level calls
  - name: Event Management
    description: APIs for getting events ingested in Togai
    externalDocs:
      description: docs
      url: https://togai.com/docs/billing/events
  - name: Metrics
    description: APIs for getting Togai metrics
    externalDocs:
      description: docs
      url: https://togai.com/docs/metrics
  - name: Licenses
    description: APIs for getting or updating license records in Togai
  - name: Entitlements
    description: APIs related to entitlements
  - name: Invoices
    description: Invoices API
  - name: Credits
    description: Credits API
  - name: Wallet
    description: Wallet API
  - name: InvoiceTemplates
    description: InvoiceTemplates API
  - name: InvoiceSequence
    description: InvoiceSequence API
  - name: Payments
    description: Payments API
  - name: Authentication
    description: Authentication API
externalDocs:
  description: Find out more about Togai
  url: https://docs.togai.com/docs
paths:
  /alerts:
    post:
      tags:
        - Alerts
      summary: Create an alert
      description: Create an alert
      operationId: createAlert
      requestBody:
        $ref: '#/components/requestBodies/CreateAlertRequest'
      responses:
        '200':
          $ref: '#/components/responses/AlertResponse'
        '400':
          $ref: '#/components/responses/ErrorResponse'
        '401':
          $ref: '#/components/responses/ErrorResponse'
        '403':
          $ref: '#/components/responses/ErrorResponse'
        '404':
          $ref: '#/components/responses/ErrorResponse'
        '429':
          $ref: '#/components/responses/ErrorResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
components:
  requestBodies:
    CreateAlertRequest:
      description: Payload to install an alert
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateAlertRequest'
          examples:
            CreateAlertRequest:
              $ref: '#/components/examples/CreateAlertRequest'
  responses:
    AlertResponse:
      description: Response for install alert request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Alert'
          examples:
            AlertResponse:
              $ref: '#/components/examples/AlertResponse'
    ErrorResponse:
      description: Error response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            ErrorResponse:
              summary: Error message
              value:
                message: <Reason message>
  schemas:
    CreateAlertRequest:
      type: object
      additionalProperties: false
      required:
        - alertTemplateId
        - interval
        - status
      properties:
        alertTemplateId:
          type: string
        interval:
          type: integer
        validity:
          type: integer
          description: >-
            Validity of the alert in minutes, if null then alert will be valid
            forever
        description:
          type: string
        entityDetails:
          additionalProperties:
            type: object
        ownerDetails:
          additionalProperties:
            type: object
        parameters:
          additionalProperties:
            type: object
        status:
          $ref: '#/components/schemas/AlertStatus'
    Alert:
      type: object
      additionalProperties: false
      required:
        - id
        - version
        - alertTemplateId
        - interval
        - status
        - createdAt
      properties:
        id:
          type: string
          description: Alert ID
        version:
          type: integer
          description: Alert Version
        description:
          type: string
          description: Alert Description
        status:
          $ref: '#/components/schemas/AlertStatus'
        validity:
          type: integer
          description: >-
            Validity of the alert in minutes, if null then alert will be valid
            forever
        alertTemplateId:
          type: string
          description: Alert Template Id
        interval:
          type: integer
          description: Interval
        entityDetails:
          additionalProperties:
            type: object
        ownerDetails:
          additionalProperties:
            type: object
        parameters:
          additionalProperties:
            type: object
        createdAt:
          type: string
          format: date-time
          description: Created At
        updatedAt:
          type: string
          format: date-time
          description: Updated At
    ErrorResponse:
      type: object
      additionalProperties: false
      required:
        - message
      properties:
        message:
          type: string
          description: error description
          maxLength: 500
    AlertStatus:
      type: string
      enum:
        - ACTIVE
        - INACTIVE
  examples:
    CreateAlertRequest:
      value:
        alertTemplateId: abcd-efgh-ijkl-mnop
        interval: '30'
        entityDetails:
          usageMeterId: um.1zYnCiM9Bpg.lv25y
        ownerDetails:
          accountId: account_1
        parameters:
          threshold: 10
    AlertResponse:
      value:
        id: alert.1zYnCiM9Bpg.lv25y
        version: 1
        alertId: alert.1zYnCiM9Bpg.lv25y
        description: Alert1 Description
        cronInterval: '30'
        ownerDetails:
          accountId: account_1
        entityDetails:
          usageMeterId: um.1zYnCiM9Bpg.lv25y
        parameters:
          threshold: 10
        status: ACTIVE
        createdAt: '2020-01-01T00:00:00Z'
        updatedAt: '2020-01-01T00:00:00Z'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Bearer <credential>

````