Skip to content

RingApi.md

Latest commit

 

History

History
174 lines (100 loc) · 6.21 KB

RingApi.md

File metadata and controls

174 lines (100 loc) · 6.21 KB

\RingApi

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

Method HTTP request Description
create_ring POST /services/haproxy/configuration/rings Add a ring
delete_ring DELETE /services/haproxy/configuration/rings/{name} Delete a ring
get_ring GET /services/haproxy/configuration/rings/{name} Return a ring
get_rings GET /services/haproxy/configuration/rings Return an array of rings
replace_ring PUT /services/haproxy/configuration/rings/{name} Replace a ring

create_ring

crate::models::Ring create_ring(ring, transaction_id, version, force_reload) Add a ring

Adds a new ring to the configuration file.

Parameters

Name Type Description Required Notes
ring Ring [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::Ring

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_ring

delete_ring(name, transaction_id, version, force_reload) Delete a ring

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

Parameters

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

crate::models::GetRing200Response get_ring(name, transaction_id) Return a ring

Returns one ring configuration by it's name.

Parameters

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

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_rings

crate::models::GetRings200Response get_rings(transaction_id) Return an array of rings

Returns an array of all configured rings.

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

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_ring

crate::models::Ring replace_ring(name, ring, transaction_id, version, force_reload) Replace a ring

Replaces a ring configuration by it's name.

Parameters

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

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]