Skip to main content
A newer release of this product is available.

Retrieve an event filter rule

Contributors
PDFs

GET /support/ems/filters/{name}/rules/{index}

Retrieves an event filter rule.

  • event filter show

Learn more

Parameters

Name Type In Required Description

name

string

path

True

Filter name

index

string

path

True

Filter index

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

index

integer

Rule index. Rules are evaluated in ascending order. If a rule's index order is not specified during creation, the rule is appended to the end of the list.

message_criteria

message_criteria

Matching message definitions for the filter. A property must be specified.

type

string

Rule type
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "index": 1,
  "message_criteria": {
    "_links": {
      "related": {
        "href": "/api/resourcelink"
      }
    },
    "name_pattern": "callhome.*",
    "severities": "error,informational",
    "snmp_trap_types": "standard|built_in"
  },
  "type": "include"
}

Error

Status: Default, Error
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": {
      "code": "string",
      "message": "string"
    },
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href

_links

Name Type Description

related

href

message_criteria

Matching message definitions for the filter. A property must be specified.

Name Type Description

_links

_links

name_pattern

string

Message name filter on which to match. Supports wildcards. Defaults to * if not specified.

severities

string

A comma-separated list of severities or a wildcard.

snmp_trap_types

string

A comma separated list of snmp_trap_types or a wildcard.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.