Skip to content

Latest commit

 

History

History
239 lines (137 loc) · 9.29 KB

File metadata and controls

239 lines (137 loc) · 9.29 KB

\DefaultsApi

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

Method HTTP request Description
create_defaults_section POST /services/haproxy/configuration/named_defaults Add a defaults section
delete_defaults_section DELETE /services/haproxy/configuration/named_defaults/{name} Delete a defaults section
get_defaults GET /services/haproxy/configuration/defaults Return defaults part of configuration
get_defaults_section GET /services/haproxy/configuration/named_defaults/{name} Return a defaults section
get_defaults_sections GET /services/haproxy/configuration/named_defaults Return an array of defaults
replace_defaults PUT /services/haproxy/configuration/defaults Replace defaults
replace_defaults_section PUT /services/haproxy/configuration/named_defaults/{name} Replace a defatults section

create_defaults_section

crate::models::Defaults create_defaults_section(defaults, transaction_id, version, force_reload) Add a defaults section

Adds a new defaults section to the configuration file.

Parameters

Name Type Description Required Notes
defaults Defaults [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::Defaults

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_defaults_section

delete_defaults_section(name, transaction_id, version, force_reload) Delete a defaults section

Deletes a defaults section from the configuration by it's name.

Parameters

Name Type Description Required Notes
name String Defaults 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_defaults

crate::models::GetDefaults200Response get_defaults(transaction_id) Return defaults part of configuration

Returns defaults part of configuration, this has been deprecated, use named_defaults instead.

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

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_defaults_section

crate::models::GetDefaults200Response get_defaults_section(name, transaction_id) Return a defaults section

Returns one defaults section configuration by it's name.

Parameters

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

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_defaults_sections

crate::models::GetDefaultsSections200Response get_defaults_sections(transaction_id) Return an array of defaults

Returns an array of all configured defaults.

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

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_defaults

crate::models::Defaults replace_defaults(defaults, transaction_id, version, force_reload) Replace defaults

Replace defaults part of config, this has been deprecated, use named_defaults instead.

Parameters

Name Type Description Required Notes
defaults Defaults [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::Defaults

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]

replace_defaults_section

crate::models::Defaults replace_defaults_section(name, defaults, transaction_id, version, force_reload) Replace a defatults section

Replaces a defatults section configuration by it's name.

Parameters

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

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]