Skip to content

Latest commit

 

History

History
174 lines (100 loc) · 6.29 KB

File metadata and controls

174 lines (100 loc) · 6.29 KB

\CacheApi

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

Method HTTP request Description
create_cache POST /services/haproxy/configuration/caches Add a cache
delete_cache DELETE /services/haproxy/configuration/caches/{name} Delete a cache
get_cache GET /services/haproxy/configuration/caches/{name} Return a cache
get_caches GET /services/haproxy/configuration/caches Return an array of caches
replace_cache PUT /services/haproxy/configuration/caches/{name} Replace a cache

create_cache

crate::models::Cache create_cache(cache, transaction_id, version, force_reload) Add a cache

Adds a new cache section to the configuration file.

Parameters

Name Type Description Required Notes
cache Cache [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::Cache

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_cache

delete_cache(name, transaction_id, version, force_reload) Delete a cache

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

Parameters

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

crate::models::GetCache200Response get_cache(name, transaction_id) Return a cache

Returns one cache section configuration by it's name.

Parameters

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

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_caches

crate::models::GetCaches200Response get_caches(transaction_id) Return an array of caches

Returns an array of all configured caches.

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

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_cache

crate::models::Cache replace_cache(name, cache, transaction_id, version, force_reload) Replace a cache

Replaces a cache configuration by it's name.

Parameters

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

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]