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

# Get alert event by ID

> No description available



## OpenAPI

````yaml openapi_v3.yaml get /v3/alert-event/{id}
openapi: 3.0.0
info:
  title: ''
  version: 1.0.0
servers:
  - url: https://api.coralogix.com/mgmt/openapi/3
  - url: https://api.eu2.coralogix.com/mgmt/openapi/3
  - url: https://api.coralogix.us/mgmt/openapi/3
  - url: https://api.cx498.coralogix.com/mgmt/openapi/3
  - url: https://api.coralogix.in/mgmt/openapi/3
  - url: https://api.coralogixsg.com/mgmt/openapi/3
  - url: https://api.ap3.coralogix.com/mgmt/openapi/3
security:
  - apiKeyAuth: []
tags:
  - name: Alert definitions service
    description: >-
      View and manage your alerts using alert definitions - data structures that
      contain the configuration required to create an alert.
    externalDocs:
      description: Learn more about alerts in our documentation
      url: https://coralogix.com/docs/user-guides/alerting/introduction-to-alerts/
  - name: Metrics Data Archive Service
    description: View and manage your storage targets for metrics.
    externalDocs:
      description: Find out more about archives
      url: >-
        https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/
  - name: Connectors service
    description: >-
      View and manage your connectors - integration instances for notification
      destinations
    externalDocs:
      description: Lean more about connectors in our documentation
      url: >-
        https://coralogix.com/docs/user-guides/notification-center/connectors/introduction/
  - name: Cases service
    description: >-
      Manage cases throughout their lifecycle. Create, view, assign,
      acknowledge, resolve, and close cases to streamline investigations and
      follow-ups.
    externalDocs:
      description: Learn more about Cases in our documentation
      url: https://coralogix.com/docs/user-guides/cases/
  - name: SAML Configuration Service
    description: Manage your SAML configuration
    externalDocs:
      url: ''
  - name: Events2Metrics Service
    description: Manage your events2metrics.
    externalDocs:
      url: ''
  - name: Presets service
    description: >-
      View and manage your presets - pre-configured templates for notification
      content rendering
    externalDocs:
      description: Lean more about presets in our documentation
      url: >-
        https://coralogix.com/docs/user-guides/notification-center/presets/introduction/
  - name: Entities service
    description: Query information about registered entities in the notification center
    externalDocs:
      description: Lean more about the notification center in our documentation
      url: https://coralogix.com/docs/user-guides/notification-center/introduction/
  - name: API Keys Service
    description: Manage your API Keys.
    externalDocs:
      url: ''
  - name: Alert events service
    description: >-
      Get information regarding your alert events - instances of alerts being
      triggered.
    externalDocs:
      description: Learn more about alert events and incidents in our documentation.
      url: https://coralogix.com/docs/user-guides/alerting/incidents/
  - name: Scopes Service
    description: A service to manage scopes
    externalDocs:
      url: ''
  - name: IP access service
    description: >-
      IP access service provides the API for managing company IP access
      settings.
    externalDocs:
      url: ''
  - name: Dashboard service
    description: Get information about the Coralogix Dashboard catalog.
    externalDocs:
      url: ''
  - name: Events Service
    description: A service for querying events.
    externalDocs:
      description: Learn more about alerts in our documentation
      url: https://coralogix.com/docs/user-guides/alerting/introduction-to-alerts/
  - name: Team Permissions Management Service
    description: Manage Team Groups.
    externalDocs:
      url: ''
  - name: Extension service
    description: A service that enables querying for extension information.
    externalDocs:
      description: Learn more about extensions in our documentation.
      url: https://coralogix.com/docs/integrations/extensions/
  - name: Extension testing service
    externalDocs:
      description: Find out more about extensions in our documentation.
      url: https://coralogix.com/docs/integrations/extensions/
  - name: Data Usage Service
    description: A service to manage data usage metrics.
    externalDocs:
      url: ''
  - name: Target Service
    description: View and manage your storage targets for logs.
    externalDocs:
      description: Find out more about archives
      url: >-
        https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/
  - name: Contextual data integration service
    description: Query for contextual data integration information.
    externalDocs:
      url: ''
  - name: Custom Enrichments Service
    description: Manage your enrichments.
    externalDocs:
      url: ''
  - name: Global routers service
    description: >-
      View and manage your global routers - entities that direct notifications
      to configured destinations based on conditions
    externalDocs:
      description: Lean more about global routers in our documentation
      url: >-
        https://coralogix.com/docs/user-guides/notification-center/routing/introduction/
  - name: Recording Rules Service
    description: A service to manage recording rules.
    externalDocs:
      url: ''
  - name: Folders for views service
    description: Create and manage view folders.
    externalDocs:
      url: ''
  - name: Incidents service
    description: >-
      Handle all operations related to incident management within Coralogix.
      Identify, manage, and resolve incidents efficiently through automated
      workflows and team collaboration.
    externalDocs:
      description: Find out more about incident management in our documentation
      url: https://coralogix.com/docs/user-guides/alerting/incidents/
  - name: Retentions Service
    description: View and manage retentions
    externalDocs:
      url: ''
  - name: Extension deployment service
    description: A service that enables querying for extension deployment information.
    externalDocs:
      description: Find out more about extensions in our documentation.
      url: https://coralogix.com/docs/integrations/extensions/
  - name: Enrichments Service
    description: Manage your enrichments.
    externalDocs:
      url: ''
  - name: Role Management Service
    description: Service for managing system and custom roles.
    externalDocs:
      url: ''
  - name: Integration service
    description: A service that enables querying for integration information.
    externalDocs:
      description: Find out more about integrations in our documentation.
      url: https://coralogix.com/docs/integrations/getting-started/
  - name: Rule Groups Service
    description: A service to manage rule groups.
    externalDocs:
      url: ''
  - name: Policies Service
    description: View and manage your TCO policies
    externalDocs:
      url: ''
  - name: Alert Scheduler Rule service
    description: Manage your alert scheduler rules.
    externalDocs:
      url: ''
  - name: Dashboard folders service
    description: Manage your dashboard folders.
    externalDocs:
      url: ''
  - name: Actions Service
    description: A service for managing actions.
    externalDocs:
      url: ''
  - name: Slos Service
    description: A service for managing Service Level Objectives (SLOs).
    externalDocs:
      url: ''
  - name: Views service
    description: Create and manage views.
    externalDocs:
      url: ''
  - name: Outgoing webhooks service
    externalDocs:
      description: Find out more about outbound webhooks in our documentation.
      url: >-
        https://coralogix.com/docs/user-guides/alerting/outbound-webhooks/generic-outbound-webhooks-alert-webhooks/
  - name: SLO Service
    description: Manage your SLOs.
    externalDocs:
      url: ''
paths:
  /v3/alert-event/{id}:
    get:
      tags:
        - Alert events service
      summary: Get alert event by ID
      description: No description available
      operationId: AlertEventService_GetAlertEvent
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
        - in: query
          name: order_bys
          required: false
          schema:
            items:
              type: object
              properties:
                direction:
                  $ref: '#/components/schemas/OrderByAlertEventDirection'
                fieldName:
                  $ref: '#/components/schemas/OrderByAlertEventFields'
            type: array
        - in: query
          name: pagination
          required: false
          schema:
            type: object
            properties:
              pageSize:
                type: integer
                format: int64
              pageToken:
                type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAlertEventResponse'
          description: ''
        '400':
          content:
            application/json: {}
          description: Bad Request
        '401':
          content:
            application/json: {}
          description: Unauthorized request
        '500':
          content:
            application/json: {}
          description: Internal server error
      externalDocs:
        url: ''
components:
  schemas:
    OrderByAlertEventDirection:
      enum:
        - ORDER_BY_ALERT_EVENT_DIRECTION_UNSPECIFIED
        - ORDER_BY_ALERT_EVENT_DIRECTION_ASC
        - ORDER_BY_ALERT_EVENT_DIRECTION_DESC
      type: string
    OrderByAlertEventFields:
      enum:
        - ORDER_BY_ALERT_EVENT_FIELDS_UNSPECIFIED
        - ORDER_BY_ALERT_EVENT_FIELDS_TIMESTAMP
      type: string
    GetAlertEventResponse:
      oneOf:
        - $ref: '#/components/schemas/GetAlertEventResponseMultiplePermutation'
        - $ref: '#/components/schemas/GetAlertEventResponseSinglePermutation'
    GetAlertEventResponseMultiplePermutation:
      title: Get alert event response
      type: object
      properties:
        id:
          type: string
        multiplePermutation:
          $ref: '#/components/schemas/AlertEventMultiplePermutation'
        pagination:
          $ref: '#/components/schemas/alerts.v3.PaginationResponse'
      additionalProperties: false
      externalDocs:
        url: ''
    GetAlertEventResponseSinglePermutation:
      title: Get alert event response
      type: object
      properties:
        id:
          type: string
        pagination:
          $ref: '#/components/schemas/alerts.v3.PaginationResponse'
        singlePermutation:
          $ref: '#/components/schemas/AlertEvent'
      additionalProperties: false
      externalDocs:
        url: ''
    AlertEventMultiplePermutation:
      type: object
      properties:
        alertEventMultiplePermutation:
          type: array
          items:
            $ref: '#/components/schemas/AlertEvent'
    alerts.v3.PaginationResponse:
      type: object
      properties:
        nextPageToken:
          type: string
        totalSize:
          type: integer
          format: int64
    AlertEvent:
      title: Alert event
      type: object
      properties:
        activityAnalysis:
          $ref: '#/components/schemas/ActivityAnalysis'
        alertId:
          type: string
        groupLabels:
          type: object
          additionalProperties:
            type: string
        incidentCorrelationKey:
          type: string
        payload:
          type: object
        payloadType:
          type: string
        permutationId:
          type: string
        permutationLabels:
          type: object
          additionalProperties:
            type: string
        preGroupingEventId:
          type: string
        status:
          $ref: '#/components/schemas/AlertStatus'
        timestamp:
          type: string
          format: date-time
      externalDocs:
        url: ''
    ActivityAnalysis:
      title: Activity analysis data structure
      type: object
      properties:
        rules:
          type: array
          items:
            type: string
        status:
          $ref: '#/components/schemas/ActivityAnalysisStatus'
      description: Configuration for alert activity analysis, containing rules and status.
      externalDocs:
        url: ''
    AlertStatus:
      enum:
        - ALERT_STATUS_RESOLVED_OR_UNSPECIFIED
        - ALERT_STATUS_TRIGGERED
      type: string
    ActivityAnalysisStatus:
      enum:
        - ACTIVITY_ANALYSIS_STATUS_ACTIVATE_OR_UNSPECIFIED
        - ACTIVITY_ANALYSIS_STATUS_MUTE
      type: string
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: API key authentication

````