mrkaminski/haproxy-client-php

OpenAPI for HAProxy DataPlanApi - PHP

Maintainers

Details

github.com/mrkaminski/haproxy-client-php

Homepage

Source

Issues

Installs: 1

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

pkg:composer/mrkaminski/haproxy-client-php

dev-master 2020-04-17 18:50 UTC

Requires

Requires (Dev)

proprietary a2eda66723a9d8bf77b5ace9df091fb5f4995019

phpapisdkhaproxyswaggerdataplanapi

This package is auto-updated.

Last update: 2026-01-18 06:56:53 UTC

README

API for editing and managing haproxy instances. Provides process information, configuration management, haproxy stats and logs. # Authentication

This PHP package is automatically generated by the Swagger Codegen project:

Requirements

PHP 5.5 and later

Installation & Usage

Composer

run composer require mrkaminski/haproxy-client-php

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basic_auth
$config = Swagger\Client\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new Swagger\Client\Api\ACLApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \Swagger\Client\Model\Acl(); // \Swagger\Client\Model\Acl | 
$parent_name = "parent_name_example"; // string | Parent name
$parent_type = "parent_type_example"; // string | Parent type
$transaction_id = "transaction_id_example"; // string | ID of the transaction where we want to add the operation. Cannot be used when version is specified.
$version = 56; // int | Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version.
$force_reload = false; // bool | 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.

try {
    $result = $apiInstance->createAcl($body, $parent_name, $parent_type, $transaction_id, $version, $force_reload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACLApi->createAcl: ', $e->getMessage(), PHP_EOL;
}
// Configure HTTP basic authorization: basic_auth
$config = Swagger\Client\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new Swagger\Client\Api\ACLApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 56; // int | ACL line ID
$parent_name = "parent_name_example"; // string | Parent name
$parent_type = "parent_type_example"; // string | Parent type
$transaction_id = "transaction_id_example"; // string | ID of the transaction where we want to add the operation. Cannot be used when version is specified.
$version = 56; // int | Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version.
$force_reload = false; // bool | 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.

try {
    $apiInstance->deleteAcl($id, $parent_name, $parent_type, $transaction_id, $version, $force_reload);
} catch (Exception $e) {
    echo 'Exception when calling ACLApi->deleteAcl: ', $e->getMessage(), PHP_EOL;
}
// Configure HTTP basic authorization: basic_auth
$config = Swagger\Client\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new Swagger\Client\Api\ACLApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 56; // int | ACL line ID
$parent_name = "parent_name_example"; // string | Parent name
$parent_type = "parent_type_example"; // string | Parent type
$transaction_id = "transaction_id_example"; // string | ID of the transaction where we want to add the operation. Cannot be used when version is specified.

try {
    $result = $apiInstance->getAcl($id, $parent_name, $parent_type, $transaction_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACLApi->getAcl: ', $e->getMessage(), PHP_EOL;
}
// Configure HTTP basic authorization: basic_auth
$config = Swagger\Client\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new Swagger\Client\Api\ACLApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$parent_name = "parent_name_example"; // string | Parent name
$parent_type = "parent_type_example"; // string | Parent type
$transaction_id = "transaction_id_example"; // string | ID of the transaction where we want to add the operation. Cannot be used when version is specified.

try {
    $result = $apiInstance->getAcls($parent_name, $parent_type, $transaction_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACLApi->getAcls: ', $e->getMessage(), PHP_EOL;
}
// Configure HTTP basic authorization: basic_auth
$config = Swagger\Client\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new Swagger\Client\Api\ACLApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \Swagger\Client\Model\Acl(); // \Swagger\Client\Model\Acl | 
$parent_name = "parent_name_example"; // string | Parent name
$parent_type = "parent_type_example"; // string | Parent type
$id = 56; // int | ACL line ID
$transaction_id = "transaction_id_example"; // string | ID of the transaction where we want to add the operation. Cannot be used when version is specified.
$version = 56; // int | Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version.
$force_reload = false; // bool | 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.

try {
    $result = $apiInstance->replaceAcl($body, $parent_name, $parent_type, $id, $transaction_id, $version, $force_reload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACLApi->replaceAcl: ', $e->getMessage(), PHP_EOL;
}
?>

Documentation for API Endpoints

All URIs are relative to /v2

Class Method HTTP request Description
ACLApi createAcl POST /services/haproxy/configuration/acls Add a new ACL line
ACLApi deleteAcl DELETE /services/haproxy/configuration/acls/{id} Delete a ACL line
ACLApi getAcl GET /services/haproxy/configuration/acls/{id} Return one ACL line
ACLApi getAcls GET /services/haproxy/configuration/acls Return an array of all ACL lines
ACLApi replaceAcl PUT /services/haproxy/configuration/acls/{id} Replace a ACL line
BackendApi createBackend POST /services/haproxy/configuration/backends Add a backend
BackendApi deleteBackend DELETE /services/haproxy/configuration/backends/{name} Delete a backend
BackendApi getBackend GET /services/haproxy/configuration/backends/{name} Return a backend
BackendApi getBackends GET /services/haproxy/configuration/backends Return an array of backends
BackendApi replaceBackend PUT /services/haproxy/configuration/backends/{name} Replace a backend
BackendOptionsApi createAcl POST /services/haproxy/configuration/acls Add a new ACL line
BackendOptionsApi createFilter POST /services/haproxy/configuration/filters Add a new Filter
BackendOptionsApi createHTTPRequestRule POST /services/haproxy/configuration/http_request_rules Add a new HTTP Request Rule
BackendOptionsApi createHTTPResponseRule POST /services/haproxy/configuration/http_response_rules Add a new HTTP Response Rule
BackendOptionsApi createLogTarget POST /services/haproxy/configuration/log_targets Add a new Log Target
BackendOptionsApi createServer POST /services/haproxy/configuration/servers Add a new server
BackendOptionsApi createServerSwitchingRule POST /services/haproxy/configuration/server_switching_rules Add a new Server Switching Rule
BackendOptionsApi createStickRule POST /services/haproxy/configuration/stick_rules Add a new Stick Rule
BackendOptionsApi createTCPRequestRule POST /services/haproxy/configuration/tcp_request_rules Add a new TCP Request Rule
BackendOptionsApi createTCPResponseRule POST /services/haproxy/configuration/tcp_response_rules Add a new TCP Response Rule
BackendOptionsApi deleteAcl DELETE /services/haproxy/configuration/acls/{id} Delete a ACL line
BackendOptionsApi deleteFilter DELETE /services/haproxy/configuration/filters/{id} Delete a Filter
BackendOptionsApi deleteHTTPRequestRule DELETE /services/haproxy/configuration/http_request_rules/{id} Delete a HTTP Request Rule
BackendOptionsApi deleteHTTPResponseRule DELETE /services/haproxy/configuration/http_response_rules/{id} Delete a HTTP Response Rule
BackendOptionsApi deleteLogTarget DELETE /services/haproxy/configuration/log_targets/{id} Delete a Log Target
BackendOptionsApi deleteServer DELETE /services/haproxy/configuration/servers/{name} Delete a server
BackendOptionsApi deleteServerSwitchingRule DELETE /services/haproxy/configuration/server_switching_rules/{id} Delete a Server Switching Rule
BackendOptionsApi deleteStickRule DELETE /services/haproxy/configuration/stick_rules/{id} Delete a Stick Rule
BackendOptionsApi deleteTCPRequestRule DELETE /services/haproxy/configuration/tcp_request_rules/{id} Delete a TCP Request Rule
BackendOptionsApi deleteTCPResponseRule DELETE /services/haproxy/configuration/tcp_response_rules/{id} Delete a TCP Response Rule
BackendOptionsApi getAcl GET /services/haproxy/configuration/acls/{id} Return one ACL line
BackendOptionsApi getAcls GET /services/haproxy/configuration/acls Return an array of all ACL lines
BackendOptionsApi getFilter GET /services/haproxy/configuration/filters/{id} Return one Filter
BackendOptionsApi getFilters GET /services/haproxy/configuration/filters Return an array of all Filters
BackendOptionsApi getHTTPRequestRule GET /services/haproxy/configuration/http_request_rules/{id} Return one HTTP Request Rule
BackendOptionsApi getHTTPRequestRules GET /services/haproxy/configuration/http_request_rules Return an array of all HTTP Request Rules
BackendOptionsApi getHTTPResponseRule GET /services/haproxy/configuration/http_response_rules/{id} Return one HTTP Response Rule
BackendOptionsApi getHTTPResponseRules GET /services/haproxy/configuration/http_response_rules Return an array of all HTTP Response Rules
BackendOptionsApi getLogTarget GET /services/haproxy/configuration/log_targets/{id} Return one Log Target
BackendOptionsApi getLogTargets GET /services/haproxy/configuration/log_targets Return an array of all Log Targets
BackendOptionsApi getRuntimeServer GET /services/haproxy/runtime/servers/{name} Return one server runtime settings
BackendOptionsApi getRuntimeServers GET /services/haproxy/runtime/servers Return an array of runtime servers' setings
BackendOptionsApi getServer GET /services/haproxy/configuration/servers/{name} Return one server
BackendOptionsApi getServerSwitchingRule GET /services/haproxy/configuration/server_switching_rules/{id} Return one Server Switching Rule
BackendOptionsApi getServerSwitchingRules GET /services/haproxy/configuration/server_switching_rules Return an array of all Server Switching Rules
BackendOptionsApi getServers GET /services/haproxy/configuration/servers Return an array of servers
BackendOptionsApi getStickRule GET /services/haproxy/configuration/stick_rules/{id} Return one Stick Rule
BackendOptionsApi getStickRules GET /services/haproxy/configuration/stick_rules Return an array of all Stick Rules
BackendOptionsApi getTCPRequestRule GET /services/haproxy/configuration/tcp_request_rules/{id} Return one TCP Request Rule
BackendOptionsApi getTCPRequestRules GET /services/haproxy/configuration/tcp_request_rules Return an array of all TCP Request Rules
BackendOptionsApi getTCPResponseRule GET /services/haproxy/configuration/tcp_response_rules/{id} Return one TCP Response Rule
BackendOptionsApi getTCPResponseRules GET /services/haproxy/configuration/tcp_response_rules Return an array of all TCP Response Rules
BackendOptionsApi replaceAcl PUT /services/haproxy/configuration/acls/{id} Replace a ACL line
BackendOptionsApi replaceFilter PUT /services/haproxy/configuration/filters/{id} Replace a Filter
BackendOptionsApi replaceHTTPRequestRule PUT /services/haproxy/configuration/http_request_rules/{id} Replace a HTTP Request Rule
BackendOptionsApi replaceHTTPResponseRule PUT /services/haproxy/configuration/http_response_rules/{id} Replace a HTTP Response Rule
BackendOptionsApi replaceLogTarget PUT /services/haproxy/configuration/log_targets/{id} Replace a Log Target
BackendOptionsApi replaceRuntimeServer PUT /services/haproxy/runtime/servers/{name} Replace server transient settings
BackendOptionsApi replaceServer PUT /services/haproxy/configuration/servers/{name} Replace a server
BackendOptionsApi replaceServerSwitchingRule PUT /services/haproxy/configuration/server_switching_rules/{id} Replace a Server Switching Rule
BackendOptionsApi replaceStickRule PUT /services/haproxy/configuration/stick_rules/{id} Replace a Stick Rule
BackendOptionsApi replaceTCPRequestRule PUT /services/haproxy/configuration/tcp_request_rules/{id} Replace a TCP Request Rule
BackendOptionsApi replaceTCPResponseRule PUT /services/haproxy/configuration/tcp_response_rules/{id} Replace a TCP Response Rule
BackendSwitchingRuleApi createBackendSwitchingRule POST /services/haproxy/configuration/backend_switching_rules Add a new Backend Switching Rule
BackendSwitchingRuleApi deleteBackendSwitchingRule DELETE /services/haproxy/configuration/backend_switching_rules/{id} Delete a Backend Switching Rule
BackendSwitchingRuleApi getBackendSwitchingRule GET /services/haproxy/configuration/backend_switching_rules/{id} Return one Backend Switching Rule
BackendSwitchingRuleApi getBackendSwitchingRules GET /services/haproxy/configuration/backend_switching_rules Return an array of all Backend Switching Rules
BackendSwitchingRuleApi replaceBackendSwitchingRule PUT /services/haproxy/configuration/backend_switching_rules/{id} Replace a Backend Switching Rule
BindApi createBind POST /services/haproxy/configuration/binds Add a new bind
BindApi deleteBind DELETE /services/haproxy/configuration/binds/{name} Delete a bind
BindApi getBind GET /services/haproxy/configuration/binds/{name} Return one bind
BindApi getBinds GET /services/haproxy/configuration/binds Return an array of binds
BindApi replaceBind PUT /services/haproxy/configuration/binds/{name} Replace a bind
ConfigurationApi getHAProxyConfiguration GET /services/haproxy/configuration/raw Return HAProxy configuration
ConfigurationApi postHAProxyConfiguration POST /services/haproxy/configuration/raw Push new haproxy configuration
DefaultsApi getDefaults GET /services/haproxy/configuration/defaults Return defaults part of configuration
DefaultsApi replaceDefaults PUT /services/haproxy/configuration/defaults Replace defaults
DiscoveryApi getAPIEndpoints GET / Return list of root endpoints
DiscoveryApi getConfigurationEndpoints GET /services/haproxy/configuration Return list of HAProxy advanced configuration endpoints
DiscoveryApi getHaproxyEndpoints GET /services/haproxy Return list of HAProxy related endpoints
DiscoveryApi getRuntimeEndpoints GET /services/haproxy/runtime Return list of HAProxy advanced runtime endpoints
DiscoveryApi getServicesEndpoints GET /services Return list of service endpoints
DiscoveryApi getStatsEndpoints GET /services/haproxy/stats Return list of HAProxy stats endpoints
FilterApi createFilter POST /services/haproxy/configuration/filters Add a new Filter
FilterApi deleteFilter DELETE /services/haproxy/configuration/filters/{id} Delete a Filter
FilterApi getFilter GET /services/haproxy/configuration/filters/{id} Return one Filter
FilterApi getFilters GET /services/haproxy/configuration/filters Return an array of all Filters
FilterApi replaceFilter PUT /services/haproxy/configuration/filters/{id} Replace a Filter
FrontendApi createFrontend POST /services/haproxy/configuration/frontends Add a frontend
FrontendApi deleteFrontend DELETE /services/haproxy/configuration/frontends/{name} Delete a frontend
FrontendApi getFrontend GET /services/haproxy/configuration/frontends/{name} Return a frontend
FrontendApi getFrontends GET /services/haproxy/configuration/frontends Return an array of frontends
FrontendApi replaceFrontend PUT /services/haproxy/configuration/frontends/{name} Replace a frontend
FrontendOptionsApi createAcl POST /services/haproxy/configuration/acls Add a new ACL line
FrontendOptionsApi createBackendSwitchingRule POST /services/haproxy/configuration/backend_switching_rules Add a new Backend Switching Rule
FrontendOptionsApi createBind POST /services/haproxy/configuration/binds Add a new bind
FrontendOptionsApi createFilter POST /services/haproxy/configuration/filters Add a new Filter
FrontendOptionsApi createHTTPRequestRule POST /services/haproxy/configuration/http_request_rules Add a new HTTP Request Rule
FrontendOptionsApi createHTTPResponseRule POST /services/haproxy/configuration/http_response_rules Add a new HTTP Response Rule
FrontendOptionsApi createLogTarget POST /services/haproxy/configuration/log_targets Add a new Log Target
FrontendOptionsApi createTCPRequestRule POST /services/haproxy/configuration/tcp_request_rules Add a new TCP Request Rule
FrontendOptionsApi createTCPResponseRule POST /services/haproxy/configuration/tcp_response_rules Add a new TCP Response Rule
FrontendOptionsApi deleteAcl DELETE /services/haproxy/configuration/acls/{id} Delete a ACL line
FrontendOptionsApi deleteBackendSwitchingRule DELETE /services/haproxy/configuration/backend_switching_rules/{id} Delete a Backend Switching Rule
FrontendOptionsApi deleteBind DELETE /services/haproxy/configuration/binds/{name} Delete a bind
FrontendOptionsApi deleteFilter DELETE /services/haproxy/configuration/filters/{id} Delete a Filter
FrontendOptionsApi deleteHTTPRequestRule DELETE /services/haproxy/configuration/http_request_rules/{id} Delete a HTTP Request Rule
FrontendOptionsApi deleteHTTPResponseRule DELETE /services/haproxy/configuration/http_response_rules/{id} Delete a HTTP Response Rule
FrontendOptionsApi deleteLogTarget DELETE /services/haproxy/configuration/log_targets/{id} Delete a Log Target
FrontendOptionsApi deleteTCPRequestRule DELETE /services/haproxy/configuration/tcp_request_rules/{id} Delete a TCP Request Rule
FrontendOptionsApi deleteTCPResponseRule DELETE /services/haproxy/configuration/tcp_response_rules/{id} Delete a TCP Response Rule
FrontendOptionsApi getAcl GET /services/haproxy/configuration/acls/{id} Return one ACL line
FrontendOptionsApi getAcls GET /services/haproxy/configuration/acls Return an array of all ACL lines
FrontendOptionsApi getBackendSwitchingRule GET /services/haproxy/configuration/backend_switching_rules/{id} Return one Backend Switching Rule
FrontendOptionsApi getBackendSwitchingRules GET /services/haproxy/configuration/backend_switching_rules Return an array of all Backend Switching Rules
FrontendOptionsApi getBind GET /services/haproxy/configuration/binds/{name} Return one bind
FrontendOptionsApi getBinds GET /services/haproxy/configuration/binds Return an array of binds
FrontendOptionsApi getFilter GET /services/haproxy/configuration/filters/{id} Return one Filter
FrontendOptionsApi getFilters GET /services/haproxy/configuration/filters Return an array of all Filters
FrontendOptionsApi getHTTPRequestRule GET /services/haproxy/configuration/http_request_rules/{id} Return one HTTP Request Rule
FrontendOptionsApi getHTTPRequestRules GET /services/haproxy/configuration/http_request_rules Return an array of all HTTP Request Rules
FrontendOptionsApi getHTTPResponseRule GET /services/haproxy/configuration/http_response_rules/{id} Return one HTTP Response Rule
FrontendOptionsApi getHTTPResponseRules GET /services/haproxy/configuration/http_response_rules Return an array of all HTTP Response Rules
FrontendOptionsApi getLogTarget GET /services/haproxy/configuration/log_targets/{id} Return one Log Target
FrontendOptionsApi getLogTargets GET /services/haproxy/configuration/log_targets Return an array of all Log Targets
FrontendOptionsApi getTCPRequestRule GET /services/haproxy/configuration/tcp_request_rules/{id} Return one TCP Request Rule
FrontendOptionsApi getTCPRequestRules GET /services/haproxy/configuration/tcp_request_rules Return an array of all TCP Request Rules
FrontendOptionsApi getTCPResponseRule GET /services/haproxy/configuration/tcp_response_rules/{id} Return one TCP Response Rule
FrontendOptionsApi getTCPResponseRules GET /services/haproxy/configuration/tcp_response_rules Return an array of all TCP Response Rules
FrontendOptionsApi replaceAcl PUT /services/haproxy/configuration/acls/{id} Replace a ACL line
FrontendOptionsApi replaceBackendSwitchingRule PUT /services/haproxy/configuration/backend_switching_rules/{id} Replace a Backend Switching Rule
FrontendOptionsApi replaceBind PUT /services/haproxy/configuration/binds/{name} Replace a bind
FrontendOptionsApi replaceFilter PUT /services/haproxy/configuration/filters/{id} Replace a Filter
FrontendOptionsApi replaceHTTPRequestRule PUT /services/haproxy/configuration/http_request_rules/{id} Replace a HTTP Request Rule
FrontendOptionsApi replaceHTTPResponseRule PUT /services/haproxy/configuration/http_response_rules/{id} Replace a HTTP Response Rule
FrontendOptionsApi replaceLogTarget PUT /services/haproxy/configuration/log_targets/{id} Replace a Log Target
FrontendOptionsApi replaceTCPRequestRule PUT /services/haproxy/configuration/tcp_request_rules/{id} Replace a TCP Request Rule
FrontendOptionsApi replaceTCPResponseRule PUT /services/haproxy/configuration/tcp_response_rules/{id} Replace a TCP Response Rule
GlobalApi getGlobal GET /services/haproxy/configuration/global Return a global part of configuration
GlobalApi replaceGlobal PUT /services/haproxy/configuration/global Replace global
HAProxyConfigurationManagementApi createAcl POST /services/haproxy/configuration/acls Add a new ACL line
HAProxyConfigurationManagementApi createBackend POST /services/haproxy/configuration/backends Add a backend
HAProxyConfigurationManagementApi createBackendSwitchingRule POST /services/haproxy/configuration/backend_switching_rules Add a new Backend Switching Rule
HAProxyConfigurationManagementApi createBind POST /services/haproxy/configuration/binds Add a new bind
HAProxyConfigurationManagementApi createFilter POST /services/haproxy/configuration/filters Add a new Filter
HAProxyConfigurationManagementApi createFrontend POST /services/haproxy/configuration/frontends Add a frontend
HAProxyConfigurationManagementApi createHTTPRequestRule POST /services/haproxy/configuration/http_request_rules Add a new HTTP Request Rule
HAProxyConfigurationManagementApi createHTTPResponseRule POST /services/haproxy/configuration/http_response_rules Add a new HTTP Response Rule
HAProxyConfigurationManagementApi createLogTarget POST /services/haproxy/configuration/log_targets Add a new Log Target
HAProxyConfigurationManagementApi createServer POST /services/haproxy/configuration/servers Add a new server
HAProxyConfigurationManagementApi createServerSwitchingRule POST /services/haproxy/configuration/server_switching_rules Add a new Server Switching Rule
HAProxyConfigurationManagementApi createStickRule POST /services/haproxy/configuration/stick_rules Add a new Stick Rule
HAProxyConfigurationManagementApi createTCPRequestRule POST /services/haproxy/configuration/tcp_request_rules Add a new TCP Request Rule
HAProxyConfigurationManagementApi createTCPResponseRule POST /services/haproxy/configuration/tcp_response_rules Add a new TCP Response Rule
HAProxyConfigurationManagementApi deleteAcl DELETE /services/haproxy/configuration/acls/{id} Delete a ACL line
HAProxyConfigurationManagementApi deleteBackend DELETE /services/haproxy/configuration/backends/{name} Delete a backend
HAProxyConfigurationManagementApi deleteBackendSwitchingRule DELETE /services/haproxy/configuration/backend_switching_rules/{id} Delete a Backend Switching Rule
HAProxyConfigurationManagementApi deleteBind DELETE /services/haproxy/configuration/binds/{name} Delete a bind
HAProxyConfigurationManagementApi deleteFilter DELETE /services/haproxy/configuration/filters/{id} Delete a Filter
HAProxyConfigurationManagementApi deleteFrontend DELETE /services/haproxy/configuration/frontends/{name} Delete a frontend
HAProxyConfigurationManagementApi deleteHTTPRequestRule DELETE /services/haproxy/configuration/http_request_rules/{id} Delete a HTTP Request Rule
HAProxyConfigurationManagementApi deleteHTTPResponseRule DELETE /services/haproxy/configuration/http_response_rules/{id} Delete a HTTP Response Rule
HAProxyConfigurationManagementApi deleteLogTarget DELETE /services/haproxy/configuration/log_targets/{id} Delete a Log Target
HAProxyConfigurationManagementApi deleteServer DELETE /services/haproxy/configuration/servers/{name} Delete a server
HAProxyConfigurationManagementApi deleteServerSwitchingRule DELETE /services/haproxy/configuration/server_switching_rules/{id} Delete a Server Switching Rule
HAProxyConfigurationManagementApi deleteStickRule DELETE /services/haproxy/configuration/stick_rules/{id} Delete a Stick Rule
HAProxyConfigurationManagementApi deleteTCPRequestRule DELETE /services/haproxy/configuration/tcp_request_rules/{id} Delete a TCP Request Rule
HAProxyConfigurationManagementApi deleteTCPResponseRule DELETE /services/haproxy/configuration/tcp_response_rules/{id} Delete a TCP Response Rule
HAProxyConfigurationManagementApi getAcl GET /services/haproxy/configuration/acls/{id} Return one ACL line
HAProxyConfigurationManagementApi getAcls GET /services/haproxy/configuration/acls Return an array of all ACL lines
HAProxyConfigurationManagementApi getBackend GET /services/haproxy/configuration/backends/{name} Return a backend
HAProxyConfigurationManagementApi getBackendSwitchingRule GET /services/haproxy/configuration/backend_switching_rules/{id} Return one Backend Switching Rule
HAProxyConfigurationManagementApi getBackendSwitchingRules GET /services/haproxy/configuration/backend_switching_rules Return an array of all Backend Switching Rules
HAProxyConfigurationManagementApi getBackends GET /services/haproxy/configuration/backends Return an array of backends
HAProxyConfigurationManagementApi getBind GET /services/haproxy/configuration/binds/{name} Return one bind
HAProxyConfigurationManagementApi getBinds GET /services/haproxy/configuration/binds Return an array of binds
HAProxyConfigurationManagementApi getDefaults GET /services/haproxy/configuration/defaults Return defaults part of configuration
HAProxyConfigurationManagementApi getFilter GET /services/haproxy/configuration/filters/{id} Return one Filter
HAProxyConfigurationManagementApi getFilters GET /services/haproxy/configuration/filters Return an array of all Filters
HAProxyConfigurationManagementApi getFrontend GET /services/haproxy/configuration/frontends/{name} Return a frontend
HAProxyConfigurationManagementApi getFrontends GET /services/haproxy/configuration/frontends Return an array of frontends
HAProxyConfigurationManagementApi getGlobal GET /services/haproxy/configuration/global Return a global part of configuration
HAProxyConfigurationManagementApi getHAProxyConfiguration GET /services/haproxy/configuration/raw Return HAProxy configuration
HAProxyConfigurationManagementApi getHTTPRequestRule GET /services/haproxy/configuration/http_request_rules/{id} Return one HTTP Request Rule
HAProxyConfigurationManagementApi getHTTPRequestRules GET /services/haproxy/configuration/http_request_rules Return an array of all HTTP Request Rules
HAProxyConfigurationManagementApi getHTTPResponseRule GET /services/haproxy/configuration/http_response_rules/{id} Return one HTTP Response Rule
HAProxyConfigurationManagementApi getHTTPResponseRules GET /services/haproxy/configuration/http_response_rules Return an array of all HTTP Response Rules
HAProxyConfigurationManagementApi getLogTarget GET /services/haproxy/configuration/log_targets/{id} Return one Log Target
HAProxyConfigurationManagementApi getLogTargets GET /services/haproxy/configuration/log_targets Return an array of all Log Targets
HAProxyConfigurationManagementApi getServer GET /services/haproxy/configuration/servers/{name} Return one server
HAProxyConfigurationManagementApi getServerSwitchingRule GET /services/haproxy/configuration/server_switching_rules/{id} Return one Server Switching Rule
HAProxyConfigurationManagementApi getServerSwitchingRules GET /services/haproxy/configuration/server_switching_rules Return an array of all Server Switching Rules
HAProxyConfigurationManagementApi getServers GET /services/haproxy/configuration/servers Return an array of servers
HAProxyConfigurationManagementApi getStickRule GET /services/haproxy/configuration/stick_rules/{id} Return one Stick Rule
HAProxyConfigurationManagementApi getStickRules GET /services/haproxy/configuration/stick_rules Return an array of all Stick Rules
HAProxyConfigurationManagementApi getTCPRequestRule GET /services/haproxy/configuration/tcp_request_rules/{id} Return one TCP Request Rule
HAProxyConfigurationManagementApi getTCPRequestRules GET /services/haproxy/configuration/tcp_request_rules Return an array of all TCP Request Rules
HAProxyConfigurationManagementApi getTCPResponseRule GET /services/haproxy/configuration/tcp_response_rules/{id} Return one TCP Response Rule
HAProxyConfigurationManagementApi getTCPResponseRules GET /services/haproxy/configuration/tcp_response_rules Return an array of all TCP Response Rules
HAProxyConfigurationManagementApi postHAProxyConfiguration POST /services/haproxy/configuration/raw Push new haproxy configuration
HAProxyConfigurationManagementApi replaceAcl PUT /services/haproxy/configuration/acls/{id} Replace a ACL line
HAProxyConfigurationManagementApi replaceBackend PUT /services/haproxy/configuration/backends/{name} Replace a backend
HAProxyConfigurationManagementApi replaceBackendSwitchingRule PUT /services/haproxy/configuration/backend_switching_rules/{id} Replace a Backend Switching Rule
HAProxyConfigurationManagementApi replaceBind PUT /services/haproxy/configuration/binds/{name} Replace a bind
HAProxyConfigurationManagementApi replaceDefaults PUT /services/haproxy/configuration/defaults Replace defaults
HAProxyConfigurationManagementApi replaceFilter PUT /services/haproxy/configuration/filters/{id} Replace a Filter
HAProxyConfigurationManagementApi replaceFrontend PUT /services/haproxy/configuration/frontends/{name} Replace a frontend
HAProxyConfigurationManagementApi replaceGlobal PUT /services/haproxy/configuration/global Replace global
HAProxyConfigurationManagementApi replaceHTTPRequestRule PUT /services/haproxy/configuration/http_request_rules/{id} Replace a HTTP Request Rule
HAProxyConfigurationManagementApi replaceHTTPResponseRule PUT /services/haproxy/configuration/http_response_rules/{id} Replace a HTTP Response Rule
HAProxyConfigurationManagementApi replaceLogTarget PUT /services/haproxy/configuration/log_targets/{id} Replace a Log Target
HAProxyConfigurationManagementApi replaceServer PUT /services/haproxy/configuration/servers/{name} Replace a server
HAProxyConfigurationManagementApi replaceServerSwitchingRule PUT /services/haproxy/configuration/server_switching_rules/{id} Replace a Server Switching Rule
HAProxyConfigurationManagementApi replaceStickRule PUT /services/haproxy/configuration/stick_rules/{id} Replace a Stick Rule
HAProxyConfigurationManagementApi replaceTCPRequestRule PUT /services/haproxy/configuration/tcp_request_rules/{id} Replace a TCP Request Rule
HAProxyConfigurationManagementApi replaceTCPResponseRule PUT /services/haproxy/configuration/tcp_response_rules/{id} Replace a TCP Response Rule
HTTPRequestRuleApi createHTTPRequestRule POST /services/haproxy/configuration/http_request_rules Add a new HTTP Request Rule
HTTPRequestRuleApi deleteHTTPRequestRule DELETE /services/haproxy/configuration/http_request_rules/{id} Delete a HTTP Request Rule
HTTPRequestRuleApi getHTTPRequestRule GET /services/haproxy/configuration/http_request_rules/{id} Return one HTTP Request Rule
HTTPRequestRuleApi getHTTPRequestRules GET /services/haproxy/configuration/http_request_rules Return an array of all HTTP Request Rules
HTTPRequestRuleApi replaceHTTPRequestRule PUT /services/haproxy/configuration/http_request_rules/{id} Replace a HTTP Request Rule
HTTPResponseRuleApi createHTTPResponseRule POST /services/haproxy/configuration/http_response_rules Add a new HTTP Response Rule
HTTPResponseRuleApi deleteHTTPResponseRule DELETE /services/haproxy/configuration/http_response_rules/{id} Delete a HTTP Response Rule
HTTPResponseRuleApi getHTTPResponseRule GET /services/haproxy/configuration/http_response_rules/{id} Return one HTTP Response Rule
HTTPResponseRuleApi getHTTPResponseRules GET /services/haproxy/configuration/http_response_rules Return an array of all HTTP Response Rules
HTTPResponseRuleApi replaceHTTPResponseRule PUT /services/haproxy/configuration/http_response_rules/{id} Replace a HTTP Response Rule
InformationApi getHaproxyProcessInfo GET /services/haproxy/runtime/info Return HAProxy process information
InformationApi getInfo GET /info Return API, hardware and OS information
LogTargetApi createLogTarget POST /services/haproxy/configuration/log_targets Add a new Log Target
LogTargetApi deleteLogTarget DELETE /services/haproxy/configuration/log_targets/{id} Delete a Log Target
LogTargetApi getLogTarget GET /services/haproxy/configuration/log_targets/{id} Return one Log Target
LogTargetApi getLogTargets GET /services/haproxy/configuration/log_targets Return an array of all Log Targets
LogTargetApi replaceLogTarget PUT /services/haproxy/configuration/log_targets/{id} Replace a Log Target
ReloadsApi getReload GET /services/haproxy/reloads/{id} Return one HAProxy reload status
ReloadsApi getReloads GET /services/haproxy/reloads Return list of HAProxy Reloads.
ServerApi createServer POST /services/haproxy/configuration/servers Add a new server
ServerApi deleteServer DELETE /services/haproxy/configuration/servers/{name} Delete a server
ServerApi getRuntimeServer GET /services/haproxy/runtime/servers/{name} Return one server runtime settings
ServerApi getRuntimeServers GET /services/haproxy/runtime/servers Return an array of runtime servers' setings
ServerApi getServer GET /services/haproxy/configuration/servers/{name} Return one server
ServerApi getServers GET /services/haproxy/configuration/servers Return an array of servers
ServerApi replaceRuntimeServer PUT /services/haproxy/runtime/servers/{name} Replace server transient settings
ServerApi replaceServer PUT /services/haproxy/configuration/servers/{name} Replace a server
ServerSwitchingRuleApi createServerSwitchingRule POST /services/haproxy/configuration/server_switching_rules Add a new Server Switching Rule
ServerSwitchingRuleApi deleteServerSwitchingRule DELETE /services/haproxy/configuration/server_switching_rules/{id} Delete a Server Switching Rule
ServerSwitchingRuleApi getServerSwitchingRule GET /services/haproxy/configuration/server_switching_rules/{id} Return one Server Switching Rule
ServerSwitchingRuleApi getServerSwitchingRules GET /services/haproxy/configuration/server_switching_rules Return an array of all Server Switching Rules
ServerSwitchingRuleApi replaceServerSwitchingRule PUT /services/haproxy/configuration/server_switching_rules/{id} Replace a Server Switching Rule
SitesApi createSite POST /services/haproxy/sites Add a site
SitesApi deleteSite DELETE /services/haproxy/sites/{name} Delete a site
SitesApi getSite GET /services/haproxy/sites/{name} Return a site
SitesApi getSites GET /services/haproxy/sites Return an array of sites
SitesApi replaceSite PUT /services/haproxy/sites/{name} Replace a site
SpecificationApi getSpecification GET /specification Data Plane API Specification
StatsApi getStats GET /services/haproxy/stats/native Gets stats
StickRuleApi createStickRule POST /services/haproxy/configuration/stick_rules Add a new Stick Rule
StickRuleApi deleteStickRule DELETE /services/haproxy/configuration/stick_rules/{id} Delete a Stick Rule
StickRuleApi getStickRule GET /services/haproxy/configuration/stick_rules/{id} Return one Stick Rule
StickRuleApi getStickRules GET /services/haproxy/configuration/stick_rules Return an array of all Stick Rules
StickRuleApi replaceStickRule PUT /services/haproxy/configuration/stick_rules/{id} Replace a Stick Rule
StickTableApi getStickTable GET /services/haproxy/runtime/stick_tables/{name} Return Stick Table
StickTableApi getStickTableEntries GET /services/haproxy/runtime/stick_table_entries Return Stick Table Entries
StickTableApi getStickTables GET /services/haproxy/runtime/stick_tables Return Stick Tables
TCPRequestRuleApi createTCPRequestRule POST /services/haproxy/configuration/tcp_request_rules Add a new TCP Request Rule
TCPRequestRuleApi deleteTCPRequestRule DELETE /services/haproxy/configuration/tcp_request_rules/{id} Delete a TCP Request Rule
TCPRequestRuleApi getTCPRequestRule GET /services/haproxy/configuration/tcp_request_rules/{id} Return one TCP Request Rule
TCPRequestRuleApi getTCPRequestRules GET /services/haproxy/configuration/tcp_request_rules Return an array of all TCP Request Rules
TCPRequestRuleApi replaceTCPRequestRule PUT /services/haproxy/configuration/tcp_request_rules/{id} Replace a TCP Request Rule
TCPResponseRuleApi createTCPResponseRule POST /services/haproxy/configuration/tcp_response_rules Add a new TCP Response Rule
TCPResponseRuleApi deleteTCPResponseRule DELETE /services/haproxy/configuration/tcp_response_rules/{id} Delete a TCP Response Rule
TCPResponseRuleApi getTCPResponseRule GET /services/haproxy/configuration/tcp_response_rules/{id} Return one TCP Response Rule
TCPResponseRuleApi getTCPResponseRules GET /services/haproxy/configuration/tcp_response_rules Return an array of all TCP Response Rules
TCPResponseRuleApi replaceTCPResponseRule PUT /services/haproxy/configuration/tcp_response_rules/{id} Replace a TCP Response Rule
TransactionsApi commitTransaction PUT /services/haproxy/transactions/{id} Commit transaction
TransactionsApi deleteTransaction DELETE /services/haproxy/transactions/{id} Delete a transaction
TransactionsApi getTransaction GET /services/haproxy/transactions/{id} Return one HAProxy configuration transactions
TransactionsApi getTransactions GET /services/haproxy/transactions Return list of HAProxy configuration transactions.
TransactionsApi startTransaction POST /services/haproxy/transactions Start a new transaction

Documentation For Models

Documentation For Authorization

basic_auth

  • Type: HTTP basic authentication