Skip to content

Latest commit

 

History

History
184 lines (110 loc) · 7.16 KB

File metadata and controls

184 lines (110 loc) · 7.16 KB

\FilterApi

All URIs are relative to http://127.0.0.1/v2

Method HTTP request Description
create_filter POST /services/haproxy/configuration/filters Add a new Filter
delete_filter DELETE /services/haproxy/configuration/filters/{index} Delete a Filter
get_filter GET /services/haproxy/configuration/filters/{index} Return one Filter
get_filters GET /services/haproxy/configuration/filters Return an array of all Filters
replace_filter PUT /services/haproxy/configuration/filters/{index} Replace a Filter

create_filter

crate::models::Filter create_filter(parent_name, parent_type, filter, transaction_id, version, force_reload) Add a new Filter

Adds a new Filter of the specified type in the specified parent.

Parameters

Name Type Description Required Notes
parent_name String Parent name [required]
parent_type String Parent type [required]
filter Filter [required]
transaction_id Option<String> ID of the transaction where we want to add the operation. Cannot be used when version is specified.
version Option<i32> Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version.
force_reload Option<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. [default to false]

Return type

crate::models::Filter

Authorization

basic_auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_filter

delete_filter(index, parent_name, parent_type, transaction_id, version, force_reload) Delete a Filter

Deletes a Filter configuration by it's index from the specified parent.

Parameters

Name Type Description Required Notes
index i32 Filter Index [required]
parent_name String Parent name [required]
parent_type String Parent type [required]
transaction_id Option<String> ID of the transaction where we want to add the operation. Cannot be used when version is specified.
version Option<i32> Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version.
force_reload Option<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. [default to false]

Return type

(empty response body)

Authorization

basic_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_filter

crate::models::GetFilter200Response get_filter(index, parent_name, parent_type, transaction_id) Return one Filter

Returns one Filter configuration by it's index in the specified parent.

Parameters

Name Type Description Required Notes
index i32 Filter Index [required]
parent_name String Parent name [required]
parent_type String Parent type [required]
transaction_id Option<String> ID of the transaction where we want to add the operation. Cannot be used when version is specified.

Return type

crate::models::GetFilter200Response

Authorization

basic_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_filters

crate::models::GetFilters200Response get_filters(parent_name, parent_type, transaction_id) Return an array of all Filters

Returns all Filters that are configured in specified parent.

Parameters

Name Type Description Required Notes
parent_name String Parent name [required]
parent_type String Parent type [required]
transaction_id Option<String> ID of the transaction where we want to add the operation. Cannot be used when version is specified.

Return type

crate::models::GetFilters200Response

Authorization

basic_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

replace_filter

crate::models::Filter replace_filter(index, parent_name, parent_type, filter, transaction_id, version, force_reload) Replace a Filter

Replaces a Filter configuration by it's index in the specified parent.

Parameters

Name Type Description Required Notes
index i32 Filter Index [required]
parent_name String Parent name [required]
parent_type String Parent type [required]
filter Filter [required]
transaction_id Option<String> ID of the transaction where we want to add the operation. Cannot be used when version is specified.
version Option<i32> Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version.
force_reload Option<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. [default to false]

Return type

crate::models::Filter

Authorization

basic_auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]