Skip to content

Latest commit

 

History

History
169 lines (100 loc) · 6.47 KB

File metadata and controls

169 lines (100 loc) · 6.47 KB

\GroupApi

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

Method HTTP request Description
create_group POST /services/haproxy/configuration/groups Add a new userlist group
delete_group DELETE /services/haproxy/configuration/groups/{name} Delete a group
get_group GET /services/haproxy/configuration/groups/{name} Return one userlist group
get_groups GET /services/haproxy/configuration/groups Return an array of userlist groups
replace_group PUT /services/haproxy/configuration/groups/{name} Replace a group

create_group

crate::models::Group create_group(userlist, group, transaction_id, version, force_reload) Add a new userlist group

Parameters

Name Type Description Required Notes
userlist String Parent userlist name [required]
group Group [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::Group

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_group

delete_group(name, userlist, transaction_id, version, force_reload) Delete a group

Parameters

Name Type Description Required Notes
name String group name [required]
userlist String Parent userlist 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_group

crate::models::GetGroup200Response get_group(name, userlist, transaction_id) Return one userlist group

Parameters

Name Type Description Required Notes
name String Group name [required]
userlist String Parent userlist 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::GetGroup200Response

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_groups

crate::models::GetGroups200Response get_groups(userlist, transaction_id) Return an array of userlist groups

Parameters

Name Type Description Required Notes
userlist String Parent userlist 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::GetGroups200Response

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_group

crate::models::Group replace_group(name, userlist, group, transaction_id, version, force_reload) Replace a group

Parameters

Name Type Description Required Notes
name String group name [required]
userlist String Parent userlist name [required]
group Group [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::Group

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]