Health Rule Suppression API

Learn about the health rule suppression API to create, configure, update, and delete health rules suppression.

This page describes the Health rule suppression API methods that you can use to create, configure, update, and delete health rules suppression. This API is useful when performing maintenance activities or troubleshooting a component.

Create a Health Rule Suppression

The API endpoint creates a new health rule suppression from the provided JSON payload for the specified application.

Resource URL

JSON 
POST https://<controller_url>/controller/alerting/rest/v1/applications/{application-id}/health-rule-suppressions

Request/Response Format

JSON

Input Parameters

Parameter Location Type Required Description
application-id Path integer Yes The application ID for which the health rule suppression is created.
name Body string Yes The name of the health rule suppression. Maximum length is 100 characters.
suppressionScheduleType Body string Yes The scheduling type. Allowed values are ONE_TIME and RECURRING. Default is ONE_TIME.
timezone Body string Optional The time zone ID. If omitted, the controller time zone is used.
startTime Body string Optional The start date and time for a one-time suppression. For example, 2026-05-01T00:00:00.
endTime Body string Optional The end date and time for a one-time suppression. For example, 2026-05-02T00:00:00.
recurringSchedule Body object Optional Required for recurring suppressions. Supports DAILY, WEEKLY, MONTHLY_SPECIFIC_DATE, and MONTHLY_SPECIFIC_DAY schedules.
healthRuleScope Body object Optional Defines whether the suppression applies to all health rules or specific health rules. Allowed scope types are ALL_HEALTH_RULES and SPECIFIC_HEALTH_RULES.

Examples

Request:
JSON 
curl -X POST "https://localhost:8080/controller/alerting/rest/v1/applications/1/health-rule-suppressions" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Health Rule Suppression",
    "suppressionScheduleType": "ONE_TIME",
    "timezone": "America/Los_Angeles",
    "startTime": "2026-05-01T00:00:00",
    "endTime": "2026-05-02T00:00:00",
    "healthRuleScope": {
      "healthRuleScopeType": "SPECIFIC_HEALTH_RULES",
      "healthRules": [
        "My health rule 1",
        "My health rule 2"
      ]
    }
  }'
Response:
JSON 
{
  "id": 123,
  "name": "My Health Rule Suppression",
  "suppressionScheduleType": "ONE_TIME",
  "timezone": "America/Los_Angeles",
  "startTime": "2026-05-01T00:00:00",
  "endTime": "2026-05-02T00:00:00",
  "healthRuleScope": {
    "healthRuleScopeType": "SPECIFIC_HEALTH_RULES",
    "healthRules": [
      "My health rule 1",
      "My health rule 2"
    ]
  }
}

Retrieve a List of Health Rule Suppression for an Application

This API endpoint retrieves all health rule suppression configured for a given application. The response includes suppression summary information such as ID, name, timezone, schedule type, and schedule details.

Resource URL

JSON 
GET https://<controller_url>/controller/alerting/rest/v1/applications/{application-id}/health-rule-suppressions

Request/Response Format

JSON

Table 1. Input Parameter
Parameter Location Type Required Description
application-id Path integer Yes The application ID for which to retrieve health rule suppression summaries.

Examples

Request:
CODE 
curl -X GET "https://localhost:8080/controller/alerting/rest/v1/applications/1/health-rule-suppressions" \
  -H "Accept: application/json"
Response:
JSON 
[
  {
    "id": 123,
    "name": "My Health Rule Suppression",
    "timezone": "America/Los_Angeles",
    "suppressionScheduleType": "ONE_TIME",
    "startTime": "2026-05-01T00:00:00",
    "endTime": "2026-05-02T00:00:00"
  }
]

Retrieve the Details of a Health Rule Suppression

This API endpoint retrieves the health rule suppression for the specified application and suppression ID.

Resource URL

JSON 
GET https://<controller_url>/controller/alerting/rest/v1/applications/{application-id}/health-rule-suppressions/{health-rule-suppression-id}

Request/Response Format

JSON

Input Parameters

Parameter Location Type Required Description
application-id Path integer Yes The application ID that contains the health rule suppression.
health-rule-suppression-id Path integer Yes The ID of the health rule suppression for which to retrieve complete details.

Examples

Request:
CODE 
curl -X GET "https://localhost:8080/controller/alerting/rest/v1/applications/1/health-rule-suppressions/123" \
  -H "Accept: application/json"
Response:
JSON 
{
  "id": 123,
  "name": "My Health Rule Suppression",
  "suppressionScheduleType": "ONE_TIME",
  "timezone": "America/Los_Angeles",
  "startTime": "2026-05-01T00:00:00",
  "endTime": "2026-05-02T00:00:00",
  "healthRuleScope": {
    "healthRuleScopeType": "SPECIFIC_HEALTH_RULES",
    "healthRules": [
      "My health rule 1",
      "My health rule 2"
    ]
  }
}

Error codes

Error Code Error
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found

Update a Heath Rule Suppression

This API endpoint updates an existing health rule suppression with the provided JSON payload for the specified application and suppression ID.

Resource URL

JSON 
PUT https://<controller_url>/controller/alerting/rest/v1/applications/{application-id}/health-rule-suppressions/{health-rule-suppression-id}

Request/Response Format

JSON

Input Parameters

Parameter Location Type Required Description
application-id Path integer Yes The application ID that contains the health rule suppression to update.
health-rule-suppression-id Path integer Yes The ID of the health rule suppression to update.
name Body string Yes The updated name of the health rule suppression. Maximum length is 100 characters.
suppressionScheduleType Body string Yes The updated scheduling type. Allowed values are ONE_TIME and RECURRING. Default is ONE_TIME.
timezone Body string Optional The time zone ID. If omitted, the controller time zone is used.
startTime Body string Optional The updated start date and time for a one-time suppression. For example, 2026-05-01T00:00:00.
endTime Body string Optional The updated end date and time for a one-time suppression. For example, 2026-05-02T00:00:00.
recurringSchedule Body object Optional Required when suppressionScheduleType is RECURRING. Supports DAILY, WEEKLY, MONTHLY_SPECIFIC_DATE, and MONTHLY_SPECIFIC_DAY schedules.
healthRuleScope Body object Optional Defines whether the suppression applies to all health rules or specific health rules. Allowed scope types are ALL_HEALTH_RULES and SPECIFIC_HEALTH_RULES.

Example

Request:

JSON 
curl -X PUT "https://localhost:8080/controller/alerting/rest/v1/applications/1/health-rule-suppressions/123" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "name": "Weekly Maintenance Suppression",
    "suppressionScheduleType": "RECURRING",
    "timezone": "America/Los_Angeles",
    "recurringSchedule": {
      "scheduleFrequency": "WEEKLY",
      "days": [
        "SATURDAY"
      ],
      "startTime": "14:00",
      "endTime": "16:00"
    },
    "healthRuleScope": {
      "healthRuleScopeType": "ALL_HEALTH_RULES"
    }
  }'

Response:

JSON 
{
  "id": 123,
  "name": "Weekly Maintenance Suppression",
  "suppressionScheduleType": "RECURRING",
  "timezone": "America/Los_Angeles",
  "recurringSchedule": {
    "scheduleFrequency": "WEEKLY",
    "days": [
      "SATURDAY"
    ],
    "startTime": "14:00",
    "endTime": "16:00"
  },
  "healthRuleScope": {
    "healthRuleScopeType": "ALL_HEALTH_RULES"
  }
}

Error Codes

Error Code Error
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found

Delete a Health Rule Suppression

This API endpoint deletes an existing health rule suppression for the specified application. Provide a valid health rule suppression ID to delete the suppression configuration.

Resource URL

JSON 
DELETE https://<controller_url>/controller/alerting/rest/v1/applications/{application-id}/health-rule-suppressions/{health-rule-suppression-id}

Input Parameters

Parameter Location Type Required Description
application-id Path integer Yes The application ID that contains the health rule suppression to delete.
health-rule-suppression-id Path integer Yes The ID of the health rule suppression to delete.

Example

Request:

CODE 
curl -X DELETE "https://localhost:8080/controller/alerting/rest/v1/applications/1/health-rule-suppressions/123"

Response:

CODE 
204 No Content