Skip to content

HttpResponseRuleApi.md

Latest commit

 

History

History
184 lines (110 loc) · 7.93 KB

HttpResponseRuleApi.md

File metadata and controls

184 lines (110 loc) · 7.93 KB
Raw

\HttpResponseRuleApi

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

Method HTTP request Description
create_http_response_rule POST /services/haproxy/configuration/http_response_rules Add a new HTTP Response Rule
delete_http_response_rule DELETE /services/haproxy/configuration/http_response_rules/{index} Delete a HTTP Response Rule
get_http_response_rule GET /services/haproxy/configuration/http_response_rules/{index} Return one HTTP Response Rule
get_http_response_rules GET /services/haproxy/configuration/http_response_rules Return an array of all HTTP Response Rules
replace_http_response_rule PUT /services/haproxy/configuration/http_response_rules/{index} Replace a HTTP Response Rule

create_http_response_rule

crate::models::HttpResponseRule create_http_response_rule(parent_name, parent_type, http_response_rule, transaction_id, version, force_reload) Add a new HTTP Response Rule

Adds a new HTTP Response Rule 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]
http_response_rule HttpResponseRule [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::HttpResponseRule

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_http_response_rule

delete_http_response_rule(index, parent_name, parent_type, transaction_id, version, force_reload) Delete a HTTP Response Rule

Deletes a HTTP Response Rule configuration by it's index from the specified parent.

Parameters

Name Type Description Required Notes
index i32 HTTP Response Rule 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_http_response_rule

crate::models::GetHttpResponseRule200Response get_http_response_rule(index, parent_name, parent_type, transaction_id) Return one HTTP Response Rule

Returns one HTTP Response Rule configuration by it's index in the specified parent.

Parameters

Name Type Description Required Notes
index i32 HTTP Response Rule 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::GetHttpResponseRule200Response

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_http_response_rules

crate::models::GetHttpResponseRules200Response get_http_response_rules(parent_name, parent_type, transaction_id) Return an array of all HTTP Response Rules

Returns all HTTP Response Rules 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::GetHttpResponseRules200Response

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_http_response_rule

crate::models::HttpResponseRule replace_http_response_rule(index, parent_name, parent_type, http_response_rule, transaction_id, version, force_reload) Replace a HTTP Response Rule

Replaces a HTTP Response Rule configuration by it's index in the specified parent.

Parameters

Name Type Description Required Notes
index i32 HTTP Response Rule Index [required]
parent_name String Parent name [required]
parent_type String Parent type [required]
http_response_rule HttpResponseRule [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::HttpResponseRule

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]