Search Alerts

Searches alerts of the tenant.

get
/api/v2/tenants/{tenantId}/alerts/search

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

Query Parameters

  • pageNointeger

    Current pagination number

  • pageSizeinteger

    No of records in each page

  • isDescendingOrderboolean

    Pagination data ordering: true for descending false for ascending

  • sortNamestring

    Field name on which paginated data is ordered

    Enum:
    idtsstartaltimec_namep_namesourcertypername
  • queryStringstring

    Generic query string to be prepared using query parameters

  • viewIDstring

  • statusHistorystring

  • statesstring

    Current state of the alert

    Enum:
    OkWarningCriticalInfo
  • startDatestring

    Filter the alert with alert base. startDate denotes the from date. Example: 2016-02-24T09:19:47 0000 (GMT)

  • endDatestring

    endDate denotes to date. Example: 2016-02-26T10:20:47 0000 (GMT)

  • uniqueIdstring

    uuid of the alert.

  • deviceStatusstring

    Status of the device

    Enum:
    manageunmanage
  • resourceTypestring

    Type of resource. Example:LOAD_BALANCER, SQS, EBS, DEVICE, SNS, REDSHIFT, SERVICE

  • resourceIdsstring

    ID of a resource. Example: DEV0000015754,148e892d-84ce-496c-a123-f91e1a8a3f7d.

  • actionsstring

    Actions performed on the alert. Example: ACKNOWLEDGED, TICKETED.

    Enum:
    ACKNOWLEDGEDTICKETEDCLOSEDIGNORESUPPRESSEDOPENPURGEDCORRELATED
  • alertTypesstring

    Types of alerts

    Enum:
    MonitoringMaintenanceApplianceAgentScheduled MaintenanceObsoleteIntegration Failure
  • metricsstring

    Metric type of the alert. Example: PING, SNMP Response.

  • durationstring

    Duration of alert. Duration is represented in Number of Days Example: 1, 7.

  • alertTimeBasestring

    Search for the alert based on the updated or created time of an alert. Example: updated.

    Enum:
    updatedcreated
  • clientIdsstring

    ID of clients. Example: client_1, client_2,526674ad-be06-4bdc-9634-e3b8c78b906e. Separate the IDs with a comma.

  • ticketIdstring

    ID of the ticket to which the alert is attached. Example: INC0000000001

  • appsstring

    Apps from which the alert is generated. Example: Email, Nagios

00