Skip to content

Latest commit

 

History

History
174 lines (100 loc) · 6.48 KB

File metadata and controls

174 lines (100 loc) · 6.48 KB

\FrontendApi

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

Method HTTP request Description
create_frontend POST /services/haproxy/configuration/frontends Add a frontend
delete_frontend DELETE /services/haproxy/configuration/frontends/{name} Delete a frontend
get_frontend GET /services/haproxy/configuration/frontends/{name} Return a frontend
get_frontends GET /services/haproxy/configuration/frontends Return an array of frontends
replace_frontend PUT /services/haproxy/configuration/frontends/{name} Replace a frontend

create_frontend

crate::models::Frontend create_frontend(frontend, transaction_id, version, force_reload) Add a frontend

Adds a new frontend to the configuration file.

Parameters

Name Type Description Required Notes
frontend Frontend [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::Frontend

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_frontend

delete_frontend(name, transaction_id, version, force_reload) Delete a frontend

Deletes a frontend from the configuration by it's name.

Parameters

Name Type Description Required Notes
name String Frontend 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_frontend

crate::models::GetFrontend200Response get_frontend(name, transaction_id) Return a frontend

Returns one frontend configuration by it's name.

Parameters

Name Type Description Required Notes
name String Frontend 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::GetFrontend200Response

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_frontends

crate::models::GetFrontends200Response get_frontends(transaction_id) Return an array of frontends

Returns an array of all configured frontends.

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::GetFrontends200Response

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_frontend

crate::models::Frontend replace_frontend(name, frontend, transaction_id, version, force_reload) Replace a frontend

Replaces a frontend configuration by it's name.

Parameters

Name Type Description Required Notes
name String Frontend name [required]
frontend Frontend [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::Frontend

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]