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

Update HA cluster reachability configuration

post
http://127.0.0.1:8080/orch-ha/reachability

Updates the IP addresses or DNS names used by appliances to reach orchestrator instances in an HA cluster. Allows configuring default reachability and label-specific overrides for multi-site deployments.

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

HA cluster reachability configuration with default and label-specific instance addresses

Configuration for how appliances reach orchestrator instances in an HA cluster. Defines IP/DNS addresses for default connectivity and optional label-specific overrides.

customDefaultReachability
array of objects
required
length ≥ 1

Default IP/DNS addresses for reaching each orchestrator instance. Required and must include all registered HA instances.

customDefaultReachability*

Mapping of an orchestrator instance to its reachability address (IP or DNS name).

string
required

Unique identifier of the orchestrator instance. Must match an existing registered HA instance ID.

string
required

IP address or DNS hostname used by appliances to reach this orchestrator instance.

reachabilityForLabel
array of objects

Optional label-specific overrides for appliance reachability. Each entry must have unique labelId and priority values.

reachabilityForLabel
Responses
200

Successfully updated HA cluster reachability configuration. Changes are logged to system audit.

401

Unauthorized - Authentication required

403

Forbidden - Insufficient permissions. Requires READ_WRITE role.

Updated about 13 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 13 hours ago

Did this page help you?