Skip to content

Latest commit

 

History

History
169 lines (100 loc) · 6.46 KB

File metadata and controls

169 lines (100 loc) · 6.46 KB

\UserApi

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

Method HTTP request Description
create_user POST /services/haproxy/configuration/users Add a new userlist user
delete_user DELETE /services/haproxy/configuration/users/{username} Delete a user
get_user GET /services/haproxy/configuration/users/{username} Return one userlist user
get_users GET /services/haproxy/configuration/users Return an array of userlist users
replace_user PUT /services/haproxy/configuration/users/{username} Replace a user

create_user

crate::models::User create_user(userlist, user, transaction_id, version, force_reload) Add a new userlist user

Parameters

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

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_user

delete_user(username, userlist, transaction_id, version, force_reload) Delete a user

Parameters

Name Type Description Required Notes
username String User username [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_user

crate::models::GetUser200Response get_user(username, userlist, transaction_id) Return one userlist user

Parameters

Name Type Description Required Notes
username String User username [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::GetUser200Response

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_users

crate::models::GetUsers200Response get_users(userlist, transaction_id) Return an array of userlist users

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

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_user

crate::models::User replace_user(username, userlist, user, transaction_id, version, force_reload) Replace a user

Parameters

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

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]