Skip to content

Latest commit

 

History

History
139 lines (79 loc) · 4.98 KB

File metadata and controls

139 lines (79 loc) · 4.98 KB

\UserlistApi

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

Method HTTP request Description
create_userlist POST /services/haproxy/configuration/userlists Add a new userlist
delete_userlist DELETE /services/haproxy/configuration/userlists/{name} Delete a userlist
get_userlist GET /services/haproxy/configuration/userlists/{name} Return one userlist
get_userlists GET /services/haproxy/configuration/userlists Return an array of userlists

create_userlist

crate::models::Userlist create_userlist(userlist, transaction_id, version, force_reload) Add a new userlist

Adds a new userlist to the configuration file.

Parameters

Name Type Description Required Notes
userlist Userlist [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::Userlist

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_userlist

delete_userlist(name, transaction_id, version, force_reload) Delete a userlist

Deletes a userlist configuration by it's name.

Parameters

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

crate::models::GetUserlist200Response get_userlist(name, transaction_id) Return one userlist

Returns one userlist configuration by it's name.

Parameters

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

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_userlists

crate::models::GetUserlists200Response get_userlists(transaction_id) Return an array of userlists

Returns an array of all configured userlists.

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

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]