Get Alert Details

Gets client's alert details by alertId

Notes

  • For an inference alert, resource name and client ID are provided in the response.
  • For an RCA alert, device ID, Name, and IP address are provided in the response.'

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

  • alertIdstringrequired

    Alert unique Identifier

Responses

  • uniqueIdstring

    Alert uuid

  • currentStatestringrequired

    Alert current state

  • serviceNamestringrequired

    Alert Metric

  • subjectstringrequired

    Alert Subject

  • appstringrequired

    Event source name which generates alert, For eg External monitoring tool like SCOM

  • descriptionstring

    Alert description details

  • oldStatestring

    Alert previous state from current sta

  • problemAreastring

  • acknowledgedboolean

    Alert akcnowledged

  • suppressedboolean

    Alert suppressed

  • permanentlySuppressedboolean

  • closedboolean

  • ticketedboolean

    Alert has incident created

  • clientUniqueIdstring

    Tenant uuid

  • alertTypestring

    OpsRamp Alerting type

    Enum:
    AgentObsoleteApplianceMonitoringScheduled MaintenanceForecastChange DetectionMONITORINGMaintenance
  • componentstring

    Component from which alert got generated

  • alertTimestring

    Time when alert was generated at source

  • deviceobject

  • resourceobject

    Resource Object details

  • monitorNamestring

    Applied monitor name for monitori

  • repeatCountstring

    Count of the alerts occured with similar state

  • tenantIdnumber

  • statusstring

  • prioritystring

    Alert priority

    Enum:
    P0P1P2P3P4P5N/A
  • elapsedTimeStringstring

  • createdDatestring

  • updatedTimestring

  • rbaboolean

    Run book automation applied

  • tenantNamestring

  • rtypestring

  • entityTypestring

  • mspNamestring

  • extAlertIdstring

  • managedByOpsRampboolean

  • actedTsnumber

  • metricTimenumber

  • eventTypestring

    Enum:
    ALERTRCAInferenceAlertINFERENCE
  • inferenceIdnumber

  • ignoreRecoveryNoiseboolean

  • availabilityboolean

  • snoozeDurationnumber

  • metricstring

  • isRecoveryAlertboolean

  • inferenceAlertboolean

  • statusHistoryobject

    Alert history

  • clientTechnologystring

  • customFieldsarray of strings

Loading Examples...