Skip to content

LogForwardApi.md

Latest commit

 

History

History
174 lines (100 loc) · 6.66 KB

LogForwardApi.md

File metadata and controls

174 lines (100 loc) · 6.66 KB
Raw

\LogForwardApi

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

Method HTTP request Description
create_log_forward POST /services/haproxy/configuration/log_forwards Add a log forward
delete_log_forward DELETE /services/haproxy/configuration/log_forwards/{name} Delete a log forward
get_log_forward GET /services/haproxy/configuration/log_forwards/{name} Return a log forward
get_log_forwards GET /services/haproxy/configuration/log_forwards Return an array of log forwards
replace_log_forward PUT /services/haproxy/configuration/log_forwards/{name} Replace a log forward

create_log_forward

crate::models::LogForward create_log_forward(log_forward, transaction_id, version, force_reload) Add a log forward

Adds a new log_forward to the configuration file.

Parameters

Name Type Description Required Notes
log_forward LogForward [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::LogForward

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_log_forward

delete_log_forward(name, transaction_id, version, force_reload) Delete a log forward

Deletes a log forward from the configuration by it's name.

Parameters

Name Type Description Required Notes
name String Log Forward name [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_log_forward

crate::models::GetLogForward200Response get_log_forward(name, transaction_id) Return a log forward

Returns one log forward configuration by it's name.

Parameters

Name Type Description Required Notes
name String Log Forward name [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::GetLogForward200Response

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_log_forwards

crate::models::GetLogForwards200Response get_log_forwards(transaction_id) Return an array of log forwards

Returns an array of all configured log forwards.

Parameters

Name Type Description Required Notes
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::GetLogForwards200Response

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_log_forward

crate::models::LogForward replace_log_forward(name, log_forward, transaction_id, version, force_reload) Replace a log forward

Replaces a log forward configuration by it's name.

Parameters

Name Type Description Required Notes
name String Log Forward name [required]
log_forward LogForward [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::LogForward

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]