Skip to content

Latest commit

 

History

History
174 lines (100 loc) · 6.58 KB

File metadata and controls

174 lines (100 loc) · 6.58 KB

\ProcessManagerApi

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

Method HTTP request Description
create_program POST /services/haproxy/configuration/programs Add a program
delete_program DELETE /services/haproxy/configuration/programs/{name} Delete a program
get_program GET /services/haproxy/configuration/programs/{name} Return a program
get_programs GET /services/haproxy/configuration/programs Return an array of programs
replace_program PUT /services/haproxy/configuration/programs/{name} Replace a program

create_program

crate::models::Program create_program(program, transaction_id, version, force_reload) Add a program

Adds a new program to the process-manager configuration file.

Parameters

Name Type Description Required Notes
program Program [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::Program

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_program

delete_program(name, transaction_id, version, force_reload) Delete a program

Deletes a program from the process-manager configuration file by its name.

Parameters

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

crate::models::GetProgram200Response get_program(name, transaction_id) Return a program

Returns one program by its name from the process-manager configuration file.

Parameters

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

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_programs

crate::models::GetPrograms200Response get_programs(transaction_id) Return an array of programs

Returns an array of all configured programs in the process-manager configuration file.

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

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_program

crate::models::Program replace_program(name, program, transaction_id, version, force_reload) Replace a program

Replaces a program from the process-manager configuration by its name.

Parameters

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

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]