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
- tenantId
Describes the clientId or mspId of tenant
Query Parameters
- action
Query based on action i..e INCLUDE or EXCLUDE rules
- Enum:
- includeexclude
- tags
Query/search the rules based on tags at each scope
- uuid
rule uuid
Responses
- results
- totalResults
- orderBy
- pageNo
- pageSize
- totalPages
- nextPage
- previousPageNo
- descendingOrder
Create config rule for given tenant
Path Parameters
- tenantId
Describes the clientId or mspId of tenant
Request Body
application/json
- name
Syslog rule name
- uuid
Rule uuid.(Not required while creating a rule)
- ruleAction
Include or exclude the expression rule while filtering syslog messages
- pattern
Filter pattern to filter syslog messages
- metricName
Custom metric name for the alert generated
- alertSub
Alert Subject
- alertDesc
Alert Description
- alertServerity
Alert Severity
- Enum:
- CriticalWarning
- tags
Group Tag name of the rule
- additionalProperties
Additional details for alerts. Eg Resource Component.