• HAProxy ALOHA

    Product Documentation

    • HAProxy Enterprise
    • HAProxy ALOHA
    • HAProxy Fusion Control Plane
    • HAProxy Unified Gateway
    • HAProxy Kubernetes Ingress Controller
    • HAProxy Edge

    API Documentation

    • HAProxy Data Plane API
    • HAProxy Fusion API
    • HAProxy Runtime API
    • HAProxy LUA API

    Configuration Documentation

    • HAProxy Config Tutorials
    • HAProxy Configuration Manual
Get HAProxy Leave Feedback
  • Light
  • Dark
  • System
  • HAProxy ALOHA
  • Changelog
  • Release notes
  • End-of-life dates
  • Getting started

    • Overview
    • Hardware models

      • ALB3200 (Deprecated)
      • ALB3350 (Deprecated)
      • ALB5200 (Deprecated)
      • ALB5300
      • ALB5350
    • Installation

      • Hardware appliance
      • Virtual appliance

        • KVM
        • Microsoft Hyper-V
        • VMware vSphere
        • VMware Workstation Player
    • Configuration wizard
    • License registration
  • Administration

    • Dynamic data updates
    • Factory reset
    • Firmware updates
    • High availability

      • Active/Active clustering
      • Active/Standby clustering
      • Configuration sync
    • Network

      • Default gateway
      • DNS
      • IP addresses
      • IP static routes
      • Isolate admin services
      • Link aggregation
      • Network interfaces
      • Network Management CLI
      • NTP
      • Policy-based routing
      • VLAN
      • Web UI
    • Troubleshooting

      • Cluster troubleshooting
      • Contact us
      • Core dump
      • Diagnostic tools
      • Firmware update troubleshooting
      • Network troubleshooting
      • Email and SNMP notifications
    • Users and passwords

      • Default password reset
      • LDAP authentication
      • RADIUS authentication
      • SSH Public Key Access
  • Load balancing

    • Overview
    • Layer 4 (LVS)

      • Overview
      • Direct Server Return
      • Health checks
      • Load balance Active FTP
      • Load balance UDP
      • LB Layer4 reference
    • Layer 7 (HAProxy)

      • Overview
      • Configuration tutorials
      • Configuration reference
      • Geolocation with MaxMind
      • Load balance UDP
    • Flows and outflows
    • GSLB
    • IP ACLs
    • NAT
    • Single sign-on

      • Kerberos
      • SAML
    • SSL
  • Observability

    • SNMP
    • Statistics
    • Logging
  • Bot management
  • PacketShield

    • Overview
    • Setup
    • Allowlists / denylists
    • Contexts
    • Instances
    • LVS and Synproxy
    • Metrics
    • Network Interfaces
    • Protected ports
  • Configuration API

    • Command line API
    • API Objects Reference

      • L4 farm
      • L4 server
      • L7 farm
      • L7 listeners
      • L7 rules
      • L7 server
      • L7 service
    • REST / JSON Web API

      • Usage
      • REST/JSON error codes
  • Data Plane API
  • Web Application Firewall
  1. HAProxy ALOHA Documentation
  2. Home
  3. HAProxy ALOHA HAProxy ALOHA
  4. Configuration API Configuration API
  5. REST / JSON Web API REST / JSON Web API

Configuration API

REST / JSON Web API

On this page
  1. Usage
  2. REST/JSON error codes
  • Usage

    Use the HTTP REST API.

  • REST/JSON error codes

    Diagnose errors for the HTTP REST API.

Do you have any suggestions on how we can improve the content of this page? Please leave feedback!

Previous page L7 service Next page Usage

On this page

  1. Usage
  2. REST/JSON error codes

Your feedback is important to us!

This site is protected by reCAPTCHA.
© 2026 HAProxy Technologies, LLC. All Rights Reserved
Manage Cookie Preferences

Privacy Settings

HAProxy's website uses cookies. By proceeding, you consent to our cookie usage. Please see our Privacy Policy and Cookie Policy for cookie usage details and instructions on how to disable cookies.
Privacy and Cookie Policy More information
Functional Cookies that make the website usable.
Analytics Help website owners understand how visitors interact with websites.
Ads Enables advertising related storage.
User data Consent for sending user data to Google for advertising purposes.
Ad personalization Consent for personalized advertising.
Show details
Consent date:
User Unique Id:
Deny
Save Accept and close
  • HAProxy ALOHA
  • Changelog
  • Release notes
  • End-of-life dates
  • Getting started

    • Overview
    • Hardware models

      • ALB3200 (Deprecated)
      • ALB3350 (Deprecated)
      • ALB5200 (Deprecated)
      • ALB5300
      • ALB5350
    • Installation

      • Hardware appliance
      • Virtual appliance

        • KVM
        • Microsoft Hyper-V
        • VMware vSphere
        • VMware Workstation Player
    • Configuration wizard
    • License registration
  • Administration

    • Dynamic data updates
    • Factory reset
    • Firmware updates
    • High availability

      • Active/Active clustering
      • Active/Standby clustering
      • Configuration sync
    • Network

      • Default gateway
      • DNS
      • IP addresses
      • IP static routes
      • Isolate admin services
      • Link aggregation
      • Network interfaces
      • Network Management CLI
      • NTP
      • Policy-based routing
      • VLAN
      • Web UI
    • Troubleshooting

      • Cluster troubleshooting
      • Contact us
      • Core dump
      • Diagnostic tools
      • Firmware update troubleshooting
      • Network troubleshooting
      • Email and SNMP notifications
    • Users and passwords

      • Default password reset
      • LDAP authentication
      • RADIUS authentication
      • SSH Public Key Access
  • Load balancing

    • Overview
    • Layer 4 (LVS)

      • Overview
      • Direct Server Return
      • Health checks
      • Load balance Active FTP
      • Load balance UDP
      • LB Layer4 reference
    • Layer 7 (HAProxy)

      • Overview
      • Configuration tutorials
      • Configuration reference
      • Geolocation with MaxMind
      • Load balance UDP
    • Flows and outflows
    • GSLB
    • IP ACLs
    • NAT
    • Single sign-on

      • Kerberos
      • SAML
    • SSL
  • Observability

    • SNMP
    • Statistics
    • Logging
  • Bot management
  • PacketShield

    • Overview
    • Setup
    • Allowlists / denylists
    • Contexts
    • Instances
    • LVS and Synproxy
    • Metrics
    • Network Interfaces
    • Protected ports
  • Configuration API

    • Command line API
    • API Objects Reference

      • L4 farm
      • L4 server
      • L7 farm
      • L7 listeners
      • L7 rules
      • L7 server
      • L7 service
    • REST / JSON Web API

      • Usage
      • REST/JSON error codes
  • Data Plane API
  • Web Application Firewall

Products Documentation

  • HAProxy Enterprise
  • HAProxy ALOHA
  • HAProxy Fusion Control Plane
  • HAProxy Unified Gateway
  • HAProxy Kubernetes Ingress Controller
  • HAProxy Edge

API Documentation

  • HAProxy Data Plane API
  • HAProxy Fusion API
  • HAProxy Runtime API
  • HAProxy LUA API

Configuration Documentation

  • HAProxy Config Tutorials
  • HAProxy Configuration Manual