Alarms

Get Alarm Info

Display information that is about cleared and currently active alarms.

If the query size is less than 2048 characters, use the GET method.

GET https://{vmanage-ip-address}/dataservice/alarms?query=query

If the query size is more than 2048 characters, use the POST method. This is the recommended method.

POST https://{vmanage-ip-address}/dataservice/alarms

Example:

• Get 10,000 alarms from the previous 6 hours using the following query:

{
  "query": {
    "condition": "AND",
    "rules": [
      {
        "value": [
          "6"
        ],
        "field": "entry_time",
        "type": "date",
        "operator": "last_n_hours"
      }
    ]
  },
  "size": 10000
}

• Get critical alarms from the previous 3 hours:

{
  "query": {
    "condition": "AND",
    "rules": [
      {
        "value": [
          "3"
        ],
        "field": "entry_time",
        "type": "date",
        "operator": "last_n_hours"
      },
      {
        "value": [
          "Critical"
        ],
        "field": "severity",
        "type": "string",
        "operator": "in"
      }
    ]
  }
}

Get Supported Fields

Displays list of fields and corresponding data type for the alarm.

GET https://{vmanage-ip-address}/dataservice/alarms/fields

Event

Get Event Info

Display information about events.

If the query size is less than 2048 characters, use the GET method.

GET https://{vmanage-ip-address}/dataservice/events?query=query

If the query size is more than 2048 characters, use the POST method. This is the recommended method.

POST https://{vmanage-ip-address}/dataservice/events

Example:

• Get 10,000 events from the previous 6 hours using the following query:

{
  "query": {
    "condition": "AND",
    "rules": [
      {
        "value": [
          "6"
        ],
        "field": "entry_time",
        "type": "date",
        "operator": "last_n_hours"
      }
    ]
  },
  "size": 10000
}

• Get critical events from the previous 3 hours:

{
  "query": {
    "condition": "AND",
    "rules": [
      {
        "value": [
          "3"
        ],
        "field": "entry_time",
        "type": "date",
        "operator": "last_n_hours"
      },
      {
        "value": [
          "critical"
        ],
        "field": "severity_level",
        "type": "string",
        "operator": "in"
      }
    ]
  }
}

Get Supported Fields

Displays list of fields and corresponding data type for the event.

GET https://{vmanage-ip-address}/dataservice/events/fields

Audit Log

Get Event Info

Display information about audit logs.

If the query size is less than 2048 characters, use the GET method.

GET https://{vmanage-ip-address}/dataservice/auditlog?query=query

If the query size is more than 2048 characters, use the POST method. This is the recommended method.

POST https://{vmanage-ip-address}/dataservice/auditlog

Example:

• Get 10,000 audit log from the previous 6 hours using the following query:

{
  "query": {
    "condition": "AND",
    "rules": [
      {
        "value": [
          "6"
        ],
        "field": "entry_time",
        "type": "date",
        "operator": "last_n_hours"
      }
    ]
  },
  "size": 10000
}

• Get critical audit logs from the previous 3 hours:

{
  "query": {
    "condition": "AND",
    "rules": [
      {
        "value": [
          "3"
        ],
        "field": "entry_time",
        "type": "date",
        "operator": "last_n_hours"
      },
      {
        "value": [
          "critical"
        ],
        "field": "severity_level",
        "type": "string",
        "operator": "in"
      }
    ]
  }
}

Get Supported Fields

Displays a list of fields and corresponding data types for the audit log.

GET https://{vmanage-ip-address}/dataservice/auditlog/fields