Download OpenAPI specification:Download
API for editing and managing haproxy instances. Provides process information, configuration management, haproxy stats and logs.
Returns a list of API managed services endpoints.
Success
General Error
Returns a list of HAProxy related endpoints.
Success
General Error
Returns a list of HAProxy stats endpoints.
Success
General Error
Returns a list of endpoints to be used for advanced configuration of HAProxy objects.
Success
General Error
Return HAProxy process information
Success
General Error
Managing transactions. Configuration changes can be grouped in the transaction. You start the transaction with trasactions POST, and call the configuration changes you need with parameter transaction_id. When you want to commit the transaction, you call the transactions PUT and all changes in that transaction is commited. If you call a configuration change without the transaction_id, transaction mechanism is implicitly called with one operation in transaction.
Returns a list of HAProxy configuration transactions. Transactions can be filtered by their status.
| status | string Enum:"failed" "in_progress" Filter by transaction status |
Success
General Error
Starts a new transaction and returns it's id
| version required | integer Configuration version on which to work on |
Transaction started
General Error
Deletes a transaction.
| id required | string Transaction id |
Transaction deleted
The specified resource was not found
General Error
Returns one HAProxy configuration transactions.
| id required | string Transaction id |
Successful operation
The specified resource was not found
General Error
Commit transaction, execute all operations in transaction and return msg
| id required | string Transaction id |
| force_reload | boolean Default: false If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. |
Transaction succesfully commited
Configuration change accepted and reload requested
Bad request
The specified resource was not found
General Error
Checking reload success. To avoid constant reloading we reload in intervals that are configurable when with reload-delay option. When a change to configuration is made and force_reload url query string parameter is false we issue a request for reload, and return the reload ID in response header. You can then use reloads endpoints to check the status of that reload ID. If force_reload is true, we override all of this and reload immediately.
Returns a list of HAProxy reloads.
Success
General Error
Returns one HAProxy reload status.
| id required | string^\d{4}-\d{2}-\d{2}-\d+$ Reload id |
Successful operation
The specified resource was not found
General Error
Managing sites (simple configuration mode). Sites are considered as one frontend with multiple backends connected to it via default_backend or use-backend directives.
Returns an array of all configured sites.
| transaction_id | string ID of the transaction where we want to add the operation. Cannot be used when version is specified. |
Successful operation
General Error
Adds a new site to the configuration file.
| transaction_id | string ID of the transaction where we want to add the operation. Cannot be used when version is specified. |
| version | integer Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. |
| force_reload | boolean Default: false If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. |
| farms | Array of objects |
| name required | string^[A-Za-z0-9-_.:]+$ |
| service |