HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. Orchestrator High Availability

Update HA notification configuration

put
http://127.0.0.1:8080/orch-ha/notificationConfig

Updates email notification settings for HA cluster health monitoring. Configures alert thresholds and recipient email for instance failure notifications. Resets any existing email alert state upon successful update.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

HA notification configuration object with email settings and failure threshold

Configuration for HA cluster email notifications when instance health checks fail.

boolean
Defaults to false

Whether email alerts are enabled for HA instance failures. When enabled, emailAddress must be provided.

integer
1 to 30
Defaults to 2

Time in minutes after which a missed health check triggers an email alert. Must be between 1 and 30 minutes.

string

Email address to receive HA failure alerts. Required when enabledEmailNotification is true.

Responses
204

Successfully updated HA notification configuration. No content returned.

401

Unauthorized - Authentication required

403

Forbidden - Insufficient permissions. Requires READ_WRITE role.

Updated about 11 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 11 hours ago

Did this page help you?