Skip to content

Add System HA Sync endpoint#901

Merged
jaredhendrickson13 merged 1 commit into
pfrest:next_minorfrom
TechAsen:feature/system-hasync-endpoint
Jun 6, 2026
Merged

Add System HA Sync endpoint#901
jaredhendrickson13 merged 1 commit into
pfrest:next_minorfrom
TechAsen:feature/system-hasync-endpoint

Conversation

@TechAsen
Copy link
Copy Markdown

Summary

Adds a new System / High Availability Sync REST API endpoint.

New endpoint:

  • GET /api/v2/system/hasync
  • PATCH /api/v2/system/hasync

Changes

  • Added RESTAPI\Models\HASync
  • Added RESTAPI\Endpoints\SystemHASyncEndpoint
  • Supports pfsync state sync settings
  • Supports XMLRPC config sync settings
  • Maps HA Sync boolean fields to on in config.xml
  • Maps API field password to pfSense config field passwordfld
  • Keeps password write-only and sensitive

Manual testing

Tested on a pfSense lab VM.

Validated:

  • pfsense-restapi buildendpoints
  • pfsense-restapi buildschemas
  • pfsense-restapi buildprivs
  • GET /api/v2/system/hasync
  • PATCH /api/v2/system/hasync
  • pfSense GUI reflects the updated HA Sync settings
  • Enabled checkbox values are written as on
  • XMLRPC sync password is written as passwordfld
  • Password is not returned by GET

@jaredhendrickson13 jaredhendrickson13 changed the base branch from master to next_minor June 6, 2026 00:17
Copy link
Copy Markdown
Member

@jaredhendrickson13 jaredhendrickson13 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, I'll have this in the next minor release.

Thanks!

@jaredhendrickson13 jaredhendrickson13 merged commit be9918b into pfrest:next_minor Jun 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants