Syslog Rules

User can create syslog rules with given attributes in their tenancy scope.

Notes

Users needs to be aware of the below properties of Syslog APIs

  • Rules or Profiles uniqueness is defined by uniqueId.
  • API endpoints need a uniqueId for reference.
  • It’s recommended that users should not delete a profile associated with a single rule in the filter.
  • Deleting profiles and rules are exclusive and are not dependent on each other.
  • Only the rules within the same tenant can be associated with the profile.

List the created rules for given tenant

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of tenant

Query Parameters

  • actionstring

    Query based on action i..e INCLUDE or EXCLUDE rules

    Enum:
    includeexclude
  • tagsstring

    Query/search the rules based on tags at each scope

  • uuidstring

    rule uuid

Responses

  • resultsarray

  • totalResultsinteger

  • orderBystring

  • pageNointeger

  • pageSizeinteger

  • totalPagesinteger

  • nextPageboolean

  • previousPageNointeger

  • descendingOrderboolean

Loading Examples...

Create config rule for given tenant

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of tenant

Request Body

application/json

  • namestring

    Syslog rule name

  • uuidstring

    Rule uuid.(Not required while creating a rule)

  • ruleActionstring

    Include or exclude the expression rule while filtering syslog messages

  • patternstring

    Filter pattern to filter syslog messages

  • metricNamestring

    Custom metric name for the alert generated

  • alertSubstring

    Alert Subject

  • alertDescstring

    Alert Description

  • alertServeritystring

    Alert Severity

    Enum:
    CriticalWarning
  • tagsstring

    Group Tag name of the rule

  • additionalPropertiesobject

    Additional details for alerts. Eg Resource Component.

Loading Examples...

Responses

Loading Examples...